httplib.h 790 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157
  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_int_in_range(const char *s, size_t len, int lo, int hi,
  698. int &out) {
  699. int val = 0;
  700. auto r = from_chars(s, s + len, val);
  701. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  702. return false;
  703. }
  704. out = val;
  705. return true;
  706. }
  707. inline bool parse_port(const char *s, size_t len, int &port) {
  708. return parse_int_in_range(s, len, 1, 65535, port);
  709. }
  710. inline bool parse_port(const std::string &s, int &port) {
  711. return parse_port(s.data(), s.size(), port);
  712. }
  713. struct UrlComponents {
  714. std::string scheme;
  715. std::string host;
  716. std::string port;
  717. std::string path;
  718. std::string query;
  719. };
  720. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  721. uc = {};
  722. size_t pos = 0;
  723. auto sep = url.find("://");
  724. if (sep != std::string::npos) {
  725. uc.scheme = url.substr(0, sep);
  726. // Scheme must be [a-z]+ only
  727. if (uc.scheme.empty()) { return false; }
  728. for (auto c : uc.scheme) {
  729. if (c < 'a' || c > 'z') { return false; }
  730. }
  731. pos = sep + 3;
  732. } else if (url.compare(0, 2, "//") == 0) {
  733. pos = 2;
  734. }
  735. auto has_authority_prefix = pos > 0;
  736. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  737. url[0] != '?' && url[0] != '#');
  738. if (has_authority) {
  739. if (pos < url.size() && url[pos] == '[') {
  740. auto close = url.find(']', pos);
  741. if (close == std::string::npos) { return false; }
  742. uc.host = url.substr(pos + 1, close - pos - 1);
  743. // IPv6 host must be [a-fA-F0-9:]+ only
  744. if (uc.host.empty()) { return false; }
  745. for (auto c : uc.host) {
  746. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  747. (c >= 'A' && c <= 'F') || c == ':')) {
  748. return false;
  749. }
  750. }
  751. pos = close + 1;
  752. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  753. // path, query or fragment delimiter (or the end of input). Otherwise the
  754. // trailing bytes would be folded into the path while the connection
  755. // still targets the bracketed address.
  756. if (pos < url.size()) {
  757. auto c = url[pos];
  758. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  759. }
  760. } else {
  761. auto end = url.find_first_of(":/?#", pos);
  762. if (end == std::string::npos) { end = url.size(); }
  763. uc.host = url.substr(pos, end - pos);
  764. pos = end;
  765. }
  766. if (pos < url.size() && url[pos] == ':') {
  767. ++pos;
  768. auto end = url.find_first_of("/?#", pos);
  769. if (end == std::string::npos) { end = url.size(); }
  770. uc.port = url.substr(pos, end - pos);
  771. pos = end;
  772. }
  773. // Without :// or //, the entire input must be consumed as host[:port].
  774. // If there is leftover (path, query, etc.), this is not a valid
  775. // host[:port] string — clear and reparse as a plain path.
  776. if (!has_authority_prefix && pos < url.size()) {
  777. uc.host.clear();
  778. uc.port.clear();
  779. pos = 0;
  780. }
  781. }
  782. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  783. auto end = url.find_first_of("?#", pos);
  784. if (end == std::string::npos) { end = url.size(); }
  785. uc.path = url.substr(pos, end - pos);
  786. pos = end;
  787. }
  788. if (pos < url.size() && url[pos] == '?') {
  789. auto end = url.find('#', pos);
  790. if (end == std::string::npos) { end = url.size(); }
  791. uc.query = url.substr(pos, end - pos);
  792. }
  793. return true;
  794. }
  795. // Resolves a relative-path or query-only Location value against the path of
  796. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  797. // references starting with '/' are returned unchanged.
  798. inline std::string resolve_relative_location(const std::string &location,
  799. const std::string &base) {
  800. if (location.empty() || location[0] == '/') { return location; }
  801. // A ':' in the first segment means the value has a scheme.
  802. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  803. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  804. auto base_path = base.substr(0, base.find_first_of("?#"));
  805. if (location[0] == '?') { return base_path + location; }
  806. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  807. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  808. // Remove "." and ".." segments from the merged path.
  809. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  810. std::string path;
  811. size_t i = 0;
  812. while (i < path_end) {
  813. auto next = (std::min)(merged.find('/', i + 1), path_end);
  814. auto segment = merged.substr(i + 1, next - i - 1);
  815. auto is_last = next == path_end;
  816. if (segment == "." || segment == "..") {
  817. if (segment == "..") {
  818. path.erase((std::min)(path.rfind('/'), path.size()));
  819. }
  820. if (is_last) { path += '/'; }
  821. } else {
  822. path += '/';
  823. path += segment;
  824. }
  825. i = next;
  826. }
  827. if (path.empty()) { path = "/"; }
  828. return path + merged.substr(path_end);
  829. }
  830. } // namespace detail
  831. enum class SSLVerifierResponse {
  832. // no decision has been made, use the built-in certificate verifier
  833. NoDecisionMade,
  834. // connection certificate is verified and accepted
  835. CertificateAccepted,
  836. // connection certificate was processed but is rejected
  837. CertificateRejected
  838. };
  839. // System CA loading policy for SSL clients. Auto (the default) loads system
  840. // CA certs only when no custom CA is configured; enable_system_ca() switches
  841. // to an explicit policy.
  842. enum class SystemCAMode { Auto, Enabled, Disabled };
  843. enum StatusCode {
  844. // Information responses
  845. Continue_100 = 100,
  846. SwitchingProtocol_101 = 101,
  847. Processing_102 = 102,
  848. EarlyHints_103 = 103,
  849. // Successful responses
  850. OK_200 = 200,
  851. Created_201 = 201,
  852. Accepted_202 = 202,
  853. NonAuthoritativeInformation_203 = 203,
  854. NoContent_204 = 204,
  855. ResetContent_205 = 205,
  856. PartialContent_206 = 206,
  857. MultiStatus_207 = 207,
  858. AlreadyReported_208 = 208,
  859. IMUsed_226 = 226,
  860. // Redirection messages
  861. MultipleChoices_300 = 300,
  862. MovedPermanently_301 = 301,
  863. Found_302 = 302,
  864. SeeOther_303 = 303,
  865. NotModified_304 = 304,
  866. UseProxy_305 = 305,
  867. unused_306 = 306,
  868. TemporaryRedirect_307 = 307,
  869. PermanentRedirect_308 = 308,
  870. // Client error responses
  871. BadRequest_400 = 400,
  872. Unauthorized_401 = 401,
  873. PaymentRequired_402 = 402,
  874. Forbidden_403 = 403,
  875. NotFound_404 = 404,
  876. MethodNotAllowed_405 = 405,
  877. NotAcceptable_406 = 406,
  878. ProxyAuthenticationRequired_407 = 407,
  879. RequestTimeout_408 = 408,
  880. Conflict_409 = 409,
  881. Gone_410 = 410,
  882. LengthRequired_411 = 411,
  883. PreconditionFailed_412 = 412,
  884. PayloadTooLarge_413 = 413,
  885. UriTooLong_414 = 414,
  886. UnsupportedMediaType_415 = 415,
  887. RangeNotSatisfiable_416 = 416,
  888. ExpectationFailed_417 = 417,
  889. ImATeapot_418 = 418,
  890. MisdirectedRequest_421 = 421,
  891. UnprocessableContent_422 = 422,
  892. Locked_423 = 423,
  893. FailedDependency_424 = 424,
  894. TooEarly_425 = 425,
  895. UpgradeRequired_426 = 426,
  896. PreconditionRequired_428 = 428,
  897. TooManyRequests_429 = 429,
  898. RequestHeaderFieldsTooLarge_431 = 431,
  899. UnavailableForLegalReasons_451 = 451,
  900. // Server error responses
  901. InternalServerError_500 = 500,
  902. NotImplemented_501 = 501,
  903. BadGateway_502 = 502,
  904. ServiceUnavailable_503 = 503,
  905. GatewayTimeout_504 = 504,
  906. HttpVersionNotSupported_505 = 505,
  907. VariantAlsoNegotiates_506 = 506,
  908. InsufficientStorage_507 = 507,
  909. LoopDetected_508 = 508,
  910. NotExtended_510 = 510,
  911. NetworkAuthenticationRequired_511 = 511,
  912. };
  913. namespace detail {
  914. // A multimap that keeps its entries in the order they were inserted.
  915. //
  916. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  917. // fields sharing a field name significant and forbids a proxy from reordering
  918. // them, and a query string's parameters are meaningful in the order the caller
  919. // wrote them. Neither standard container expresses it: std::unordered_multimap
  920. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  921. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  922. // key, which would drop control data such as Host behind whatever else the
  923. // message carries and alphabetise a query string.
  924. //
  925. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  926. // scan, which beats hashing for the handful of entries a message carries
  927. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  928. //
  929. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  930. // Params, whose parameter names are case-sensitive, not.
  931. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  932. public:
  933. using key_type = std::string;
  934. using mapped_type = Mapped;
  935. using value_type = std::pair<std::string, Mapped>;
  936. using size_type = std::size_t;
  937. using difference_type = std::ptrdiff_t;
  938. using reference = value_type &;
  939. using const_reference = const value_type &;
  940. private:
  941. static size_type npos() { return static_cast<size_type>(-1); }
  942. static bool keys_equal(const std::string &a, const std::string &b) {
  943. return KeyEqual()(a, b);
  944. }
  945. // Iterating yields every entry in insertion order, but equal_range() and
  946. // find() have to walk only the entries sharing one key, which are not
  947. // adjacent. Both are the same iterator type: key_idx_ selects between the
  948. // two traversals, and since equality compares only the position, an iterator
  949. // restricted to one key still compares equal to end().
  950. template <typename V> class iterator_t {
  951. public:
  952. using iterator_category = std::bidirectional_iterator_tag;
  953. using value_type = insertion_ordered_multimap::value_type;
  954. using difference_type = insertion_ordered_multimap::difference_type;
  955. using pointer = V *;
  956. using reference = V &;
  957. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  958. template <typename U,
  959. typename std::enable_if<std::is_convertible<U *, V *>::value,
  960. int>::type = 0>
  961. iterator_t(const iterator_t<U> &rhs)
  962. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  963. key_idx_(rhs.key_idx_) {}
  964. reference operator*() const { return data_[idx_]; }
  965. pointer operator->() const { return data_ + idx_; }
  966. iterator_t &operator++() {
  967. // Saturating, so that advancing past the last entry of a key (which
  968. // get_multimap_value() does when asked for an out-of-range id) stays at
  969. // end() instead of running off the container.
  970. if (idx_ >= size_) { return *this; }
  971. ++idx_;
  972. if (key_idx_ != npos()) {
  973. while (idx_ < size_ && !matches(idx_)) {
  974. ++idx_;
  975. }
  976. }
  977. return *this;
  978. }
  979. iterator_t operator++(int) {
  980. auto tmp = *this;
  981. ++*this;
  982. return tmp;
  983. }
  984. iterator_t &operator--() {
  985. if (idx_ == 0) { return *this; }
  986. --idx_;
  987. if (key_idx_ != npos()) {
  988. while (idx_ > 0 && !matches(idx_)) {
  989. --idx_;
  990. }
  991. }
  992. return *this;
  993. }
  994. iterator_t operator--(int) {
  995. auto tmp = *this;
  996. --*this;
  997. return tmp;
  998. }
  999. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1000. return idx_ == rhs.idx_;
  1001. }
  1002. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1003. return idx_ != rhs.idx_;
  1004. }
  1005. private:
  1006. friend class insertion_ordered_multimap;
  1007. template <typename> friend class iterator_t;
  1008. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1009. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1010. bool matches(size_type i) const {
  1011. return keys_equal(data_[i].first, data_[key_idx_].first);
  1012. }
  1013. V *data_;
  1014. size_type idx_;
  1015. size_type size_;
  1016. size_type key_idx_;
  1017. };
  1018. public:
  1019. using iterator = iterator_t<value_type>;
  1020. using const_iterator = iterator_t<const value_type>;
  1021. insertion_ordered_multimap() = default;
  1022. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1023. : entries_(il) {}
  1024. template <typename InputIt>
  1025. insertion_ordered_multimap(InputIt first, InputIt last)
  1026. : entries_(first, last) {}
  1027. iterator begin() { return make_iter(0, npos()); }
  1028. iterator end() { return make_iter(entries_.size(), npos()); }
  1029. const_iterator begin() const { return make_citer(0, npos()); }
  1030. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1031. const_iterator cbegin() const { return begin(); }
  1032. const_iterator cend() const { return end(); }
  1033. bool empty() const { return entries_.empty(); }
  1034. size_type size() const { return entries_.size(); }
  1035. void clear() { entries_.clear(); }
  1036. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1037. iterator insert(const value_type &val) {
  1038. entries_.push_back(val);
  1039. return make_iter(entries_.size() - 1, npos());
  1040. }
  1041. iterator insert(value_type &&val) {
  1042. entries_.push_back(std::move(val));
  1043. return make_iter(entries_.size() - 1, npos());
  1044. }
  1045. template <typename... Args> iterator emplace(Args &&...args) {
  1046. entries_.emplace_back(std::forward<Args>(args)...);
  1047. return make_iter(entries_.size() - 1, npos());
  1048. }
  1049. // For entries that have to lead the message, such as the Host header field
  1050. // (RFC 9110 5.3 recommends sending control data first).
  1051. template <typename... Args> iterator emplace_front(Args &&...args) {
  1052. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1053. return make_iter(0, npos());
  1054. }
  1055. iterator find(const std::string &key) {
  1056. auto i = index_of(key);
  1057. return i == npos() ? end() : make_iter(i, i);
  1058. }
  1059. const_iterator find(const std::string &key) const {
  1060. auto i = index_of(key);
  1061. return i == npos() ? end() : make_citer(i, i);
  1062. }
  1063. size_type count(const std::string &key) const {
  1064. size_type n = 0;
  1065. for (const auto &entry : entries_) {
  1066. if (keys_equal(entry.first, key)) { n++; }
  1067. }
  1068. return n;
  1069. }
  1070. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1071. auto i = index_of(key);
  1072. return i == npos() ? std::make_pair(end(), end())
  1073. : std::make_pair(make_iter(i, i), end());
  1074. }
  1075. std::pair<const_iterator, const_iterator>
  1076. equal_range(const std::string &key) const {
  1077. auto i = index_of(key);
  1078. return i == npos() ? std::make_pair(end(), end())
  1079. : std::make_pair(make_citer(i, i), end());
  1080. }
  1081. size_type erase(const std::string &key) {
  1082. auto before = entries_.size();
  1083. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1084. [&](const value_type &entry) {
  1085. return keys_equal(entry.first, key);
  1086. }),
  1087. entries_.end());
  1088. return before - entries_.size();
  1089. }
  1090. iterator erase(const_iterator pos) {
  1091. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1092. return make_iter(pos.idx_, npos());
  1093. }
  1094. // Erases what iterating [first, last) would actually visit, so erasing an
  1095. // equal_range() removes only the entries with that key, not everything
  1096. // positioned between them.
  1097. iterator erase(const_iterator first, const_iterator last) {
  1098. auto from = first.idx_;
  1099. auto to = last.idx_;
  1100. if (from >= to) { return make_iter(from, npos()); }
  1101. auto begin_it = entries_.begin();
  1102. auto from_it = begin_it + static_cast<difference_type>(from);
  1103. auto to_it = begin_it + static_cast<difference_type>(to);
  1104. if (first.key_idx_ == npos()) {
  1105. entries_.erase(from_it, to_it);
  1106. } else {
  1107. auto key = entries_[first.key_idx_].first;
  1108. auto keep = from_it;
  1109. for (auto it = from_it; it != to_it; ++it) {
  1110. if (!keys_equal(it->first, key)) {
  1111. if (keep != it) { *keep = std::move(*it); }
  1112. ++keep;
  1113. }
  1114. }
  1115. if (keep != to_it) {
  1116. keep = std::move(to_it, entries_.end(), keep);
  1117. } else {
  1118. keep = entries_.end();
  1119. }
  1120. entries_.erase(keep, entries_.end());
  1121. }
  1122. return make_iter(from, npos());
  1123. }
  1124. friend bool operator==(const insertion_ordered_multimap &lhs,
  1125. const insertion_ordered_multimap &rhs) {
  1126. return lhs.entries_ == rhs.entries_;
  1127. }
  1128. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1129. const insertion_ordered_multimap &rhs) {
  1130. return !(lhs == rhs);
  1131. }
  1132. private:
  1133. size_type index_of(const std::string &key) const {
  1134. for (size_type i = 0; i < entries_.size(); i++) {
  1135. if (keys_equal(entries_[i].first, key)) { return i; }
  1136. }
  1137. return npos();
  1138. }
  1139. iterator make_iter(size_type idx, size_type key_idx) {
  1140. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1141. }
  1142. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1143. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1144. }
  1145. std::vector<value_type> entries_;
  1146. };
  1147. } // namespace detail
  1148. using Headers =
  1149. detail::insertion_ordered_multimap<std::string,
  1150. detail::case_ignore::equal_to>;
  1151. // Query parameter names are case-sensitive, unlike header field names.
  1152. using Params =
  1153. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1154. using Match = std::smatch;
  1155. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1156. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1157. /*
  1158. * detail: type-erased storage used by UserData.
  1159. * ABI-stable regardless of C++ standard — always uses this custom
  1160. * implementation instead of std::any.
  1161. */
  1162. namespace detail {
  1163. using any_type_id = const void *;
  1164. template <typename T> any_type_id any_typeid() noexcept {
  1165. static const char id = 0;
  1166. return &id;
  1167. }
  1168. struct any_storage {
  1169. virtual ~any_storage() = default;
  1170. virtual std::unique_ptr<any_storage> clone() const = 0;
  1171. virtual any_type_id type_id() const noexcept = 0;
  1172. };
  1173. template <typename T> struct any_value final : any_storage {
  1174. T value;
  1175. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1176. std::unique_ptr<any_storage> clone() const override {
  1177. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1178. }
  1179. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1180. };
  1181. } // namespace detail
  1182. class UserData {
  1183. public:
  1184. UserData() = default;
  1185. UserData(UserData &&) noexcept = default;
  1186. UserData &operator=(UserData &&) noexcept = default;
  1187. UserData(const UserData &o) {
  1188. for (const auto &e : o.entries_) {
  1189. if (e.second) { entries_[e.first] = e.second->clone(); }
  1190. }
  1191. }
  1192. UserData &operator=(const UserData &o) {
  1193. if (this != &o) {
  1194. entries_.clear();
  1195. for (const auto &e : o.entries_) {
  1196. if (e.second) { entries_[e.first] = e.second->clone(); }
  1197. }
  1198. }
  1199. return *this;
  1200. }
  1201. template <typename T> void set(const std::string &key, T &&value) {
  1202. using D = typename std::decay<T>::type;
  1203. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1204. }
  1205. template <typename T> T *get(const std::string &key) 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<detail::any_value<T> *>(it->second.get())->value;
  1210. }
  1211. template <typename T> const T *get(const std::string &key) const noexcept {
  1212. auto it = entries_.find(key);
  1213. if (it == entries_.end() || !it->second) { return nullptr; }
  1214. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1215. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1216. }
  1217. bool has(const std::string &key) const noexcept {
  1218. return entries_.find(key) != entries_.end();
  1219. }
  1220. void erase(const std::string &key) { entries_.erase(key); }
  1221. void clear() noexcept { entries_.clear(); }
  1222. private:
  1223. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1224. entries_;
  1225. };
  1226. struct Response;
  1227. using ResponseHandler = std::function<bool(const Response &response)>;
  1228. struct FormData {
  1229. std::string name;
  1230. std::string content;
  1231. std::string filename;
  1232. std::string content_type;
  1233. Headers headers;
  1234. };
  1235. struct FormField {
  1236. std::string name;
  1237. std::string content;
  1238. Headers headers;
  1239. };
  1240. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1241. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1242. // should see the parts as they were sent. A std::multimap sorts by field name
  1243. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1244. // than the case-insensitive predicate Headers uses.
  1245. using FormFields =
  1246. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1247. using FormFiles =
  1248. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1249. struct MultipartFormData {
  1250. FormFields fields; // Text fields from multipart
  1251. FormFiles files; // Files from multipart
  1252. // Text field access
  1253. std::string get_field(const std::string &key, size_t id = 0) const;
  1254. std::vector<std::string> get_fields(const std::string &key) const;
  1255. bool has_field(const std::string &key) const;
  1256. size_t get_field_count(const std::string &key) const;
  1257. // File access
  1258. FormData get_file(const std::string &key, size_t id = 0) const;
  1259. std::vector<FormData> get_files(const std::string &key) const;
  1260. bool has_file(const std::string &key) const;
  1261. size_t get_file_count(const std::string &key) const;
  1262. };
  1263. struct UploadFormData {
  1264. std::string name;
  1265. std::string content;
  1266. std::string filename;
  1267. std::string content_type;
  1268. };
  1269. using UploadFormDataItems = std::vector<UploadFormData>;
  1270. class DataSink {
  1271. public:
  1272. DataSink() : os(&sb_), sb_(*this) {}
  1273. DataSink(const DataSink &) = delete;
  1274. DataSink &operator=(const DataSink &) = delete;
  1275. DataSink(DataSink &&) = delete;
  1276. DataSink &operator=(DataSink &&) = delete;
  1277. std::function<bool(const char *data, size_t data_len)> write;
  1278. // Only `write` is mandatory. The rest are defaulted so that a provider
  1279. // calling one on a writer that does not set it gets sensible behaviour
  1280. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1281. // `this` is safe: DataSink is neither copyable nor movable.
  1282. std::function<bool()> is_writable = []() { return true; };
  1283. std::function<void()> done = []() {};
  1284. std::function<void(const Headers &trailer)> done_with_trailer =
  1285. [this](const Headers & /*trailer*/) { done(); };
  1286. std::ostream os;
  1287. private:
  1288. class data_sink_streambuf final : public std::streambuf {
  1289. public:
  1290. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1291. protected:
  1292. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1293. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1294. return 0;
  1295. }
  1296. private:
  1297. DataSink &sink_;
  1298. };
  1299. data_sink_streambuf sb_;
  1300. };
  1301. using ContentProvider =
  1302. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1303. using ContentProviderWithoutLength =
  1304. std::function<bool(size_t offset, DataSink &sink)>;
  1305. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1306. struct FormDataProvider {
  1307. std::string name;
  1308. ContentProviderWithoutLength provider;
  1309. std::string filename;
  1310. std::string content_type;
  1311. };
  1312. using FormDataProviderItems = std::vector<FormDataProvider>;
  1313. inline FormDataProvider
  1314. make_file_provider(const std::string &name, const std::string &filepath,
  1315. const std::string &filename = std::string(),
  1316. const std::string &content_type = std::string()) {
  1317. FormDataProvider fdp;
  1318. fdp.name = name;
  1319. fdp.filename = filename.empty() ? filepath : filename;
  1320. fdp.content_type = content_type;
  1321. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1322. std::ifstream f(filepath, std::ios::binary);
  1323. if (!f) { return false; }
  1324. if (offset > 0) {
  1325. f.seekg(static_cast<std::streamoff>(offset));
  1326. if (!f.good()) {
  1327. sink.done();
  1328. return true;
  1329. }
  1330. }
  1331. char buf[8192];
  1332. f.read(buf, sizeof(buf));
  1333. auto n = static_cast<size_t>(f.gcount());
  1334. if (n > 0) { return sink.write(buf, n); }
  1335. sink.done(); // EOF
  1336. return true;
  1337. };
  1338. return fdp;
  1339. }
  1340. inline std::pair<size_t, ContentProvider>
  1341. make_file_body(const std::string &filepath) {
  1342. size_t size = 0;
  1343. {
  1344. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1345. if (!f) { return {0, ContentProvider{}}; }
  1346. size = static_cast<size_t>(f.tellg());
  1347. }
  1348. ContentProvider provider = [filepath](size_t offset, size_t length,
  1349. DataSink &sink) -> bool {
  1350. std::ifstream f(filepath, std::ios::binary);
  1351. if (!f) { return false; }
  1352. f.seekg(static_cast<std::streamoff>(offset));
  1353. if (!f.good()) { return false; }
  1354. char buf[8192];
  1355. while (length > 0) {
  1356. auto to_read = (std::min)(sizeof(buf), length);
  1357. f.read(buf, static_cast<std::streamsize>(to_read));
  1358. auto n = static_cast<size_t>(f.gcount());
  1359. // The file is shorter than the size make_file_body() measured, which the
  1360. // caller has already committed to as Content-Length. The body cannot be
  1361. // completed, so fail as every other error here does.
  1362. if (n == 0) { return false; }
  1363. if (!sink.write(buf, n)) { return false; }
  1364. length -= n;
  1365. }
  1366. return true;
  1367. };
  1368. return {size, std::move(provider)};
  1369. }
  1370. using ContentReceiverWithProgress = std::function<bool(
  1371. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1372. using ContentReceiver =
  1373. std::function<bool(const char *data, size_t data_length)>;
  1374. using FormDataHeader = std::function<bool(const FormData &file)>;
  1375. class ContentReader {
  1376. public:
  1377. using Reader = std::function<bool(ContentReceiver receiver)>;
  1378. using FormDataReader =
  1379. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1380. ContentReader(Reader reader, FormDataReader multipart_reader)
  1381. : reader_(std::move(reader)),
  1382. formdata_reader_(std::move(multipart_reader)) {}
  1383. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1384. return formdata_reader_(std::move(header), std::move(receiver));
  1385. }
  1386. bool operator()(ContentReceiver receiver) const {
  1387. return reader_(std::move(receiver));
  1388. }
  1389. Reader reader_;
  1390. FormDataReader formdata_reader_;
  1391. };
  1392. using Range = std::pair<ssize_t, ssize_t>;
  1393. using Ranges = std::vector<Range>;
  1394. #ifdef CPPHTTPLIB_SSL_ENABLED
  1395. // TLS abstraction layer - public type definitions and API
  1396. namespace tls {
  1397. // Opaque handles (defined as void* for abstraction)
  1398. using ctx_t = void *;
  1399. using session_t = void *;
  1400. using const_session_t = const void *; // For read-only session access
  1401. using cert_t = void *;
  1402. using ca_store_t = void *;
  1403. // TLS versions
  1404. enum class Version {
  1405. TLS1_2 = 0x0303,
  1406. TLS1_3 = 0x0304,
  1407. };
  1408. // Subject Alternative Names (SAN) entry types
  1409. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1410. // SAN entry structure
  1411. struct SanEntry {
  1412. SanType type;
  1413. std::string value;
  1414. };
  1415. // Verification context for certificate verification callback
  1416. struct VerifyContext {
  1417. session_t session; // TLS session handle
  1418. cert_t cert; // Current certificate being verified
  1419. int depth; // Certificate chain depth (0 = leaf)
  1420. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1421. long error_code; // Backend-specific error code (0 = no error)
  1422. const char *error_string; // Human-readable error description
  1423. // Certificate introspection methods
  1424. std::string subject_cn() const;
  1425. std::string issuer_name() const;
  1426. bool check_hostname(const char *hostname) const;
  1427. std::vector<SanEntry> sans() const;
  1428. bool validity(time_t &not_before, time_t &not_after) const;
  1429. std::string serial() const;
  1430. };
  1431. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1432. // TlsError codes for TLS operations (backend-independent)
  1433. enum class ErrorCode : int {
  1434. Success = 0,
  1435. WantRead, // Non-blocking: need to wait for read
  1436. WantWrite, // Non-blocking: need to wait for write
  1437. PeerClosed, // Peer closed the connection
  1438. Fatal, // Unrecoverable error
  1439. SyscallError, // System call error (check sys_errno)
  1440. CertVerifyFailed, // Certificate verification failed
  1441. HostnameMismatch, // Hostname verification failed
  1442. };
  1443. // TLS error information
  1444. struct TlsError {
  1445. ErrorCode code = ErrorCode::Fatal;
  1446. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1447. int sys_errno = 0; // errno when SyscallError
  1448. // Convert verification error code to human-readable string
  1449. static std::string verify_error_to_string(long error_code);
  1450. };
  1451. // RAII wrapper for peer certificate
  1452. class PeerCert {
  1453. public:
  1454. PeerCert();
  1455. PeerCert(PeerCert &&other) noexcept;
  1456. PeerCert &operator=(PeerCert &&other) noexcept;
  1457. ~PeerCert();
  1458. PeerCert(const PeerCert &) = delete;
  1459. PeerCert &operator=(const PeerCert &) = delete;
  1460. explicit operator bool() const;
  1461. std::string subject_cn() const;
  1462. std::string issuer_name() const;
  1463. bool check_hostname(const char *hostname) const;
  1464. std::vector<SanEntry> sans() const;
  1465. bool validity(time_t &not_before, time_t &not_after) const;
  1466. std::string serial() const;
  1467. private:
  1468. explicit PeerCert(cert_t cert);
  1469. cert_t cert_ = nullptr;
  1470. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1471. };
  1472. // Callback for TLS context setup (used by SSLServer constructor)
  1473. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1474. } // namespace tls
  1475. #endif
  1476. struct Request {
  1477. std::string method;
  1478. std::string path;
  1479. std::string matched_route;
  1480. Params params;
  1481. Headers headers;
  1482. Headers trailers;
  1483. std::string body;
  1484. std::string remote_addr;
  1485. int remote_port = -1;
  1486. std::string local_addr;
  1487. int local_port = -1;
  1488. // for server
  1489. std::string version;
  1490. std::string target;
  1491. MultipartFormData form;
  1492. Ranges ranges;
  1493. Match matches;
  1494. std::unordered_map<std::string, std::string> path_params;
  1495. std::function<bool()> is_connection_closed = []() { return true; };
  1496. // for client
  1497. std::vector<std::string> accept_content_types;
  1498. ResponseHandler response_handler;
  1499. ContentReceiverWithProgress content_receiver;
  1500. DownloadProgress download_progress;
  1501. UploadProgress upload_progress;
  1502. bool has_header(const std::string &key) const;
  1503. std::string get_header_value(const std::string &key, const char *def = "",
  1504. size_t id = 0) const;
  1505. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1506. size_t id = 0) const;
  1507. size_t get_header_value_count(const std::string &key) const;
  1508. void set_header(const std::string &key, const std::string &val);
  1509. bool has_trailer(const std::string &key) const;
  1510. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1511. size_t get_trailer_value_count(const std::string &key) const;
  1512. bool has_param(const std::string &key) const;
  1513. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1514. std::vector<std::string> get_param_values(const std::string &key) const;
  1515. size_t get_param_value_count(const std::string &key) const;
  1516. bool is_multipart_form_data() const;
  1517. // private members...
  1518. bool body_consumed_ = false;
  1519. bool expect_100_continue_pending_ = false;
  1520. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1521. size_t content_length_ = 0;
  1522. ContentProvider content_provider_;
  1523. bool is_chunked_content_provider_ = false;
  1524. size_t authorization_count_ = 0;
  1525. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1526. (std::chrono::steady_clock::time_point::min)();
  1527. #ifdef CPPHTTPLIB_SSL_ENABLED
  1528. tls::const_session_t ssl = nullptr;
  1529. tls::PeerCert peer_cert() const;
  1530. std::string sni() const;
  1531. #endif
  1532. };
  1533. namespace detail {
  1534. // Declared up here, away from the rest of the compression helpers, because
  1535. // `Response` stores one.
  1536. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1537. } // namespace detail
  1538. struct Response {
  1539. std::string version;
  1540. int status = -1;
  1541. std::string reason;
  1542. Headers headers;
  1543. Headers trailers;
  1544. std::string body;
  1545. std::string location; // Redirect location
  1546. // User-defined context — set by pre-routing/pre-request handlers and read
  1547. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1548. UserData user_data;
  1549. bool has_header(const std::string &key) const;
  1550. std::string get_header_value(const std::string &key, const char *def = "",
  1551. size_t id = 0) const;
  1552. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1553. size_t id = 0) const;
  1554. size_t get_header_value_count(const std::string &key) const;
  1555. void set_header(const std::string &key, const std::string &val);
  1556. bool has_trailer(const std::string &key) const;
  1557. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1558. size_t get_trailer_value_count(const std::string &key) const;
  1559. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1560. void set_content(const char *s, size_t n, const std::string &content_type);
  1561. void set_content(const std::string &s, const std::string &content_type);
  1562. void set_content(std::string &&s, const std::string &content_type);
  1563. void set_content_provider(
  1564. size_t length, const std::string &content_type, ContentProvider provider,
  1565. ContentProviderResourceReleaser resource_releaser = nullptr);
  1566. void set_content_provider(
  1567. const std::string &content_type, ContentProviderWithoutLength provider,
  1568. ContentProviderResourceReleaser resource_releaser = nullptr);
  1569. void set_chunked_content_provider(
  1570. const std::string &content_type, ContentProviderWithoutLength provider,
  1571. ContentProviderResourceReleaser resource_releaser = nullptr);
  1572. void set_file_content(const std::string &path,
  1573. const std::string &content_type);
  1574. void set_file_content(const std::string &path);
  1575. Response() = default;
  1576. Response(const Response &) = default;
  1577. Response &operator=(const Response &) = default;
  1578. Response(Response &&) = default;
  1579. Response &operator=(Response &&) = default;
  1580. ~Response() {
  1581. if (content_provider_resource_releaser_) {
  1582. content_provider_resource_releaser_(content_provider_success_);
  1583. }
  1584. }
  1585. // private members...
  1586. size_t content_length_ = 0;
  1587. ContentProvider content_provider_;
  1588. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1589. bool is_chunked_content_provider_ = false;
  1590. bool is_file_content_provider_ = false;
  1591. bool content_provider_success_ = false;
  1592. std::string file_content_path_;
  1593. std::string file_content_content_type_;
  1594. // Content coding chosen for the response body, decided once so that the
  1595. // headers and the body cannot disagree: where the file is opened for a
  1596. // file-backed content provider (keeping the ETag honest), and in
  1597. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1598. // for every other kind of response.
  1599. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1600. };
  1601. enum class Error {
  1602. Success = 0,
  1603. Unknown,
  1604. Connection,
  1605. BindIPAddress,
  1606. Read,
  1607. Write,
  1608. ExceedRedirectCount,
  1609. Canceled,
  1610. SSLConnection,
  1611. SSLLoadingCerts,
  1612. SSLServerVerification,
  1613. SSLServerHostnameVerification,
  1614. UnsupportedMultipartBoundaryChars,
  1615. Compression,
  1616. ConnectionTimeout,
  1617. ProxyConnection,
  1618. ConnectionClosed,
  1619. Timeout,
  1620. ResourceExhaustion,
  1621. TooManyFormDataFiles,
  1622. ExceedMaxPayloadSize,
  1623. ExceedUriMaxLength,
  1624. ExceedMaxSocketDescriptorCount,
  1625. InvalidRequestLine,
  1626. InvalidHTTPMethod,
  1627. InvalidHTTPVersion,
  1628. InvalidHeaders,
  1629. MultipartParsing,
  1630. OpenFile,
  1631. Listen,
  1632. GetSockName,
  1633. UnsupportedAddressFamily,
  1634. HTTPParsing,
  1635. InvalidRangeHeader,
  1636. UnsupportedContentEncoding,
  1637. WebSocketHandshake,
  1638. UserCallbackException,
  1639. // For internal use only
  1640. SSLPeerCouldBeClosed_,
  1641. };
  1642. std::string to_string(Error error);
  1643. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1644. class Stream {
  1645. public:
  1646. virtual ~Stream() = default;
  1647. virtual bool is_readable() const = 0;
  1648. virtual bool wait_readable() const = 0;
  1649. virtual bool wait_writable() const = 0;
  1650. virtual bool is_peer_alive() const { return wait_writable(); }
  1651. virtual ssize_t read(char *ptr, size_t size) = 0;
  1652. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1653. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1654. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1655. virtual socket_t socket() const = 0;
  1656. virtual time_t duration() const = 0;
  1657. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1658. (void)sec;
  1659. (void)usec;
  1660. }
  1661. // Bytes already pulled off the socket and sitting in this stream's own
  1662. // buffer. Exposing them lets a line reader scan for a terminator in one
  1663. // pass instead of asking for a byte at a time. A stream that does no
  1664. // buffering of its own reports none, and readers fall back to read().
  1665. virtual const char *buffered_data(size_t &size) const {
  1666. size = 0;
  1667. return nullptr;
  1668. }
  1669. // Discards `size` bytes previously returned by buffered_data().
  1670. virtual void consume_buffered(size_t size) { (void)size; }
  1671. ssize_t write(const char *ptr);
  1672. ssize_t write(const std::string &s);
  1673. Error get_error() const { return error_; }
  1674. protected:
  1675. Error error_ = Error::Success;
  1676. };
  1677. class TaskQueue {
  1678. public:
  1679. TaskQueue() = default;
  1680. virtual ~TaskQueue() = default;
  1681. virtual bool enqueue(std::function<void()> fn) = 0;
  1682. virtual void shutdown() = 0;
  1683. virtual void on_idle() {}
  1684. };
  1685. class ThreadPool final : public TaskQueue {
  1686. public:
  1687. explicit ThreadPool(
  1688. size_t n, size_t max_n = 0, size_t mqr = 0,
  1689. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1690. ThreadPool(const ThreadPool &) = delete;
  1691. ~ThreadPool() override = default;
  1692. bool enqueue(std::function<void()> fn) override;
  1693. void shutdown() override;
  1694. private:
  1695. void worker(bool is_dynamic);
  1696. void move_to_finished(std::thread::id id);
  1697. void cleanup_finished_threads();
  1698. size_t base_thread_count_;
  1699. size_t max_thread_count_;
  1700. size_t max_queued_requests_;
  1701. time_t idle_timeout_sec_;
  1702. size_t idle_thread_count_;
  1703. bool shutdown_;
  1704. std::list<std::function<void()>> jobs_;
  1705. std::vector<std::thread> threads_; // base threads
  1706. std::list<std::thread> dynamic_threads_; // dynamic threads
  1707. std::vector<std::thread>
  1708. finished_threads_; // exited dynamic threads awaiting join
  1709. std::condition_variable cond_;
  1710. std::mutex mutex_;
  1711. };
  1712. using Logger = std::function<void(const Request &, const Response &)>;
  1713. // Forward declaration for Error type
  1714. enum class Error;
  1715. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1716. using SocketOptions = std::function<void(socket_t sock)>;
  1717. void default_socket_options(socket_t sock);
  1718. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1719. const char *status_message(int status);
  1720. std::string to_string(Error error);
  1721. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1722. std::string get_bearer_token_auth(const Request &req);
  1723. namespace detail {
  1724. class MatcherBase {
  1725. public:
  1726. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1727. virtual ~MatcherBase() = default;
  1728. const std::string &pattern() const { return pattern_; }
  1729. // Match request path and populate its matches and
  1730. virtual bool match(Request &request) const = 0;
  1731. private:
  1732. std::string pattern_;
  1733. };
  1734. /**
  1735. * Captures parameters in request path and stores them in Request::path_params
  1736. *
  1737. * Capture name is a substring of a pattern from : to /.
  1738. * The rest of the pattern is matched against the request path directly
  1739. * Parameters are captured starting from the next character after
  1740. * the end of the last matched static pattern fragment until the next /.
  1741. *
  1742. * Example pattern:
  1743. * "/path/fragments/:capture/more/fragments/:second_capture"
  1744. * Static fragments:
  1745. * "/path/fragments/", "more/fragments/"
  1746. *
  1747. * Given the following request path:
  1748. * "/path/fragments/:1/more/fragments/:2"
  1749. * the resulting capture will be
  1750. * {{"capture", "1"}, {"second_capture", "2"}}
  1751. */
  1752. class PathParamsMatcher final : public MatcherBase {
  1753. public:
  1754. PathParamsMatcher(const std::string &pattern);
  1755. bool match(Request &request) const override;
  1756. private:
  1757. // Treat segment separators as the end of path parameter capture
  1758. // Does not need to handle query parameters as they are parsed before path
  1759. // matching
  1760. static constexpr char separator = '/';
  1761. // Contains static path fragments to match against, excluding the '/' after
  1762. // path params
  1763. // Fragments are separated by path params
  1764. std::vector<std::string> static_fragments_;
  1765. // Stores the names of the path parameters to be used as keys in the
  1766. // Request::path_params map
  1767. std::vector<std::string> param_names_;
  1768. };
  1769. /**
  1770. * Performs std::regex_match on request path
  1771. * and stores the result in Request::matches
  1772. *
  1773. * Note that regex match is performed directly on the whole request.
  1774. * This means that wildcard patterns may match multiple path segments with /:
  1775. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1776. */
  1777. class RegexMatcher final : public MatcherBase {
  1778. public:
  1779. RegexMatcher(const std::string &pattern)
  1780. : MatcherBase(pattern), regex_(pattern) {}
  1781. bool match(Request &request) const override;
  1782. private:
  1783. std::regex regex_;
  1784. };
  1785. int close_socket(socket_t sock) noexcept;
  1786. bool is_accept_resource_error();
  1787. bool is_accept_transient_error();
  1788. ssize_t write_headers(Stream &strm, const Headers &headers);
  1789. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1790. time_t usec);
  1791. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1792. const std::string &boundary);
  1793. ContentProvider
  1794. make_multipart_content_provider(const UploadFormDataItems &items,
  1795. const std::string &boundary);
  1796. } // namespace detail
  1797. bool is_valid_multipart_boundary(const std::string &boundary);
  1798. // Serializer for multipart/form-data request bodies. The boundary is owned
  1799. // by the writer so that per-part framing and the final terminator always
  1800. // agree. Field names and filenames are escaped following the WHATWG HTML
  1801. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1802. // in content types.
  1803. class MultipartFormDataWriter {
  1804. public:
  1805. MultipartFormDataWriter();
  1806. // precondition: is_valid_multipart_boundary(boundary)
  1807. explicit MultipartFormDataWriter(std::string boundary);
  1808. const std::string &boundary() const;
  1809. std::string content_type() const;
  1810. // In-memory items -> whole body (known length)
  1811. std::string serialize(const UploadFormDataItems &items) const;
  1812. size_t content_length(const UploadFormDataItems &items) const;
  1813. // Per-part framing for streaming via a content provider
  1814. std::string item_begin(const UploadFormData &item) const;
  1815. static std::string item_end();
  1816. std::string finish() const;
  1817. private:
  1818. std::string boundary_;
  1819. };
  1820. class Server {
  1821. public:
  1822. using Handler = std::function<void(const Request &, Response &)>;
  1823. using ExceptionHandler =
  1824. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1825. enum class HandlerResponse {
  1826. Handled,
  1827. Unhandled,
  1828. };
  1829. using HandlerWithResponse =
  1830. std::function<HandlerResponse(const Request &, Response &)>;
  1831. using HandlerWithContentReader = std::function<void(
  1832. const Request &, Response &, const ContentReader &content_reader)>;
  1833. using Expect100ContinueHandler =
  1834. std::function<int(const Request &, Response &)>;
  1835. using StartHandler = std::function<void()>;
  1836. using WebSocketHandler =
  1837. std::function<void(const Request &, ws::WebSocket &)>;
  1838. using SubProtocolSelector =
  1839. std::function<std::string(const std::vector<std::string> &protocols)>;
  1840. Server();
  1841. virtual ~Server();
  1842. virtual bool is_valid() const;
  1843. Server &Get(const std::string &pattern, Handler handler);
  1844. Server &Post(const std::string &pattern, Handler handler);
  1845. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1846. Server &Put(const std::string &pattern, Handler handler);
  1847. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1848. Server &Patch(const std::string &pattern, Handler handler);
  1849. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1850. Server &Delete(const std::string &pattern, Handler handler);
  1851. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1852. Server &Options(const std::string &pattern, Handler handler);
  1853. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1854. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1855. // server accept it; an unregistered method is still rejected with 400.
  1856. // `method` must be a valid HTTP method token and must not be one of the
  1857. // built-in methods, which have their own registration functions above. A
  1858. // rejected registration makes is_valid() return false, so listen() fails.
  1859. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1860. Handler handler);
  1861. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1862. HandlerWithContentReader handler);
  1863. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1864. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1865. SubProtocolSelector sub_protocol_selector);
  1866. bool set_base_dir(const std::string &dir,
  1867. const std::string &mount_point = std::string());
  1868. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1869. Headers headers = Headers());
  1870. bool remove_mount_point(const std::string &mount_point);
  1871. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1872. const std::string &mime);
  1873. Server &set_default_file_mimetype(const std::string &mime);
  1874. Server &set_file_request_handler(Handler handler);
  1875. template <class ErrorHandlerFunc>
  1876. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1877. return set_error_handler_core(
  1878. std::forward<ErrorHandlerFunc>(handler),
  1879. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1880. }
  1881. Server &set_exception_handler(ExceptionHandler handler);
  1882. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1883. Server &set_post_routing_handler(Handler handler);
  1884. Server &set_pre_request_handler(HandlerWithResponse handler);
  1885. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1886. Server &set_start_handler(StartHandler handler);
  1887. Server &set_logger(Logger logger);
  1888. Server &set_pre_compression_logger(Logger logger);
  1889. Server &set_error_logger(ErrorLogger error_logger);
  1890. Server &set_address_family(int family);
  1891. Server &set_tcp_nodelay(bool on);
  1892. Server &set_ipv6_v6only(bool on);
  1893. Server &set_socket_options(SocketOptions socket_options);
  1894. Server &set_default_headers(Headers headers);
  1895. Server &
  1896. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1897. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1898. Server &set_keep_alive_max_count(size_t count);
  1899. Server &set_keep_alive_timeout(time_t sec);
  1900. template <class Rep, class Period>
  1901. Server &
  1902. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1903. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1904. template <class Rep, class Period>
  1905. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1906. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1907. template <class Rep, class Period>
  1908. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1909. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1910. template <class Rep, class Period>
  1911. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1912. Server &set_payload_max_length(size_t length);
  1913. Server &set_static_file_compression(bool on);
  1914. Server &set_static_file_compression_min_length(size_t length);
  1915. Server &set_static_file_compression_max_length(size_t length);
  1916. Server &set_websocket_ping_interval(time_t sec);
  1917. template <class Rep, class Period>
  1918. Server &set_websocket_ping_interval(
  1919. const std::chrono::duration<Rep, Period> &duration);
  1920. Server &set_websocket_max_missed_pongs(int count);
  1921. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1922. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1923. bool listen_after_bind();
  1924. bool listen(const std::string &host, int port, int socket_flags = 0);
  1925. bool is_running() const;
  1926. void wait_until_ready() const;
  1927. void stop() noexcept;
  1928. void decommission();
  1929. std::function<TaskQueue *(void)> new_task_queue;
  1930. protected:
  1931. bool process_request(Stream &strm, const std::string &remote_addr,
  1932. int remote_port, const std::string &local_addr,
  1933. int local_port, bool close_connection,
  1934. bool &connection_closed,
  1935. const std::function<void(Request &)> &setup_request,
  1936. bool *websocket_upgraded = nullptr);
  1937. // Runs the per-connection serving loop and stops an exception thrown by a
  1938. // user callback from escaping the worker thread.
  1939. //
  1940. // process_request() wraps only routing() in a try/catch. Content providers,
  1941. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1942. // handlers all run outside it, and the task queue calls the job without a
  1943. // catch, so an exception from any of those would terminate the process.
  1944. //
  1945. // No 500 is possible here: by the time a content provider runs, the status
  1946. // line and headers are already on the wire. Report it through the error
  1947. // logger and drop the connection, which is what the peer observes either
  1948. // way. Other connections are unaffected.
  1949. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1950. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1951. return serve();
  1952. #else
  1953. try {
  1954. return serve();
  1955. } catch (...) {
  1956. // The error logger is a user callback too, so it must not be able to
  1957. // throw the guard back open.
  1958. try {
  1959. output_error_log(Error::UserCallbackException, nullptr);
  1960. } catch (...) {}
  1961. return false;
  1962. }
  1963. #endif
  1964. }
  1965. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1966. std::vector<std::string> trusted_proxies_;
  1967. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1968. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1969. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1970. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1971. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1972. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1973. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1974. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1975. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1976. bool static_file_compression_ = false;
  1977. size_t static_file_compression_min_length_ =
  1978. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1979. size_t static_file_compression_max_length_ =
  1980. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1981. time_t websocket_ping_interval_sec_ =
  1982. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1983. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1984. private:
  1985. using Handlers =
  1986. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1987. using HandlersForContentReader =
  1988. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1989. HandlerWithContentReader>>;
  1990. // Both handler tables for one custom method live in a single entry, so that
  1991. // routing() needs only one map lookup per request to reach either of them.
  1992. struct CustomHandlerEntry {
  1993. Handlers handlers;
  1994. HandlersForContentReader handlers_for_content_reader;
  1995. };
  1996. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1997. static std::unique_ptr<detail::MatcherBase>
  1998. make_matcher(const std::string &pattern);
  1999. static const std::set<std::string> &builtin_methods();
  2000. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2001. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2002. template <typename H>
  2003. Server &add_handler(
  2004. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2005. const std::string &pattern, H handler) {
  2006. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2007. return *this;
  2008. }
  2009. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2010. Server &set_error_handler_core(Handler handler, std::false_type);
  2011. socket_t create_server_socket(const std::string &host, int port,
  2012. int socket_flags,
  2013. SocketOptions socket_options) const;
  2014. int bind_internal(const std::string &host, int port, int socket_flags);
  2015. bool listen_internal();
  2016. bool routing(Request &req, Response &res, Stream &strm);
  2017. bool handle_file_request(Request &req, Response &res);
  2018. bool check_if_not_modified(const Request &req, Response &res,
  2019. const std::string &etag, time_t mtime) const;
  2020. bool check_if_range(Request &req, const std::string &etag,
  2021. time_t mtime) const;
  2022. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2023. Stream &strm);
  2024. bool dispatch_request_for_content_reader(
  2025. Request &req, Response &res, ContentReader content_reader,
  2026. const HandlersForContentReader &handlers) const;
  2027. bool parse_request_line(const char *s, Request &req) const;
  2028. detail::EncodingType static_file_encoding(const Request &req,
  2029. const Response &res,
  2030. const std::string &content_type,
  2031. size_t length) const;
  2032. bool apply_static_file_compression(const Request &req, Response &res) const;
  2033. void apply_ranges(const Request &req, Response &res,
  2034. std::string &content_type, std::string &boundary) const;
  2035. bool write_response(Stream &strm, bool close_connection, Request &req,
  2036. Response &res);
  2037. bool write_response_with_content(Stream &strm, bool close_connection,
  2038. const Request &req, Response &res);
  2039. bool write_response_core(Stream &strm, bool close_connection,
  2040. const Request &req, Response &res,
  2041. bool need_apply_ranges);
  2042. bool write_content_with_provider(Stream &strm, const Request &req,
  2043. Response &res, const std::string &boundary,
  2044. const std::string &content_type);
  2045. bool read_content(Stream &strm, Request &req, Response &res);
  2046. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2047. Response &res,
  2048. ContentReceiver receiver,
  2049. FormDataHeader multipart_header,
  2050. ContentReceiver multipart_receiver);
  2051. bool read_content_core(Stream &strm, Request &req, Response &res,
  2052. ContentReceiver receiver,
  2053. FormDataHeader multipart_header,
  2054. ContentReceiver multipart_receiver) const;
  2055. virtual bool process_and_close_socket(socket_t sock);
  2056. void output_log(const Request &req, const Response &res) const;
  2057. void output_pre_compression_log(const Request &req,
  2058. const Response &res) const;
  2059. void output_error_log(const Error &err, const Request *req) const;
  2060. std::atomic<bool> is_running_{false};
  2061. std::atomic<bool> is_decommissioned{false};
  2062. // Set when CustomRoute() refuses a registration. Written before listen(),
  2063. // read by is_valid() on the same thread, so it needs no synchronization.
  2064. bool has_invalid_registration_ = false;
  2065. struct MountPointEntry {
  2066. std::string mount_point;
  2067. std::string base_dir;
  2068. std::string resolved_base_dir;
  2069. Headers headers;
  2070. };
  2071. std::vector<MountPointEntry> base_dirs_;
  2072. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2073. std::string default_file_mimetype_ = "application/octet-stream";
  2074. Handler file_request_handler_;
  2075. Handlers get_handlers_;
  2076. Handlers post_handlers_;
  2077. HandlersForContentReader post_handlers_for_content_reader_;
  2078. Handlers put_handlers_;
  2079. HandlersForContentReader put_handlers_for_content_reader_;
  2080. Handlers patch_handlers_;
  2081. HandlersForContentReader patch_handlers_for_content_reader_;
  2082. Handlers delete_handlers_;
  2083. HandlersForContentReader delete_handlers_for_content_reader_;
  2084. Handlers options_handlers_;
  2085. CustomHandlers custom_handlers_;
  2086. struct WebSocketHandlerEntry {
  2087. std::unique_ptr<detail::MatcherBase> matcher;
  2088. WebSocketHandler handler;
  2089. SubProtocolSelector sub_protocol_selector;
  2090. };
  2091. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2092. WebSocketHandlers websocket_handlers_;
  2093. HandlerWithResponse error_handler_;
  2094. ExceptionHandler exception_handler_;
  2095. HandlerWithResponse pre_routing_handler_;
  2096. Handler post_routing_handler_;
  2097. HandlerWithResponse pre_request_handler_;
  2098. Expect100ContinueHandler expect_100_continue_handler_;
  2099. StartHandler start_handler_;
  2100. mutable std::mutex logger_mutex_;
  2101. Logger logger_;
  2102. Logger pre_compression_logger_;
  2103. ErrorLogger error_logger_;
  2104. int address_family_ = AF_UNSPEC;
  2105. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2106. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2107. SocketOptions socket_options_ = default_socket_options;
  2108. Headers default_headers_;
  2109. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2110. detail::write_headers;
  2111. };
  2112. class Result {
  2113. public:
  2114. Result() = default;
  2115. Result(std::unique_ptr<Response> &&res, Error err,
  2116. Headers &&request_headers = Headers{})
  2117. : res_(std::move(res)), err_(err),
  2118. request_headers_(std::move(request_headers)) {}
  2119. // Response
  2120. operator bool() const { return res_ != nullptr; }
  2121. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2122. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2123. const Response &value() const { return *res_; }
  2124. Response &value() { return *res_; }
  2125. const Response &operator*() const { return *res_; }
  2126. Response &operator*() { return *res_; }
  2127. const Response *operator->() const { return res_.get(); }
  2128. Response *operator->() { return res_.get(); }
  2129. // Error
  2130. Error error() const { return err_; }
  2131. // Request Headers
  2132. bool has_request_header(const std::string &key) const;
  2133. std::string get_request_header_value(const std::string &key,
  2134. const char *def = "",
  2135. size_t id = 0) const;
  2136. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2137. size_t id = 0) const;
  2138. size_t get_request_header_value_count(const std::string &key) const;
  2139. private:
  2140. std::unique_ptr<Response> res_;
  2141. Error err_ = Error::Unknown;
  2142. Headers request_headers_;
  2143. #ifdef CPPHTTPLIB_SSL_ENABLED
  2144. public:
  2145. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2146. int ssl_error)
  2147. : res_(std::move(res)), err_(err),
  2148. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2149. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2150. int ssl_error, uint64_t ssl_backend_error)
  2151. : res_(std::move(res)), err_(err),
  2152. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2153. ssl_backend_error_(ssl_backend_error) {}
  2154. int ssl_error() const { return ssl_error_; }
  2155. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2156. private:
  2157. int ssl_error_ = 0;
  2158. uint64_t ssl_backend_error_ = 0;
  2159. #endif
  2160. };
  2161. struct ClientConnection {
  2162. socket_t sock = INVALID_SOCKET;
  2163. bool is_open() const { return sock != INVALID_SOCKET; }
  2164. ClientConnection() = default;
  2165. ~ClientConnection();
  2166. ClientConnection(const ClientConnection &) = delete;
  2167. ClientConnection &operator=(const ClientConnection &) = delete;
  2168. ClientConnection(ClientConnection &&other) noexcept
  2169. : sock(other.sock)
  2170. #ifdef CPPHTTPLIB_SSL_ENABLED
  2171. ,
  2172. session(other.session)
  2173. #endif
  2174. {
  2175. other.sock = INVALID_SOCKET;
  2176. #ifdef CPPHTTPLIB_SSL_ENABLED
  2177. other.session = nullptr;
  2178. #endif
  2179. }
  2180. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2181. if (this != &other) {
  2182. sock = other.sock;
  2183. other.sock = INVALID_SOCKET;
  2184. #ifdef CPPHTTPLIB_SSL_ENABLED
  2185. session = other.session;
  2186. other.session = nullptr;
  2187. #endif
  2188. }
  2189. return *this;
  2190. }
  2191. #ifdef CPPHTTPLIB_SSL_ENABLED
  2192. tls::session_t session = nullptr;
  2193. #endif
  2194. };
  2195. namespace detail {
  2196. struct ChunkedDecoder;
  2197. struct BodyReader {
  2198. Stream *stream = nullptr;
  2199. bool has_content_length = false;
  2200. size_t content_length = 0;
  2201. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2202. size_t bytes_read = 0;
  2203. bool chunked = false;
  2204. bool eof = false;
  2205. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2206. Error last_error = Error::Success;
  2207. ssize_t read(char *buf, size_t len);
  2208. bool has_error() const { return last_error != Error::Success; }
  2209. };
  2210. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2211. size_t len) {
  2212. (void)stream;
  2213. return br.read(buf, len);
  2214. }
  2215. class decompressor;
  2216. enum class NoProxyKind {
  2217. Wildcard, // "*"
  2218. HostnameSuffix, // "example.com" or ".example.com"
  2219. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2220. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2221. };
  2222. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2223. // Lets one CIDR matcher cover both families.
  2224. using IPBytes = std::array<uint8_t, 16>;
  2225. struct NoProxyEntry {
  2226. NoProxyKind kind = NoProxyKind::Wildcard;
  2227. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2228. IPBytes net{};
  2229. int prefix_bits = 0;
  2230. };
  2231. struct NormalizedTarget {
  2232. std::string hostname; // lowercase; brackets and trailing dot removed
  2233. bool is_ipv4 = false;
  2234. bool is_ipv6 = false;
  2235. IPBytes ip{};
  2236. };
  2237. } // namespace detail
  2238. class ClientImpl {
  2239. public:
  2240. explicit ClientImpl(const std::string &host);
  2241. explicit ClientImpl(const std::string &host, int port);
  2242. explicit ClientImpl(const std::string &host, int port,
  2243. const std::string &client_cert_path,
  2244. const std::string &client_key_path);
  2245. virtual ~ClientImpl();
  2246. virtual bool is_valid() const;
  2247. struct StreamHandle {
  2248. std::unique_ptr<Response> response;
  2249. Error error = Error::Success;
  2250. StreamHandle() = default;
  2251. StreamHandle(const StreamHandle &) = delete;
  2252. StreamHandle &operator=(const StreamHandle &) = delete;
  2253. StreamHandle(StreamHandle &&) = default;
  2254. StreamHandle &operator=(StreamHandle &&) = default;
  2255. ~StreamHandle() = default;
  2256. bool is_valid() const {
  2257. return response != nullptr && error == Error::Success;
  2258. }
  2259. ssize_t read(char *buf, size_t len);
  2260. void parse_trailers_if_needed();
  2261. Error get_read_error() const { return body_reader_.last_error; }
  2262. bool has_read_error() const { return body_reader_.has_error(); }
  2263. bool trailers_parsed_ = false;
  2264. private:
  2265. friend class ClientImpl;
  2266. ssize_t read_with_decompression(char *buf, size_t len);
  2267. std::unique_ptr<ClientConnection> connection_;
  2268. std::unique_ptr<Stream> socket_stream_;
  2269. Stream *stream_ = nullptr;
  2270. detail::BodyReader body_reader_;
  2271. std::unique_ptr<detail::decompressor> decompressor_;
  2272. std::string decompress_buffer_;
  2273. size_t decompress_offset_ = 0;
  2274. size_t decompressed_bytes_read_ = 0;
  2275. };
  2276. // clang-format off
  2277. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2278. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2279. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2280. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2281. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2282. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2283. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2284. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2285. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2286. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2287. Result Head(const std::string &path);
  2288. Result Head(const std::string &path, const Headers &headers);
  2289. Result Post(const std::string &path);
  2290. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2291. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2292. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2293. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2294. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2295. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2296. Result Post(const std::string &path, const Params &params);
  2297. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, const Headers &headers);
  2299. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2301. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2302. 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);
  2303. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2304. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2305. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2306. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2307. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2309. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2310. Result Put(const std::string &path);
  2311. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2312. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2313. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2314. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2315. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2317. Result Put(const std::string &path, const Params &params);
  2318. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, const Headers &headers);
  2320. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2321. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2322. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2323. 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);
  2324. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2325. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2326. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2327. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2328. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2330. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2331. Result Patch(const std::string &path);
  2332. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2333. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2334. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2335. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2336. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2338. Result Patch(const std::string &path, const Params &params);
  2339. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2343. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2344. 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);
  2345. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2347. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2348. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2349. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2351. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2352. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2353. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2354. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2355. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2356. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2357. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2358. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2359. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2360. Result Options(const std::string &path);
  2361. Result Options(const std::string &path, const Headers &headers);
  2362. // clang-format on
  2363. // Streaming API: Open a stream for reading response body incrementally
  2364. // Socket ownership is transferred to StreamHandle for true streaming
  2365. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2366. StreamHandle open_stream(const std::string &method, const std::string &path,
  2367. const Params &params = {},
  2368. const Headers &headers = {},
  2369. const std::string &body = {},
  2370. const std::string &content_type = {});
  2371. bool send(Request &req, Response &res, Error &error);
  2372. Result send(const Request &req);
  2373. void stop();
  2374. std::string host() const;
  2375. int port() const;
  2376. size_t is_socket_open() const;
  2377. socket_t socket() const;
  2378. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2379. void set_default_headers(Headers headers);
  2380. void
  2381. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2382. void set_address_family(int family);
  2383. void set_tcp_nodelay(bool on);
  2384. void set_ipv6_v6only(bool on);
  2385. void set_socket_options(SocketOptions socket_options);
  2386. void set_connection_timeout(time_t sec, time_t usec = 0);
  2387. template <class Rep, class Period>
  2388. void
  2389. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2390. void set_read_timeout(time_t sec, time_t usec = 0);
  2391. template <class Rep, class Period>
  2392. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2393. void set_write_timeout(time_t sec, time_t usec = 0);
  2394. template <class Rep, class Period>
  2395. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2396. void set_max_timeout(time_t msec);
  2397. template <class Rep, class Period>
  2398. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2399. void set_basic_auth(const std::string &username, const std::string &password);
  2400. void set_bearer_token_auth(const std::string &token);
  2401. void set_keep_alive(bool on);
  2402. void set_follow_location(bool on);
  2403. void set_path_encode(bool on);
  2404. void set_compress(bool on);
  2405. void set_decompress(bool on);
  2406. void set_payload_max_length(size_t length);
  2407. void set_interface(const std::string &intf);
  2408. void set_proxy(const std::string &host, int port);
  2409. void set_proxy_basic_auth(const std::string &username,
  2410. const std::string &password);
  2411. void set_proxy_bearer_token_auth(const std::string &token);
  2412. void set_no_proxy(const std::vector<std::string> &patterns);
  2413. void set_logger(Logger logger);
  2414. void set_error_logger(ErrorLogger error_logger);
  2415. protected:
  2416. struct Socket {
  2417. socket_t sock = INVALID_SOCKET;
  2418. // For Mbed TLS compatibility: start_time for request timeout tracking
  2419. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2420. bool is_open() const { return sock != INVALID_SOCKET; }
  2421. #ifdef CPPHTTPLIB_SSL_ENABLED
  2422. tls::session_t ssl = nullptr;
  2423. #endif
  2424. };
  2425. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2426. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2427. virtual bool setup_proxy_connection(
  2428. Socket &socket,
  2429. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2430. Response &res, bool &success, Error &error);
  2431. bool is_proxy_enabled_for_host(const std::string &host) const;
  2432. // All of:
  2433. // shutdown_ssl
  2434. // shutdown_socket
  2435. // close_socket
  2436. // disconnect
  2437. // should ONLY be called when socket_mutex_ is locked, and only when
  2438. // no other thread is using the socket.
  2439. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2440. void shutdown_socket(Socket &socket) const;
  2441. void close_socket(Socket &socket);
  2442. void disconnect(bool gracefully);
  2443. bool process_request(Stream &strm, Request &req, Response &res,
  2444. bool close_connection, Error &error);
  2445. bool write_content_with_provider(Stream &strm, const Request &req,
  2446. Error &error) const;
  2447. void copy_settings(const ClientImpl &rhs);
  2448. void output_log(const Request &req, const Response &res) const;
  2449. void output_error_log(const Error &err, const Request *req) const;
  2450. // Socket endpoint information
  2451. const std::string host_;
  2452. const int port_;
  2453. // Current open socket
  2454. Socket socket_;
  2455. mutable std::mutex socket_mutex_;
  2456. std::recursive_mutex request_mutex_;
  2457. // These are all protected under socket_mutex
  2458. size_t socket_requests_in_flight_ = 0;
  2459. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2460. bool socket_should_be_closed_when_request_is_done_ = false;
  2461. // Hostname to connection target map. The value is an IP literal or another
  2462. // hostname; only the connection target changes, never the identity.
  2463. std::map<std::string, std::string> addr_map_;
  2464. // Default headers
  2465. Headers default_headers_;
  2466. // Header writer
  2467. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2468. detail::write_headers;
  2469. // Settings
  2470. std::string client_cert_path_;
  2471. std::string client_key_path_;
  2472. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2473. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2474. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2475. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2476. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2477. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2478. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2479. std::string basic_auth_username_;
  2480. std::string basic_auth_password_;
  2481. std::string bearer_token_auth_token_;
  2482. bool keep_alive_ = false;
  2483. bool follow_location_ = false;
  2484. bool path_encode_ = true;
  2485. int address_family_ = AF_UNSPEC;
  2486. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2487. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2488. SocketOptions socket_options_ = nullptr;
  2489. bool compress_ = false;
  2490. bool decompress_ = true;
  2491. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2492. bool has_payload_max_length_ = false;
  2493. std::string interface_;
  2494. std::string proxy_host_;
  2495. int proxy_port_ = -1;
  2496. std::string proxy_basic_auth_username_;
  2497. std::string proxy_basic_auth_password_;
  2498. std::string proxy_bearer_token_auth_token_;
  2499. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2500. mutable detail::NormalizedTarget host_normalized_;
  2501. mutable bool host_normalized_valid_ = false;
  2502. mutable std::mutex logger_mutex_;
  2503. Logger logger_;
  2504. ErrorLogger error_logger_;
  2505. private:
  2506. bool send_(Request &req, Response &res, Error &error);
  2507. Result send_(Request &&req);
  2508. socket_t create_client_socket(Error &error) const;
  2509. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2510. bool skip_100_continue = true) const;
  2511. bool write_request(Stream &strm, Request &req, bool close_connection,
  2512. Error &error, bool skip_body, bool &rejected_locally);
  2513. bool write_request_body(Stream &strm, Request &req, Error &error);
  2514. void prepare_default_headers(Request &r, bool for_stream,
  2515. const std::string &ct);
  2516. bool redirect(Request &req, Response &res, Error &error);
  2517. bool create_redirect_client(const std::string &scheme,
  2518. const std::string &host, int port, Request &req,
  2519. Response &res, const std::string &path,
  2520. const std::string &location, Error &error);
  2521. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2522. bool handle_request(Stream &strm, Request &req, Response &res,
  2523. bool close_connection, Error &error);
  2524. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2525. Request &req, const char *body, size_t content_length,
  2526. ContentProvider content_provider,
  2527. ContentProviderWithoutLength content_provider_without_length,
  2528. const std::string &content_type, ContentReceiver content_receiver,
  2529. Error &error);
  2530. Result send_with_content_provider_and_receiver(
  2531. const std::string &method, const std::string &path,
  2532. const Headers &headers, const char *body, size_t content_length,
  2533. ContentProvider content_provider,
  2534. ContentProviderWithoutLength content_provider_without_length,
  2535. const std::string &content_type, ContentReceiver content_receiver,
  2536. UploadProgress progress);
  2537. ContentProviderWithoutLength get_multipart_content_provider(
  2538. const std::string &boundary, const UploadFormDataItems &items,
  2539. const FormDataProviderItems &provider_items) const;
  2540. virtual bool
  2541. process_socket(const Socket &socket,
  2542. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2543. std::function<bool(Stream &strm)> callback);
  2544. virtual bool is_ssl() const;
  2545. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2546. #ifdef CPPHTTPLIB_SSL_ENABLED
  2547. public:
  2548. void set_digest_auth(const std::string &username,
  2549. const std::string &password);
  2550. void set_proxy_digest_auth(const std::string &username,
  2551. const std::string &password);
  2552. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2553. const std::string &ca_cert_dir_path = std::string());
  2554. void enable_server_certificate_verification(bool enabled);
  2555. void enable_server_hostname_verification(bool enabled);
  2556. void enable_system_ca(bool enabled);
  2557. protected:
  2558. std::string digest_auth_username_;
  2559. std::string digest_auth_password_;
  2560. std::string proxy_digest_auth_username_;
  2561. std::string proxy_digest_auth_password_;
  2562. std::string ca_cert_file_path_;
  2563. std::string ca_cert_dir_path_;
  2564. bool server_certificate_verification_ = true;
  2565. bool server_hostname_verification_ = true;
  2566. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2567. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2568. int last_ssl_error_ = 0;
  2569. uint64_t last_backend_error_ = 0;
  2570. #endif
  2571. };
  2572. class Client {
  2573. public:
  2574. // Universal interface
  2575. explicit Client(const std::string &scheme_host_port);
  2576. explicit Client(const std::string &scheme_host_port,
  2577. const std::string &client_cert_path,
  2578. const std::string &client_key_path);
  2579. // HTTP only interface
  2580. explicit Client(const std::string &host, int port);
  2581. explicit Client(const std::string &host, int port,
  2582. const std::string &client_cert_path,
  2583. const std::string &client_key_path);
  2584. Client(Client &&) = default;
  2585. Client &operator=(Client &&) = default;
  2586. ~Client();
  2587. bool is_valid() const;
  2588. // clang-format off
  2589. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2590. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2591. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2592. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2593. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2594. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2595. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2596. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2597. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2598. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2599. Result Head(const std::string &path);
  2600. Result Head(const std::string &path, const Headers &headers);
  2601. Result Post(const std::string &path);
  2602. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2603. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2604. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2605. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2606. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2607. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2608. Result Post(const std::string &path, const Params &params);
  2609. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, const Headers &headers);
  2611. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2614. 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);
  2615. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2616. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2617. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2618. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2619. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2620. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2621. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2622. Result Put(const std::string &path);
  2623. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2624. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2625. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2626. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2627. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2628. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2629. Result Put(const std::string &path, const Params &params);
  2630. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, const Headers &headers);
  2632. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2633. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2635. 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);
  2636. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2637. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2638. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2639. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2640. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2641. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2642. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2643. Result Patch(const std::string &path);
  2644. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2645. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2646. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2647. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2648. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2650. Result Patch(const std::string &path, const Params &params);
  2651. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, const Headers &headers);
  2653. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2654. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2656. 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);
  2657. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2658. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2659. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2660. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2661. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2662. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2663. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2664. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2665. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2666. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2667. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2668. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2669. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2670. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2671. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2672. Result Options(const std::string &path);
  2673. Result Options(const std::string &path, const Headers &headers);
  2674. // clang-format on
  2675. // Streaming API: Open a stream for reading response body incrementally
  2676. // Socket ownership is transferred to StreamHandle for true streaming
  2677. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2678. ClientImpl::StreamHandle open_stream(const std::string &method,
  2679. const std::string &path,
  2680. const Params &params = {},
  2681. const Headers &headers = {},
  2682. const std::string &body = {},
  2683. const std::string &content_type = {});
  2684. bool send(Request &req, Response &res, Error &error);
  2685. Result send(const Request &req);
  2686. void stop();
  2687. std::string host() const;
  2688. int port() const;
  2689. size_t is_socket_open() const;
  2690. socket_t socket() const;
  2691. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2692. void set_default_headers(Headers headers);
  2693. void
  2694. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2695. void set_address_family(int family);
  2696. void set_tcp_nodelay(bool on);
  2697. void set_socket_options(SocketOptions socket_options);
  2698. void set_connection_timeout(time_t sec, time_t usec = 0);
  2699. template <class Rep, class Period>
  2700. void
  2701. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2702. void set_read_timeout(time_t sec, time_t usec = 0);
  2703. template <class Rep, class Period>
  2704. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2705. void set_write_timeout(time_t sec, time_t usec = 0);
  2706. template <class Rep, class Period>
  2707. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2708. void set_max_timeout(time_t msec);
  2709. template <class Rep, class Period>
  2710. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2711. void set_basic_auth(const std::string &username, const std::string &password);
  2712. void set_bearer_token_auth(const std::string &token);
  2713. void set_keep_alive(bool on);
  2714. void set_follow_location(bool on);
  2715. void set_path_encode(bool on);
  2716. void set_compress(bool on);
  2717. void set_decompress(bool on);
  2718. void set_payload_max_length(size_t length);
  2719. void set_interface(const std::string &intf);
  2720. void set_proxy(const std::string &host, int port);
  2721. void set_proxy_basic_auth(const std::string &username,
  2722. const std::string &password);
  2723. void set_proxy_bearer_token_auth(const std::string &token);
  2724. void set_no_proxy(const std::vector<std::string> &patterns);
  2725. void set_logger(Logger logger);
  2726. void set_error_logger(ErrorLogger error_logger);
  2727. private:
  2728. std::unique_ptr<ClientImpl> cli_;
  2729. #ifdef CPPHTTPLIB_SSL_ENABLED
  2730. public:
  2731. void set_digest_auth(const std::string &username,
  2732. const std::string &password);
  2733. void set_proxy_digest_auth(const std::string &username,
  2734. const std::string &password);
  2735. void enable_server_certificate_verification(bool enabled);
  2736. void enable_server_hostname_verification(bool enabled);
  2737. void enable_system_ca(bool enabled);
  2738. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2739. const std::string &ca_cert_dir_path = std::string());
  2740. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2741. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2742. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2743. void set_session_verifier(
  2744. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2745. tls::ctx_t tls_context() const;
  2746. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2747. void enable_windows_certificate_verification(bool enabled);
  2748. #endif
  2749. private:
  2750. bool is_ssl_ = false;
  2751. #endif
  2752. };
  2753. #ifdef CPPHTTPLIB_SSL_ENABLED
  2754. class SSLServer : public Server {
  2755. public:
  2756. SSLServer(const char *cert_path, const char *private_key_path,
  2757. const char *client_ca_cert_file_path = nullptr,
  2758. const char *client_ca_cert_dir_path = nullptr,
  2759. const char *private_key_password = nullptr);
  2760. struct PemMemory {
  2761. const char *cert_pem;
  2762. size_t cert_pem_len;
  2763. const char *key_pem;
  2764. size_t key_pem_len;
  2765. const char *client_ca_pem;
  2766. size_t client_ca_pem_len;
  2767. const char *private_key_password;
  2768. };
  2769. explicit SSLServer(const PemMemory &pem);
  2770. // The callback receives the ctx_t handle which can be cast to the
  2771. // appropriate backend type (SSL_CTX* for OpenSSL,
  2772. // tls::impl::MbedTlsContext* for Mbed TLS)
  2773. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2774. ~SSLServer() override;
  2775. bool is_valid() const override;
  2776. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2777. const char *client_ca_pem = nullptr,
  2778. const char *password = nullptr);
  2779. tls::ctx_t tls_context() const { return ctx_; }
  2780. int ssl_last_error() const { return last_ssl_error_; }
  2781. private:
  2782. bool process_and_close_socket(socket_t sock) override;
  2783. tls::ctx_t ctx_ = nullptr;
  2784. std::mutex ctx_mutex_;
  2785. int last_ssl_error_ = 0;
  2786. };
  2787. class SSLClient final : public ClientImpl {
  2788. public:
  2789. explicit SSLClient(const std::string &host);
  2790. explicit SSLClient(const std::string &host, int port);
  2791. explicit SSLClient(const std::string &host, int port,
  2792. const std::string &client_cert_path,
  2793. const std::string &client_key_path,
  2794. const std::string &private_key_password = std::string());
  2795. struct PemMemory {
  2796. const char *cert_pem;
  2797. size_t cert_pem_len;
  2798. const char *key_pem;
  2799. size_t key_pem_len;
  2800. const char *private_key_password;
  2801. };
  2802. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2803. ~SSLClient() override;
  2804. bool is_valid() const override;
  2805. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2806. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2807. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2808. // Post-handshake session verifier (backend-independent)
  2809. void set_session_verifier(
  2810. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2811. tls::ctx_t tls_context() const { return ctx_; }
  2812. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2813. void enable_windows_certificate_verification(bool enabled);
  2814. #endif
  2815. private:
  2816. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2817. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2818. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2819. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2820. bool
  2821. process_socket(const Socket &socket,
  2822. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2823. std::function<bool(Stream &strm)> callback) override;
  2824. bool is_ssl() const override;
  2825. bool setup_proxy_connection(
  2826. Socket &socket,
  2827. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2828. Response &res, bool &success, Error &error) override;
  2829. bool connect_with_proxy(
  2830. Socket &sock,
  2831. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2832. Response &res, bool &success, Error &error);
  2833. bool initialize_ssl(Socket &socket, Error &error);
  2834. void init_ctx();
  2835. void reset_ctx_on_error();
  2836. bool load_certs();
  2837. tls::ctx_t ctx_ = nullptr;
  2838. std::mutex ctx_mutex_;
  2839. std::once_flag initialize_cert_;
  2840. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2841. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2842. // Used to keep custom CA configuration exclusive with system CA loading.
  2843. bool ca_cert_store_set_ = false;
  2844. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2845. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2846. bool enable_windows_cert_verification_ = true;
  2847. // Like ca_cert_store_set_, tracks what ctx_ cannot report back: whether
  2848. // set_server_certificate_verifier() installed a verifier.
  2849. bool server_certificate_verifier_set_ = false;
  2850. #endif
  2851. friend class ClientImpl;
  2852. };
  2853. #endif // CPPHTTPLIB_SSL_ENABLED
  2854. namespace detail {
  2855. template <typename T, typename U>
  2856. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2857. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2858. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2859. duration - std::chrono::seconds(sec))
  2860. .count();
  2861. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2862. }
  2863. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2864. return N - 1;
  2865. }
  2866. inline bool is_numeric(const std::string &str) {
  2867. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2868. }
  2869. inline size_t get_header_value_u64(const Headers &headers,
  2870. const std::string &key, size_t def,
  2871. size_t id, bool &is_invalid_value) {
  2872. is_invalid_value = false;
  2873. auto rng = headers.equal_range(key);
  2874. auto it = rng.first;
  2875. std::advance(it, static_cast<ssize_t>(id));
  2876. if (it != rng.second) {
  2877. if (is_numeric(it->second)) {
  2878. // Parse at size_t width so an out-of-range Content-Length is reported
  2879. // rather than silently saturated/truncated (a value above 2^32 would
  2880. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2881. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2882. size_t val = 0;
  2883. const auto &s = it->second;
  2884. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2885. if (r.ec == std::errc::result_out_of_range) {
  2886. is_invalid_value = true;
  2887. return (std::numeric_limits<size_t>::max)();
  2888. }
  2889. return val;
  2890. } else {
  2891. is_invalid_value = true;
  2892. }
  2893. }
  2894. return def;
  2895. }
  2896. inline size_t get_header_value_u64(const Headers &headers,
  2897. const std::string &key, size_t def,
  2898. size_t id) {
  2899. auto dummy = false;
  2900. return get_header_value_u64(headers, key, def, id, dummy);
  2901. }
  2902. } // namespace detail
  2903. template <class Rep, class Period>
  2904. inline Server &
  2905. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2906. detail::duration_to_sec_and_usec(
  2907. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2908. return *this;
  2909. }
  2910. template <class Rep, class Period>
  2911. inline Server &
  2912. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2913. detail::duration_to_sec_and_usec(
  2914. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2915. return *this;
  2916. }
  2917. template <class Rep, class Period>
  2918. inline Server &
  2919. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2920. detail::duration_to_sec_and_usec(
  2921. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2922. return *this;
  2923. }
  2924. template <class Rep, class Period>
  2925. inline void ClientImpl::set_connection_timeout(
  2926. const std::chrono::duration<Rep, Period> &duration) {
  2927. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2928. set_connection_timeout(sec, usec);
  2929. });
  2930. }
  2931. template <class Rep, class Period>
  2932. inline void ClientImpl::set_read_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_read_timeout(sec, usec); });
  2936. }
  2937. template <class Rep, class Period>
  2938. inline void ClientImpl::set_write_timeout(
  2939. const std::chrono::duration<Rep, Period> &duration) {
  2940. detail::duration_to_sec_and_usec(
  2941. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2942. }
  2943. template <class Rep, class Period>
  2944. inline void ClientImpl::set_max_timeout(
  2945. const std::chrono::duration<Rep, Period> &duration) {
  2946. auto msec =
  2947. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2948. set_max_timeout(msec);
  2949. }
  2950. template <class Rep, class Period>
  2951. inline void Client::set_connection_timeout(
  2952. const std::chrono::duration<Rep, Period> &duration) {
  2953. cli_->set_connection_timeout(duration);
  2954. }
  2955. template <class Rep, class Period>
  2956. inline void
  2957. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2958. cli_->set_read_timeout(duration);
  2959. }
  2960. template <class Rep, class Period>
  2961. inline void
  2962. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2963. cli_->set_write_timeout(duration);
  2964. }
  2965. inline void Client::set_max_timeout(time_t msec) {
  2966. cli_->set_max_timeout(msec);
  2967. }
  2968. template <class Rep, class Period>
  2969. inline void
  2970. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2971. cli_->set_max_timeout(duration);
  2972. }
  2973. /*
  2974. * Forward declarations and types that will be part of the .h file if split into
  2975. * .h + .cc.
  2976. */
  2977. std::string hosted_at(const std::string &hostname);
  2978. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2979. // JavaScript-style URL encoding/decoding functions
  2980. std::string encode_uri_component(const std::string &value);
  2981. std::string encode_uri(const std::string &value);
  2982. std::string decode_uri_component(const std::string &value);
  2983. std::string decode_uri(const std::string &value);
  2984. // RFC 3986 compliant URL component encoding/decoding functions
  2985. std::string encode_path_component(const std::string &component);
  2986. std::string decode_path_component(const std::string &component);
  2987. std::string encode_query_component(const std::string &component,
  2988. bool space_as_plus = true);
  2989. std::string decode_query_component(const std::string &component,
  2990. bool plus_as_space = true);
  2991. std::string sanitize_filename(const std::string &filename);
  2992. std::string append_query_params(const std::string &path, const Params &params);
  2993. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2994. std::pair<std::string, std::string>
  2995. make_basic_authentication_header(const std::string &username,
  2996. const std::string &password,
  2997. bool is_proxy = false);
  2998. namespace detail {
  2999. #if defined(_WIN32)
  3000. inline std::wstring u8string_to_wstring(const char *s) {
  3001. if (!s) { return std::wstring(); }
  3002. auto len = static_cast<int>(strlen(s));
  3003. if (!len) { return std::wstring(); }
  3004. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3005. if (!wlen) { return std::wstring(); }
  3006. std::wstring ws;
  3007. ws.resize(wlen);
  3008. wlen = ::MultiByteToWideChar(
  3009. CP_UTF8, 0, s, len,
  3010. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3011. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3012. return ws;
  3013. }
  3014. #endif
  3015. struct FileStat {
  3016. FileStat(const std::string &path);
  3017. bool is_file() const;
  3018. bool is_dir() const;
  3019. time_t mtime() const;
  3020. size_t size() const;
  3021. private:
  3022. #if defined(_WIN32)
  3023. struct _stat st_;
  3024. #else
  3025. struct stat st_;
  3026. #endif
  3027. int ret_ = -1;
  3028. };
  3029. std::string make_host_and_port_string(const std::string &host, int port,
  3030. bool is_ssl);
  3031. template <typename T>
  3032. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3033. Error &error);
  3034. std::string trim_copy(const std::string &s);
  3035. void divide(
  3036. const char *data, std::size_t size, char d,
  3037. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3038. fn);
  3039. void divide(
  3040. const std::string &str, char d,
  3041. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3042. fn);
  3043. void split(const char *b, const char *e, char d,
  3044. std::function<void(const char *, const char *)> fn);
  3045. void split(const char *b, const char *e, char d, size_t m,
  3046. std::function<void(const char *, const char *)> fn);
  3047. bool split_find(const char *b, const char *e, char d,
  3048. std::function<bool(const char *, const char *)> fn);
  3049. bool has_header_token(const Headers &headers, const std::string &key,
  3050. const std::string &token);
  3051. std::string websocket_accept_key(const std::string &client_key);
  3052. bool is_websocket_upgrade(const Request &req);
  3053. bool process_client_socket(
  3054. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3055. time_t write_timeout_sec, time_t write_timeout_usec,
  3056. time_t max_timeout_msec,
  3057. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3058. std::function<bool(Stream &)> callback);
  3059. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3060. int port, int address_family, bool tcp_nodelay,
  3061. bool ipv6_v6only, SocketOptions socket_options,
  3062. time_t connection_timeout_sec,
  3063. time_t connection_timeout_usec,
  3064. time_t read_timeout_sec, time_t read_timeout_usec,
  3065. time_t write_timeout_sec,
  3066. time_t write_timeout_usec,
  3067. const std::string &intf, Error &error);
  3068. const char *get_header_value(const Headers &headers, const std::string &key,
  3069. const char *def, size_t id);
  3070. std::string get_combined_header_value(const Headers &headers,
  3071. const std::string &key);
  3072. std::string params_to_query_str(const Params &params);
  3073. void parse_query_text(const char *data, std::size_t size, Params &params);
  3074. void parse_query_text(const std::string &s, Params &params);
  3075. bool parse_multipart_boundary(const std::string &content_type,
  3076. std::string &boundary);
  3077. bool parse_range_header(const std::string &s, Ranges &ranges);
  3078. bool parse_accept_header(const std::string &s,
  3079. std::vector<std::string> &content_types);
  3080. void parse_disposition_params(const std::string &s, Params &params);
  3081. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3082. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3083. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3084. EncodingType encoding_type(const Request &req, const Response &res,
  3085. const std::string &content_type);
  3086. EncodingType encoding_type(const Request &req, const Response &res);
  3087. class BufferStream final : public Stream {
  3088. public:
  3089. BufferStream() = default;
  3090. ~BufferStream() override = default;
  3091. bool is_readable() const override;
  3092. bool wait_readable() const override;
  3093. bool wait_writable() const override;
  3094. ssize_t read(char *ptr, size_t size) override;
  3095. ssize_t write(const char *ptr, size_t size) override;
  3096. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3097. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3098. socket_t socket() const override;
  3099. time_t duration() const override;
  3100. const std::string &get_buffer() const;
  3101. private:
  3102. std::string buffer;
  3103. size_t position = 0;
  3104. };
  3105. class compressor {
  3106. public:
  3107. virtual ~compressor() = default;
  3108. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3109. virtual bool compress(const char *data, size_t data_length, bool last,
  3110. Callback callback) = 0;
  3111. };
  3112. class decompressor {
  3113. public:
  3114. virtual ~decompressor() = default;
  3115. virtual bool is_valid() const = 0;
  3116. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3117. virtual bool decompress(const char *data, size_t data_length,
  3118. Callback callback) = 0;
  3119. };
  3120. class nocompressor final : public compressor {
  3121. public:
  3122. ~nocompressor() override = default;
  3123. bool compress(const char *data, size_t data_length, bool /*last*/,
  3124. Callback callback) override;
  3125. };
  3126. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3127. class gzip_compressor final : public compressor {
  3128. public:
  3129. gzip_compressor();
  3130. ~gzip_compressor() override;
  3131. bool compress(const char *data, size_t data_length, bool last,
  3132. Callback callback) override;
  3133. private:
  3134. bool is_valid_ = false;
  3135. z_stream strm_;
  3136. };
  3137. class gzip_decompressor final : public decompressor {
  3138. public:
  3139. gzip_decompressor();
  3140. ~gzip_decompressor() override;
  3141. bool is_valid() const override;
  3142. bool decompress(const char *data, size_t data_length,
  3143. Callback callback) override;
  3144. private:
  3145. bool is_valid_ = false;
  3146. z_stream strm_;
  3147. };
  3148. #endif
  3149. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3150. class brotli_compressor final : public compressor {
  3151. public:
  3152. brotli_compressor();
  3153. ~brotli_compressor();
  3154. bool compress(const char *data, size_t data_length, bool last,
  3155. Callback callback) override;
  3156. private:
  3157. BrotliEncoderState *state_ = nullptr;
  3158. };
  3159. class brotli_decompressor final : public decompressor {
  3160. public:
  3161. brotli_decompressor();
  3162. ~brotli_decompressor();
  3163. bool is_valid() const override;
  3164. bool decompress(const char *data, size_t data_length,
  3165. Callback callback) override;
  3166. private:
  3167. BrotliDecoderResult decoder_r;
  3168. BrotliDecoderState *decoder_s = nullptr;
  3169. };
  3170. #endif
  3171. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3172. class zstd_compressor : public compressor {
  3173. public:
  3174. zstd_compressor();
  3175. ~zstd_compressor();
  3176. bool compress(const char *data, size_t data_length, bool last,
  3177. Callback callback) override;
  3178. private:
  3179. ZSTD_CCtx *ctx_ = nullptr;
  3180. };
  3181. class zstd_decompressor : public decompressor {
  3182. public:
  3183. zstd_decompressor();
  3184. ~zstd_decompressor();
  3185. bool is_valid() const override;
  3186. bool decompress(const char *data, size_t data_length,
  3187. Callback callback) override;
  3188. private:
  3189. ZSTD_DCtx *ctx_ = nullptr;
  3190. };
  3191. #endif
  3192. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3193. // to store data. The call can set memory on stack for performance.
  3194. class stream_line_reader {
  3195. public:
  3196. stream_line_reader(Stream &strm, char *fixed_buffer,
  3197. size_t fixed_buffer_size);
  3198. const char *ptr() const;
  3199. size_t size() const;
  3200. bool end_with_crlf() const;
  3201. bool getline();
  3202. private:
  3203. void append(char c);
  3204. void append(const char *data, size_t size);
  3205. Stream &strm_;
  3206. char *fixed_buffer_;
  3207. const size_t fixed_buffer_size_;
  3208. size_t fixed_buffer_used_size_ = 0;
  3209. std::string growable_buffer_;
  3210. };
  3211. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3212. const Headers &src_headers);
  3213. struct ChunkedDecoder {
  3214. Stream &strm;
  3215. size_t chunk_remaining = 0;
  3216. bool finished = false;
  3217. char line_buf[64];
  3218. size_t last_chunk_total = 0;
  3219. size_t last_chunk_offset = 0;
  3220. explicit ChunkedDecoder(Stream &s);
  3221. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3222. size_t &out_chunk_total);
  3223. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3224. };
  3225. class mmap {
  3226. public:
  3227. mmap(const char *path);
  3228. ~mmap();
  3229. bool open(const char *path);
  3230. void close();
  3231. bool is_open() const;
  3232. size_t size() const;
  3233. const char *data() const;
  3234. private:
  3235. #if defined(_WIN32)
  3236. HANDLE hFile_ = NULL;
  3237. HANDLE hMapping_ = NULL;
  3238. #else
  3239. int fd_ = -1;
  3240. #endif
  3241. size_t size_ = 0;
  3242. void *addr_ = nullptr;
  3243. bool is_open_empty_file = false;
  3244. };
  3245. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3246. namespace fields {
  3247. bool is_token_char(char c);
  3248. bool is_token(const std::string &s);
  3249. bool is_field_name(const std::string &s);
  3250. bool is_vchar(char c);
  3251. bool is_obs_text(char c);
  3252. bool is_field_vchar(char c);
  3253. bool is_field_content(const std::string &s);
  3254. bool is_field_value(const std::string &s);
  3255. bool is_field_valid(const std::string &name, const std::string &value);
  3256. bool is_request_target(const std::string &s);
  3257. } // namespace fields
  3258. } // namespace detail
  3259. /*
  3260. * TLS Abstraction Layer Declarations
  3261. */
  3262. #ifdef CPPHTTPLIB_SSL_ENABLED
  3263. // TLS abstraction layer - backend-specific type declarations
  3264. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3265. namespace tls {
  3266. namespace impl {
  3267. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3268. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3269. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3270. struct MbedTlsContext {
  3271. mbedtls_ssl_config conf;
  3272. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3273. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3274. mbedtls_entropy_context entropy;
  3275. mbedtls_ctr_drbg_context ctr_drbg;
  3276. #endif
  3277. mbedtls_x509_crt ca_chain;
  3278. mbedtls_x509_crt own_cert;
  3279. mbedtls_pk_context own_key;
  3280. bool is_server = false;
  3281. bool verify_client = false;
  3282. bool has_verify_callback = false;
  3283. MbedTlsContext();
  3284. ~MbedTlsContext();
  3285. MbedTlsContext(const MbedTlsContext &) = delete;
  3286. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3287. };
  3288. } // namespace impl
  3289. } // namespace tls
  3290. #endif
  3291. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3292. namespace tls {
  3293. namespace impl {
  3294. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3295. // This struct is accessible via tls::impl for use in SSL context
  3296. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3297. struct WolfSSLContext {
  3298. WOLFSSL_CTX *ctx = nullptr;
  3299. bool is_server = false;
  3300. bool verify_client = false;
  3301. bool has_verify_callback = false;
  3302. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3303. WolfSSLContext();
  3304. ~WolfSSLContext();
  3305. WolfSSLContext(const WolfSSLContext &) = delete;
  3306. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3307. };
  3308. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3309. struct WolfSSLCAStore {
  3310. std::string pem_data;
  3311. };
  3312. } // namespace impl
  3313. } // namespace tls
  3314. #endif
  3315. #endif // CPPHTTPLIB_SSL_ENABLED
  3316. namespace stream {
  3317. class Result {
  3318. public:
  3319. Result();
  3320. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3321. Result(Result &&other) noexcept;
  3322. Result &operator=(Result &&other) noexcept;
  3323. Result(const Result &) = delete;
  3324. Result &operator=(const Result &) = delete;
  3325. // Response info
  3326. bool is_valid() const;
  3327. explicit operator bool() const;
  3328. int status() const;
  3329. const Headers &headers() const;
  3330. std::string get_header_value(const std::string &key,
  3331. const char *def = "") const;
  3332. bool has_header(const std::string &key) const;
  3333. Error error() const;
  3334. Error read_error() const;
  3335. bool has_read_error() const;
  3336. // Stream reading
  3337. bool next();
  3338. const char *data() const;
  3339. size_t size() const;
  3340. std::string read_all();
  3341. private:
  3342. ClientImpl::StreamHandle handle_;
  3343. std::string buffer_;
  3344. size_t current_size_ = 0;
  3345. size_t chunk_size_;
  3346. bool finished_ = false;
  3347. };
  3348. // GET
  3349. template <typename ClientType>
  3350. inline Result Get(ClientType &cli, const std::string &path,
  3351. size_t chunk_size = 8192) {
  3352. return Result{cli.open_stream("GET", path), chunk_size};
  3353. }
  3354. template <typename ClientType>
  3355. inline Result Get(ClientType &cli, const std::string &path,
  3356. const Headers &headers, size_t chunk_size = 8192) {
  3357. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3358. }
  3359. template <typename ClientType>
  3360. inline Result Get(ClientType &cli, const std::string &path,
  3361. const Params &params, size_t chunk_size = 8192) {
  3362. return Result{cli.open_stream("GET", path, params), chunk_size};
  3363. }
  3364. template <typename ClientType>
  3365. inline Result Get(ClientType &cli, const std::string &path,
  3366. const Params &params, const Headers &headers,
  3367. size_t chunk_size = 8192) {
  3368. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3369. }
  3370. // POST
  3371. template <typename ClientType>
  3372. inline Result Post(ClientType &cli, const std::string &path,
  3373. const std::string &body, const std::string &content_type,
  3374. size_t chunk_size = 8192) {
  3375. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3376. chunk_size};
  3377. }
  3378. template <typename ClientType>
  3379. inline Result Post(ClientType &cli, const std::string &path,
  3380. const Headers &headers, const std::string &body,
  3381. const std::string &content_type, size_t chunk_size = 8192) {
  3382. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3383. chunk_size};
  3384. }
  3385. template <typename ClientType>
  3386. inline Result Post(ClientType &cli, const std::string &path,
  3387. const Params &params, const std::string &body,
  3388. const std::string &content_type, size_t chunk_size = 8192) {
  3389. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3390. chunk_size};
  3391. }
  3392. template <typename ClientType>
  3393. inline Result Post(ClientType &cli, const std::string &path,
  3394. const Params &params, const Headers &headers,
  3395. const std::string &body, const std::string &content_type,
  3396. size_t chunk_size = 8192) {
  3397. return Result{
  3398. cli.open_stream("POST", path, params, headers, body, content_type),
  3399. chunk_size};
  3400. }
  3401. // PUT
  3402. template <typename ClientType>
  3403. inline Result Put(ClientType &cli, const std::string &path,
  3404. const std::string &body, const std::string &content_type,
  3405. size_t chunk_size = 8192) {
  3406. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3407. chunk_size};
  3408. }
  3409. template <typename ClientType>
  3410. inline Result Put(ClientType &cli, const std::string &path,
  3411. const Headers &headers, const std::string &body,
  3412. const std::string &content_type, size_t chunk_size = 8192) {
  3413. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3414. chunk_size};
  3415. }
  3416. template <typename ClientType>
  3417. inline Result Put(ClientType &cli, const std::string &path,
  3418. const Params &params, const std::string &body,
  3419. const std::string &content_type, size_t chunk_size = 8192) {
  3420. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3421. chunk_size};
  3422. }
  3423. template <typename ClientType>
  3424. inline Result Put(ClientType &cli, const std::string &path,
  3425. const Params &params, const Headers &headers,
  3426. const std::string &body, const std::string &content_type,
  3427. size_t chunk_size = 8192) {
  3428. return Result{
  3429. cli.open_stream("PUT", path, params, headers, body, content_type),
  3430. chunk_size};
  3431. }
  3432. // PATCH
  3433. template <typename ClientType>
  3434. inline Result Patch(ClientType &cli, const std::string &path,
  3435. const std::string &body, const std::string &content_type,
  3436. size_t chunk_size = 8192) {
  3437. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Patch(ClientType &cli, const std::string &path,
  3442. const Headers &headers, const std::string &body,
  3443. const std::string &content_type, size_t chunk_size = 8192) {
  3444. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3445. chunk_size};
  3446. }
  3447. template <typename ClientType>
  3448. inline Result Patch(ClientType &cli, const std::string &path,
  3449. const Params &params, const std::string &body,
  3450. const std::string &content_type, size_t chunk_size = 8192) {
  3451. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3452. chunk_size};
  3453. }
  3454. template <typename ClientType>
  3455. inline Result Patch(ClientType &cli, const std::string &path,
  3456. const Params &params, const Headers &headers,
  3457. const std::string &body, const std::string &content_type,
  3458. size_t chunk_size = 8192) {
  3459. return Result{
  3460. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3461. chunk_size};
  3462. }
  3463. // DELETE
  3464. template <typename ClientType>
  3465. inline Result Delete(ClientType &cli, const std::string &path,
  3466. size_t chunk_size = 8192) {
  3467. return Result{cli.open_stream("DELETE", path), chunk_size};
  3468. }
  3469. template <typename ClientType>
  3470. inline Result Delete(ClientType &cli, const std::string &path,
  3471. const Headers &headers, size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3473. }
  3474. template <typename ClientType>
  3475. inline Result Delete(ClientType &cli, const std::string &path,
  3476. const std::string &body, const std::string &content_type,
  3477. size_t chunk_size = 8192) {
  3478. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3479. chunk_size};
  3480. }
  3481. template <typename ClientType>
  3482. inline Result Delete(ClientType &cli, const std::string &path,
  3483. const Headers &headers, const std::string &body,
  3484. const std::string &content_type,
  3485. size_t chunk_size = 8192) {
  3486. return Result{
  3487. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3488. chunk_size};
  3489. }
  3490. template <typename ClientType>
  3491. inline Result Delete(ClientType &cli, const std::string &path,
  3492. const Params &params, size_t chunk_size = 8192) {
  3493. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3494. }
  3495. template <typename ClientType>
  3496. inline Result Delete(ClientType &cli, const std::string &path,
  3497. const Params &params, const Headers &headers,
  3498. size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Delete(ClientType &cli, const std::string &path,
  3503. const Params &params, const std::string &body,
  3504. const std::string &content_type,
  3505. size_t chunk_size = 8192) {
  3506. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3507. chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Delete(ClientType &cli, const std::string &path,
  3511. const Params &params, const Headers &headers,
  3512. const std::string &body, const std::string &content_type,
  3513. size_t chunk_size = 8192) {
  3514. return Result{
  3515. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3516. chunk_size};
  3517. }
  3518. // HEAD
  3519. template <typename ClientType>
  3520. inline Result Head(ClientType &cli, const std::string &path,
  3521. size_t chunk_size = 8192) {
  3522. return Result{cli.open_stream("HEAD", path), chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Head(ClientType &cli, const std::string &path,
  3526. const Headers &headers, size_t chunk_size = 8192) {
  3527. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3528. }
  3529. template <typename ClientType>
  3530. inline Result Head(ClientType &cli, const std::string &path,
  3531. const Params &params, size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3533. }
  3534. template <typename ClientType>
  3535. inline Result Head(ClientType &cli, const std::string &path,
  3536. const Params &params, const Headers &headers,
  3537. size_t chunk_size = 8192) {
  3538. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3539. }
  3540. // OPTIONS
  3541. template <typename ClientType>
  3542. inline Result Options(ClientType &cli, const std::string &path,
  3543. size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Options(ClientType &cli, const std::string &path,
  3548. const Headers &headers, size_t chunk_size = 8192) {
  3549. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3550. }
  3551. template <typename ClientType>
  3552. inline Result Options(ClientType &cli, const std::string &path,
  3553. const Params &params, size_t chunk_size = 8192) {
  3554. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3555. }
  3556. template <typename ClientType>
  3557. inline Result Options(ClientType &cli, const std::string &path,
  3558. const Params &params, const Headers &headers,
  3559. size_t chunk_size = 8192) {
  3560. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3561. }
  3562. } // namespace stream
  3563. namespace sse {
  3564. struct SSEMessage {
  3565. std::string event; // Event type (default: "message")
  3566. std::string data; // Event payload
  3567. std::string id; // Event ID for Last-Event-ID header
  3568. SSEMessage();
  3569. void clear();
  3570. };
  3571. class SSEClient {
  3572. public:
  3573. using MessageHandler = std::function<void(const SSEMessage &)>;
  3574. using ErrorHandler = std::function<void(Error)>;
  3575. using OpenHandler = std::function<void()>;
  3576. SSEClient(Client &client, const std::string &path);
  3577. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3578. ~SSEClient();
  3579. SSEClient(const SSEClient &) = delete;
  3580. SSEClient &operator=(const SSEClient &) = delete;
  3581. // Event handlers
  3582. SSEClient &on_message(MessageHandler handler);
  3583. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3584. SSEClient &on_open(OpenHandler handler);
  3585. SSEClient &on_error(ErrorHandler handler);
  3586. SSEClient &set_reconnect_interval(int ms);
  3587. SSEClient &set_max_reconnect_attempts(int n);
  3588. // Update headers (thread-safe)
  3589. SSEClient &set_headers(const Headers &headers);
  3590. // State accessors
  3591. bool is_connected() const;
  3592. const std::string &last_event_id() const;
  3593. // Blocking start - runs event loop with auto-reconnect
  3594. void start();
  3595. // Non-blocking start - runs in background thread
  3596. void start_async();
  3597. // Stop the client (thread-safe)
  3598. void stop();
  3599. private:
  3600. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3601. void run_event_loop();
  3602. void dispatch_event(const SSEMessage &msg);
  3603. bool should_reconnect(int count) const;
  3604. void wait_for_reconnect();
  3605. // Client and path
  3606. Client &client_;
  3607. std::string path_;
  3608. Headers headers_;
  3609. mutable std::mutex headers_mutex_;
  3610. // Callbacks
  3611. MessageHandler on_message_;
  3612. std::map<std::string, MessageHandler> event_handlers_;
  3613. OpenHandler on_open_;
  3614. ErrorHandler on_error_;
  3615. // Configuration
  3616. int reconnect_interval_ms_ = 3000;
  3617. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3618. // State
  3619. std::atomic<bool> running_{false};
  3620. std::atomic<bool> connected_{false};
  3621. std::string last_event_id_;
  3622. // Async support
  3623. std::thread async_thread_;
  3624. };
  3625. } // namespace sse
  3626. namespace ws {
  3627. enum class Opcode : uint8_t {
  3628. Continuation = 0x0,
  3629. Text = 0x1,
  3630. Binary = 0x2,
  3631. Close = 0x8,
  3632. Ping = 0x9,
  3633. Pong = 0xA,
  3634. };
  3635. enum class CloseStatus : uint16_t {
  3636. Normal = 1000,
  3637. GoingAway = 1001,
  3638. ProtocolError = 1002,
  3639. UnsupportedData = 1003,
  3640. NoStatus = 1005,
  3641. Abnormal = 1006,
  3642. InvalidPayload = 1007,
  3643. PolicyViolation = 1008,
  3644. MessageTooBig = 1009,
  3645. MandatoryExtension = 1010,
  3646. InternalError = 1011,
  3647. };
  3648. // Timeout is returned only when a read timeout was set and it elapsed before
  3649. // any byte of a frame arrived: nothing was consumed and the connection is
  3650. // still open, so the caller can send on it and read again. `msg` is left
  3651. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3652. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3653. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3654. // upgrade handshake fully succeeded. On failure error() identifies the
  3655. // failing layer; status()/headers() expose the server's upgrade response
  3656. // when one was received (status() is -1 otherwise).
  3657. class Result {
  3658. public:
  3659. Result() = default;
  3660. Result(Error err, int status, Headers &&headers)
  3661. : err_(err), status_(status), headers_(std::move(headers)) {}
  3662. explicit operator bool() const { return err_ == Error::Success; }
  3663. Error error() const { return err_; }
  3664. // Upgrade response info
  3665. int status() const { return status_; }
  3666. const Headers &headers() const { return headers_; }
  3667. std::string get_header_value(const std::string &key,
  3668. const char *def = "") const {
  3669. return detail::get_header_value(headers_, key, def, 0);
  3670. }
  3671. bool has_header(const std::string &key) const {
  3672. return headers_.find(key) != headers_.end();
  3673. }
  3674. #ifdef CPPHTTPLIB_SSL_ENABLED
  3675. Result(Error err, int status, Headers &&headers, int ssl_error,
  3676. uint64_t ssl_backend_error)
  3677. : err_(err), status_(status), headers_(std::move(headers)),
  3678. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3679. int ssl_error() const { return ssl_error_; }
  3680. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3681. #endif
  3682. private:
  3683. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3684. int status_ = -1;
  3685. Headers headers_;
  3686. #ifdef CPPHTTPLIB_SSL_ENABLED
  3687. int ssl_error_ = 0;
  3688. uint64_t ssl_backend_error_ = 0;
  3689. #endif
  3690. };
  3691. class WebSocket {
  3692. public:
  3693. WebSocket(const WebSocket &) = delete;
  3694. WebSocket &operator=(const WebSocket &) = delete;
  3695. ~WebSocket();
  3696. ReadResult read(std::string &msg);
  3697. bool send(const std::string &data);
  3698. bool send(const char *data, size_t len);
  3699. void close(CloseStatus status = CloseStatus::Normal,
  3700. const std::string &reason = "");
  3701. const Request &request() const;
  3702. bool is_open() const;
  3703. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3704. // A server handler owns its connection's timeout this way; a client sets it
  3705. // through WebSocketClient. Safe to call while another thread is in read().
  3706. //
  3707. // Only a timeout set here is reported as Timeout. The compile-time default
  3708. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3709. // than a request for control, so when it elapses read() returns Fail and
  3710. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3711. void set_read_timeout(time_t sec, time_t usec = 0);
  3712. template <class Rep, class Period>
  3713. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3714. private:
  3715. friend class httplib::Server;
  3716. friend class WebSocketClient;
  3717. WebSocket(
  3718. Stream &strm, const Request &req, bool is_server,
  3719. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3720. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3721. : strm_(strm), req_(req), is_server_(is_server),
  3722. ping_interval_sec_(ping_interval_sec),
  3723. max_missed_pongs_(max_missed_pongs) {
  3724. start_heartbeat();
  3725. }
  3726. WebSocket(
  3727. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3728. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3729. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3730. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3731. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3732. max_missed_pongs_(max_missed_pongs) {
  3733. start_heartbeat();
  3734. }
  3735. void start_heartbeat();
  3736. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3737. Stream &strm_;
  3738. std::unique_ptr<Stream> owned_strm_;
  3739. Request req_;
  3740. bool is_server_;
  3741. time_t ping_interval_sec_;
  3742. int max_missed_pongs_;
  3743. int unacked_pings_ = 0;
  3744. std::atomic<bool> closed_{false};
  3745. // Set once the caller has bounded read() through set_read_timeout(). Until
  3746. // then the timeout in effect is the compile-time default, and elapsing it
  3747. // is a failure that closes the connection, not a Timeout.
  3748. std::atomic<bool> read_timeout_set_{false};
  3749. std::mutex write_mutex_;
  3750. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3751. // may do so: read_websocket_frame() reads a payload until it has the whole
  3752. // declared length, so a second parser stealing bytes silently corrupts the
  3753. // message the first one is assembling.
  3754. std::mutex read_mutex_;
  3755. std::thread ping_thread_;
  3756. std::mutex ping_mutex_;
  3757. std::condition_variable ping_cv_;
  3758. };
  3759. class WebSocketClient {
  3760. public:
  3761. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3762. const Headers &headers = {});
  3763. ~WebSocketClient();
  3764. WebSocketClient(const WebSocketClient &) = delete;
  3765. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3766. bool is_valid() const;
  3767. Result connect();
  3768. ReadResult read(std::string &msg);
  3769. bool send(const std::string &data);
  3770. bool send(const char *data, size_t len);
  3771. void close(CloseStatus status = CloseStatus::Normal,
  3772. const std::string &reason = "");
  3773. bool is_open() const;
  3774. const std::string &subprotocol() const;
  3775. void set_read_timeout(time_t sec, time_t usec = 0);
  3776. template <class Rep, class Period>
  3777. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3778. void set_write_timeout(time_t sec, time_t usec = 0);
  3779. template <class Rep, class Period>
  3780. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3781. void set_websocket_ping_interval(time_t sec);
  3782. void set_websocket_max_missed_pongs(int count);
  3783. void set_tcp_nodelay(bool on);
  3784. void set_address_family(int family);
  3785. void set_ipv6_v6only(bool on);
  3786. void set_socket_options(SocketOptions socket_options);
  3787. void set_connection_timeout(time_t sec, time_t usec = 0);
  3788. template <class Rep, class Period>
  3789. void
  3790. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3791. void set_interface(const std::string &intf);
  3792. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3793. #ifdef CPPHTTPLIB_SSL_ENABLED
  3794. struct PemMemory {
  3795. const char *cert_pem;
  3796. size_t cert_pem_len;
  3797. const char *key_pem;
  3798. size_t key_pem_len;
  3799. const char *private_key_password;
  3800. };
  3801. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3802. const PemMemory &pem, const Headers &headers = {});
  3803. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3804. const std::string &ca_cert_dir_path = std::string());
  3805. void set_ca_cert_store(tls::ca_store_t store);
  3806. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3807. void enable_server_certificate_verification(bool enabled);
  3808. void enable_server_hostname_verification(bool enabled);
  3809. void enable_system_ca(bool enabled);
  3810. #endif
  3811. private:
  3812. void shutdown_and_close();
  3813. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3814. int &ssl_error, uint64_t &ssl_backend_error);
  3815. void prepare_default_headers(Request &req);
  3816. std::string host_;
  3817. int port_;
  3818. std::string path_;
  3819. Headers headers_;
  3820. std::string subprotocol_;
  3821. bool is_valid_ = false;
  3822. socket_t sock_ = INVALID_SOCKET;
  3823. std::unique_ptr<WebSocket> ws_;
  3824. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3825. time_t read_timeout_usec_ = 0;
  3826. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3827. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3828. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3829. time_t websocket_ping_interval_sec_ =
  3830. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3831. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3832. int address_family_ = AF_UNSPEC;
  3833. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3834. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3835. SocketOptions socket_options_ = nullptr;
  3836. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3837. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3838. std::string interface_;
  3839. // Hostname to connection target map. The value is an IP literal or another
  3840. // hostname; only the connection target changes, never the identity.
  3841. std::map<std::string, std::string> addr_map_;
  3842. #ifdef CPPHTTPLIB_SSL_ENABLED
  3843. bool is_ssl_ = false;
  3844. tls::ctx_t tls_ctx_ = nullptr;
  3845. tls::session_t tls_session_ = nullptr;
  3846. std::string ca_cert_file_path_;
  3847. std::string ca_cert_dir_path_;
  3848. bool custom_ca_loaded_ = false;
  3849. bool certs_loaded_ = false;
  3850. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3851. bool server_certificate_verification_ = true;
  3852. bool server_hostname_verification_ = true;
  3853. #endif
  3854. };
  3855. template <class Rep, class Period>
  3856. inline void WebSocket::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_read_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_read_timeout(sec, usec); });
  3866. }
  3867. template <class Rep, class Period>
  3868. inline void WebSocketClient::set_write_timeout(
  3869. const std::chrono::duration<Rep, Period> &duration) {
  3870. detail::duration_to_sec_and_usec(
  3871. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3872. }
  3873. template <class Rep, class Period>
  3874. inline void WebSocketClient::set_connection_timeout(
  3875. const std::chrono::duration<Rep, Period> &duration) {
  3876. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3877. set_connection_timeout(sec, usec);
  3878. });
  3879. }
  3880. namespace impl {
  3881. bool is_valid_utf8(const std::string &s);
  3882. // Three states, because a failure that consumed bytes and one that consumed
  3883. // none are not the same thing: the first has left the stream in the middle of
  3884. // a frame and the connection cannot be reused, the second can just be retried.
  3885. enum class FrameRead { Ok, Fail, Timeout };
  3886. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3887. std::string &payload, bool &fin,
  3888. bool expect_masked, size_t max_len);
  3889. } // namespace impl
  3890. } // namespace ws
  3891. // ----------------------------------------------------------------------------
  3892. /*
  3893. * Implementation that will be part of the .cc file if split into .h + .cc.
  3894. */
  3895. namespace stream {
  3896. // stream::Result implementations
  3897. inline Result::Result() : chunk_size_(8192) {}
  3898. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3899. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3900. inline Result::Result(Result &&other) noexcept
  3901. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3902. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3903. finished_(other.finished_) {
  3904. other.current_size_ = 0;
  3905. other.finished_ = true;
  3906. }
  3907. inline Result &Result::operator=(Result &&other) noexcept {
  3908. if (this != &other) {
  3909. handle_ = std::move(other.handle_);
  3910. buffer_ = std::move(other.buffer_);
  3911. current_size_ = other.current_size_;
  3912. chunk_size_ = other.chunk_size_;
  3913. finished_ = other.finished_;
  3914. other.current_size_ = 0;
  3915. other.finished_ = true;
  3916. }
  3917. return *this;
  3918. }
  3919. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3920. inline Result::operator bool() const { return is_valid(); }
  3921. inline int Result::status() const {
  3922. return handle_.response ? handle_.response->status : -1;
  3923. }
  3924. inline const Headers &Result::headers() const {
  3925. static const Headers empty_headers;
  3926. return handle_.response ? handle_.response->headers : empty_headers;
  3927. }
  3928. inline std::string Result::get_header_value(const std::string &key,
  3929. const char *def) const {
  3930. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3931. }
  3932. inline bool Result::has_header(const std::string &key) const {
  3933. return handle_.response ? handle_.response->has_header(key) : false;
  3934. }
  3935. inline Error Result::error() const { return handle_.error; }
  3936. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3937. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3938. inline bool Result::next() {
  3939. if (!handle_.is_valid() || finished_) { return false; }
  3940. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3941. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3942. if (n > 0) {
  3943. current_size_ = static_cast<size_t>(n);
  3944. return true;
  3945. }
  3946. current_size_ = 0;
  3947. finished_ = true;
  3948. return false;
  3949. }
  3950. inline const char *Result::data() const { return buffer_.data(); }
  3951. inline size_t Result::size() const { return current_size_; }
  3952. inline std::string Result::read_all() {
  3953. std::string result;
  3954. while (next()) {
  3955. result.append(data(), size());
  3956. }
  3957. return result;
  3958. }
  3959. } // namespace stream
  3960. namespace sse {
  3961. // SSEMessage implementations
  3962. inline SSEMessage::SSEMessage() : event("message") {}
  3963. inline void SSEMessage::clear() {
  3964. event = "message";
  3965. data.clear();
  3966. id.clear();
  3967. }
  3968. // SSEClient implementations
  3969. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3970. : client_(client), path_(path) {}
  3971. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3972. const Headers &headers)
  3973. : client_(client), path_(path), headers_(headers) {}
  3974. inline SSEClient::~SSEClient() { stop(); }
  3975. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3976. on_message_ = std::move(handler);
  3977. return *this;
  3978. }
  3979. inline SSEClient &SSEClient::on_event(const std::string &type,
  3980. MessageHandler handler) {
  3981. event_handlers_[type] = std::move(handler);
  3982. return *this;
  3983. }
  3984. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3985. on_open_ = std::move(handler);
  3986. return *this;
  3987. }
  3988. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3989. on_error_ = std::move(handler);
  3990. return *this;
  3991. }
  3992. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3993. reconnect_interval_ms_ = ms;
  3994. return *this;
  3995. }
  3996. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3997. max_reconnect_attempts_ = n;
  3998. return *this;
  3999. }
  4000. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4001. std::lock_guard<std::mutex> lock(headers_mutex_);
  4002. headers_ = headers;
  4003. return *this;
  4004. }
  4005. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4006. inline const std::string &SSEClient::last_event_id() const {
  4007. return last_event_id_;
  4008. }
  4009. inline void SSEClient::start() {
  4010. running_.store(true);
  4011. run_event_loop();
  4012. }
  4013. inline void SSEClient::start_async() {
  4014. running_.store(true);
  4015. async_thread_ = std::thread([this]() { run_event_loop(); });
  4016. }
  4017. inline void SSEClient::stop() {
  4018. running_.store(false);
  4019. client_.stop(); // Cancel any pending operations
  4020. if (async_thread_.joinable()) { async_thread_.join(); }
  4021. }
  4022. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4023. int &retry_ms) {
  4024. // Blank line signals end of event
  4025. if (line.empty() || line == "\r") { return true; }
  4026. // Lines starting with ':' are comments (ignored)
  4027. if (!line.empty() && line[0] == ':') { return false; }
  4028. // Find the colon separator
  4029. auto colon_pos = line.find(':');
  4030. if (colon_pos == std::string::npos) {
  4031. // Line with no colon is treated as field name with empty value
  4032. return false;
  4033. }
  4034. auto field = line.substr(0, colon_pos);
  4035. std::string value;
  4036. // Value starts after colon, skip optional single space
  4037. if (colon_pos + 1 < line.size()) {
  4038. auto value_start = colon_pos + 1;
  4039. if (line[value_start] == ' ') { value_start++; }
  4040. value = line.substr(value_start);
  4041. // Remove trailing \r if present
  4042. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  4043. }
  4044. // Handle known fields
  4045. if (field == "event") {
  4046. msg.event = value;
  4047. } else if (field == "data") {
  4048. // Multiple data lines are concatenated with newlines
  4049. if (!msg.data.empty()) { msg.data += "\n"; }
  4050. msg.data += value;
  4051. } else if (field == "id") {
  4052. // Empty id is valid (clears the last event ID)
  4053. msg.id = value;
  4054. } else if (field == "retry") {
  4055. // Parse retry interval in milliseconds
  4056. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4057. if (detail::is_numeric(value)) {
  4058. int v = 0;
  4059. auto res =
  4060. detail::from_chars(value.data(), value.data() + value.size(), v);
  4061. if (res.ec == std::errc{}) { retry_ms = v; }
  4062. }
  4063. }
  4064. // Unknown fields are ignored per SSE spec
  4065. return false;
  4066. }
  4067. inline void SSEClient::run_event_loop() {
  4068. auto reconnect_count = 0;
  4069. while (running_.load()) {
  4070. // Build headers, including Last-Event-ID if we have one
  4071. Headers request_headers;
  4072. {
  4073. std::lock_guard<std::mutex> lock(headers_mutex_);
  4074. request_headers = headers_;
  4075. }
  4076. if (!last_event_id_.empty()) {
  4077. request_headers.emplace("Last-Event-ID", last_event_id_);
  4078. }
  4079. // Open streaming connection
  4080. auto result = stream::Get(client_, path_, request_headers);
  4081. // Connection error handling
  4082. if (!result) {
  4083. connected_.store(false);
  4084. if (on_error_) { on_error_(result.error()); }
  4085. if (!should_reconnect(reconnect_count)) { break; }
  4086. wait_for_reconnect();
  4087. reconnect_count++;
  4088. continue;
  4089. }
  4090. if (result.status() != StatusCode::OK_200) {
  4091. connected_.store(false);
  4092. if (on_error_) { on_error_(Error::Connection); }
  4093. // For certain errors, don't reconnect.
  4094. // Note: 401 is intentionally absent so that handlers can refresh
  4095. // credentials via set_headers() and let the client reconnect.
  4096. if (result.status() == StatusCode::NoContent_204 ||
  4097. result.status() == StatusCode::NotFound_404 ||
  4098. result.status() == StatusCode::Forbidden_403) {
  4099. break;
  4100. }
  4101. if (!should_reconnect(reconnect_count)) { break; }
  4102. wait_for_reconnect();
  4103. reconnect_count++;
  4104. continue;
  4105. }
  4106. // Connection successful
  4107. connected_.store(true);
  4108. reconnect_count = 0;
  4109. if (on_open_) { on_open_(); }
  4110. // Event receiving loop
  4111. std::string buffer;
  4112. SSEMessage current_msg;
  4113. while (running_.load() && result.next()) {
  4114. buffer.append(result.data(), result.size());
  4115. // Process complete lines in the buffer
  4116. size_t line_start = 0;
  4117. size_t newline_pos;
  4118. while ((newline_pos = buffer.find('\n', line_start)) !=
  4119. std::string::npos) {
  4120. auto line = buffer.substr(line_start, newline_pos - line_start);
  4121. line_start = newline_pos + 1;
  4122. // Parse the line and check if event is complete
  4123. auto event_complete =
  4124. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4125. if (event_complete && !current_msg.data.empty()) {
  4126. // Update last_event_id for reconnection
  4127. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4128. // Dispatch event to appropriate handler
  4129. dispatch_event(current_msg);
  4130. current_msg.clear();
  4131. }
  4132. }
  4133. // Keep unprocessed data in buffer
  4134. buffer.erase(0, line_start);
  4135. }
  4136. // Connection ended
  4137. connected_.store(false);
  4138. if (!running_.load()) { break; }
  4139. // Check for read errors
  4140. if (result.has_read_error()) {
  4141. if (on_error_) { on_error_(result.read_error()); }
  4142. }
  4143. if (!should_reconnect(reconnect_count)) { break; }
  4144. wait_for_reconnect();
  4145. reconnect_count++;
  4146. }
  4147. connected_.store(false);
  4148. }
  4149. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4150. // Check for specific event type handler first
  4151. auto it = event_handlers_.find(msg.event);
  4152. if (it != event_handlers_.end()) {
  4153. it->second(msg);
  4154. return;
  4155. }
  4156. // Fall back to generic message handler
  4157. if (on_message_) { on_message_(msg); }
  4158. }
  4159. inline bool SSEClient::should_reconnect(int count) const {
  4160. if (!running_.load()) { return false; }
  4161. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4162. return count < max_reconnect_attempts_;
  4163. }
  4164. inline void SSEClient::wait_for_reconnect() {
  4165. // Use small increments to check running_ flag frequently.
  4166. // Always wait at least one increment, so that a zero interval (e.g.
  4167. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4168. const auto step_ms = 100;
  4169. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4170. auto waited = 0;
  4171. while (running_.load() && waited < interval_ms) {
  4172. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4173. waited += step_ms;
  4174. }
  4175. }
  4176. } // namespace sse
  4177. #ifdef CPPHTTPLIB_SSL_ENABLED
  4178. /*
  4179. * TLS abstraction layer - internal function declarations
  4180. * These are implementation details and not part of the public API.
  4181. */
  4182. namespace tls {
  4183. // Client context
  4184. ctx_t create_client_context();
  4185. void free_context(ctx_t ctx);
  4186. bool set_min_version(ctx_t ctx, Version version);
  4187. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4188. bool load_ca_file(ctx_t ctx, const char *file_path);
  4189. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4190. bool load_system_certs(ctx_t ctx);
  4191. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4192. const char *password);
  4193. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4194. const char *key_path, const char *password);
  4195. // Server context
  4196. ctx_t create_server_context();
  4197. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4198. const char *password);
  4199. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4200. const char *key_path, const char *password);
  4201. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4202. void set_verify_client(ctx_t ctx, bool require);
  4203. // Session management
  4204. session_t create_session(ctx_t ctx, socket_t sock);
  4205. void free_session(session_t session);
  4206. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4207. // Handshake (non-blocking capable)
  4208. TlsError connect(session_t session);
  4209. TlsError accept(session_t session);
  4210. // Handshake with timeout (blocking until timeout)
  4211. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4212. time_t timeout_usec, TlsError *err);
  4213. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4214. time_t timeout_usec, TlsError *err);
  4215. // I/O (non-blocking capable)
  4216. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4217. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4218. int pending(const_session_t session);
  4219. void shutdown(session_t session, bool graceful);
  4220. // Connection state
  4221. bool is_peer_closed(session_t session, socket_t sock);
  4222. // Certificate verification
  4223. cert_t get_peer_cert(const_session_t session);
  4224. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4225. // do not use them after free_session(), as with get_peer_cert().
  4226. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4227. void free_cert(cert_t cert);
  4228. bool verify_hostname(cert_t cert, const char *hostname);
  4229. uint64_t hostname_mismatch_code();
  4230. long get_verify_result(const_session_t session);
  4231. // Certificate introspection
  4232. std::string get_cert_subject_cn(cert_t cert);
  4233. std::string get_cert_issuer_name(cert_t cert);
  4234. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4235. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4236. std::string get_cert_serial(cert_t cert);
  4237. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4238. const char *get_sni(const_session_t session);
  4239. // CA store management
  4240. ca_store_t create_ca_store(const char *pem, size_t len);
  4241. void free_ca_store(ca_store_t store);
  4242. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4243. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4244. std::vector<std::string> get_ca_names(ctx_t ctx);
  4245. // Dynamic certificate update (for servers)
  4246. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4247. const char *password);
  4248. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4249. // Certificate verification callback
  4250. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4251. long get_verify_error(const_session_t session);
  4252. std::string verify_error_string(long error_code);
  4253. // TlsError information
  4254. uint64_t peek_error();
  4255. uint64_t get_error();
  4256. std::string error_string(uint64_t code);
  4257. } // namespace tls
  4258. #endif // CPPHTTPLIB_SSL_ENABLED
  4259. /*
  4260. * Group 1: detail namespace - Non-SSL utilities
  4261. */
  4262. namespace detail {
  4263. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4264. const void *optval, socklen_t optlen) {
  4265. return setsockopt(sock, level, optname,
  4266. #ifdef _WIN32
  4267. reinterpret_cast<const char *>(optval),
  4268. #else
  4269. optval,
  4270. #endif
  4271. optlen) == 0;
  4272. }
  4273. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4274. time_t sec, time_t usec) {
  4275. #ifdef _WIN32
  4276. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4277. #else
  4278. timeval timeout;
  4279. timeout.tv_sec = static_cast<long>(sec);
  4280. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4281. #endif
  4282. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4283. }
  4284. inline bool is_hex(char c, int &v) {
  4285. if (is_ascii_digit(c)) {
  4286. v = c - '0';
  4287. return true;
  4288. } else if ('A' <= c && c <= 'F') {
  4289. v = c - 'A' + 10;
  4290. return true;
  4291. } else if ('a' <= c && c <= 'f') {
  4292. v = c - 'a' + 10;
  4293. return true;
  4294. }
  4295. return false;
  4296. }
  4297. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4298. int &val) {
  4299. if (i >= s.size()) { return false; }
  4300. val = 0;
  4301. for (; cnt; i++, cnt--) {
  4302. if (!s[i]) { return false; }
  4303. auto v = 0;
  4304. if (is_hex(s[i], v)) {
  4305. val = val * 16 + v;
  4306. } else {
  4307. return false;
  4308. }
  4309. }
  4310. return true;
  4311. }
  4312. inline std::string from_i_to_hex(size_t n) {
  4313. static const auto charset = "0123456789abcdef";
  4314. std::string ret;
  4315. do {
  4316. ret = charset[n & 15] + ret;
  4317. n >>= 4;
  4318. } while (n > 0);
  4319. return ret;
  4320. }
  4321. inline std::string compute_etag(const FileStat &fs,
  4322. const std::string &suffix = std::string()) {
  4323. if (!fs.is_file()) { return std::string(); }
  4324. // If mtime cannot be determined (negative value indicates an error
  4325. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4326. // value like 0 could collide with a real file that legitimately has
  4327. // mtime == 0 (epoch) and lead to misleading validators.
  4328. auto mtime_raw = fs.mtime();
  4329. if (mtime_raw < 0) { return std::string(); }
  4330. auto mtime = static_cast<size_t>(mtime_raw);
  4331. auto size = fs.size();
  4332. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4333. from_i_to_hex(size) + suffix + "\"";
  4334. }
  4335. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4336. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4337. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4338. inline std::string file_mtime_to_http_date(time_t mtime) {
  4339. if (mtime < 0) { return std::string(); }
  4340. struct tm tm_buf;
  4341. #ifdef _WIN32
  4342. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4343. #else
  4344. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4345. #endif
  4346. char buf[64];
  4347. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4348. return std::string();
  4349. }
  4350. return std::string(buf);
  4351. }
  4352. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4353. inline time_t parse_http_date(const std::string &date_str) {
  4354. struct tm tm_buf;
  4355. // Create a classic locale object once for all parsing attempts
  4356. const std::locale classic_locale = std::locale::classic();
  4357. // Try to parse using std::get_time (C++11, cross-platform)
  4358. auto try_parse = [&](const char *fmt) -> bool {
  4359. std::istringstream ss(date_str);
  4360. ss.imbue(classic_locale);
  4361. memset(&tm_buf, 0, sizeof(tm_buf));
  4362. ss >> std::get_time(&tm_buf, fmt);
  4363. return !ss.fail();
  4364. };
  4365. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4366. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4367. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4368. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4369. // asctime format: "Sun Nov 6 08:49:37 1994"
  4370. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4371. return static_cast<time_t>(-1);
  4372. }
  4373. }
  4374. }
  4375. #ifdef _WIN32
  4376. return _mkgmtime(&tm_buf);
  4377. #elif defined _AIX
  4378. return mktime(&tm_buf);
  4379. #else
  4380. return timegm(&tm_buf);
  4381. #endif
  4382. }
  4383. inline bool is_weak_etag(const std::string &s) {
  4384. // Check if the string is a weak ETag (starts with 'W/"')
  4385. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4386. }
  4387. inline bool is_strong_etag(const std::string &s) {
  4388. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4389. // chars)
  4390. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4391. }
  4392. inline size_t to_utf8(int code, char *buff) {
  4393. if (code < 0x0080) {
  4394. buff[0] = static_cast<char>(code & 0x7F);
  4395. return 1;
  4396. } else if (code < 0x0800) {
  4397. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4398. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4399. return 2;
  4400. } else if (code < 0xD800) {
  4401. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4402. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4403. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4404. return 3;
  4405. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4406. return 0;
  4407. } else if (code < 0x10000) {
  4408. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4409. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4410. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4411. return 3;
  4412. } else if (code < 0x110000) {
  4413. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4414. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4415. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4416. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4417. return 4;
  4418. }
  4419. // NOTREACHED
  4420. return 0;
  4421. }
  4422. } // namespace detail
  4423. namespace ws {
  4424. namespace impl {
  4425. inline bool is_valid_utf8(const std::string &s) {
  4426. size_t i = 0;
  4427. auto n = s.size();
  4428. while (i < n) {
  4429. auto c = static_cast<unsigned char>(s[i]);
  4430. size_t len;
  4431. uint32_t cp;
  4432. if (c < 0x80) {
  4433. i++;
  4434. continue;
  4435. } else if ((c & 0xE0) == 0xC0) {
  4436. len = 2;
  4437. cp = c & 0x1F;
  4438. } else if ((c & 0xF0) == 0xE0) {
  4439. len = 3;
  4440. cp = c & 0x0F;
  4441. } else if ((c & 0xF8) == 0xF0) {
  4442. len = 4;
  4443. cp = c & 0x07;
  4444. } else {
  4445. return false;
  4446. }
  4447. if (i + len > n) { return false; }
  4448. for (size_t j = 1; j < len; j++) {
  4449. auto b = static_cast<unsigned char>(s[i + j]);
  4450. if ((b & 0xC0) != 0x80) { return false; }
  4451. cp = (cp << 6) | (b & 0x3F);
  4452. }
  4453. // Overlong encoding check
  4454. if (len == 2 && cp < 0x80) { return false; }
  4455. if (len == 3 && cp < 0x800) { return false; }
  4456. if (len == 4 && cp < 0x10000) { return false; }
  4457. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4458. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4459. if (cp > 0x10FFFF) { return false; }
  4460. i += len;
  4461. }
  4462. return true;
  4463. }
  4464. } // namespace impl
  4465. } // namespace ws
  4466. namespace detail {
  4467. // NOTE: This code came up with the following stackoverflow post:
  4468. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4469. inline std::string base64_encode(const std::string &in) {
  4470. static const auto lookup =
  4471. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4472. std::string out;
  4473. out.reserve(in.size());
  4474. // Unsigned: the accumulator is never masked, so with a signed int the
  4475. // `val << 8` below overflows once enough bytes are folded in (undefined
  4476. // behaviour before C++20). Only the low bits are ever emitted, so the
  4477. // wrap-around of an unsigned accumulator does not affect the output.
  4478. uint32_t val = 0;
  4479. auto valb = -6;
  4480. for (auto c : in) {
  4481. val = (val << 8) + static_cast<uint8_t>(c);
  4482. valb += 8;
  4483. while (valb >= 0) {
  4484. out.push_back(lookup[(val >> valb) & 0x3F]);
  4485. valb -= 6;
  4486. }
  4487. }
  4488. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4489. while (out.size() % 4) {
  4490. out.push_back('=');
  4491. }
  4492. return out;
  4493. }
  4494. inline std::string sha1(const std::string &input) {
  4495. // RFC 3174 SHA-1 implementation
  4496. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4497. return (x << n) | (x >> (32 - n));
  4498. };
  4499. uint32_t h0 = 0x67452301;
  4500. uint32_t h1 = 0xEFCDAB89;
  4501. uint32_t h2 = 0x98BADCFE;
  4502. uint32_t h3 = 0x10325476;
  4503. uint32_t h4 = 0xC3D2E1F0;
  4504. // Pre-processing: adding padding bits
  4505. std::string msg = input;
  4506. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4507. msg.push_back(static_cast<char>(0x80u));
  4508. while (msg.size() % 64 != 56) {
  4509. msg.push_back(0);
  4510. }
  4511. // Append original length in bits as 64-bit big-endian
  4512. for (int i = 56; i >= 0; i -= 8) {
  4513. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4514. }
  4515. // Process each 512-bit chunk
  4516. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4517. uint32_t w[80];
  4518. for (size_t i = 0; i < 16; i++) {
  4519. w[i] =
  4520. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4521. << 24) |
  4522. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4523. << 16) |
  4524. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4525. << 8) |
  4526. (static_cast<uint32_t>(
  4527. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4528. }
  4529. for (int i = 16; i < 80; i++) {
  4530. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4531. }
  4532. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4533. for (int i = 0; i < 80; i++) {
  4534. uint32_t f, k;
  4535. if (i < 20) {
  4536. f = (b & c) | ((~b) & d);
  4537. k = 0x5A827999;
  4538. } else if (i < 40) {
  4539. f = b ^ c ^ d;
  4540. k = 0x6ED9EBA1;
  4541. } else if (i < 60) {
  4542. f = (b & c) | (b & d) | (c & d);
  4543. k = 0x8F1BBCDC;
  4544. } else {
  4545. f = b ^ c ^ d;
  4546. k = 0xCA62C1D6;
  4547. }
  4548. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4549. e = d;
  4550. d = c;
  4551. c = left_rotate(b, 30);
  4552. b = a;
  4553. a = temp;
  4554. }
  4555. h0 += a;
  4556. h1 += b;
  4557. h2 += c;
  4558. h3 += d;
  4559. h4 += e;
  4560. }
  4561. // Produce the final hash as a 20-byte binary string
  4562. std::string hash(20, '\0');
  4563. for (size_t i = 0; i < 4; i++) {
  4564. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4565. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4566. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4567. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4568. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4569. }
  4570. return hash;
  4571. }
  4572. inline std::string websocket_accept_key(const std::string &client_key) {
  4573. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4574. return base64_encode(sha1(client_key + magic));
  4575. }
  4576. inline bool is_websocket_upgrade(const Request &req) {
  4577. if (req.method != "GET") { return false; }
  4578. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4579. // list of protocols and asks recipients to match each name
  4580. // case-insensitively, so look for the token rather than compare the whole
  4581. // field value.
  4582. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4583. // Check Connection: Upgrade
  4584. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4585. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4586. // RFC 6455 Section 4.2.1
  4587. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4588. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4589. return false;
  4590. }
  4591. static const std::string b64chars =
  4592. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4593. for (size_t i = 0; i < 22; i++) {
  4594. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4595. }
  4596. // Check Sec-WebSocket-Version: 13
  4597. auto version = req.get_header_value("Sec-WebSocket-Version");
  4598. if (version != "13") { return false; }
  4599. return true;
  4600. }
  4601. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4602. const char *data, size_t len, bool fin,
  4603. bool mask) {
  4604. // First byte: FIN + opcode
  4605. uint8_t header[2];
  4606. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4607. (static_cast<uint8_t>(opcode) & 0x0F));
  4608. // Second byte: MASK + payload length
  4609. if (len < 126) {
  4610. header[1] = static_cast<uint8_t>(len);
  4611. if (mask) { header[1] |= 0x80; }
  4612. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4613. } else if (len <= 0xFFFF) {
  4614. header[1] = 126;
  4615. if (mask) { header[1] |= 0x80; }
  4616. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4617. uint8_t ext[2];
  4618. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4619. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4620. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4621. } else {
  4622. header[1] = 127;
  4623. if (mask) { header[1] |= 0x80; }
  4624. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4625. uint8_t ext[8];
  4626. for (int i = 7; i >= 0; i--) {
  4627. ext[7 - i] =
  4628. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4629. }
  4630. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4631. }
  4632. if (mask) {
  4633. // Generate random mask key
  4634. thread_local std::mt19937 rng(std::random_device{}());
  4635. uint8_t mask_key[4];
  4636. auto r = rng();
  4637. std::memcpy(mask_key, &r, 4);
  4638. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4639. // Write masked payload in chunks
  4640. const size_t chunk_size = 4096;
  4641. std::vector<char> buf((std::min)(len, chunk_size));
  4642. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4643. size_t n = (std::min)(chunk_size, len - offset);
  4644. for (size_t i = 0; i < n; i++) {
  4645. buf[i] =
  4646. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4647. }
  4648. if (strm.write(buf.data(), n) < 0) { return false; }
  4649. }
  4650. } else {
  4651. if (len > 0) {
  4652. if (strm.write(data, len) < 0) { return false; }
  4653. }
  4654. }
  4655. return true;
  4656. }
  4657. } // namespace detail
  4658. namespace ws {
  4659. namespace impl {
  4660. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4661. // hands back whatever its buffer already holds -- so every multi-byte field has
  4662. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4663. // header straddles the read buffer's boundary.
  4664. //
  4665. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4666. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4667. // there is a failure like any other. (When read() fails it always records why,
  4668. // so the error belongs to this call and not to an earlier one.)
  4669. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4670. auto p = static_cast<char *>(buf);
  4671. size_t total = 0;
  4672. while (total < size) {
  4673. auto n = strm.read(p + total, size - total);
  4674. if (n <= 0) {
  4675. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4676. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4677. }
  4678. total += static_cast<size_t>(n);
  4679. }
  4680. return FrameRead::Ok;
  4681. }
  4682. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4683. std::string &payload, bool &fin,
  4684. bool expect_masked, size_t max_len) {
  4685. // Read first 2 bytes. This is the only read that may report a timeout: it
  4686. // sits on a frame boundary, where nothing has been consumed yet.
  4687. uint8_t header[2];
  4688. FrameRead first = read_exact(strm, header, 2);
  4689. if (first != FrameRead::Ok) { return first; }
  4690. fin = (header[0] & 0x80) != 0;
  4691. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4692. if (header[0] & 0x70) { return FrameRead::Fail; }
  4693. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4694. bool masked = (header[1] & 0x80) != 0;
  4695. uint64_t payload_len = header[1] & 0x7F;
  4696. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4697. // MUST have a payload length of 125 bytes or less
  4698. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4699. if (is_control) {
  4700. if (!fin) { return FrameRead::Fail; }
  4701. if (payload_len > 125) { return FrameRead::Fail; }
  4702. }
  4703. if (masked != expect_masked) { return FrameRead::Fail; }
  4704. // Extended payload length
  4705. if (payload_len == 126) {
  4706. uint8_t ext[2];
  4707. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4708. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4709. } else if (payload_len == 127) {
  4710. uint8_t ext[8];
  4711. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4712. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4713. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4714. payload_len = 0;
  4715. for (int i = 0; i < 8; i++) {
  4716. payload_len = (payload_len << 8) | ext[i];
  4717. }
  4718. }
  4719. if (payload_len > max_len) { return FrameRead::Fail; }
  4720. // Read mask key if present
  4721. uint8_t mask_key[4] = {0};
  4722. if (masked) {
  4723. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4724. return FrameRead::Fail;
  4725. }
  4726. }
  4727. // Read payload
  4728. payload.resize(static_cast<size_t>(payload_len));
  4729. if (payload_len > 0 &&
  4730. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4731. FrameRead::Ok) {
  4732. return FrameRead::Fail;
  4733. }
  4734. // Unmask if needed
  4735. if (masked) {
  4736. for (size_t i = 0; i < payload.size(); i++) {
  4737. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4738. }
  4739. }
  4740. return FrameRead::Ok;
  4741. }
  4742. } // namespace impl
  4743. } // namespace ws
  4744. namespace detail {
  4745. inline bool is_valid_path(const std::string &path) {
  4746. size_t level = 0;
  4747. size_t i = 0;
  4748. // Skip slash
  4749. while (i < path.size() && path[i] == '/') {
  4750. i++;
  4751. }
  4752. while (i < path.size()) {
  4753. // Read component
  4754. auto beg = i;
  4755. while (i < path.size() && path[i] != '/') {
  4756. if (path[i] == '\0') {
  4757. return false;
  4758. } else if (path[i] == '\\') {
  4759. return false;
  4760. }
  4761. i++;
  4762. }
  4763. auto len = i - beg;
  4764. assert(len > 0);
  4765. if (!path.compare(beg, len, ".")) {
  4766. ;
  4767. } else if (!path.compare(beg, len, "..")) {
  4768. if (level == 0) { return false; }
  4769. level--;
  4770. } else {
  4771. level++;
  4772. }
  4773. // Skip slash
  4774. while (i < path.size() && path[i] == '/') {
  4775. i++;
  4776. }
  4777. }
  4778. return true;
  4779. }
  4780. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4781. #if defined(_WIN32)
  4782. char buf[_MAX_PATH];
  4783. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4784. resolved = buf;
  4785. #elif defined(PATH_MAX)
  4786. char buf[PATH_MAX];
  4787. if (realpath(path, buf) == nullptr) { return false; }
  4788. resolved = buf;
  4789. #else
  4790. auto buf = realpath(path, nullptr);
  4791. auto guard = scope_exit([&]() { std::free(buf); });
  4792. if (buf == nullptr) { return false; }
  4793. resolved = buf;
  4794. #endif
  4795. return true;
  4796. }
  4797. inline bool is_path_within_base(const std::string &resolved_path,
  4798. const std::string &resolved_base) {
  4799. #if defined(_WIN32)
  4800. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4801. resolved_base.size()) == 0;
  4802. #else
  4803. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4804. resolved_base.size()) == 0;
  4805. #endif
  4806. }
  4807. inline FileStat::FileStat(const std::string &path) {
  4808. #if defined(_WIN32)
  4809. auto wpath = u8string_to_wstring(path.c_str());
  4810. ret_ = _wstat(wpath.c_str(), &st_);
  4811. #else
  4812. ret_ = stat(path.c_str(), &st_);
  4813. #endif
  4814. }
  4815. inline bool FileStat::is_file() const {
  4816. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4817. }
  4818. inline bool FileStat::is_dir() const {
  4819. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4820. }
  4821. inline time_t FileStat::mtime() const {
  4822. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4823. : static_cast<time_t>(-1);
  4824. }
  4825. inline size_t FileStat::size() const {
  4826. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4827. }
  4828. inline std::string encode_path(const std::string &s) {
  4829. std::string result;
  4830. result.reserve(s.size());
  4831. for (size_t i = 0; s[i]; i++) {
  4832. switch (s[i]) {
  4833. case ' ': result += "%20"; break;
  4834. case '+': result += "%2B"; break;
  4835. case '\'': result += "%27"; break;
  4836. case ',': result += "%2C"; break;
  4837. // case ':': result += "%3A"; break; // ok? probably...
  4838. case ';': result += "%3B"; break;
  4839. default:
  4840. auto c = static_cast<uint8_t>(s[i]);
  4841. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4842. // in a request-target as-is.
  4843. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4844. result += '%';
  4845. char hex[4];
  4846. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4847. assert(len == 2);
  4848. result.append(hex, static_cast<size_t>(len));
  4849. } else {
  4850. result += s[i];
  4851. }
  4852. break;
  4853. }
  4854. }
  4855. return result;
  4856. }
  4857. inline std::string file_extension(const std::string &path) {
  4858. std::smatch m;
  4859. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4860. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4861. return std::string();
  4862. }
  4863. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4864. template <typename T>
  4865. inline bool parse_header(const char *beg, const char *end, T fn);
  4866. template <typename T>
  4867. inline bool parse_header(const char *beg, const char *end, T fn) {
  4868. // Skip trailing spaces and tabs.
  4869. while (beg < end && is_space_or_tab(end[-1])) {
  4870. end--;
  4871. }
  4872. auto p = beg;
  4873. while (p < end && *p != ':') {
  4874. p++;
  4875. }
  4876. auto name = std::string(beg, p);
  4877. if (!detail::fields::is_field_name(name)) { return false; }
  4878. if (p == end) { return false; }
  4879. auto key_end = p;
  4880. if (*p++ != ':') { return false; }
  4881. while (p < end && is_space_or_tab(*p)) {
  4882. p++;
  4883. }
  4884. if (p <= end) {
  4885. auto key_len = key_end - beg;
  4886. if (!key_len) { return false; }
  4887. auto key = std::string(beg, key_end);
  4888. auto val = std::string(p, end);
  4889. if (!detail::fields::is_field_value(val)) { return false; }
  4890. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4891. // percent-decoded by the recipient. Applications that need to interpret a
  4892. // value as a URI component should call httplib::decode_uri_component()
  4893. // (or decode_path_component()) explicitly.
  4894. fn(key, val);
  4895. return true;
  4896. }
  4897. return false;
  4898. }
  4899. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4900. const Headers &src_headers) {
  4901. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4902. // transfer coding is complete when a chunk with a chunk-size of zero is
  4903. // received, possibly followed by a trailer section, and finally terminated by
  4904. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4905. //
  4906. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4907. // doesn't care for the existence of the final CRLF. In other words, it seems
  4908. // to be ok whether the final CRLF exists or not in the chunked data.
  4909. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4910. //
  4911. // According to the reference code in RFC 9112, cpp-httplib now allows
  4912. // chunked transfer coding data without the final CRLF.
  4913. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4914. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4915. "transfer-encoding",
  4916. "content-length",
  4917. "host",
  4918. "authorization",
  4919. "www-authenticate",
  4920. "proxy-authenticate",
  4921. "proxy-authorization",
  4922. "cookie",
  4923. "set-cookie",
  4924. "cache-control",
  4925. "expect",
  4926. "max-forwards",
  4927. "pragma",
  4928. "range",
  4929. "te",
  4930. "age",
  4931. "expires",
  4932. "date",
  4933. "location",
  4934. "retry-after",
  4935. "vary",
  4936. "warning",
  4937. "content-encoding",
  4938. "content-type",
  4939. "content-range",
  4940. "trailer"};
  4941. case_ignore::unordered_set<std::string> declared_trailers;
  4942. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4943. if (!trailer_header.empty()) {
  4944. // split() trims each token and skips empty ones, so the name arrives ready
  4945. // to look up.
  4946. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4947. ',', [&](const char *b, const char *e) {
  4948. // A legitimate message declares only a handful of trailers. Cap the
  4949. // set so a peer cannot grow it without bound: an oversized set only
  4950. // arises from an attempt to force many colliding names into
  4951. // quadratic lookups (case_ignore::hash is unkeyed).
  4952. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4953. return;
  4954. }
  4955. std::string key(b, e);
  4956. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4957. declared_trailers.insert(key);
  4958. }
  4959. });
  4960. }
  4961. size_t trailer_header_count = 0;
  4962. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4963. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4964. // Count every received trailer field, not only the declared ones stored in
  4965. // dest, so undeclared fields cannot keep this loop running past the limit.
  4966. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4967. constexpr auto line_terminator_len = 2;
  4968. auto line_beg = line_reader.ptr();
  4969. auto line_end =
  4970. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4971. if (!parse_header(line_beg, line_end,
  4972. [&](const std::string &key, const std::string &val) {
  4973. if (declared_trailers.find(key) !=
  4974. declared_trailers.end()) {
  4975. dest.emplace(key, val);
  4976. }
  4977. })) {
  4978. return false;
  4979. }
  4980. trailer_header_count++;
  4981. if (!line_reader.getline()) { return false; }
  4982. }
  4983. return true;
  4984. }
  4985. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4986. size_t right) {
  4987. while (b + left < e && is_space_or_tab(b[left])) {
  4988. left++;
  4989. }
  4990. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4991. right--;
  4992. }
  4993. return std::make_pair(left, right);
  4994. }
  4995. inline std::string trim_copy(const std::string &s) {
  4996. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4997. return s.substr(r.first, r.second - r.first);
  4998. }
  4999. inline std::string trim_double_quotes_copy(const std::string &s) {
  5000. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5001. return s.substr(1, s.size() - 2);
  5002. }
  5003. return s;
  5004. }
  5005. inline void
  5006. divide(const char *data, std::size_t size, char d,
  5007. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5008. fn) {
  5009. const auto it = std::find(data, data + size, d);
  5010. const auto found = static_cast<std::size_t>(it != data + size);
  5011. const auto lhs_data = data;
  5012. const auto lhs_size = static_cast<std::size_t>(it - data);
  5013. const auto rhs_data = it + found;
  5014. const auto rhs_size = size - lhs_size - found;
  5015. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5016. }
  5017. inline void
  5018. divide(const std::string &str, char d,
  5019. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5020. fn) {
  5021. divide(str.data(), str.size(), d, std::move(fn));
  5022. }
  5023. inline void split(const char *b, const char *e, char d,
  5024. std::function<void(const char *, const char *)> fn) {
  5025. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5026. }
  5027. inline void split(const char *b, const char *e, char d, size_t m,
  5028. std::function<void(const char *, const char *)> fn) {
  5029. size_t i = 0;
  5030. size_t beg = 0;
  5031. size_t count = 1;
  5032. while (e ? (b + i < e) : (b[i] != '\0')) {
  5033. if (b[i] == d && count < m) {
  5034. auto r = trim(b, e, beg, i);
  5035. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5036. beg = i + 1;
  5037. count++;
  5038. }
  5039. i++;
  5040. }
  5041. if (i) {
  5042. auto r = trim(b, e, beg, i);
  5043. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5044. }
  5045. }
  5046. // Same contract as split(), except that a delimiter inside a quoted-string is
  5047. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5048. // quoted-string, and ';' and '=' are legal characters inside one.
  5049. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5050. std::function<void(const char *, const char *)> fn) {
  5051. size_t i = 0;
  5052. size_t beg = 0;
  5053. size_t count = 1;
  5054. auto in_quotes = false;
  5055. while (e ? (b + i < e) : (b[i] != '\0')) {
  5056. if (b[i] == '"') {
  5057. in_quotes = !in_quotes;
  5058. } else if (b[i] == d && !in_quotes && count < m) {
  5059. auto r = trim(b, e, beg, i);
  5060. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5061. beg = i + 1;
  5062. count++;
  5063. }
  5064. i++;
  5065. }
  5066. if (i) {
  5067. auto r = trim(b, e, beg, i);
  5068. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5069. }
  5070. }
  5071. inline void split_unquoted(const char *b, const char *e, char d,
  5072. std::function<void(const char *, const char *)> fn) {
  5073. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5074. std::move(fn));
  5075. }
  5076. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5077. // key a token, so the first '=' is the separator even when the value is a
  5078. // quoted-string carrying more of them.
  5079. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5080. std::string &val) {
  5081. divide(
  5082. b, static_cast<std::size_t>(e - b), '=',
  5083. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5084. const auto kr = trim(kb, kb + klen, 0, klen);
  5085. key.assign(kb + kr.first, kb + kr.second);
  5086. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5087. val.assign(vb + vr.first, vb + vr.second);
  5088. });
  5089. }
  5090. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5091. std::function<bool(const char *, const char *)> fn) {
  5092. size_t i = 0;
  5093. size_t beg = 0;
  5094. size_t count = 1;
  5095. while (e ? (b + i < e) : (b[i] != '\0')) {
  5096. if (b[i] == d && count < m) {
  5097. auto r = trim(b, e, beg, i);
  5098. if (r.first < r.second) {
  5099. auto found = fn(&b[r.first], &b[r.second]);
  5100. if (found) { return true; }
  5101. }
  5102. beg = i + 1;
  5103. count++;
  5104. }
  5105. i++;
  5106. }
  5107. if (i) {
  5108. auto r = trim(b, e, beg, i);
  5109. if (r.first < r.second) {
  5110. auto found = fn(&b[r.first], &b[r.second]);
  5111. if (found) { return true; }
  5112. }
  5113. }
  5114. return false;
  5115. }
  5116. inline bool split_find(const char *b, const char *e, char d,
  5117. std::function<bool(const char *, const char *)> fn) {
  5118. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5119. std::move(fn));
  5120. }
  5121. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5122. size_t fixed_buffer_size)
  5123. : strm_(strm), fixed_buffer_(fixed_buffer),
  5124. fixed_buffer_size_(fixed_buffer_size) {}
  5125. inline const char *stream_line_reader::ptr() const {
  5126. if (growable_buffer_.empty()) {
  5127. return fixed_buffer_;
  5128. } else {
  5129. return growable_buffer_.data();
  5130. }
  5131. }
  5132. inline size_t stream_line_reader::size() const {
  5133. if (growable_buffer_.empty()) {
  5134. return fixed_buffer_used_size_;
  5135. } else {
  5136. return growable_buffer_.size();
  5137. }
  5138. }
  5139. inline bool stream_line_reader::end_with_crlf() const {
  5140. auto end = ptr() + size();
  5141. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5142. }
  5143. inline bool stream_line_reader::getline() {
  5144. fixed_buffer_used_size_ = 0;
  5145. growable_buffer_.clear();
  5146. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5147. char prev_byte = 0;
  5148. #endif
  5149. for (size_t i = 0;; i++) {
  5150. // Fast path: whatever the stream has already buffered can be scanned for
  5151. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5152. // call, a bounds check and a one-byte copy per character of the request.
  5153. size_t buffered_size = 0;
  5154. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5155. auto take = buffered_size;
  5156. auto terminated = false;
  5157. for (size_t at = 0; at < buffered_size;) {
  5158. auto nl = static_cast<const char *>(
  5159. memchr(buffered + at, '\n', buffered_size - at));
  5160. if (!nl) { break; }
  5161. auto pos = static_cast<size_t>(nl - buffered);
  5162. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5163. take = pos + 1;
  5164. terminated = true;
  5165. break;
  5166. #else
  5167. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5168. // be the last byte of an earlier chunk, hence prev_byte.
  5169. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5170. take = pos + 1;
  5171. terminated = true;
  5172. break;
  5173. }
  5174. at = pos + 1;
  5175. #endif
  5176. }
  5177. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5178. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5179. prev_byte = buffered[take - 1];
  5180. #endif
  5181. append(buffered, take);
  5182. strm_.consume_buffered(take);
  5183. i += take;
  5184. if (terminated) { return true; }
  5185. continue;
  5186. }
  5187. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5188. // Treat exceptionally long lines as an error to
  5189. // prevent infinite loops/memory exhaustion
  5190. return false;
  5191. }
  5192. char byte;
  5193. auto n = strm_.read(&byte, 1);
  5194. if (n < 0) {
  5195. return false;
  5196. } else if (n == 0) {
  5197. if (i == 0) {
  5198. return false;
  5199. } else {
  5200. break;
  5201. }
  5202. }
  5203. append(byte);
  5204. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5205. if (byte == '\n') { break; }
  5206. #else
  5207. if (prev_byte == '\r' && byte == '\n') { break; }
  5208. prev_byte = byte;
  5209. #endif
  5210. }
  5211. return true;
  5212. }
  5213. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5214. inline void stream_line_reader::append(const char *data, size_t size) {
  5215. // Once the line has outgrown the fixed buffer everything must keep going to
  5216. // the growable one, even if a later chunk would have fit. Without the
  5217. // emptiness check a short append after a long one would land in the fixed
  5218. // buffer, which ptr() and size() no longer look at, and be lost.
  5219. if (growable_buffer_.empty() &&
  5220. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5221. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5222. fixed_buffer_used_size_ += size;
  5223. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5224. } else {
  5225. // Unlike the per-character overload, this can be the very first append of
  5226. // the line, so the fixed buffer may hold nothing and carry no terminator
  5227. // yet. assign() takes an explicit length and does not need one.
  5228. if (growable_buffer_.empty()) {
  5229. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5230. }
  5231. growable_buffer_.append(data, size);
  5232. }
  5233. }
  5234. inline mmap::mmap(const char *path) { open(path); }
  5235. inline mmap::~mmap() { close(); }
  5236. inline bool mmap::open(const char *path) {
  5237. close();
  5238. #if defined(_WIN32)
  5239. auto wpath = u8string_to_wstring(path);
  5240. if (wpath.empty()) { return false; }
  5241. hFile_ =
  5242. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5243. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5244. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5245. LARGE_INTEGER size{};
  5246. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5247. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5248. // See:
  5249. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5250. if (static_cast<ULONGLONG>(size.QuadPart) >
  5251. (std::numeric_limits<decltype(size_)>::max)()) {
  5252. // `size_t` might be 32-bits, on 32-bits Windows.
  5253. return false;
  5254. }
  5255. size_ = static_cast<size_t>(size.QuadPart);
  5256. hMapping_ =
  5257. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5258. // Special treatment for an empty file...
  5259. if (hMapping_ == NULL && size_ == 0) {
  5260. close();
  5261. is_open_empty_file = true;
  5262. return true;
  5263. }
  5264. if (hMapping_ == NULL) {
  5265. close();
  5266. return false;
  5267. }
  5268. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5269. if (addr_ == nullptr) {
  5270. close();
  5271. return false;
  5272. }
  5273. #else
  5274. fd_ = ::open(path, O_RDONLY);
  5275. if (fd_ == -1) { return false; }
  5276. struct stat sb;
  5277. if (fstat(fd_, &sb) == -1) {
  5278. close();
  5279. return false;
  5280. }
  5281. size_ = static_cast<size_t>(sb.st_size);
  5282. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5283. // Special treatment for an empty file...
  5284. if (addr_ == MAP_FAILED && size_ == 0) {
  5285. close();
  5286. is_open_empty_file = true;
  5287. return false;
  5288. }
  5289. if (addr_ == MAP_FAILED) {
  5290. // Clear the sentinel before `close()`, since `is_open()` only checks
  5291. // `addr_` against nullptr and `munmap()` must not be called with it.
  5292. addr_ = nullptr;
  5293. close();
  5294. return false;
  5295. }
  5296. #endif
  5297. return true;
  5298. }
  5299. inline bool mmap::is_open() const {
  5300. return is_open_empty_file ? true : addr_ != nullptr;
  5301. }
  5302. inline size_t mmap::size() const { return size_; }
  5303. inline const char *mmap::data() const {
  5304. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5305. }
  5306. inline void mmap::close() {
  5307. #if defined(_WIN32)
  5308. if (addr_) {
  5309. ::UnmapViewOfFile(addr_);
  5310. addr_ = nullptr;
  5311. }
  5312. if (hMapping_) {
  5313. ::CloseHandle(hMapping_);
  5314. hMapping_ = NULL;
  5315. }
  5316. if (hFile_ != INVALID_HANDLE_VALUE) {
  5317. ::CloseHandle(hFile_);
  5318. hFile_ = INVALID_HANDLE_VALUE;
  5319. }
  5320. is_open_empty_file = false;
  5321. #else
  5322. if (addr_ != nullptr) {
  5323. munmap(addr_, size_);
  5324. addr_ = nullptr;
  5325. }
  5326. if (fd_ != -1) {
  5327. ::close(fd_);
  5328. fd_ = -1;
  5329. }
  5330. #endif
  5331. size_ = 0;
  5332. }
  5333. inline int close_socket(socket_t sock) noexcept {
  5334. #ifdef _WIN32
  5335. return closesocket(sock);
  5336. #else
  5337. return close(sock);
  5338. #endif
  5339. }
  5340. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5341. ssize_t res = 0;
  5342. while (true) {
  5343. res = fn();
  5344. if (res < 0 && errno == EINTR) {
  5345. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5346. continue;
  5347. }
  5348. break;
  5349. }
  5350. return res;
  5351. }
  5352. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5353. return handle_EINTR([&]() {
  5354. return recv(sock,
  5355. #ifdef _WIN32
  5356. static_cast<char *>(ptr), static_cast<int>(size),
  5357. #else
  5358. ptr, size,
  5359. #endif
  5360. flags);
  5361. });
  5362. }
  5363. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5364. int flags) {
  5365. return handle_EINTR([&]() {
  5366. return send(sock,
  5367. #ifdef _WIN32
  5368. static_cast<const char *>(ptr), static_cast<int>(size),
  5369. #else
  5370. ptr, size,
  5371. #endif
  5372. flags);
  5373. });
  5374. }
  5375. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5376. #ifdef _WIN32
  5377. return ::WSAPoll(fds, nfds, timeout);
  5378. #else
  5379. return ::poll(fds, nfds, timeout);
  5380. #endif
  5381. }
  5382. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5383. time_t usec) {
  5384. struct pollfd pfd;
  5385. pfd.fd = sock;
  5386. pfd.events = events;
  5387. pfd.revents = 0;
  5388. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5389. // "return immediately", which callers here rely on to probe a socket.
  5390. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5391. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5392. }
  5393. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5394. return select_impl(sock, POLLIN, sec, usec);
  5395. }
  5396. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5397. return select_impl(sock, POLLOUT, sec, usec);
  5398. }
  5399. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5400. time_t usec) {
  5401. struct pollfd pfd_read;
  5402. pfd_read.fd = sock;
  5403. pfd_read.events = POLLIN | POLLOUT;
  5404. pfd_read.revents = 0;
  5405. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5406. auto poll_res =
  5407. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5408. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5409. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5410. auto error = 0;
  5411. socklen_t len = sizeof(error);
  5412. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5413. reinterpret_cast<char *>(&error), &len);
  5414. auto successful = res >= 0 && !error;
  5415. return successful ? Error::Success : Error::Connection;
  5416. }
  5417. return Error::Connection;
  5418. }
  5419. inline bool is_socket_alive(socket_t sock) {
  5420. const auto val = detail::select_read(sock, 0, 0);
  5421. if (val == 0) {
  5422. return true;
  5423. } else if (val < 0 && errno == EBADF) {
  5424. return false;
  5425. }
  5426. char buf[1];
  5427. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5428. }
  5429. class SocketStream final : public Stream {
  5430. public:
  5431. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5432. time_t write_timeout_sec, time_t write_timeout_usec,
  5433. time_t max_timeout_msec = 0,
  5434. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5435. (std::chrono::steady_clock::time_point::min)());
  5436. ~SocketStream() override;
  5437. bool is_readable() const override;
  5438. bool wait_readable() const override;
  5439. bool wait_writable() const override;
  5440. bool is_peer_alive() const override;
  5441. ssize_t read(char *ptr, size_t size) override;
  5442. ssize_t write(const char *ptr, size_t size) override;
  5443. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5444. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5445. socket_t socket() const override;
  5446. time_t duration() const override;
  5447. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5448. const char *buffered_data(size_t &size) const override;
  5449. void consume_buffered(size_t size) override;
  5450. // The caller has just seen this socket become readable. Lets the next read
  5451. // skip its own readiness wait, which would otherwise ask the kernel a
  5452. // question that was answered a moment ago. Consumed by that read.
  5453. void set_readable_hint() { readable_hint_ = true; }
  5454. private:
  5455. bool ensure_readable();
  5456. socket_t sock_;
  5457. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5458. // thread while a read is in flight -- that is the point of it, for a caller
  5459. // holding one connection and wanting control back to send on it.
  5460. std::atomic<time_t> read_timeout_sec_;
  5461. std::atomic<time_t> read_timeout_usec_;
  5462. time_t write_timeout_sec_;
  5463. time_t write_timeout_usec_;
  5464. time_t max_timeout_msec_;
  5465. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5466. std::vector<char> read_buff_;
  5467. size_t read_buff_off_ = 0;
  5468. size_t read_buff_content_size_ = 0;
  5469. bool readable_hint_ = false;
  5470. static const size_t read_buff_size_ = 1024l * 4;
  5471. };
  5472. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5473. time_t keep_alive_timeout_sec) {
  5474. using namespace std::chrono;
  5475. const auto interval_usec =
  5476. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5477. // Avoid expensive `steady_clock::now()` call for the first time
  5478. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5479. const auto start = steady_clock::now() - microseconds{interval_usec};
  5480. const auto timeout = seconds{keep_alive_timeout_sec};
  5481. while (true) {
  5482. if (svr_sock == INVALID_SOCKET) {
  5483. break; // Server socket is closed
  5484. }
  5485. auto val = select_read(sock, 0, interval_usec);
  5486. if (val < 0) {
  5487. break; // Ssocket error
  5488. } else if (val == 0) {
  5489. if (steady_clock::now() - start > timeout) {
  5490. break; // Timeout
  5491. }
  5492. } else {
  5493. return true; // Ready for read
  5494. }
  5495. }
  5496. return false;
  5497. }
  5498. template <typename T>
  5499. inline bool
  5500. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5501. size_t keep_alive_max_count,
  5502. time_t keep_alive_timeout_sec, T callback) {
  5503. assert(keep_alive_max_count > 0);
  5504. auto ret = false;
  5505. auto count = keep_alive_max_count;
  5506. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5507. auto close_connection = count == 1;
  5508. auto connection_closed = false;
  5509. ret = callback(close_connection, connection_closed);
  5510. if (!ret || connection_closed) { break; }
  5511. count--;
  5512. }
  5513. return ret;
  5514. }
  5515. template <typename T>
  5516. inline bool
  5517. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5518. size_t keep_alive_max_count,
  5519. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5520. time_t read_timeout_usec, time_t write_timeout_sec,
  5521. time_t write_timeout_usec, T callback) {
  5522. return process_server_socket_core(
  5523. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5524. [&](bool close_connection, bool &connection_closed) {
  5525. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5526. write_timeout_sec, write_timeout_usec);
  5527. // process_server_socket_core() only gets here once keep_alive() has
  5528. // seen the socket go readable.
  5529. strm.set_readable_hint();
  5530. return callback(strm, close_connection, connection_closed);
  5531. });
  5532. }
  5533. inline bool process_client_socket(
  5534. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5535. time_t write_timeout_sec, time_t write_timeout_usec,
  5536. time_t max_timeout_msec,
  5537. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5538. std::function<bool(Stream &)> callback) {
  5539. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5540. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5541. start_time);
  5542. return callback(strm);
  5543. }
  5544. inline int shutdown_socket(socket_t sock) noexcept {
  5545. #ifdef _WIN32
  5546. return shutdown(sock, SD_BOTH);
  5547. #else
  5548. return shutdown(sock, SHUT_RDWR);
  5549. #endif
  5550. }
  5551. // Half-closes the write side and drains any in-flight/queued bytes before
  5552. // the final shutdown+close. Closing with unread data in the receive queue
  5553. // (or bytes arriving after the receive side is closed) makes the stack send
  5554. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5555. // response as a failed read even though it was fully written.
  5556. inline void drain_and_close_socket(socket_t sock) noexcept {
  5557. #ifdef _WIN32
  5558. shutdown(sock, SD_SEND);
  5559. #else
  5560. shutdown(sock, SHUT_WR);
  5561. #endif
  5562. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5563. size_t total = 0;
  5564. const auto deadline = std::chrono::steady_clock::now() +
  5565. std::chrono::milliseconds(100); // bound #1
  5566. while (total < size_t(1024u * 1024u)) { // bound #2
  5567. const auto remaining =
  5568. std::chrono::duration_cast<std::chrono::microseconds>(
  5569. deadline - std::chrono::steady_clock::now())
  5570. .count();
  5571. if (remaining <= 0) { break; }
  5572. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5573. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5574. if (n <= 0) { break; }
  5575. total += static_cast<size_t>(n);
  5576. }
  5577. shutdown_socket(sock);
  5578. close_socket(sock);
  5579. }
  5580. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5581. if (s.size() > 1 && s[0] == '\0') {
  5582. auto ret = s;
  5583. ret[0] = '@';
  5584. return ret;
  5585. }
  5586. return s;
  5587. }
  5588. inline std::string
  5589. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5590. if (s.size() > 1 && s[0] == '@') {
  5591. auto ret = s;
  5592. ret[0] = '\0';
  5593. return ret;
  5594. }
  5595. return s;
  5596. }
  5597. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5598. const struct addrinfo *hints,
  5599. struct addrinfo **res, time_t timeout_sec) {
  5600. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5601. if (timeout_sec <= 0) {
  5602. // No timeout specified, use standard getaddrinfo
  5603. return getaddrinfo(node, service, hints, res);
  5604. }
  5605. #ifdef _WIN32
  5606. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5607. OVERLAPPED overlapped = {};
  5608. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5609. if (!event) { return EAI_FAIL; }
  5610. overlapped.hEvent = event;
  5611. PADDRINFOEXW result_addrinfo = nullptr;
  5612. HANDLE cancel_handle = nullptr;
  5613. ADDRINFOEXW hints_ex = {};
  5614. if (hints) {
  5615. hints_ex.ai_flags = hints->ai_flags;
  5616. hints_ex.ai_family = hints->ai_family;
  5617. hints_ex.ai_socktype = hints->ai_socktype;
  5618. hints_ex.ai_protocol = hints->ai_protocol;
  5619. }
  5620. auto wnode = u8string_to_wstring(node);
  5621. auto wservice = u8string_to_wstring(service);
  5622. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5623. hints ? &hints_ex : nullptr, &result_addrinfo,
  5624. nullptr, &overlapped, nullptr, &cancel_handle);
  5625. if (ret == WSA_IO_PENDING) {
  5626. auto wait_result =
  5627. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5628. if (wait_result == WAIT_TIMEOUT) {
  5629. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5630. ::CloseHandle(event);
  5631. return EAI_AGAIN;
  5632. }
  5633. DWORD bytes_returned;
  5634. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5635. &bytes_returned, FALSE)) {
  5636. ::CloseHandle(event);
  5637. return ::WSAGetLastError();
  5638. }
  5639. }
  5640. ::CloseHandle(event);
  5641. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5642. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5643. return 0;
  5644. }
  5645. return ret;
  5646. #elif TARGET_OS_MAC && defined(__clang__)
  5647. if (!node) { return EAI_NONAME; }
  5648. // macOS implementation using CFHost API for asynchronous DNS resolution
  5649. CFStringRef hostname_ref = CFStringCreateWithCString(
  5650. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5651. if (!hostname_ref) { return EAI_MEMORY; }
  5652. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5653. CFRelease(hostname_ref);
  5654. if (!host_ref) { return EAI_MEMORY; }
  5655. // Set up context for callback
  5656. struct CFHostContext {
  5657. bool completed = false;
  5658. bool success = false;
  5659. CFArrayRef addresses = nullptr;
  5660. std::mutex mutex;
  5661. std::condition_variable cv;
  5662. } context;
  5663. CFHostClientContext client_context;
  5664. memset(&client_context, 0, sizeof(client_context));
  5665. client_context.info = &context;
  5666. // Set callback
  5667. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5668. const CFStreamError *error, void *info) {
  5669. auto ctx = static_cast<CFHostContext *>(info);
  5670. std::lock_guard<std::mutex> lock(ctx->mutex);
  5671. if (error && error->error != 0) {
  5672. ctx->success = false;
  5673. } else {
  5674. Boolean hasBeenResolved;
  5675. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5676. if (ctx->addresses && hasBeenResolved) {
  5677. CFRetain(ctx->addresses);
  5678. ctx->success = true;
  5679. } else {
  5680. ctx->success = false;
  5681. }
  5682. }
  5683. ctx->completed = true;
  5684. ctx->cv.notify_one();
  5685. };
  5686. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5687. CFRelease(host_ref);
  5688. return EAI_SYSTEM;
  5689. }
  5690. // Schedule on run loop
  5691. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5692. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5693. // Start resolution
  5694. CFStreamError stream_error;
  5695. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5696. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5697. CFRelease(host_ref);
  5698. return EAI_FAIL;
  5699. }
  5700. // Wait for completion with timeout
  5701. auto timeout_time =
  5702. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5703. bool timed_out = false;
  5704. {
  5705. std::unique_lock<std::mutex> lock(context.mutex);
  5706. while (!context.completed) {
  5707. auto now = std::chrono::steady_clock::now();
  5708. if (now >= timeout_time) {
  5709. timed_out = true;
  5710. break;
  5711. }
  5712. // Run the runloop for a short time
  5713. lock.unlock();
  5714. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5715. lock.lock();
  5716. }
  5717. }
  5718. // Clean up
  5719. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5720. CFHostSetClient(host_ref, nullptr, nullptr);
  5721. if (timed_out || !context.completed) {
  5722. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5723. CFRelease(host_ref);
  5724. return EAI_AGAIN;
  5725. }
  5726. if (!context.success || !context.addresses) {
  5727. CFRelease(host_ref);
  5728. return EAI_NODATA;
  5729. }
  5730. // Convert CFArray to addrinfo
  5731. CFIndex count = CFArrayGetCount(context.addresses);
  5732. if (count == 0) {
  5733. CFRelease(context.addresses);
  5734. CFRelease(host_ref);
  5735. return EAI_NODATA;
  5736. }
  5737. struct addrinfo *result_addrinfo = nullptr;
  5738. struct addrinfo **current = &result_addrinfo;
  5739. for (CFIndex i = 0; i < count; i++) {
  5740. CFDataRef addr_data =
  5741. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5742. if (!addr_data) continue;
  5743. const struct sockaddr *sockaddr_ptr =
  5744. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5745. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5746. // Allocate addrinfo structure
  5747. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5748. if (!*current) {
  5749. freeaddrinfo(result_addrinfo);
  5750. CFRelease(context.addresses);
  5751. CFRelease(host_ref);
  5752. return EAI_MEMORY;
  5753. }
  5754. memset(*current, 0, sizeof(struct addrinfo));
  5755. // Set up addrinfo fields
  5756. (*current)->ai_family = sockaddr_ptr->sa_family;
  5757. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5758. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5759. (*current)->ai_addrlen = sockaddr_len;
  5760. // Copy sockaddr
  5761. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5762. if (!(*current)->ai_addr) {
  5763. freeaddrinfo(result_addrinfo);
  5764. CFRelease(context.addresses);
  5765. CFRelease(host_ref);
  5766. return EAI_MEMORY;
  5767. }
  5768. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5769. // Set port if service is specified
  5770. if (service && *service) {
  5771. int port = 0;
  5772. if (parse_port(service, strlen(service), port)) {
  5773. if (sockaddr_ptr->sa_family == AF_INET) {
  5774. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5775. ->sin_port = htons(static_cast<uint16_t>(port));
  5776. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5777. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5778. ->sin6_port = htons(static_cast<uint16_t>(port));
  5779. }
  5780. }
  5781. }
  5782. current = &((*current)->ai_next);
  5783. }
  5784. CFRelease(context.addresses);
  5785. CFRelease(host_ref);
  5786. *res = result_addrinfo;
  5787. return 0;
  5788. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5789. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5790. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5791. // the resolver worker still references the stack-local gaicb. The cancel
  5792. // path therefore waits (gai_suspend with no timeout) for the worker to
  5793. // actually finish before letting the stack frame go. The trade-off is that
  5794. // a wedged DNS server can hold this thread for the system resolver timeout
  5795. // (~30s by default) past the caller's connection timeout.
  5796. struct gaicb request{};
  5797. struct gaicb *requests[1] = {&request};
  5798. struct sigevent sevp{};
  5799. struct timespec timeout{timeout_sec, 0};
  5800. request.ar_name = node;
  5801. request.ar_service = service;
  5802. request.ar_request = hints;
  5803. sevp.sigev_notify = SIGEV_NONE;
  5804. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5805. if (rc != 0) { return rc; }
  5806. auto cleanup = scope_exit([&] {
  5807. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5808. });
  5809. int wait_result = gai_suspend(requests, 1, &timeout);
  5810. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5811. int gai_result = gai_error(&request);
  5812. if (gai_result == 0) {
  5813. *res = request.ar_result;
  5814. request.ar_result = nullptr;
  5815. return 0;
  5816. }
  5817. return gai_result;
  5818. }
  5819. gai_cancel(&request);
  5820. while (gai_error(&request) == EAI_INPROGRESS) {
  5821. gai_suspend(requests, 1, nullptr);
  5822. }
  5823. return wait_result;
  5824. #else
  5825. // Fallback implementation using thread-based timeout for other Unix systems.
  5826. struct GetAddrInfoState {
  5827. ~GetAddrInfoState() {
  5828. if (info) { freeaddrinfo(info); }
  5829. }
  5830. std::mutex mutex;
  5831. std::condition_variable result_cv;
  5832. bool completed = false;
  5833. int result = EAI_SYSTEM;
  5834. std::string node;
  5835. std::string service;
  5836. struct addrinfo hints;
  5837. struct addrinfo *info = nullptr;
  5838. };
  5839. // Allocate on the heap, so the resolver thread can keep using the data.
  5840. auto state = std::make_shared<GetAddrInfoState>();
  5841. if (node) { state->node = node; }
  5842. state->service = service;
  5843. state->hints = *hints;
  5844. std::thread resolve_thread([state]() {
  5845. auto thread_result =
  5846. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5847. &state->info);
  5848. std::lock_guard<std::mutex> lock(state->mutex);
  5849. state->result = thread_result;
  5850. state->completed = true;
  5851. state->result_cv.notify_one();
  5852. });
  5853. // Wait for completion or timeout
  5854. std::unique_lock<std::mutex> lock(state->mutex);
  5855. auto finished =
  5856. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5857. [&] { return state->completed; });
  5858. if (finished) {
  5859. // Operation completed within timeout
  5860. resolve_thread.join();
  5861. *res = state->info;
  5862. state->info = nullptr; // Pass ownership to caller
  5863. return state->result;
  5864. } else {
  5865. // Timeout occurred
  5866. resolve_thread.detach(); // Let the thread finish in background
  5867. return EAI_AGAIN; // Return timeout error
  5868. }
  5869. #endif
  5870. #else
  5871. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5872. return getaddrinfo(node, service, hints, res);
  5873. #endif
  5874. }
  5875. template <typename BindOrConnect>
  5876. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5877. int address_family, int socket_flags, bool tcp_nodelay,
  5878. bool ipv6_v6only, SocketOptions socket_options,
  5879. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5880. // Get address info
  5881. const char *node = nullptr;
  5882. struct addrinfo hints;
  5883. struct addrinfo *result;
  5884. memset(&hints, 0, sizeof(struct addrinfo));
  5885. hints.ai_socktype = SOCK_STREAM;
  5886. hints.ai_protocol = IPPROTO_IP;
  5887. if (!ip.empty()) {
  5888. node = ip.c_str();
  5889. // Ask getaddrinfo to convert IP in c-string to address
  5890. hints.ai_family = AF_UNSPEC;
  5891. hints.ai_flags = AI_NUMERICHOST;
  5892. } else {
  5893. if (!host.empty()) { node = host.c_str(); }
  5894. hints.ai_family = address_family;
  5895. hints.ai_flags = socket_flags;
  5896. }
  5897. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5898. if (hints.ai_family == AF_UNIX) {
  5899. const auto addrlen = host.length();
  5900. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5901. #ifdef SOCK_CLOEXEC
  5902. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5903. hints.ai_protocol);
  5904. #else
  5905. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5906. #endif
  5907. if (sock != INVALID_SOCKET) {
  5908. sockaddr_un addr{};
  5909. addr.sun_family = AF_UNIX;
  5910. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5911. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5912. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5913. hints.ai_addrlen = static_cast<socklen_t>(
  5914. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5915. #ifndef SOCK_CLOEXEC
  5916. #ifndef _WIN32
  5917. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5918. #endif
  5919. #endif
  5920. if (socket_options) { socket_options(sock); }
  5921. #ifdef _WIN32
  5922. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5923. // remove the option.
  5924. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5925. #endif
  5926. bool dummy;
  5927. if (!bind_or_connect(sock, hints, dummy)) {
  5928. close_socket(sock);
  5929. sock = INVALID_SOCKET;
  5930. }
  5931. }
  5932. return sock;
  5933. }
  5934. #endif
  5935. auto service = std::to_string(port);
  5936. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5937. timeout_sec)) {
  5938. #if defined __linux__ && !defined __ANDROID__
  5939. res_init();
  5940. #endif
  5941. return INVALID_SOCKET;
  5942. }
  5943. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5944. for (auto rp = result; rp; rp = rp->ai_next) {
  5945. // Create a socket
  5946. #ifdef _WIN32
  5947. auto sock =
  5948. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5949. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5950. /**
  5951. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5952. * and above the socket creation fails on older Windows Systems.
  5953. *
  5954. * Let's try to create a socket the old way in this case.
  5955. *
  5956. * Reference:
  5957. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5958. *
  5959. * WSA_FLAG_NO_HANDLE_INHERIT:
  5960. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5961. * SP1, and later
  5962. *
  5963. */
  5964. if (sock == INVALID_SOCKET) {
  5965. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5966. }
  5967. #else
  5968. #ifdef SOCK_CLOEXEC
  5969. auto sock =
  5970. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5971. #else
  5972. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5973. #endif
  5974. #endif
  5975. if (sock == INVALID_SOCKET) { continue; }
  5976. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5977. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5978. close_socket(sock);
  5979. continue;
  5980. }
  5981. #endif
  5982. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5983. if (rp->ai_family == AF_INET6) {
  5984. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5985. }
  5986. if (socket_options) { socket_options(sock); }
  5987. // bind or connect
  5988. auto quit = false;
  5989. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5990. close_socket(sock);
  5991. if (quit) { break; }
  5992. }
  5993. return INVALID_SOCKET;
  5994. }
  5995. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5996. #ifdef _WIN32
  5997. auto flags = nonblocking ? 1UL : 0UL;
  5998. ioctlsocket(sock, FIONBIO, &flags);
  5999. #else
  6000. auto flags = fcntl(sock, F_GETFL, 0);
  6001. fcntl(sock, F_SETFL,
  6002. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6003. #endif
  6004. }
  6005. inline bool is_connection_error() {
  6006. #ifdef _WIN32
  6007. return WSAGetLastError() != WSAEWOULDBLOCK;
  6008. #else
  6009. return errno != EINPROGRESS;
  6010. #endif
  6011. }
  6012. // accept() failed because the process or the network stack is temporarily out
  6013. // of resources. The listening socket is still usable, so back off briefly and
  6014. // try again.
  6015. inline bool is_accept_resource_error() {
  6016. #ifdef _WIN32
  6017. auto err = WSAGetLastError();
  6018. return err == WSAEMFILE || err == WSAENOBUFS;
  6019. #else
  6020. auto err = errno;
  6021. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6022. #endif
  6023. }
  6024. // accept() failed for a reason that says nothing about the listening socket:
  6025. // the pending connection went away before it could be accepted, or the call
  6026. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6027. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6028. // connection that way.
  6029. inline bool is_accept_transient_error() {
  6030. #ifdef _WIN32
  6031. auto err = WSAGetLastError();
  6032. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6033. err == WSAECONNABORTED;
  6034. #else
  6035. auto err = errno;
  6036. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6037. err == ECONNABORTED;
  6038. #endif
  6039. }
  6040. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6041. struct addrinfo hints;
  6042. struct addrinfo *result;
  6043. memset(&hints, 0, sizeof(struct addrinfo));
  6044. hints.ai_family = AF_UNSPEC;
  6045. hints.ai_socktype = SOCK_STREAM;
  6046. hints.ai_protocol = 0;
  6047. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6048. return false;
  6049. }
  6050. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6051. auto ret = false;
  6052. for (auto rp = result; rp; rp = rp->ai_next) {
  6053. const auto &ai = *rp;
  6054. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6055. ret = true;
  6056. break;
  6057. }
  6058. }
  6059. return ret;
  6060. }
  6061. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6062. #define USE_IF2IP
  6063. #endif
  6064. #ifdef USE_IF2IP
  6065. inline std::string if2ip(int address_family, const std::string &ifn) {
  6066. struct ifaddrs *ifap;
  6067. getifaddrs(&ifap);
  6068. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6069. std::string addr_candidate;
  6070. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6071. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6072. (AF_UNSPEC == address_family ||
  6073. ifa->ifa_addr->sa_family == address_family)) {
  6074. if (ifa->ifa_addr->sa_family == AF_INET) {
  6075. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6076. char buf[INET_ADDRSTRLEN];
  6077. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6078. return std::string(buf, INET_ADDRSTRLEN);
  6079. }
  6080. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6081. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6082. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6083. char buf[INET6_ADDRSTRLEN] = {};
  6084. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6085. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6086. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6087. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6088. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6089. } else {
  6090. return std::string(buf, INET6_ADDRSTRLEN);
  6091. }
  6092. }
  6093. }
  6094. }
  6095. }
  6096. }
  6097. return addr_candidate;
  6098. }
  6099. #endif
  6100. inline socket_t create_client_socket(
  6101. const std::string &host, const std::string &ip, int port,
  6102. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6103. SocketOptions socket_options, time_t connection_timeout_sec,
  6104. time_t connection_timeout_usec, time_t read_timeout_sec,
  6105. time_t read_timeout_usec, time_t write_timeout_sec,
  6106. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6107. auto sock = create_socket(
  6108. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6109. std::move(socket_options),
  6110. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6111. if (!intf.empty()) {
  6112. #ifdef USE_IF2IP
  6113. auto ip_from_if = if2ip(address_family, intf);
  6114. if (ip_from_if.empty()) { ip_from_if = intf; }
  6115. if (!bind_ip_address(sock2, ip_from_if)) {
  6116. error = Error::BindIPAddress;
  6117. return false;
  6118. }
  6119. #endif
  6120. }
  6121. set_nonblocking(sock2, true);
  6122. auto ret =
  6123. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6124. if (ret < 0) {
  6125. if (is_connection_error()) {
  6126. error = Error::Connection;
  6127. return false;
  6128. }
  6129. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6130. connection_timeout_usec);
  6131. if (error != Error::Success) {
  6132. if (error == Error::ConnectionTimeout) { quit = true; }
  6133. return false;
  6134. }
  6135. }
  6136. set_nonblocking(sock2, false);
  6137. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6138. read_timeout_usec);
  6139. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6140. write_timeout_usec);
  6141. error = Error::Success;
  6142. return true;
  6143. },
  6144. connection_timeout_sec); // Pass DNS timeout
  6145. if (sock != INVALID_SOCKET) {
  6146. error = Error::Success;
  6147. } else {
  6148. if (error == Error::Success) { error = Error::Connection; }
  6149. }
  6150. return sock;
  6151. }
  6152. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6153. socklen_t addr_len, std::string &ip, int &port) {
  6154. if (addr.ss_family == AF_INET) {
  6155. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6156. } else if (addr.ss_family == AF_INET6) {
  6157. port =
  6158. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6159. } else {
  6160. return false;
  6161. }
  6162. std::array<char, NI_MAXHOST> ipstr{};
  6163. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6164. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6165. 0, NI_NUMERICHOST)) {
  6166. return false;
  6167. }
  6168. ip = ipstr.data();
  6169. return true;
  6170. }
  6171. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6172. struct sockaddr_storage addr;
  6173. socklen_t addr_len = sizeof(addr);
  6174. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6175. &addr_len)) {
  6176. get_ip_and_port(addr, addr_len, ip, port);
  6177. }
  6178. }
  6179. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6180. struct sockaddr_storage addr;
  6181. socklen_t addr_len = sizeof(addr);
  6182. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6183. &addr_len)) {
  6184. #ifndef _WIN32
  6185. if (addr.ss_family == AF_UNIX) {
  6186. #if defined(__linux__)
  6187. struct ucred ucred;
  6188. socklen_t len = sizeof(ucred);
  6189. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6190. port = ucred.pid;
  6191. }
  6192. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6193. pid_t pid;
  6194. socklen_t len = sizeof(pid);
  6195. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6196. port = pid;
  6197. }
  6198. #endif
  6199. return;
  6200. }
  6201. #endif
  6202. get_ip_and_port(addr, addr_len, ip, port);
  6203. }
  6204. }
  6205. // Recursive form retained so operator""_t below can compute hashes for
  6206. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6207. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6208. // instead, which is iterative and stack-safe.
  6209. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6210. unsigned int h) {
  6211. return (l == 0)
  6212. ? h
  6213. : str2tag_core(
  6214. s + 1, l - 1,
  6215. // Unsets the 6 high bits of h, therefore no overflow happens
  6216. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6217. h * 33) ^
  6218. static_cast<unsigned char>(*s));
  6219. }
  6220. inline unsigned int str2tag(const std::string &s) {
  6221. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6222. // for compile-time UDL evaluation of short string literals, but at runtime
  6223. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6224. // would blow the stack with one frame per character.
  6225. unsigned int h = 0;
  6226. for (auto c : s) {
  6227. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6228. static_cast<unsigned char>(c);
  6229. }
  6230. return h;
  6231. }
  6232. namespace udl {
  6233. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6234. return str2tag_core(s, l, 0);
  6235. }
  6236. } // namespace udl
  6237. inline std::string
  6238. find_content_type(const std::string &path,
  6239. const std::map<std::string, std::string> &user_data,
  6240. const std::string &default_content_type) {
  6241. auto ext = file_extension(path);
  6242. auto it = user_data.find(ext);
  6243. if (it != user_data.end()) { return it->second; }
  6244. using udl::operator""_t;
  6245. switch (str2tag(ext)) {
  6246. default: return default_content_type;
  6247. case "css"_t: return "text/css";
  6248. case "csv"_t: return "text/csv";
  6249. case "htm"_t:
  6250. case "html"_t: return "text/html";
  6251. case "js"_t:
  6252. case "mjs"_t: return "text/javascript";
  6253. case "txt"_t: return "text/plain";
  6254. case "vtt"_t: return "text/vtt";
  6255. case "apng"_t: return "image/apng";
  6256. case "avif"_t: return "image/avif";
  6257. case "bmp"_t: return "image/bmp";
  6258. case "gif"_t: return "image/gif";
  6259. case "png"_t: return "image/png";
  6260. case "svg"_t: return "image/svg+xml";
  6261. case "webp"_t: return "image/webp";
  6262. case "ico"_t: return "image/x-icon";
  6263. case "tif"_t: return "image/tiff";
  6264. case "tiff"_t: return "image/tiff";
  6265. case "jpg"_t:
  6266. case "jpeg"_t: return "image/jpeg";
  6267. case "mp4"_t: return "video/mp4";
  6268. case "mpeg"_t: return "video/mpeg";
  6269. case "webm"_t: return "video/webm";
  6270. case "mp3"_t: return "audio/mp3";
  6271. case "mpga"_t: return "audio/mpeg";
  6272. case "weba"_t: return "audio/webm";
  6273. case "wav"_t: return "audio/wave";
  6274. case "otf"_t: return "font/otf";
  6275. case "ttf"_t: return "font/ttf";
  6276. case "woff"_t: return "font/woff";
  6277. case "woff2"_t: return "font/woff2";
  6278. case "7z"_t: return "application/x-7z-compressed";
  6279. case "atom"_t: return "application/atom+xml";
  6280. case "pdf"_t: return "application/pdf";
  6281. case "json"_t: return "application/json";
  6282. case "rss"_t: return "application/rss+xml";
  6283. case "tar"_t: return "application/x-tar";
  6284. case "xht"_t:
  6285. case "xhtml"_t: return "application/xhtml+xml";
  6286. case "xslt"_t: return "application/xslt+xml";
  6287. case "xml"_t: return "application/xml";
  6288. case "gz"_t: return "application/gzip";
  6289. case "zip"_t: return "application/zip";
  6290. case "wasm"_t: return "application/wasm";
  6291. }
  6292. }
  6293. inline std::string
  6294. extract_media_type(const std::string &content_type,
  6295. std::map<std::string, std::string> *params = nullptr) {
  6296. // Extract type/subtype from Content-Type value (RFC 2045)
  6297. // e.g. "application/json; charset=utf-8" -> "application/json"
  6298. auto media_type = content_type;
  6299. auto semicolon_pos = media_type.find(';');
  6300. if (semicolon_pos != std::string::npos) {
  6301. auto param_str = media_type.substr(semicolon_pos + 1);
  6302. media_type = media_type.substr(0, semicolon_pos);
  6303. if (params) {
  6304. // Parse parameters: key=value pairs separated by ';'
  6305. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6306. [&](const char *b, const char *e) {
  6307. std::string key;
  6308. std::string val;
  6309. divide_param_pair(b, e, key, val);
  6310. if (!key.empty()) {
  6311. params->emplace(trim_copy(key),
  6312. trim_double_quotes_copy(val));
  6313. }
  6314. });
  6315. }
  6316. }
  6317. // Trim whitespace from media type
  6318. return trim_copy(media_type);
  6319. }
  6320. inline bool can_compress_content_type(const std::string &content_type) {
  6321. using udl::operator""_t;
  6322. auto mime_type = extract_media_type(content_type);
  6323. auto tag = str2tag(mime_type);
  6324. switch (tag) {
  6325. case "image/svg+xml"_t:
  6326. case "application/javascript"_t:
  6327. case "application/x-javascript"_t:
  6328. case "application/json"_t:
  6329. case "application/ld+json"_t:
  6330. case "application/xml"_t:
  6331. case "application/xhtml+xml"_t:
  6332. case "application/rss+xml"_t:
  6333. case "application/atom+xml"_t:
  6334. case "application/xslt+xml"_t:
  6335. case "application/protobuf"_t: return true;
  6336. case "text/event-stream"_t: return false;
  6337. default: return !mime_type.rfind("text/", 0);
  6338. }
  6339. }
  6340. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6341. double &quality) {
  6342. quality = 1.0;
  6343. token.clear();
  6344. // Split on first ';': left = token name, right = parameters
  6345. const char *params_b = nullptr;
  6346. std::size_t params_len = 0;
  6347. divide(
  6348. b, static_cast<std::size_t>(e - b), ';',
  6349. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6350. auto r = trim(lb, lb + llen, 0, llen);
  6351. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6352. params_b = rb;
  6353. params_len = rlen;
  6354. });
  6355. if (token.empty()) { return false; }
  6356. if (params_len == 0) { return true; }
  6357. // Scan parameters for q= (stops on first match)
  6358. bool invalid = false;
  6359. split_find(params_b, params_b + params_len, ';',
  6360. (std::numeric_limits<size_t>::max)(),
  6361. [&](const char *pb, const char *pe) -> bool {
  6362. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6363. auto len = static_cast<size_t>(pe - pb);
  6364. if (len < 2) { return false; }
  6365. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6366. return false;
  6367. }
  6368. // Trim the value portion
  6369. auto r = trim(pb, pe, 2, len);
  6370. if (r.first >= r.second) {
  6371. invalid = true;
  6372. return true;
  6373. }
  6374. double v = 0.0;
  6375. auto res = from_chars(pb + r.first, pb + r.second, v);
  6376. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6377. v < 0.0 || v > 1.0) {
  6378. invalid = true;
  6379. return true;
  6380. }
  6381. quality = v;
  6382. return true;
  6383. });
  6384. return !invalid;
  6385. }
  6386. inline EncodingType encoding_type(const Request &req,
  6387. const std::string &content_type) {
  6388. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6389. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6390. if (s.empty()) { return EncodingType::None; }
  6391. // Single-pass: iterate tokens and track the best supported encoding.
  6392. // Server preference breaks ties (br > gzip > zstd).
  6393. EncodingType best = EncodingType::None;
  6394. double best_q = 0.0; // q=0 means "not acceptable"
  6395. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6396. auto priority = [](EncodingType t) -> int {
  6397. switch (t) {
  6398. case EncodingType::Brotli: return 0;
  6399. case EncodingType::Gzip: return 1;
  6400. case EncodingType::Zstd: return 2;
  6401. default: return 3;
  6402. }
  6403. };
  6404. std::string name;
  6405. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6406. double quality = 1.0;
  6407. if (!parse_quality(b, e, name, quality)) { return; }
  6408. if (quality <= 0.0) { return; }
  6409. EncodingType type = EncodingType::None;
  6410. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6411. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6412. #endif
  6413. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6414. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6415. type = EncodingType::Gzip;
  6416. }
  6417. #endif
  6418. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6419. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6420. type = EncodingType::Zstd;
  6421. }
  6422. #endif
  6423. if (type == EncodingType::None) { return; }
  6424. // Higher q-value wins; for equal q, server preference breaks ties
  6425. if (quality > best_q ||
  6426. (quality == best_q && priority(type) < priority(best))) {
  6427. best_q = quality;
  6428. best = type;
  6429. }
  6430. });
  6431. return best;
  6432. }
  6433. // `content_type` is taken separately because a file-backed response has not
  6434. // been given one yet when its coding has to be decided.
  6435. inline EncodingType encoding_type(const Request &req, const Response &res,
  6436. const std::string &content_type) {
  6437. // The response already names a content coding of its own: a handler serving
  6438. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6439. // point whose headers name the coding its files are stored in. Applying one
  6440. // on top of that would double-encode the body and append a second
  6441. // `Content-Encoding` field line.
  6442. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6443. return encoding_type(req, content_type);
  6444. }
  6445. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6446. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6447. }
  6448. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6449. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6450. if (type == EncodingType::Gzip) {
  6451. return detail::make_unique<gzip_compressor>();
  6452. }
  6453. #endif
  6454. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6455. if (type == EncodingType::Brotli) {
  6456. return detail::make_unique<brotli_compressor>();
  6457. }
  6458. #endif
  6459. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6460. if (type == EncodingType::Zstd) {
  6461. return detail::make_unique<zstd_compressor>();
  6462. }
  6463. #endif
  6464. (void)type;
  6465. return nullptr;
  6466. }
  6467. inline const char *encoding_name(EncodingType type) {
  6468. switch (type) {
  6469. case EncodingType::Gzip: return "gzip";
  6470. case EncodingType::Brotli: return "br";
  6471. case EncodingType::Zstd: return "zstd";
  6472. default: return "";
  6473. }
  6474. }
  6475. inline bool nocompressor::compress(const char *data, size_t data_length,
  6476. bool /*last*/, Callback callback) {
  6477. if (!data_length) { return true; }
  6478. return callback(data, data_length);
  6479. }
  6480. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6481. inline gzip_compressor::gzip_compressor() {
  6482. std::memset(&strm_, 0, sizeof(strm_));
  6483. strm_.zalloc = Z_NULL;
  6484. strm_.zfree = Z_NULL;
  6485. strm_.opaque = Z_NULL;
  6486. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6487. Z_DEFAULT_STRATEGY) == Z_OK;
  6488. }
  6489. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6490. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6491. bool last, Callback callback) {
  6492. assert(is_valid_);
  6493. do {
  6494. constexpr size_t max_avail_in =
  6495. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6496. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6497. (std::min)(data_length, max_avail_in));
  6498. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6499. data_length -= strm_.avail_in;
  6500. data += strm_.avail_in;
  6501. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6502. auto ret = Z_OK;
  6503. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6504. do {
  6505. strm_.avail_out = static_cast<uInt>(buff.size());
  6506. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6507. ret = deflate(&strm_, flush);
  6508. if (ret == Z_STREAM_ERROR) { return false; }
  6509. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6510. return false;
  6511. }
  6512. } while (strm_.avail_out == 0);
  6513. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6514. (flush == Z_NO_FLUSH && ret == Z_OK));
  6515. assert(strm_.avail_in == 0);
  6516. } while (data_length > 0);
  6517. return true;
  6518. }
  6519. inline gzip_decompressor::gzip_decompressor() {
  6520. std::memset(&strm_, 0, sizeof(strm_));
  6521. strm_.zalloc = Z_NULL;
  6522. strm_.zfree = Z_NULL;
  6523. strm_.opaque = Z_NULL;
  6524. // 15 is the value of wbits, which should be at the maximum possible value
  6525. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6526. // that the stream type should be automatically detected either gzip or
  6527. // deflate.
  6528. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6529. }
  6530. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6531. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6532. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6533. Callback callback) {
  6534. assert(is_valid_);
  6535. auto ret = Z_OK;
  6536. do {
  6537. constexpr size_t max_avail_in =
  6538. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6539. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6540. (std::min)(data_length, max_avail_in));
  6541. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6542. data_length -= strm_.avail_in;
  6543. data += strm_.avail_in;
  6544. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6545. while (strm_.avail_in > 0 && ret == Z_OK) {
  6546. strm_.avail_out = static_cast<uInt>(buff.size());
  6547. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6548. ret = inflate(&strm_, Z_NO_FLUSH);
  6549. assert(ret != Z_STREAM_ERROR);
  6550. switch (ret) {
  6551. case Z_NEED_DICT:
  6552. case Z_DATA_ERROR:
  6553. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6554. }
  6555. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6556. return false;
  6557. }
  6558. }
  6559. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6560. } while (data_length > 0);
  6561. return true;
  6562. }
  6563. #endif
  6564. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6565. inline brotli_compressor::brotli_compressor() {
  6566. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6567. }
  6568. inline brotli_compressor::~brotli_compressor() {
  6569. BrotliEncoderDestroyInstance(state_);
  6570. }
  6571. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6572. bool last, Callback callback) {
  6573. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6574. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6575. auto available_in = data_length;
  6576. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6577. for (;;) {
  6578. if (last) {
  6579. if (BrotliEncoderIsFinished(state_)) { break; }
  6580. } else {
  6581. if (!available_in) { break; }
  6582. }
  6583. auto available_out = buff.size();
  6584. auto next_out = buff.data();
  6585. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6586. &available_out, &next_out, nullptr)) {
  6587. return false;
  6588. }
  6589. auto output_bytes = buff.size() - available_out;
  6590. if (output_bytes) {
  6591. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6592. }
  6593. }
  6594. return true;
  6595. }
  6596. inline brotli_decompressor::brotli_decompressor() {
  6597. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6598. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6599. : BROTLI_DECODER_RESULT_ERROR;
  6600. }
  6601. inline brotli_decompressor::~brotli_decompressor() {
  6602. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6603. }
  6604. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6605. inline bool brotli_decompressor::decompress(const char *data,
  6606. size_t data_length,
  6607. Callback callback) {
  6608. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6609. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6610. return 0;
  6611. }
  6612. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6613. size_t avail_in = data_length;
  6614. size_t total_out;
  6615. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6616. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6617. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6618. char *next_out = buff.data();
  6619. size_t avail_out = buff.size();
  6620. decoder_r = BrotliDecoderDecompressStream(
  6621. decoder_s, &avail_in, &next_in, &avail_out,
  6622. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6623. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6624. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6625. }
  6626. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6627. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6628. }
  6629. #endif
  6630. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6631. inline zstd_compressor::zstd_compressor() {
  6632. ctx_ = ZSTD_createCCtx();
  6633. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6634. }
  6635. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6636. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6637. bool last, Callback callback) {
  6638. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6639. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6640. ZSTD_inBuffer input = {data, data_length, 0};
  6641. bool finished;
  6642. do {
  6643. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6644. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6645. if (ZSTD_isError(remaining)) { return false; }
  6646. if (!callback(buff.data(), output.pos)) { return false; }
  6647. finished = last ? (remaining == 0) : (input.pos == input.size);
  6648. } while (!finished);
  6649. return true;
  6650. }
  6651. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6652. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6653. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6654. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6655. Callback callback) {
  6656. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6657. ZSTD_inBuffer input = {data, data_length, 0};
  6658. while (input.pos < input.size) {
  6659. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6660. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6661. if (ZSTD_isError(remaining)) { return false; }
  6662. if (!callback(buff.data(), output.pos)) { return false; }
  6663. }
  6664. return true;
  6665. }
  6666. #endif
  6667. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6668. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6669. // unknown coding, and its payload would be handed back still compressed.
  6670. inline bool is_zlib_encoding(const std::string &encoding) {
  6671. return case_ignore::equal(encoding, "gzip") ||
  6672. case_ignore::equal(encoding, "deflate");
  6673. }
  6674. inline bool is_brotli_encoding(const std::string &encoding) {
  6675. return case_ignore::equal(encoding, "br");
  6676. }
  6677. inline bool is_zstd_encoding(const std::string &encoding) {
  6678. return case_ignore::equal(encoding, "zstd");
  6679. }
  6680. // Returns true if the content coding is one cpp-httplib is able to decompress
  6681. // when the corresponding support is compiled in.
  6682. inline bool is_known_content_encoding(const std::string &encoding) {
  6683. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6684. is_zstd_encoding(encoding);
  6685. }
  6686. inline std::unique_ptr<decompressor>
  6687. create_decompressor(const std::string &encoding) {
  6688. std::unique_ptr<decompressor> decompressor;
  6689. if (is_zlib_encoding(encoding)) {
  6690. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6691. decompressor = detail::make_unique<gzip_decompressor>();
  6692. #endif
  6693. } else if (is_brotli_encoding(encoding)) {
  6694. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6695. decompressor = detail::make_unique<brotli_decompressor>();
  6696. #endif
  6697. } else if (is_zstd_encoding(encoding)) {
  6698. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6699. decompressor = detail::make_unique<zstd_decompressor>();
  6700. #endif
  6701. }
  6702. return decompressor;
  6703. }
  6704. // Returns the best available compressor and its Content-Encoding name.
  6705. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6706. inline std::pair<std::unique_ptr<compressor>, const char *>
  6707. create_compressor() {
  6708. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6709. return {detail::make_unique<brotli_compressor>(), "br"};
  6710. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6711. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6712. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6713. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6714. #else
  6715. return {nullptr, nullptr};
  6716. #endif
  6717. }
  6718. inline bool is_prohibited_header_name(const std::string &name) {
  6719. using udl::operator""_t;
  6720. switch (str2tag(name)) {
  6721. case "REMOTE_ADDR"_t:
  6722. case "REMOTE_PORT"_t:
  6723. case "LOCAL_ADDR"_t:
  6724. case "LOCAL_PORT"_t: return true;
  6725. default: return false;
  6726. }
  6727. }
  6728. inline bool has_header(const Headers &headers, const std::string &key) {
  6729. if (is_prohibited_header_name(key)) { return false; }
  6730. return headers.find(key) != headers.end();
  6731. }
  6732. inline const char *get_header_value(const Headers &headers,
  6733. const std::string &key, const char *def,
  6734. size_t id) {
  6735. if (is_prohibited_header_name(key)) {
  6736. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6737. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6738. throw std::invalid_argument(msg);
  6739. #else
  6740. return "";
  6741. #endif
  6742. }
  6743. auto rng = headers.equal_range(key);
  6744. auto it = rng.first;
  6745. std::advance(it, static_cast<ssize_t>(id));
  6746. if (it != rng.second) { return it->second.c_str(); }
  6747. return def;
  6748. }
  6749. inline size_t get_header_value_count(const Headers &headers,
  6750. const std::string &key) {
  6751. return headers.count(key);
  6752. }
  6753. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6754. // list may be sent as several field lines, and the combined field value is
  6755. // those values joined by commas in the order they were received. Callers that
  6756. // parse such a list must work on the combined value; reading only the first
  6757. // occurrence silently drops whatever the later field lines carry.
  6758. inline std::string get_combined_header_value(const Headers &headers,
  6759. const std::string &key) {
  6760. std::string combined;
  6761. auto rng = headers.equal_range(key);
  6762. for (auto it = rng.first; it != rng.second; ++it) {
  6763. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6764. // elements, so an empty field line must not contribute a bare comma to the
  6765. // combined value.
  6766. if (it->second.empty()) { continue; }
  6767. if (!combined.empty()) { combined += ", "; }
  6768. combined += it->second;
  6769. }
  6770. return combined;
  6771. }
  6772. inline bool has_header_token(const Headers &headers, const std::string &key,
  6773. const std::string &token) {
  6774. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6775. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6776. // several lines. Match complete tokens rather than searching the raw value,
  6777. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6778. auto rng = headers.equal_range(key);
  6779. for (auto it = rng.first; it != rng.second; ++it) {
  6780. const auto &value = it->second;
  6781. if (split_find(value.data(), value.data() + value.size(), ',',
  6782. [&](const char *b, const char *e) {
  6783. return case_ignore::equal(std::string(b, e), token);
  6784. })) {
  6785. return true;
  6786. }
  6787. }
  6788. return false;
  6789. }
  6790. template <typename Map>
  6791. inline typename Map::mapped_type
  6792. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6793. auto rng = m.equal_range(key);
  6794. auto it = rng.first;
  6795. std::advance(it, static_cast<ssize_t>(id));
  6796. if (it != rng.second) { return it->second; }
  6797. return typename Map::mapped_type();
  6798. }
  6799. inline void set_header(Headers &headers, const std::string &key,
  6800. const std::string &val) {
  6801. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6802. }
  6803. inline bool read_headers(Stream &strm, Headers &headers) {
  6804. const auto bufsiz = 2048;
  6805. char buf[bufsiz];
  6806. stream_line_reader line_reader(strm, buf, bufsiz);
  6807. size_t header_count = 0;
  6808. for (;;) {
  6809. if (!line_reader.getline()) { return false; }
  6810. // Check if the line ends with CRLF.
  6811. auto line_terminator_len = 2;
  6812. if (line_reader.end_with_crlf()) {
  6813. // Blank line indicates end of headers.
  6814. if (line_reader.size() == 2) { break; }
  6815. } else {
  6816. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6817. // Blank line indicates end of headers.
  6818. if (line_reader.size() == 1) { break; }
  6819. line_terminator_len = 1;
  6820. #else
  6821. continue; // Skip invalid line.
  6822. #endif
  6823. }
  6824. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6825. // Check header count limit
  6826. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6827. // Exclude line terminator
  6828. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6829. if (!parse_header(line_reader.ptr(), end,
  6830. [&](const std::string &key, const std::string &val) {
  6831. headers.emplace(key, val);
  6832. })) {
  6833. return false;
  6834. }
  6835. header_count++;
  6836. }
  6837. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6838. // headers that have different values to prevent request smuggling.
  6839. auto cl_range = headers.equal_range("Content-Length");
  6840. if (cl_range.first != cl_range.second) {
  6841. const auto &first_val = cl_range.first->second;
  6842. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6843. if (it->second != first_val) { return false; }
  6844. }
  6845. }
  6846. return true;
  6847. }
  6848. inline bool parse_status_line(const char *line, std::string &version,
  6849. int &status, std::string &reason) {
  6850. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6851. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6852. #else
  6853. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6854. #endif
  6855. std::cmatch m;
  6856. if (!std::regex_match(line, m, re)) { return false; }
  6857. version = std::string(m[1]);
  6858. status = std::stoi(std::string(m[2]));
  6859. reason = std::string(m[3]);
  6860. return true;
  6861. }
  6862. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6863. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6864. struct WebSocketUpgradeResponse {
  6865. Error error = Error::Success;
  6866. int status = -1;
  6867. Headers headers;
  6868. std::string selected_subprotocol;
  6869. };
  6870. inline bool read_websocket_upgrade_response(Stream &strm,
  6871. const std::string &expected_accept,
  6872. WebSocketUpgradeResponse &upgrade) {
  6873. // Read status line
  6874. const auto bufsiz = 2048;
  6875. char buf[bufsiz];
  6876. stream_line_reader line_reader(strm, buf, bufsiz);
  6877. if (!line_reader.getline()) {
  6878. upgrade.error = Error::Read;
  6879. return false;
  6880. }
  6881. std::string version;
  6882. std::string reason;
  6883. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6884. upgrade.error = Error::WebSocketHandshake;
  6885. return false;
  6886. }
  6887. // Read the headers even for a rejection so the caller can see why the
  6888. // server refused the upgrade. A non-101 response may carry a body; it is
  6889. // deliberately left unread since the caller closes the socket right away.
  6890. if (!read_headers(strm, upgrade.headers)) {
  6891. upgrade.error = Error::Read;
  6892. return false;
  6893. }
  6894. const auto &headers = upgrade.headers;
  6895. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6896. upgrade.error = Error::WebSocketHandshake;
  6897. return false;
  6898. }
  6899. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6900. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6901. upgrade.error = Error::WebSocketHandshake;
  6902. return false;
  6903. }
  6904. // Verify Connection: Upgrade
  6905. if (!has_header_token(headers, "Connection", "upgrade")) {
  6906. upgrade.error = Error::WebSocketHandshake;
  6907. return false;
  6908. }
  6909. // Verify Sec-WebSocket-Accept header value
  6910. auto it = headers.find("Sec-WebSocket-Accept");
  6911. if (it == headers.end() || it->second != expected_accept) {
  6912. upgrade.error = Error::WebSocketHandshake;
  6913. return false;
  6914. }
  6915. // Extract negotiated subprotocol
  6916. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6917. if (proto_it != headers.end()) {
  6918. upgrade.selected_subprotocol = proto_it->second;
  6919. }
  6920. return true;
  6921. }
  6922. enum class ReadContentResult {
  6923. Success, // Successfully read the content
  6924. PayloadTooLarge, // The content exceeds the specified payload limit
  6925. Error // An error occurred while reading the content
  6926. };
  6927. inline ReadContentResult read_content_with_length(
  6928. Stream &strm, size_t len, DownloadProgress progress,
  6929. ContentReceiverWithProgress out,
  6930. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6931. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6932. detail::BodyReader br;
  6933. br.stream = &strm;
  6934. br.has_content_length = true;
  6935. br.content_length = len;
  6936. br.payload_max_length = payload_max_length;
  6937. br.chunked = false;
  6938. br.bytes_read = 0;
  6939. br.last_error = Error::Success;
  6940. size_t r = 0;
  6941. while (r < len) {
  6942. auto read_len = static_cast<size_t>(len - r);
  6943. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6944. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6945. if (n <= 0) {
  6946. // Check if it was a payload size error
  6947. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6948. return ReadContentResult::PayloadTooLarge;
  6949. }
  6950. return ReadContentResult::Error;
  6951. }
  6952. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6953. return ReadContentResult::Error;
  6954. }
  6955. r += static_cast<size_t>(n);
  6956. if (progress) {
  6957. if (!progress(r, len)) { return ReadContentResult::Error; }
  6958. }
  6959. }
  6960. return ReadContentResult::Success;
  6961. }
  6962. inline ReadContentResult
  6963. read_content_without_length(Stream &strm, size_t payload_max_length,
  6964. ContentReceiverWithProgress out) {
  6965. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6966. size_t r = 0;
  6967. for (;;) {
  6968. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6969. if (n == 0) { return ReadContentResult::Success; }
  6970. if (n < 0) { return ReadContentResult::Error; }
  6971. // Check if adding this data would exceed the payload limit
  6972. if (r > payload_max_length ||
  6973. payload_max_length - r < static_cast<size_t>(n)) {
  6974. return ReadContentResult::PayloadTooLarge;
  6975. }
  6976. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6977. return ReadContentResult::Error;
  6978. }
  6979. r += static_cast<size_t>(n);
  6980. }
  6981. return ReadContentResult::Success;
  6982. }
  6983. template <typename T>
  6984. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6985. size_t payload_max_length,
  6986. ContentReceiverWithProgress out) {
  6987. detail::ChunkedDecoder dec(strm);
  6988. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6989. size_t total_len = 0;
  6990. for (;;) {
  6991. size_t chunk_offset = 0;
  6992. size_t chunk_total = 0;
  6993. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6994. if (n < 0) { return ReadContentResult::Error; }
  6995. if (n == 0) {
  6996. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6997. return ReadContentResult::Error;
  6998. }
  6999. return ReadContentResult::Success;
  7000. }
  7001. if (total_len > payload_max_length ||
  7002. payload_max_length - total_len < static_cast<size_t>(n)) {
  7003. return ReadContentResult::PayloadTooLarge;
  7004. }
  7005. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7006. return ReadContentResult::Error;
  7007. }
  7008. total_len += static_cast<size_t>(n);
  7009. }
  7010. }
  7011. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7012. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7013. // is the final transfer coding. A single field value may list several
  7014. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7015. // several Transfer-Encoding lines, which combine into one comma-separated
  7016. // list in the order the lines were received. Headers preserves that order,
  7017. // so the final coding is the last token of the last line. Match it
  7018. // case-insensitively rather than comparing the whole value against
  7019. // "chunked".
  7020. //
  7021. // Security: reading a chunked message as unframed leaves its body in the
  7022. // socket, where a keep-alive connection parses it as a smuggled request.
  7023. // Server::process_request() answers 400 and closes when the final coding is
  7024. // not chunked, so a request whose framing cannot be determined never
  7025. // reaches the "no body" path.
  7026. auto rng = headers.equal_range("Transfer-Encoding");
  7027. if (rng.first == rng.second) { return false; }
  7028. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7029. // combined list ending in nothing rather than inheriting the line before it.
  7030. std::string last_coding;
  7031. for (auto it = rng.first; it != rng.second; ++it) {
  7032. const auto &value = it->second;
  7033. last_coding.clear();
  7034. split(value.data(), value.data() + value.size(), ',',
  7035. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7036. }
  7037. return case_ignore::equal(last_coding, "chunked");
  7038. }
  7039. inline bool has_conflicting_content_length(const Headers &headers) {
  7040. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7041. // Content-Length is framed ambiguously. The body readers here delimit it by
  7042. // the transfer coding and drop Content-Length, while an intermediary may do
  7043. // the reverse, so the two disagree on where the body ends and a reused
  7044. // connection is desynchronised (request/response smuggling). Content-Length:
  7045. // 0 is tolerated for compatibility with existing peers.
  7046. return has_header(headers, "Transfer-Encoding") &&
  7047. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7048. }
  7049. template <typename T, typename U>
  7050. bool prepare_content_receiver(T &x, int &status,
  7051. ContentReceiverWithProgress receiver,
  7052. bool decompress, size_t payload_max_length,
  7053. bool &exceed_payload_max_length, U callback) {
  7054. if (decompress) {
  7055. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7056. std::unique_ptr<decompressor> decompressor;
  7057. if (!encoding.empty()) {
  7058. // A coding we know about but were not built with is an error. An
  7059. // unrecognized coding (including "identity") is left alone and the
  7060. // payload is passed through as-is, since some servers misuse the header,
  7061. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7062. decompressor = detail::create_decompressor(encoding);
  7063. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7064. status = StatusCode::UnsupportedMediaType_415;
  7065. return false;
  7066. }
  7067. }
  7068. if (decompressor) {
  7069. if (decompressor->is_valid()) {
  7070. size_t decompressed_size = 0;
  7071. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7072. size_t off, size_t len) {
  7073. return decompressor->decompress(
  7074. buf, n, [&](const char *buf2, size_t n2) {
  7075. // Guard against zip-bomb: check
  7076. // decompressed size against limit.
  7077. if (payload_max_length > 0 &&
  7078. (decompressed_size >= payload_max_length ||
  7079. n2 > payload_max_length - decompressed_size)) {
  7080. exceed_payload_max_length = true;
  7081. return false;
  7082. }
  7083. decompressed_size += n2;
  7084. return receiver(buf2, n2, off, len);
  7085. });
  7086. };
  7087. return callback(std::move(out));
  7088. } else {
  7089. status = StatusCode::InternalServerError_500;
  7090. return false;
  7091. }
  7092. }
  7093. }
  7094. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7095. size_t len) {
  7096. return receiver(buf, n, off, len);
  7097. };
  7098. return callback(std::move(out));
  7099. }
  7100. template <typename T>
  7101. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7102. DownloadProgress progress,
  7103. ContentReceiverWithProgress receiver, bool decompress) {
  7104. bool exceed_payload_max_length = false;
  7105. return prepare_content_receiver(
  7106. x, status, std::move(receiver), decompress, payload_max_length,
  7107. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7108. auto ret = true;
  7109. // Note: exceed_payload_max_length may also be set by the decompressor
  7110. // wrapper in prepare_content_receiver when the decompressed payload
  7111. // size exceeds the limit.
  7112. if (is_chunked_transfer_encoding(x.headers)) {
  7113. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7114. if (result == ReadContentResult::Success) {
  7115. ret = true;
  7116. } else if (result == ReadContentResult::PayloadTooLarge) {
  7117. exceed_payload_max_length = true;
  7118. ret = false;
  7119. } else {
  7120. ret = false;
  7121. }
  7122. } else if (!has_header(x.headers, "Content-Length")) {
  7123. auto result =
  7124. read_content_without_length(strm, payload_max_length, out);
  7125. if (result == ReadContentResult::Success) {
  7126. ret = true;
  7127. } else if (result == ReadContentResult::PayloadTooLarge) {
  7128. exceed_payload_max_length = true;
  7129. ret = false;
  7130. } else {
  7131. ret = false;
  7132. }
  7133. } else {
  7134. auto is_invalid_value = false;
  7135. auto len = get_header_value_u64(x.headers, "Content-Length",
  7136. (std::numeric_limits<size_t>::max)(),
  7137. 0, is_invalid_value);
  7138. if (is_invalid_value) {
  7139. ret = false;
  7140. } else if (len > 0) {
  7141. auto result = read_content_with_length(
  7142. strm, len, std::move(progress), out, payload_max_length);
  7143. ret = (result == ReadContentResult::Success);
  7144. if (result == ReadContentResult::PayloadTooLarge) {
  7145. exceed_payload_max_length = true;
  7146. }
  7147. }
  7148. }
  7149. if (!ret) {
  7150. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7151. : StatusCode::BadRequest_400;
  7152. }
  7153. return ret;
  7154. });
  7155. }
  7156. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7157. const std::string &path) {
  7158. // Neither the method nor the request target may carry CR/LF, SP or other
  7159. // control octets; otherwise a value smuggled into either splits the request
  7160. // line and injects headers or a whole request.
  7161. if (!fields::is_token(method)) { return -1; }
  7162. if (!fields::is_request_target(path)) { return -1; }
  7163. std::string s = method;
  7164. s += ' ';
  7165. s += path;
  7166. s += " HTTP/1.1\r\n";
  7167. return strm.write(s.data(), s.size());
  7168. }
  7169. inline ssize_t write_response_line(Stream &strm, int status) {
  7170. std::string s = "HTTP/1.1 ";
  7171. s += std::to_string(status);
  7172. s += ' ';
  7173. s += httplib::status_message(status);
  7174. s += "\r\n";
  7175. return strm.write(s.data(), s.size());
  7176. }
  7177. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7178. ssize_t write_len = 0;
  7179. for (const auto &x : headers) {
  7180. // Skip fields with invalid names or values to prevent response splitting
  7181. // via CR/LF injection, matching set_header(). The client validates request
  7182. // headers up front in check_and_write_headers, but the server passes
  7183. // res.headers straight to this writer, and res.headers is a public field
  7184. // an application can populate directly with request-derived values.
  7185. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7186. std::string s;
  7187. s = x.first;
  7188. s += ": ";
  7189. s += x.second;
  7190. s += "\r\n";
  7191. auto len = strm.write(s.data(), s.size());
  7192. if (len < 0) { return len; }
  7193. write_len += len;
  7194. }
  7195. auto len = strm.write("\r\n");
  7196. if (len < 0) { return len; }
  7197. write_len += len;
  7198. return write_len;
  7199. }
  7200. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7201. size_t offset = 0;
  7202. while (offset < l) {
  7203. auto length = strm.write(d + offset, l - offset);
  7204. if (length < 0) { return false; }
  7205. offset += static_cast<size_t>(length);
  7206. }
  7207. return true;
  7208. }
  7209. template <typename T>
  7210. inline bool write_content_with_progress(Stream &strm,
  7211. const ContentProvider &content_provider,
  7212. size_t offset, size_t length,
  7213. T is_shutting_down,
  7214. const UploadProgress &upload_progress,
  7215. Error &error) {
  7216. size_t end_offset = offset + length;
  7217. size_t start_offset = offset;
  7218. auto ok = true;
  7219. auto finished = false;
  7220. DataSink data_sink;
  7221. data_sink.write = [&](const char *d, size_t l) -> bool {
  7222. if (ok) {
  7223. if (write_data(strm, d, l)) {
  7224. offset += l;
  7225. if (upload_progress && length > 0) {
  7226. size_t current_written = offset - start_offset;
  7227. if (!upload_progress(current_written, length)) {
  7228. ok = false;
  7229. return false;
  7230. }
  7231. }
  7232. } else {
  7233. ok = false;
  7234. }
  7235. }
  7236. return ok;
  7237. };
  7238. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7239. // The body is framed by `length`, so a provider that reports itself done
  7240. // early has truncated it. Record that and let the short-body check below
  7241. // fail the write, rather than calling the provider again forever.
  7242. data_sink.done = [&]() { finished = true; };
  7243. while (offset < end_offset && !finished && !is_shutting_down()) {
  7244. auto last_offset = offset;
  7245. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7246. error = Error::Write;
  7247. return false;
  7248. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7249. error = Error::Canceled;
  7250. return false;
  7251. } else if (!ok) {
  7252. error = Error::Write;
  7253. return false;
  7254. }
  7255. // A provider that reports success without writing anything and without
  7256. // reporting itself done gets handed the same offset and length again on
  7257. // the next pass, so it would spin here for as long as the peer stays
  7258. // connected. Treat making no progress as a short body, like done() early.
  7259. if (!finished && offset == last_offset) {
  7260. error = Error::Write;
  7261. return false;
  7262. }
  7263. }
  7264. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7265. error = Error::Write;
  7266. return false;
  7267. }
  7268. error = Error::Success;
  7269. return true;
  7270. }
  7271. template <typename T>
  7272. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7273. size_t offset, size_t length, T is_shutting_down,
  7274. Error &error) {
  7275. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7276. is_shutting_down, nullptr, error);
  7277. }
  7278. template <typename T>
  7279. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7280. size_t offset, size_t length,
  7281. const T &is_shutting_down) {
  7282. auto error = Error::Success;
  7283. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7284. error);
  7285. }
  7286. template <typename T>
  7287. inline bool
  7288. write_content_without_length(Stream &strm,
  7289. const ContentProvider &content_provider,
  7290. const T &is_shutting_down) {
  7291. size_t offset = 0;
  7292. auto data_available = true;
  7293. auto ok = true;
  7294. DataSink data_sink;
  7295. data_sink.write = [&](const char *d, size_t l) -> bool {
  7296. if (ok) {
  7297. offset += l;
  7298. if (!write_data(strm, d, l)) { ok = false; }
  7299. }
  7300. return ok;
  7301. };
  7302. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7303. data_sink.done = [&](void) { data_available = false; };
  7304. while (data_available && !is_shutting_down()) {
  7305. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7306. return false;
  7307. } else if (!content_provider(offset, 0, data_sink)) {
  7308. return false;
  7309. } else if (!ok) {
  7310. return false;
  7311. }
  7312. }
  7313. return !data_available; // true only if done() was called, false if shutting
  7314. // down
  7315. }
  7316. // Runs a known-length content provider to completion and compresses what it
  7317. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7318. // by an mmap hands the compressor a pointer straight into the mapping.
  7319. inline bool compress_content_provider(const ContentProvider &content_provider,
  7320. size_t length, compressor &cmp,
  7321. std::string &out) {
  7322. size_t offset = 0;
  7323. auto ok = true;
  7324. auto finished = false;
  7325. DataSink data_sink;
  7326. auto append = [&](const char *data, size_t data_len) {
  7327. out.append(data, data_len);
  7328. return true;
  7329. };
  7330. data_sink.write = [&](const char *d, size_t l) -> bool {
  7331. if (!ok) { return false; }
  7332. offset += l;
  7333. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7334. return ok;
  7335. };
  7336. // The body is framed by `length`, so a provider that reports itself done
  7337. // early has truncated it; the short-body check below turns that into a
  7338. // failure rather than calling the provider again forever.
  7339. data_sink.done = [&]() { finished = true; };
  7340. while (offset < length && !finished) {
  7341. auto prev_offset = offset;
  7342. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7343. return false;
  7344. }
  7345. // No Stream to block on here, so a provider that keeps returning true
  7346. // without writing would spin. Treat a pass that made no progress as a
  7347. // failure.
  7348. if (offset == prev_offset) { return false; }
  7349. }
  7350. if (offset != length) { return false; }
  7351. return cmp.compress(nullptr, 0, true, append);
  7352. }
  7353. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7354. // and the file flag, so recording them has to come after; keeping all of it
  7355. // here means a third file-serving path cannot get that order wrong.
  7356. inline void set_file_content_provider(Response &res,
  7357. const std::shared_ptr<mmap> &m,
  7358. const std::string &content_type,
  7359. EncodingType encoding) {
  7360. res.set_content_provider(
  7361. m->size(), content_type,
  7362. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7363. sink.write(m->data() + offset, length);
  7364. return true;
  7365. });
  7366. res.is_file_content_provider_ = true;
  7367. res.content_coding_ = encoding;
  7368. }
  7369. template <typename T, typename U>
  7370. inline bool
  7371. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7372. const T &is_shutting_down, U &compressor, Error &error) {
  7373. size_t offset = 0;
  7374. auto data_available = true;
  7375. auto ok = true;
  7376. DataSink data_sink;
  7377. data_sink.write = [&](const char *d, size_t l) -> bool {
  7378. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7379. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7380. // zero-length chunk is the terminator, so it must not be emitted here.
  7381. if (ok && l > 0) {
  7382. offset += l;
  7383. std::string payload;
  7384. if (compressor.compress(d, l, false,
  7385. [&](const char *data, size_t data_len) {
  7386. payload.append(data, data_len);
  7387. return true;
  7388. })) {
  7389. if (!payload.empty()) {
  7390. // Emit chunked response header and footer for each chunk
  7391. auto chunk =
  7392. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7393. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7394. }
  7395. } else {
  7396. ok = false;
  7397. }
  7398. }
  7399. return ok;
  7400. };
  7401. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7402. auto done_with_trailer = [&](const Headers *trailer) {
  7403. if (!ok) { return; }
  7404. data_available = false;
  7405. std::string payload;
  7406. if (!compressor.compress(nullptr, 0, true,
  7407. [&](const char *data, size_t data_len) {
  7408. payload.append(data, data_len);
  7409. return true;
  7410. })) {
  7411. ok = false;
  7412. return;
  7413. }
  7414. if (!payload.empty()) {
  7415. // Emit chunked response header and footer for each chunk
  7416. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7417. if (!write_data(strm, chunk.data(), chunk.size())) {
  7418. ok = false;
  7419. return;
  7420. }
  7421. }
  7422. constexpr const char done_marker[] = "0\r\n";
  7423. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7424. // Trailer
  7425. if (trailer) {
  7426. for (const auto &kv : *trailer) {
  7427. // Skip fields with invalid names or values to prevent response
  7428. // splitting via CR/LF injection, matching set_header().
  7429. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7430. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7431. if (!write_data(strm, field_line.data(), field_line.size())) {
  7432. ok = false;
  7433. }
  7434. }
  7435. }
  7436. constexpr const char crlf[] = "\r\n";
  7437. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7438. };
  7439. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7440. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7441. done_with_trailer(&trailer);
  7442. };
  7443. while (data_available && !is_shutting_down()) {
  7444. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7445. error = Error::Write;
  7446. return false;
  7447. } else if (!content_provider(offset, 0, data_sink)) {
  7448. error = Error::Canceled;
  7449. return false;
  7450. } else if (!ok) {
  7451. error = Error::Write;
  7452. return false;
  7453. }
  7454. }
  7455. if (data_available) { // exited due to is_shutting_down(), not done()
  7456. error = Error::Write;
  7457. return false;
  7458. }
  7459. error = Error::Success;
  7460. return true;
  7461. }
  7462. template <typename T, typename U>
  7463. inline bool write_content_chunked(Stream &strm,
  7464. const ContentProvider &content_provider,
  7465. const T &is_shutting_down, U &compressor) {
  7466. auto error = Error::Success;
  7467. return write_content_chunked(strm, content_provider, is_shutting_down,
  7468. compressor, error);
  7469. }
  7470. template <typename T>
  7471. inline bool redirect(T &cli, Request &req, Response &res,
  7472. const std::string &path, const std::string &location,
  7473. Error &error) {
  7474. Request new_req = req;
  7475. new_req.path = path;
  7476. new_req.redirect_count_ -= 1;
  7477. if (res.status == StatusCode::SeeOther_303 &&
  7478. (req.method != "GET" && req.method != "HEAD")) {
  7479. new_req.method = "GET";
  7480. new_req.body.clear();
  7481. new_req.headers.clear();
  7482. }
  7483. Response new_res;
  7484. auto ret = cli.send(new_req, new_res, error);
  7485. if (ret) {
  7486. req = std::move(new_req);
  7487. res = std::move(new_res);
  7488. if (res.location.empty()) { res.location = location; }
  7489. }
  7490. return ret;
  7491. }
  7492. inline std::string params_to_query_str(const Params &params) {
  7493. std::string query;
  7494. for (auto it = params.begin(); it != params.end(); ++it) {
  7495. if (it != params.begin()) { query += '&'; }
  7496. query += encode_query_component(it->first);
  7497. query += '=';
  7498. query += encode_query_component(it->second);
  7499. }
  7500. return query;
  7501. }
  7502. // Splits one "key=value" span of a query string at its first '='. A span with
  7503. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7504. // "?flag" keeps its name.
  7505. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7506. std::string &val) {
  7507. divide(b, static_cast<std::size_t>(e - b), '=',
  7508. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7509. std::size_t rhs_size) {
  7510. key.assign(lhs_data, lhs_size);
  7511. val.assign(rhs_data, rhs_size);
  7512. });
  7513. }
  7514. inline void parse_query_text(const char *data, std::size_t size,
  7515. Params &params) {
  7516. std::set<std::string> cache;
  7517. split(data, data + size, '&', [&](const char *b, const char *e) {
  7518. std::string kv(b, e);
  7519. if (cache.find(kv) != cache.end()) { return; }
  7520. cache.insert(std::move(kv));
  7521. std::string key;
  7522. std::string val;
  7523. divide_query_pair(b, e, key, val);
  7524. if (!key.empty()) {
  7525. params.emplace(decode_query_component(key), decode_query_component(val));
  7526. }
  7527. });
  7528. }
  7529. inline void parse_query_text(const std::string &s, Params &params) {
  7530. parse_query_text(s.data(), s.size(), params);
  7531. }
  7532. // Normalize a query string by decoding and re-encoding each key/value pair
  7533. // while preserving the original parameter order. This avoids double-encoding
  7534. // and ensures consistent encoding. It works on the raw string rather than
  7535. // parsing into Params and re-serializing, because that round trip cannot
  7536. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7537. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7538. // duplicated pairs.
  7539. inline std::string normalize_query_string(const std::string &query) {
  7540. std::string result;
  7541. split(query.data(), query.data() + query.size(), '&',
  7542. [&](const char *b, const char *e) {
  7543. std::string key;
  7544. std::string val;
  7545. divide_query_pair(b, e, key, val);
  7546. if (!key.empty()) {
  7547. auto dec_key = decode_query_component(key);
  7548. auto dec_val = decode_query_component(val);
  7549. if (!result.empty()) { result += '&'; }
  7550. result += encode_query_component(dec_key);
  7551. if (!val.empty() || std::find(b, e, '=') != e) {
  7552. result += '=';
  7553. result += encode_query_component(dec_val);
  7554. }
  7555. }
  7556. });
  7557. return result;
  7558. }
  7559. // Build the request target that goes on the wire from a caller-supplied path.
  7560. // Shared by the buffered send path and the streaming API so that both put the
  7561. // same bytes in the request line for the same input.
  7562. inline std::string encode_request_target(const std::string &target,
  7563. bool path_encode) {
  7564. // `substr(0, npos)` yields the whole string, which is what the no-query
  7565. // case needs.
  7566. auto query_pos = target.find('?');
  7567. auto path_part = target.substr(0, query_pos);
  7568. std::string query_part;
  7569. if (query_pos != std::string::npos) {
  7570. query_part = target.substr(query_pos + 1);
  7571. }
  7572. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7573. if (!query_part.empty()) {
  7574. // When path encoding is disabled the caller has supplied an already-encoded
  7575. // target and expects the exact bytes to be sent on the wire, so skip
  7576. // normalization for the query too. Normalizing would decode-then-re-encode
  7577. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7578. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7579. if (path_encode) {
  7580. auto normalized = normalize_query_string(query_part);
  7581. if (!normalized.empty()) {
  7582. result += '?';
  7583. result += normalized;
  7584. }
  7585. } else {
  7586. result += '?';
  7587. result += query_part;
  7588. }
  7589. }
  7590. return result;
  7591. }
  7592. inline bool parse_multipart_boundary(const std::string &content_type,
  7593. std::string &boundary) {
  7594. std::map<std::string, std::string> params;
  7595. extract_media_type(content_type, &params);
  7596. auto it = params.find("boundary");
  7597. if (it == params.end()) { return false; }
  7598. boundary = it->second;
  7599. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7600. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7601. // bytes costs a nearly full comparison at nearly every position: the
  7602. // boundary's length multiplies the worst-case cost of scanning a body.
  7603. return !boundary.empty() && boundary.size() <= 70;
  7604. }
  7605. inline void parse_disposition_params(const std::string &s, Params &params) {
  7606. std::set<std::string> cache;
  7607. split_unquoted(s.data(), s.data() + s.size(), ';',
  7608. [&](const char *b, const char *e) {
  7609. std::string kv(b, e);
  7610. if (cache.find(kv) != cache.end()) { return; }
  7611. cache.insert(kv);
  7612. std::string key;
  7613. std::string val;
  7614. divide_param_pair(b, e, key, val);
  7615. if (!key.empty()) {
  7616. params.emplace(trim_double_quotes_copy(key),
  7617. trim_double_quotes_copy(val));
  7618. }
  7619. });
  7620. }
  7621. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7622. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7623. #else
  7624. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7625. #endif
  7626. auto is_valid = [](const std::string &str) {
  7627. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7628. };
  7629. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7630. const auto pos = static_cast<size_t>(6);
  7631. const auto len = static_cast<size_t>(s.size() - 6);
  7632. auto all_valid_ranges = true;
  7633. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7634. if (!all_valid_ranges) { return; }
  7635. const auto it = std::find(b, e, '-');
  7636. if (it == e) {
  7637. all_valid_ranges = false;
  7638. return;
  7639. }
  7640. const auto lhs = std::string(b, it);
  7641. const auto rhs = std::string(it + 1, e);
  7642. if (!is_valid(lhs) || !is_valid(rhs)) {
  7643. all_valid_ranges = false;
  7644. return;
  7645. }
  7646. ssize_t first = -1;
  7647. if (!lhs.empty()) {
  7648. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7649. // would turn the range into a suffix range.
  7650. auto res =
  7651. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7652. if (res.ec != std::errc{}) {
  7653. all_valid_ranges = false;
  7654. return;
  7655. }
  7656. }
  7657. ssize_t last = -1;
  7658. if (!rhs.empty()) {
  7659. // An overflowing last-byte-pos is past any content length, so keeping
  7660. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7661. ssize_t v;
  7662. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7663. if (res.ec == std::errc{}) { last = v; }
  7664. }
  7665. if ((first == -1 && last == -1) ||
  7666. (first != -1 && last != -1 && first > last)) {
  7667. all_valid_ranges = false;
  7668. return;
  7669. }
  7670. ranges.emplace_back(first, last);
  7671. });
  7672. return all_valid_ranges && !ranges.empty();
  7673. }
  7674. return false;
  7675. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7676. }
  7677. #else
  7678. } catch (...) { return false; }
  7679. #endif
  7680. inline bool parse_accept_header(const std::string &s,
  7681. std::vector<std::string> &content_types) {
  7682. content_types.clear();
  7683. // Empty string is considered valid (no preference)
  7684. if (s.empty()) { return true; }
  7685. struct AcceptEntry {
  7686. std::string media_type;
  7687. double quality;
  7688. int order;
  7689. };
  7690. std::vector<AcceptEntry> entries;
  7691. int order = 0;
  7692. bool has_invalid_entry = false;
  7693. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7694. // has to parse and ignore empty list elements, so a leading, trailing or
  7695. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7696. // split() skips them, and the header length limit bounds how many a sender
  7697. // can send, so ignoring all of them cannot be used as a denial-of-service
  7698. // vector.
  7699. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7700. std::string entry(b, e);
  7701. entry = trim_copy(entry);
  7702. AcceptEntry accept_entry;
  7703. accept_entry.order = order++;
  7704. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7705. accept_entry.media_type, accept_entry.quality)) {
  7706. has_invalid_entry = true;
  7707. return;
  7708. }
  7709. // Remove additional parameters from media type
  7710. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7711. // Basic validation of media type format
  7712. if (accept_entry.media_type.empty()) {
  7713. has_invalid_entry = true;
  7714. return;
  7715. }
  7716. // Check for basic media type format (should contain '/' or be '*')
  7717. if (accept_entry.media_type != "*" &&
  7718. accept_entry.media_type.find('/') == std::string::npos) {
  7719. has_invalid_entry = true;
  7720. return;
  7721. }
  7722. entries.push_back(std::move(accept_entry));
  7723. });
  7724. // Return false if any invalid entry was found
  7725. if (has_invalid_entry) { return false; }
  7726. // Sort by quality (descending), then by original order (ascending)
  7727. std::sort(entries.begin(), entries.end(),
  7728. [](const AcceptEntry &a, const AcceptEntry &b) {
  7729. if (a.quality != b.quality) {
  7730. return a.quality > b.quality; // Higher quality first
  7731. }
  7732. return a.order < b.order; // Earlier order first for same quality
  7733. });
  7734. // Extract sorted media types
  7735. content_types.reserve(entries.size());
  7736. for (auto &entry : entries) {
  7737. content_types.push_back(std::move(entry.media_type));
  7738. }
  7739. return true;
  7740. }
  7741. class FormDataParser {
  7742. public:
  7743. FormDataParser() = default;
  7744. void set_boundary(std::string &&boundary) {
  7745. boundary_ = std::move(boundary);
  7746. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7747. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7748. }
  7749. bool is_valid() const { return is_valid_; }
  7750. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7751. const ContentReceiver &content_callback) {
  7752. // Once the close delimiter has been seen the rest of the body is epilogue
  7753. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7754. // spread across reads is not copied in only to be erased right away.
  7755. if (state_ == 5) { return true; }
  7756. buf_append(buf, n);
  7757. while (buf_size() > 0) {
  7758. switch (state_) {
  7759. case 0: { // Initial boundary
  7760. auto pos = buf_find(dash_boundary_crlf_);
  7761. if (pos == buf_size()) {
  7762. // Not found yet: keep only a possible partial boundary at the tail so
  7763. // that a body which never contains the boundary cannot grow the
  7764. // buffer (and get rescanned from the start) without bound.
  7765. auto keep = dash_boundary_crlf_.size() - 1;
  7766. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7767. return true;
  7768. }
  7769. buf_erase(pos + dash_boundary_crlf_.size());
  7770. state_ = 1;
  7771. break;
  7772. }
  7773. case 1: { // New entry
  7774. clear_file_info();
  7775. state_ = 2;
  7776. break;
  7777. }
  7778. case 2: { // Headers
  7779. auto pos = buf_find(crlf_);
  7780. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7781. while (pos < buf_size()) {
  7782. // Empty line
  7783. if (pos == 0) {
  7784. if (!header_callback(file_)) {
  7785. is_valid_ = false;
  7786. return false;
  7787. }
  7788. buf_erase(crlf_.size());
  7789. state_ = 3;
  7790. break;
  7791. }
  7792. // Check header count limit
  7793. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7794. is_valid_ = false;
  7795. return false;
  7796. }
  7797. header_count_++;
  7798. const auto header = buf_head(pos);
  7799. if (!parse_header(header.data(), header.data() + header.size(),
  7800. [&](const std::string &, const std::string &) {})) {
  7801. is_valid_ = false;
  7802. return false;
  7803. }
  7804. // Parse and emplace space trimmed headers into a map
  7805. if (!parse_header(
  7806. header.data(), header.data() + header.size(),
  7807. [&](const std::string &key, const std::string &val) {
  7808. file_.headers.emplace(key, val);
  7809. })) {
  7810. is_valid_ = false;
  7811. return false;
  7812. }
  7813. constexpr const char header_content_type[] = "Content-Type:";
  7814. if (start_with_case_ignore(header, header_content_type)) {
  7815. file_.content_type =
  7816. trim_copy(header.substr(str_len(header_content_type)));
  7817. } else {
  7818. std::string disposition_params;
  7819. if (parse_content_disposition(header, disposition_params)) {
  7820. Params params;
  7821. parse_disposition_params(disposition_params, params);
  7822. auto it = params.find("name");
  7823. if (it != params.end()) {
  7824. file_.name = it->second;
  7825. } else {
  7826. is_valid_ = false;
  7827. return false;
  7828. }
  7829. it = params.find("filename");
  7830. if (it != params.end()) { file_.filename = it->second; }
  7831. it = params.find("filename*");
  7832. if (it != params.end()) {
  7833. // RFC 5987: only UTF-8 encoding is allowed
  7834. const auto &val = it->second;
  7835. constexpr const char utf8_prefix[] = "UTF-8''";
  7836. constexpr size_t prefix_len = str_len(utf8_prefix);
  7837. if (val.size() > prefix_len &&
  7838. start_with_case_ignore(val, utf8_prefix)) {
  7839. file_.filename = decode_path_component(
  7840. val.substr(prefix_len)); // override...
  7841. } else {
  7842. is_valid_ = false;
  7843. return false;
  7844. }
  7845. }
  7846. }
  7847. }
  7848. buf_erase(pos + crlf_.size());
  7849. pos = buf_find(crlf_);
  7850. }
  7851. if (state_ != 3) { return true; }
  7852. break;
  7853. }
  7854. case 3: { // Body
  7855. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7856. auto pos = buf_find(crlf_dash_boundary_);
  7857. if (pos < buf_size()) {
  7858. if (!content_callback(buf_data(), pos)) {
  7859. is_valid_ = false;
  7860. return false;
  7861. }
  7862. buf_erase(pos + crlf_dash_boundary_.size());
  7863. state_ = 4;
  7864. } else {
  7865. auto len = buf_size() - crlf_dash_boundary_.size();
  7866. if (len > 0) {
  7867. if (!content_callback(buf_data(), len)) {
  7868. is_valid_ = false;
  7869. return false;
  7870. }
  7871. buf_erase(len);
  7872. }
  7873. return true;
  7874. }
  7875. break;
  7876. }
  7877. case 4: { // Boundary
  7878. if (crlf_.size() > buf_size()) { return true; }
  7879. if (buf_start_with(crlf_)) {
  7880. buf_erase(crlf_.size());
  7881. state_ = 1;
  7882. } else if (buf_start_with(dash_)) {
  7883. buf_erase(dash_.size());
  7884. is_valid_ = true;
  7885. state_ = 5;
  7886. } else {
  7887. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7888. // accepted after a boundary; RFC 2046 allows transport-padding in
  7889. // between, but this parser has never supported it. Either way the
  7890. // body is already destined to be rejected, so fail now instead of
  7891. // buffering the rest of it. Both are two bytes, so the check above
  7892. // already guarantees enough buffered data to decide.
  7893. is_valid_ = false;
  7894. return false;
  7895. }
  7896. break;
  7897. }
  7898. case 5: { // Epilogue
  7899. buf_erase(buf_size());
  7900. break;
  7901. }
  7902. }
  7903. }
  7904. return true;
  7905. }
  7906. private:
  7907. void clear_file_info() {
  7908. file_.name.clear();
  7909. file_.filename.clear();
  7910. file_.content_type.clear();
  7911. file_.headers.clear();
  7912. header_count_ = 0;
  7913. }
  7914. bool start_with_case_ignore(const std::string &a, const char *b,
  7915. size_t offset = 0) const {
  7916. const auto b_len = strlen(b);
  7917. if (a.size() < offset + b_len) { return false; }
  7918. for (size_t i = 0; i < b_len; i++) {
  7919. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7920. return false;
  7921. }
  7922. }
  7923. return true;
  7924. }
  7925. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7926. // Returns true if header matches, with the params portion in `params_out`.
  7927. bool parse_content_disposition(const std::string &header,
  7928. std::string &params_out) const {
  7929. constexpr const char prefix[] = "Content-Disposition:";
  7930. constexpr size_t prefix_len = str_len(prefix);
  7931. if (!start_with_case_ignore(header, prefix)) { return false; }
  7932. // Skip whitespace after "Content-Disposition:"
  7933. auto pos = prefix_len;
  7934. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7935. pos++;
  7936. }
  7937. // Match "form-data;" (case-insensitive)
  7938. constexpr const char form_data[] = "form-data;";
  7939. constexpr size_t form_data_len = str_len(form_data);
  7940. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7941. pos += form_data_len;
  7942. // Skip whitespace after "form-data;"
  7943. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7944. pos++;
  7945. }
  7946. params_out = header.substr(pos);
  7947. return true;
  7948. }
  7949. const std::string dash_ = "--";
  7950. const std::string crlf_ = "\r\n";
  7951. std::string boundary_;
  7952. std::string dash_boundary_crlf_;
  7953. std::string crlf_dash_boundary_;
  7954. size_t state_ = 0;
  7955. bool is_valid_ = false;
  7956. FormData file_;
  7957. size_t header_count_ = 0;
  7958. // Buffer
  7959. bool start_with(const std::string &a, size_t spos, size_t epos,
  7960. const std::string &b) const {
  7961. if (epos - spos < b.size()) { return false; }
  7962. for (size_t i = 0; i < b.size(); i++) {
  7963. if (a[i + spos] != b[i]) { return false; }
  7964. }
  7965. return true;
  7966. }
  7967. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7968. const char *buf_data() const { return &buf_[buf_spos_]; }
  7969. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7970. bool buf_start_with(const std::string &s) const {
  7971. return start_with(buf_, buf_spos_, buf_epos_, s);
  7972. }
  7973. size_t buf_find(const std::string &s) const {
  7974. auto c = s.front();
  7975. size_t off = buf_spos_;
  7976. while (off < buf_epos_) {
  7977. auto pos = off;
  7978. while (true) {
  7979. if (pos == buf_epos_) { return buf_size(); }
  7980. if (buf_[pos] == c) { break; }
  7981. pos++;
  7982. }
  7983. auto remaining_size = buf_epos_ - pos;
  7984. if (s.size() > remaining_size) { return buf_size(); }
  7985. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7986. off = pos + 1;
  7987. }
  7988. return buf_size();
  7989. }
  7990. void buf_append(const char *data, size_t n) {
  7991. auto remaining_size = buf_size();
  7992. if (remaining_size > 0 && buf_spos_ > 0) {
  7993. for (size_t i = 0; i < remaining_size; i++) {
  7994. buf_[i] = buf_[buf_spos_ + i];
  7995. }
  7996. }
  7997. buf_spos_ = 0;
  7998. buf_epos_ = remaining_size;
  7999. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8000. for (size_t i = 0; i < n; i++) {
  8001. buf_[buf_epos_ + i] = data[i];
  8002. }
  8003. buf_epos_ += n;
  8004. }
  8005. void buf_erase(size_t size) { buf_spos_ += size; }
  8006. std::string buf_;
  8007. size_t buf_spos_ = 0;
  8008. size_t buf_epos_ = 0;
  8009. };
  8010. inline std::string random_string(size_t length) {
  8011. constexpr const char data[] =
  8012. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8013. thread_local auto engine([]() {
  8014. // std::random_device might actually be deterministic on some
  8015. // platforms, but due to lack of support in the c++ standard library,
  8016. // doing better requires either some ugly hacks or breaking portability.
  8017. std::random_device seed_gen;
  8018. // Request 128 bits of entropy for initialization
  8019. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8020. return std::mt19937(seed_sequence);
  8021. }());
  8022. std::string result;
  8023. for (size_t i = 0; i < length; i++) {
  8024. result += data[engine() % (sizeof(data) - 1)];
  8025. }
  8026. return result;
  8027. }
  8028. inline std::string make_multipart_data_boundary() {
  8029. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8030. }
  8031. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8032. auto valid = true;
  8033. for (size_t i = 0; i < boundary.size(); i++) {
  8034. auto c = boundary[i];
  8035. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8036. valid = false;
  8037. break;
  8038. }
  8039. }
  8040. return valid;
  8041. }
  8042. // Escape a multipart field name/filename following the WHATWG HTML standard
  8043. // ("escape a multipart form-data name"), which is what browsers send:
  8044. // '"' -> %22, CR -> %0D, LF -> %0A
  8045. // With escape_quote = false, only CR and LF are escaped; this is for header
  8046. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8047. inline std::string escape_multipart_field(const std::string &s,
  8048. bool escape_quote = true) {
  8049. std::string result;
  8050. result.reserve(s.size());
  8051. for (auto c : s) {
  8052. switch (c) {
  8053. case '"':
  8054. if (escape_quote) {
  8055. result += "%22";
  8056. } else {
  8057. result += c;
  8058. }
  8059. break;
  8060. case '\r': result += "%0D"; break;
  8061. case '\n': result += "%0A"; break;
  8062. default: result += c; break;
  8063. }
  8064. }
  8065. return result;
  8066. }
  8067. template <typename T>
  8068. inline std::string
  8069. serialize_multipart_formdata_item_begin(const T &item,
  8070. const std::string &boundary) {
  8071. std::string body = "--" + boundary + "\r\n";
  8072. body += "Content-Disposition: form-data; name=\"" +
  8073. escape_multipart_field(item.name) + "\"";
  8074. if (!item.filename.empty()) {
  8075. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8076. }
  8077. body += "\r\n";
  8078. if (!item.content_type.empty()) {
  8079. body +=
  8080. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8081. "\r\n";
  8082. }
  8083. body += "\r\n";
  8084. return body;
  8085. }
  8086. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8087. inline std::string
  8088. serialize_multipart_formdata_finish(const std::string &boundary) {
  8089. return "--" + boundary + "--\r\n";
  8090. }
  8091. inline std::string
  8092. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8093. return "multipart/form-data; boundary=" + boundary;
  8094. }
  8095. inline std::string
  8096. serialize_multipart_formdata(const UploadFormDataItems &items,
  8097. const std::string &boundary, bool finish = true) {
  8098. std::string body;
  8099. for (const auto &item : items) {
  8100. body += serialize_multipart_formdata_item_begin(item, boundary);
  8101. body += item.content + serialize_multipart_formdata_item_end();
  8102. }
  8103. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8104. return body;
  8105. }
  8106. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8107. const std::string &boundary) {
  8108. size_t total = 0;
  8109. for (const auto &item : items) {
  8110. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8111. total += item.content.size();
  8112. total += serialize_multipart_formdata_item_end().size();
  8113. }
  8114. total += serialize_multipart_formdata_finish(boundary).size();
  8115. return total;
  8116. }
  8117. struct MultipartSegment {
  8118. const char *data;
  8119. size_t size;
  8120. };
  8121. // NOTE: items must outlive the returned ContentProvider
  8122. // (safe for synchronous use inside Post/Put/Patch)
  8123. inline ContentProvider
  8124. make_multipart_content_provider(const UploadFormDataItems &items,
  8125. const std::string &boundary) {
  8126. // Own the per-item header strings and the finish string
  8127. std::vector<std::string> owned;
  8128. owned.reserve(items.size() + 1);
  8129. for (const auto &item : items)
  8130. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8131. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8132. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8133. std::vector<MultipartSegment> segs;
  8134. segs.reserve(items.size() * 3 + 1);
  8135. static const char crlf[] = "\r\n";
  8136. for (size_t i = 0; i < items.size(); i++) {
  8137. segs.push_back({owned[i].data(), owned[i].size()});
  8138. segs.push_back({items[i].content.data(), items[i].content.size()});
  8139. segs.push_back({crlf, 2});
  8140. }
  8141. segs.push_back({owned.back().data(), owned.back().size()});
  8142. struct MultipartState {
  8143. std::vector<std::string> owned;
  8144. std::vector<MultipartSegment> segs;
  8145. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8146. };
  8147. auto state = std::make_shared<MultipartState>();
  8148. state->owned = std::move(owned);
  8149. // `segs` holds raw pointers into owned strings; std::string move preserves
  8150. // the data pointer, so these pointers remain valid after the move above.
  8151. state->segs = std::move(segs);
  8152. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8153. // Buffer multiple small segments into fewer, larger writes to avoid
  8154. // excessive TCP packets when there are many form data items (#2410)
  8155. auto &buf = state->buf;
  8156. auto buf_size = buf.size();
  8157. size_t buf_len = 0;
  8158. size_t remaining = length;
  8159. // Find the first segment containing 'offset'
  8160. size_t pos = 0;
  8161. size_t seg_idx = 0;
  8162. for (; seg_idx < state->segs.size(); seg_idx++) {
  8163. const auto &seg = state->segs[seg_idx];
  8164. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8165. pos += seg.size;
  8166. }
  8167. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8168. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8169. const auto &seg = state->segs[seg_idx];
  8170. size_t available = seg.size - seg_offset;
  8171. size_t to_copy = (std::min)(available, remaining);
  8172. const char *src = seg.data + seg_offset;
  8173. seg_offset = 0; // only the first segment has a non-zero offset
  8174. while (to_copy > 0) {
  8175. size_t space = buf_size - buf_len;
  8176. size_t chunk = (std::min)(to_copy, space);
  8177. std::memcpy(buf.data() + buf_len, src, chunk);
  8178. buf_len += chunk;
  8179. src += chunk;
  8180. to_copy -= chunk;
  8181. remaining -= chunk;
  8182. if (buf_len == buf_size) {
  8183. if (!sink.write(buf.data(), buf_len)) { return false; }
  8184. buf_len = 0;
  8185. }
  8186. }
  8187. }
  8188. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8189. return true;
  8190. };
  8191. }
  8192. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8193. if (ranges.size() <= 1) return;
  8194. // Sort ranges by start position
  8195. std::sort(ranges.begin(), ranges.end(),
  8196. [](const Range &a, const Range &b) { return a.first < b.first; });
  8197. Ranges coalesced;
  8198. coalesced.reserve(ranges.size());
  8199. for (auto &r : ranges) {
  8200. auto first_pos = r.first;
  8201. auto last_pos = r.second;
  8202. // Handle special cases like in range_error
  8203. if (first_pos == -1 && last_pos == -1) {
  8204. first_pos = 0;
  8205. last_pos = static_cast<ssize_t>(content_length);
  8206. }
  8207. if (first_pos == -1) {
  8208. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8209. last_pos = static_cast<ssize_t>(content_length) - 1;
  8210. }
  8211. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8212. last_pos = static_cast<ssize_t>(content_length) - 1;
  8213. }
  8214. // Skip invalid ranges
  8215. if (!(0 <= first_pos && first_pos <= last_pos &&
  8216. last_pos < static_cast<ssize_t>(content_length))) {
  8217. continue;
  8218. }
  8219. // Coalesce with previous range if overlapping or adjacent (but not
  8220. // identical)
  8221. if (!coalesced.empty()) {
  8222. auto &prev = coalesced.back();
  8223. // Check if current range overlaps or is adjacent to previous range
  8224. // but don't coalesce identical ranges (allow duplicates)
  8225. if (first_pos <= prev.second + 1 &&
  8226. !(first_pos == prev.first && last_pos == prev.second)) {
  8227. // Extend the previous range
  8228. prev.second = (std::max)(prev.second, last_pos);
  8229. continue;
  8230. }
  8231. }
  8232. // Add new range
  8233. coalesced.emplace_back(first_pos, last_pos);
  8234. }
  8235. ranges = std::move(coalesced);
  8236. }
  8237. inline bool range_error(Request &req, Response &res) {
  8238. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8239. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8240. req.ranges.clear();
  8241. if (res.status == StatusCode::PartialContent_206) {
  8242. res.status = StatusCode::OK_200;
  8243. }
  8244. return false;
  8245. }
  8246. ssize_t content_len = static_cast<ssize_t>(
  8247. res.content_length_ ? res.content_length_ : res.body.size());
  8248. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8249. size_t overwrapping_count = 0;
  8250. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8251. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8252. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8253. // Too many ranges
  8254. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8255. for (auto &r : req.ranges) {
  8256. auto &first_pos = r.first;
  8257. auto &last_pos = r.second;
  8258. if (first_pos == -1 && last_pos == -1) {
  8259. first_pos = 0;
  8260. last_pos = content_len;
  8261. }
  8262. if (first_pos == -1) {
  8263. first_pos = content_len - last_pos;
  8264. last_pos = content_len - 1;
  8265. }
  8266. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8267. // A client can limit the number of bytes requested without knowing the
  8268. // size of the selected representation. If the last-pos value is absent,
  8269. // or if the value is greater than or equal to the current length of the
  8270. // representation data, the byte range is interpreted as the remainder of
  8271. // the representation (i.e., the server replaces the value of last-pos
  8272. // with a value that is one less than the current length of the selected
  8273. // representation).
  8274. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8275. if (last_pos == -1 || last_pos >= content_len) {
  8276. last_pos = content_len - 1;
  8277. }
  8278. // Range must be within content length
  8279. if (!(0 <= first_pos && first_pos <= last_pos &&
  8280. last_pos <= content_len - 1)) {
  8281. return true;
  8282. }
  8283. // Request must not have more than two overlapping ranges
  8284. for (const auto &processed_range : processed_ranges) {
  8285. if (!(last_pos < processed_range.first ||
  8286. first_pos > processed_range.second)) {
  8287. overwrapping_count++;
  8288. if (overwrapping_count > 2) { return true; }
  8289. break; // Only count once per range
  8290. }
  8291. }
  8292. processed_ranges.emplace_back(first_pos, last_pos);
  8293. }
  8294. // After validation, coalesce overlapping ranges as per RFC 9110
  8295. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8296. }
  8297. return false;
  8298. }
  8299. inline std::pair<size_t, size_t>
  8300. get_range_offset_and_length(Range r, size_t content_length) {
  8301. assert(r.first != -1 && r.second != -1);
  8302. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8303. assert(r.first <= r.second &&
  8304. r.second < static_cast<ssize_t>(content_length));
  8305. (void)(content_length);
  8306. return std::make_pair(static_cast<size_t>(r.first),
  8307. static_cast<size_t>(r.second - r.first) + 1);
  8308. }
  8309. inline std::string make_content_range_header_field(
  8310. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8311. auto st = offset_and_length.first;
  8312. auto ed = st + offset_and_length.second - 1;
  8313. std::string field = "bytes ";
  8314. field += std::to_string(st);
  8315. field += '-';
  8316. field += std::to_string(ed);
  8317. field += '/';
  8318. field += std::to_string(content_length);
  8319. return field;
  8320. }
  8321. template <typename SToken, typename CToken, typename Content>
  8322. bool process_multipart_ranges_data(const Request &req,
  8323. const std::string &boundary,
  8324. const std::string &content_type,
  8325. size_t content_length, SToken stoken,
  8326. CToken ctoken, Content content) {
  8327. for (size_t i = 0; i < req.ranges.size(); i++) {
  8328. ctoken("--");
  8329. stoken(boundary);
  8330. ctoken("\r\n");
  8331. if (!content_type.empty()) {
  8332. ctoken("Content-Type: ");
  8333. stoken(content_type);
  8334. ctoken("\r\n");
  8335. }
  8336. auto offset_and_length =
  8337. get_range_offset_and_length(req.ranges[i], content_length);
  8338. ctoken("Content-Range: ");
  8339. stoken(make_content_range_header_field(offset_and_length, content_length));
  8340. ctoken("\r\n");
  8341. ctoken("\r\n");
  8342. if (!content(offset_and_length.first, offset_and_length.second)) {
  8343. return false;
  8344. }
  8345. ctoken("\r\n");
  8346. }
  8347. ctoken("--");
  8348. stoken(boundary);
  8349. ctoken("--");
  8350. return true;
  8351. }
  8352. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8353. const std::string &boundary,
  8354. const std::string &content_type,
  8355. size_t content_length,
  8356. std::string &data) {
  8357. process_multipart_ranges_data(
  8358. req, boundary, content_type, content_length,
  8359. [&](const std::string &token) { data += token; },
  8360. [&](const std::string &token) { data += token; },
  8361. [&](size_t offset, size_t length) {
  8362. assert(offset + length <= content_length);
  8363. data += res.body.substr(offset, length);
  8364. return true;
  8365. });
  8366. }
  8367. inline size_t get_multipart_ranges_data_length(const Request &req,
  8368. const std::string &boundary,
  8369. const std::string &content_type,
  8370. size_t content_length) {
  8371. size_t data_length = 0;
  8372. process_multipart_ranges_data(
  8373. req, boundary, content_type, content_length,
  8374. [&](const std::string &token) { data_length += token.size(); },
  8375. [&](const std::string &token) { data_length += token.size(); },
  8376. [&](size_t /*offset*/, size_t length) {
  8377. data_length += length;
  8378. return true;
  8379. });
  8380. return data_length;
  8381. }
  8382. template <typename T>
  8383. inline bool
  8384. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8385. const std::string &boundary,
  8386. const std::string &content_type,
  8387. size_t content_length, const T &is_shutting_down) {
  8388. return process_multipart_ranges_data(
  8389. req, boundary, content_type, content_length,
  8390. [&](const std::string &token) { strm.write(token); },
  8391. [&](const std::string &token) { strm.write(token); },
  8392. [&](size_t offset, size_t length) {
  8393. return write_content(strm, res.content_provider_, offset, length,
  8394. is_shutting_down);
  8395. });
  8396. }
  8397. inline bool has_framed_body(const Request &req) {
  8398. return is_chunked_transfer_encoding(req.headers) ||
  8399. req.get_header_value_u64("Content-Length") > 0;
  8400. }
  8401. inline bool is_connection_persistent(const Request &req) {
  8402. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8403. if (req.version == "HTTP/1.0" &&
  8404. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8405. return false;
  8406. }
  8407. return true;
  8408. }
  8409. inline bool expect_content(const Request &req) {
  8410. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8411. req.method == "DELETE") {
  8412. return true;
  8413. }
  8414. return has_framed_body(req);
  8415. }
  8416. #ifdef _WIN32
  8417. class WSInit {
  8418. public:
  8419. WSInit() {
  8420. WSADATA wsaData;
  8421. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8422. }
  8423. ~WSInit() {
  8424. if (is_valid_) WSACleanup();
  8425. }
  8426. bool is_valid_ = false;
  8427. };
  8428. static WSInit wsinit_;
  8429. #endif
  8430. // RFC 9110 Section 11.6.1 defines a challenge list as
  8431. // WWW-Authenticate = #challenge
  8432. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8433. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8434. // so a server may offer several schemes, each with its own comma-separated
  8435. // auth-param list, in either order and either as separate field lines or
  8436. // packed into one. Splitting on every comma would break apart a challenge's
  8437. // own param list; splitting only on the first space would miss a Digest
  8438. // challenge that isn't first. Split on commas that aren't inside a
  8439. // quoted-string instead, then track which scheme each resulting segment
  8440. // belongs to: a segment whose text before "=" contains whitespace (or that
  8441. // has no "=" at all) starts a new challenge named by its leading token.
  8442. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8443. std::vector<std::string> segments;
  8444. size_t start = 0;
  8445. auto in_quotes = false;
  8446. for (size_t i = 0; i < s.size(); i++) {
  8447. auto c = s[i];
  8448. if (in_quotes) {
  8449. if (c == '\\' && i + 1 < s.size()) {
  8450. i++;
  8451. } else if (c == '"') {
  8452. in_quotes = false;
  8453. }
  8454. } else if (c == '"') {
  8455. in_quotes = true;
  8456. } else if (c == ',') {
  8457. segments.push_back(s.substr(start, i - start));
  8458. start = i + 1;
  8459. }
  8460. }
  8461. segments.push_back(s.substr(start));
  8462. return segments;
  8463. }
  8464. inline std::string unescape_quoted_pairs(const std::string &s) {
  8465. std::string out;
  8466. out.reserve(s.size());
  8467. for (size_t i = 0; i < s.size(); i++) {
  8468. if (s[i] == '\\' && i + 1 < s.size()) {
  8469. out += s[++i];
  8470. } else {
  8471. out += s[i];
  8472. }
  8473. }
  8474. return out;
  8475. }
  8476. inline bool parse_www_authenticate(const Response &res,
  8477. std::map<std::string, std::string> &auth,
  8478. bool is_proxy) {
  8479. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8480. auto combined = get_combined_header_value(res.headers, auth_key);
  8481. if (combined.empty()) { return false; }
  8482. auto found_digest = false;
  8483. auto in_digest_challenge = false;
  8484. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8485. auto segment = trim_copy(raw_segment);
  8486. if (segment.empty()) { continue; }
  8487. auto eq_pos = segment.find('=');
  8488. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8489. // for the first segment of a challenge, "<scheme> <key>") must be
  8490. // trimmed before its boundaries are inspected.
  8491. auto key_part = trim_copy(
  8492. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8493. auto space_pos = key_part.find_last_of(" \t");
  8494. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8495. // "<scheme>[ <key>]" starts a new challenge.
  8496. auto scheme_end =
  8497. space_pos == std::string::npos ? key_part.size() : space_pos;
  8498. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8499. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8500. // from one challenge is never paired with another's algorithm.
  8501. in_digest_challenge =
  8502. !found_digest &&
  8503. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8504. if (in_digest_challenge) { found_digest = true; }
  8505. if (space_pos == std::string::npos) {
  8506. // Bare scheme (or a token68), no auth-param on this segment.
  8507. continue;
  8508. }
  8509. key_part = key_part.substr(space_pos + 1);
  8510. }
  8511. if (!in_digest_challenge) { continue; }
  8512. auto val = trim_copy(segment.substr(eq_pos + 1));
  8513. auto unquoted = trim_double_quotes_copy(val);
  8514. if (unquoted.size() != val.size()) {
  8515. unquoted = unescape_quoted_pairs(unquoted);
  8516. }
  8517. auth[std::move(key_part)] = std::move(unquoted);
  8518. }
  8519. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8520. // make_digest_authentication_header() dereferences both unconditionally, so
  8521. // a challenge missing either can't produce a usable Authorization header.
  8522. // Treat it the same as no Digest challenge at all.
  8523. return found_digest && auth.find("realm") != auth.end() &&
  8524. auth.find("nonce") != auth.end();
  8525. }
  8526. class ContentProviderAdapter {
  8527. public:
  8528. explicit ContentProviderAdapter(
  8529. ContentProviderWithoutLength &&content_provider)
  8530. : content_provider_(std::move(content_provider)) {}
  8531. bool operator()(size_t offset, size_t, DataSink &sink) {
  8532. return content_provider_(offset, sink);
  8533. }
  8534. private:
  8535. ContentProviderWithoutLength content_provider_;
  8536. };
  8537. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8538. namespace fields {
  8539. inline bool is_token_char(char c) {
  8540. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8541. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8542. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8543. }
  8544. inline bool is_token(const std::string &s) {
  8545. if (s.empty()) { return false; }
  8546. for (auto c : s) {
  8547. if (!is_token_char(c)) { return false; }
  8548. }
  8549. return true;
  8550. }
  8551. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8552. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8553. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8554. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8555. inline bool is_field_content(const std::string &s) {
  8556. if (s.empty()) { return true; }
  8557. if (s.size() == 1) {
  8558. return is_field_vchar(s[0]);
  8559. } else if (s.size() == 2) {
  8560. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8561. } else {
  8562. size_t i = 0;
  8563. if (!is_field_vchar(s[i])) { return false; }
  8564. i++;
  8565. while (i < s.size() - 1) {
  8566. auto c = s[i++];
  8567. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8568. } else {
  8569. return false;
  8570. }
  8571. }
  8572. return is_field_vchar(s[i]);
  8573. }
  8574. }
  8575. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8576. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8577. return is_field_name(name) && is_field_value(value);
  8578. }
  8579. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8580. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8581. inline bool is_request_target(const std::string &s) {
  8582. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8583. }
  8584. } // namespace fields
  8585. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8586. WebSocketUpgradeResponse &upgrade) {
  8587. // Generate random Sec-WebSocket-Key
  8588. thread_local std::mt19937 rng(std::random_device{}());
  8589. std::string key_bytes(16, '\0');
  8590. for (size_t i = 0; i < 16; i += 4) {
  8591. auto r = rng();
  8592. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8593. }
  8594. auto client_key = base64_encode(key_bytes);
  8595. req.headers.erase("Upgrade");
  8596. req.headers.erase("Connection");
  8597. req.headers.erase("Sec-WebSocket-Key");
  8598. req.headers.erase("Sec-WebSocket-Version");
  8599. req.headers.emplace("Upgrade", "websocket");
  8600. req.headers.emplace("Connection", "Upgrade");
  8601. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8602. req.headers.emplace("Sec-WebSocket-Version", "13");
  8603. // Build the request in memory first, like ClientImpl::write_request does.
  8604. // Writing straight to the socket would leak a request line onto the wire
  8605. // before check_and_write_headers gets a chance to reject an invalid header,
  8606. // and would emit one small write per header.
  8607. BufferStream bstrm;
  8608. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8609. upgrade.error = Error::Write;
  8610. return false;
  8611. }
  8612. auto error = Error::Success;
  8613. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8614. upgrade.error = error;
  8615. return false;
  8616. }
  8617. const auto &data = bstrm.get_buffer();
  8618. if (!write_data(strm, data.data(), data.size())) {
  8619. upgrade.error = Error::Write;
  8620. return false;
  8621. }
  8622. // Verify 101 response and Sec-WebSocket-Accept header
  8623. auto expected_accept = websocket_accept_key(client_key);
  8624. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8625. }
  8626. inline bool is_ip_address(const std::string &host) {
  8627. struct in_addr addr4;
  8628. struct in6_addr addr6;
  8629. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8630. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8631. }
  8632. // Resolve where a client should connect for `host`, honoring a user-supplied
  8633. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8634. // supplying the Host header and SNI; only the connection target changes.
  8635. //
  8636. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8637. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8638. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8639. // absent or empty mapping leaves `host` as the connection target; without the
  8640. // empty check the value would reach getaddrinfo as a null node and silently
  8641. // resolve to loopback.
  8642. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8643. const std::string &host, std::string &connect_host,
  8644. std::string &ip) {
  8645. connect_host = host;
  8646. ip.clear();
  8647. auto it = addr_map.find(host);
  8648. if (it == addr_map.end() || it->second.empty()) { return; }
  8649. if (is_ip_address(it->second)) {
  8650. ip = it->second;
  8651. } else {
  8652. connect_host = it->second;
  8653. }
  8654. }
  8655. } // namespace detail
  8656. /*
  8657. * Group 2: detail namespace - SSL common utilities
  8658. */
  8659. #ifdef CPPHTTPLIB_SSL_ENABLED
  8660. namespace detail {
  8661. class SSLSocketStream final : public Stream {
  8662. public:
  8663. SSLSocketStream(
  8664. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8665. time_t read_timeout_usec, time_t write_timeout_sec,
  8666. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8667. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8668. (std::chrono::steady_clock::time_point::min)());
  8669. ~SSLSocketStream() override;
  8670. bool is_readable() const override;
  8671. bool wait_readable() const override;
  8672. bool wait_writable() const override;
  8673. bool is_peer_alive() const override;
  8674. ssize_t read(char *ptr, size_t size) override;
  8675. ssize_t write(const char *ptr, size_t size) override;
  8676. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8677. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8678. socket_t socket() const override;
  8679. time_t duration() const override;
  8680. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8681. // See SocketStream::set_readable_hint().
  8682. void set_readable_hint() { readable_hint_ = true; }
  8683. private:
  8684. bool ensure_readable();
  8685. socket_t sock_;
  8686. tls::session_t session_;
  8687. time_t read_timeout_sec_;
  8688. time_t read_timeout_usec_;
  8689. time_t write_timeout_sec_;
  8690. time_t write_timeout_usec_;
  8691. time_t max_timeout_msec_;
  8692. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8693. bool readable_hint_ = false;
  8694. };
  8695. // A TLS stream for WebSocket connections, where the receive path and the
  8696. // send path (application send() plus the heartbeat ping thread) run on
  8697. // different threads. A single TLS session must never be entered
  8698. // concurrently, so every call into the session is serialized by one mutex.
  8699. //
  8700. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8701. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8702. // call under the lock, then waits for readiness with select() outside the
  8703. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8704. // blocked waiting for data never stalls a concurrent sender.
  8705. //
  8706. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8707. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8708. class WebSocketSSLStream final : public Stream {
  8709. public:
  8710. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8711. time_t read_timeout_sec, time_t read_timeout_usec,
  8712. time_t write_timeout_sec, time_t write_timeout_usec);
  8713. ~WebSocketSSLStream() override;
  8714. bool is_readable() const override;
  8715. bool wait_readable() const override;
  8716. bool wait_writable() const override;
  8717. ssize_t read(char *ptr, size_t size) override;
  8718. ssize_t write(const char *ptr, size_t size) override;
  8719. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8720. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8721. socket_t socket() const override;
  8722. time_t duration() const override;
  8723. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8724. private:
  8725. mutable std::mutex session_mutex_;
  8726. socket_t sock_;
  8727. tls::session_t session_;
  8728. // WebSocket::close() shortens the read timeout from the closing thread
  8729. // while the receive thread is inside wait_readable(), so these two are read
  8730. // and written concurrently. The write timeouts are never mutated.
  8731. std::atomic<time_t> read_timeout_sec_;
  8732. std::atomic<time_t> read_timeout_usec_;
  8733. time_t write_timeout_sec_;
  8734. time_t write_timeout_usec_;
  8735. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8736. };
  8737. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8738. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8739. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8740. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8741. unsigned int hash_length = 0;
  8742. unsigned char hash[EVP_MAX_MD_SIZE];
  8743. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8744. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8745. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8746. std::stringstream ss;
  8747. for (auto i = 0u; i < hash_length; ++i) {
  8748. ss << std::hex << std::setw(2) << std::setfill('0')
  8749. << static_cast<unsigned int>(hash[i]);
  8750. }
  8751. return ss.str();
  8752. }
  8753. inline std::string MD5(const std::string &s) {
  8754. return message_digest(s, EVP_md5());
  8755. }
  8756. inline std::string SHA_256(const std::string &s) {
  8757. return message_digest(s, EVP_sha256());
  8758. }
  8759. inline std::string SHA_512(const std::string &s) {
  8760. return message_digest(s, EVP_sha512());
  8761. }
  8762. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8763. namespace {
  8764. template <size_t N>
  8765. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8766. std::stringstream ss;
  8767. for (size_t i = 0; i < N; ++i) {
  8768. ss << std::hex << std::setw(2) << std::setfill('0')
  8769. << static_cast<unsigned int>(hash[i]);
  8770. }
  8771. return ss.str();
  8772. }
  8773. } // namespace
  8774. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8775. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8776. // initialized once. PSA state is process-global; do not free it.
  8777. inline bool ensure_mbedtls_psa_crypto() {
  8778. static std::once_flag once;
  8779. static bool ok = false;
  8780. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8781. return ok;
  8782. }
  8783. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8784. unsigned char *out, size_t out_size) {
  8785. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8786. size_t olen = 0;
  8787. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8788. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8789. olen == out_size;
  8790. }
  8791. #endif
  8792. inline std::string MD5(const std::string &s) {
  8793. unsigned char hash[16];
  8794. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8795. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8796. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8797. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8798. hash);
  8799. #else
  8800. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8801. hash);
  8802. #endif
  8803. return hash_to_hex(hash);
  8804. }
  8805. inline std::string SHA_256(const std::string &s) {
  8806. unsigned char hash[32];
  8807. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8808. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8809. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8810. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8811. hash, 0);
  8812. #else
  8813. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8814. s.size(), hash, 0);
  8815. #endif
  8816. return hash_to_hex(hash);
  8817. }
  8818. inline std::string SHA_512(const std::string &s) {
  8819. unsigned char hash[64];
  8820. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8821. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8822. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8823. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8824. hash, 0);
  8825. #else
  8826. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8827. s.size(), hash, 0);
  8828. #endif
  8829. return hash_to_hex(hash);
  8830. }
  8831. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8832. namespace {
  8833. template <size_t N>
  8834. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8835. std::stringstream ss;
  8836. for (size_t i = 0; i < N; ++i) {
  8837. ss << std::hex << std::setw(2) << std::setfill('0')
  8838. << static_cast<unsigned int>(hash[i]);
  8839. }
  8840. return ss.str();
  8841. }
  8842. } // namespace
  8843. inline std::string MD5(const std::string &s) {
  8844. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8845. wc_Md5Hash(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_256(const std::string &s) {
  8850. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8851. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8852. static_cast<word32>(s.size()), hash);
  8853. return hash_to_hex(hash);
  8854. }
  8855. inline std::string SHA_512(const std::string &s) {
  8856. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8857. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8858. static_cast<word32>(s.size()), hash);
  8859. return hash_to_hex(hash);
  8860. }
  8861. #endif
  8862. template <typename T>
  8863. inline bool process_server_socket_ssl(
  8864. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8865. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8866. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8867. time_t write_timeout_usec, T callback) {
  8868. return process_server_socket_core(
  8869. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8870. [&](bool close_connection, bool &connection_closed) {
  8871. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8872. write_timeout_sec, write_timeout_usec);
  8873. // See the non-TLS path in process_server_socket().
  8874. strm.set_readable_hint();
  8875. return callback(strm, close_connection, connection_closed);
  8876. });
  8877. }
  8878. template <typename T>
  8879. inline bool process_client_socket_ssl(
  8880. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8881. time_t read_timeout_usec, time_t write_timeout_sec,
  8882. time_t write_timeout_usec, time_t max_timeout_msec,
  8883. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8884. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8885. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8886. start_time);
  8887. return callback(strm);
  8888. }
  8889. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8890. const Request &req, const std::map<std::string, std::string> &auth,
  8891. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8892. const std::string &password, bool is_proxy = false) {
  8893. std::string nc;
  8894. {
  8895. std::stringstream ss;
  8896. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8897. nc = ss.str();
  8898. }
  8899. std::string qop;
  8900. if (auth.find("qop") != auth.end()) {
  8901. qop = auth.at("qop");
  8902. if (qop.find("auth-int") != std::string::npos) {
  8903. qop = "auth-int";
  8904. } else if (qop.find("auth") != std::string::npos) {
  8905. qop = "auth";
  8906. } else {
  8907. qop.clear();
  8908. }
  8909. }
  8910. std::string algo = "MD5";
  8911. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8912. std::string response;
  8913. {
  8914. auto H = algo == "SHA-256" ? detail::SHA_256
  8915. : algo == "SHA-512" ? detail::SHA_512
  8916. : detail::MD5;
  8917. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8918. auto A2 = req.method + ":" + req.path;
  8919. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8920. if (qop.empty()) {
  8921. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8922. } else {
  8923. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8924. ":" + qop + ":" + H(A2));
  8925. }
  8926. }
  8927. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8928. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8929. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8930. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8931. (qop.empty() ? ", response=\""
  8932. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8933. cnonce + "\", response=\"") +
  8934. response + "\"" +
  8935. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8936. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8937. return std::make_pair(key, field);
  8938. }
  8939. inline bool match_hostname(const std::string &pattern,
  8940. const std::string &hostname) {
  8941. // Exact match (case-insensitive)
  8942. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8943. // Split both pattern and hostname into components by '.'
  8944. std::vector<std::string> pattern_components;
  8945. if (!pattern.empty()) {
  8946. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8947. [&](const char *b, const char *e) {
  8948. pattern_components.emplace_back(b, e);
  8949. });
  8950. }
  8951. std::vector<std::string> host_components;
  8952. if (!hostname.empty()) {
  8953. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8954. [&](const char *b, const char *e) {
  8955. host_components.emplace_back(b, e);
  8956. });
  8957. }
  8958. // Component count must match
  8959. if (host_components.size() != pattern_components.size()) { return false; }
  8960. // Compare each component with wildcard support
  8961. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8962. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8963. auto itr = pattern_components.begin();
  8964. for (const auto &h : host_components) {
  8965. auto &p = *itr;
  8966. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8967. bool partial_match = false;
  8968. if (!p.empty() && p[p.size() - 1] == '*') {
  8969. const auto prefix_length = p.size() - 1;
  8970. if (prefix_length == 0) {
  8971. partial_match = true;
  8972. } else if (h.size() >= prefix_length) {
  8973. partial_match =
  8974. std::equal(p.begin(),
  8975. p.begin() + static_cast<std::string::difference_type>(
  8976. prefix_length),
  8977. h.begin(), [](const char ca, const char cb) {
  8978. return detail::case_ignore::to_lower(ca) ==
  8979. detail::case_ignore::to_lower(cb);
  8980. });
  8981. }
  8982. }
  8983. if (!partial_match) { return false; }
  8984. }
  8985. ++itr;
  8986. }
  8987. return true;
  8988. }
  8989. #ifdef _WIN32
  8990. // Verify certificate using Windows CertGetCertificateChain API.
  8991. // This provides real-time certificate validation with Windows Update
  8992. // integration, independent of the TLS backend.
  8993. inline bool verify_cert_with_windows_schannel(
  8994. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  8995. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  8996. if (der_cert.empty()) { return false; }
  8997. out_error = 0;
  8998. // Create Windows certificate context from DER data
  8999. auto cert_context = CertCreateCertificateContext(
  9000. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9001. static_cast<DWORD>(der_cert.size()));
  9002. if (!cert_context) {
  9003. out_error = GetLastError();
  9004. return false;
  9005. }
  9006. auto cert_guard =
  9007. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9008. // Give CryptoAPI the certificates the server sent. Without them it follows
  9009. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9010. std::vector<tls::cert_t> peer_certs;
  9011. tls::get_peer_certs(session, peer_certs);
  9012. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9013. auto store_guard = scope_exit([&] {
  9014. for (auto cert : peer_certs) {
  9015. tls::free_cert(cert);
  9016. }
  9017. if (store) { CertCloseStore(store, 0); }
  9018. });
  9019. for (auto cert : peer_certs) {
  9020. std::vector<unsigned char> der;
  9021. if (store && tls::get_cert_der(cert, der)) {
  9022. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9023. static_cast<DWORD>(der.size()),
  9024. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9025. }
  9026. }
  9027. // Setup chain parameters
  9028. CERT_CHAIN_PARA chain_para = {};
  9029. chain_para.cbSize = sizeof(chain_para);
  9030. // Require the server authentication usage along the chain, which also
  9031. // rejects roots that Windows trusts only for other purposes.
  9032. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9033. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9034. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9035. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9036. // Build certificate chain with revocation checking
  9037. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9038. auto chain_result = CertGetCertificateChain(
  9039. nullptr, cert_context, nullptr, store, &chain_para,
  9040. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9041. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9042. nullptr, &chain_context);
  9043. if (!chain_result || !chain_context) {
  9044. out_error = GetLastError();
  9045. return false;
  9046. }
  9047. auto chain_guard =
  9048. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9049. // Check if chain has errors
  9050. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  9051. out_error = chain_context->TrustStatus.dwErrorStatus;
  9052. return false;
  9053. }
  9054. // Verify SSL policy
  9055. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9056. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9057. #ifdef AUTHTYPE_SERVER
  9058. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9059. #endif
  9060. std::wstring whost;
  9061. if (verify_hostname) {
  9062. whost = u8string_to_wstring(hostname.c_str());
  9063. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9064. }
  9065. CERT_CHAIN_POLICY_PARA policy_para = {};
  9066. policy_para.cbSize = sizeof(policy_para);
  9067. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9068. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9069. #else
  9070. policy_para.dwFlags = 0;
  9071. #endif
  9072. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9073. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9074. policy_status.cbSize = sizeof(policy_status);
  9075. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9076. &policy_para, &policy_status)) {
  9077. out_error = GetLastError();
  9078. return false;
  9079. }
  9080. if (policy_status.dwError != 0) {
  9081. out_error = policy_status.dwError;
  9082. return false;
  9083. }
  9084. return true;
  9085. }
  9086. #endif // _WIN32
  9087. // Loads CA file/dir configuration and applies the system CA policy to a
  9088. // client TLS context. PEM data and native stores are applied to the context
  9089. // directly at set time; has_custom_store reflects them for the Auto policy
  9090. // decision.
  9091. inline bool load_client_ca_config(tls::ctx_t ctx,
  9092. const std::string &ca_cert_file_path,
  9093. const std::string &ca_cert_dir_path,
  9094. bool has_custom_store, SystemCAMode mode,
  9095. uint64_t &backend_error) {
  9096. auto ret = true;
  9097. if (!ca_cert_file_path.empty()) {
  9098. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9099. backend_error = tls::get_error();
  9100. ret = false;
  9101. }
  9102. } else if (!ca_cert_dir_path.empty()) {
  9103. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9104. backend_error = tls::get_error();
  9105. ret = false;
  9106. }
  9107. }
  9108. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9109. !ca_cert_dir_path.empty() || has_custom_store;
  9110. if (mode == SystemCAMode::Enabled ||
  9111. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9112. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9113. }
  9114. return ret;
  9115. }
  9116. // The parts of session setup that only SSLClient needs, plus the handful
  9117. // WebSocketClient also exposes; everything else takes the defaults, which is
  9118. // what keeps the two clients on one implementation.
  9119. struct ClientTlsSessionOptions {
  9120. // Both SSLClient and WebSocketClient expose this independently of
  9121. // certificate verification.
  9122. bool server_hostname_verification = true;
  9123. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9124. // When non-null, guards session creation against concurrent use of the
  9125. // context. A WebSocketClient is not safe to use from several threads to
  9126. // begin with, so it passes nothing.
  9127. std::mutex *ctx_mutex = nullptr;
  9128. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9129. // The caller decides whether Schannel has anything to say about this
  9130. // connection; see SSLClient::initialize_ssl().
  9131. bool windows_cert_verification = false;
  9132. // A server certificate verifier works on the backend's chain verification,
  9133. // so the backend keeps deciding and Schannel only adds its own check.
  9134. bool server_certificate_verifier_set = false;
  9135. #endif
  9136. };
  9137. // Filled in on failure for callers that report error details.
  9138. struct ClientTlsSessionError {
  9139. Error error = Error::Success;
  9140. int ssl_error = 0;
  9141. uint64_t backend_error = 0;
  9142. };
  9143. // Establishes a client TLS session on an already connected socket. On failure
  9144. // the session is left for the caller to free: SSLClient frees it right away,
  9145. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9146. inline bool setup_client_tls_session(
  9147. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9148. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9149. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9150. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9151. using namespace tls;
  9152. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9153. if (out_error) {
  9154. out_error->error = error;
  9155. out_error->ssl_error = ssl_error;
  9156. out_error->backend_error = backend_error;
  9157. }
  9158. return false;
  9159. };
  9160. if (!ctx) {
  9161. session = nullptr;
  9162. return fail(Error::SSLConnection, 0, 0);
  9163. }
  9164. // With Windows verification on and no server certificate verifier set,
  9165. // Schannel is the only chain verifier. The backend's trust store is a
  9166. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9167. // demand, so the backend's verdict is not used.
  9168. auto windows_verifies_chain = false;
  9169. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9170. windows_verifies_chain = options.windows_cert_verification &&
  9171. !options.server_certificate_verifier_set;
  9172. #endif
  9173. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9174. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9175. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9176. // Schannel verifies the chain instead, chain verification happens during
  9177. // the handshake even for IP hosts; the certificate identity is verified
  9178. // post-handshake via verify_hostname().
  9179. set_verify_client(ctx,
  9180. server_certificate_verification && !windows_verifies_chain);
  9181. #endif
  9182. {
  9183. std::unique_lock<std::mutex> guard;
  9184. if (options.ctx_mutex) {
  9185. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9186. }
  9187. session = create_session(ctx, sock);
  9188. }
  9189. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9190. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9191. // their identity is checked post-handshake below instead. On Mbed TLS and
  9192. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9193. // options.server_hostname_verification is threaded through here.
  9194. if (!is_ip_address(host)) {
  9195. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9196. return fail(Error::SSLConnection, 0, get_error());
  9197. }
  9198. }
  9199. TlsError tls_err;
  9200. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9201. &tls_err)) {
  9202. auto error = Error::SSLConnection;
  9203. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9204. error = Error::SSLServerVerification;
  9205. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9206. error = Error::SSLServerHostnameVerification;
  9207. }
  9208. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9209. }
  9210. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9211. if (options.session_verifier) {
  9212. verification_status = options.session_verifier(session);
  9213. }
  9214. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9215. return fail(Error::SSLServerVerification, 0, get_error());
  9216. }
  9217. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9218. server_certificate_verification) {
  9219. if (!windows_verifies_chain) {
  9220. auto verify_result = get_verify_result(session);
  9221. if (verify_result != 0) {
  9222. return fail(Error::SSLServerVerification, 0,
  9223. static_cast<uint64_t>(verify_result));
  9224. }
  9225. }
  9226. auto server_cert = get_peer_cert(session);
  9227. if (!server_cert) {
  9228. return fail(Error::SSLServerVerification, 0, get_error());
  9229. }
  9230. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9231. // Identity check against the peer certificate, post-handshake for all
  9232. // backends. For IP hosts this is the only identity verification, since no
  9233. // hostname is bound during the handshake.
  9234. if (options.server_hostname_verification) {
  9235. if (!verify_hostname(server_cert, host.c_str())) {
  9236. return fail(Error::SSLServerHostnameVerification, 0,
  9237. hostname_mismatch_code());
  9238. }
  9239. }
  9240. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9241. // Windows Schannel verification, which lets Windows fetch missing roots
  9242. // and intermediates on demand. It must not be skipped: unless a server
  9243. // certificate verifier is set, it is the only chain check.
  9244. if (options.windows_cert_verification) {
  9245. std::vector<unsigned char> der;
  9246. uint64_t wincrypt_error = 0;
  9247. if (!get_cert_der(server_cert, der) ||
  9248. !verify_cert_with_windows_schannel(
  9249. der, host, options.server_hostname_verification, wincrypt_error,
  9250. session)) {
  9251. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9252. }
  9253. }
  9254. #endif
  9255. }
  9256. return true;
  9257. }
  9258. } // namespace detail
  9259. #endif // CPPHTTPLIB_SSL_ENABLED
  9260. /*
  9261. * Group 3: httplib namespace - Non-SSL public API implementations
  9262. */
  9263. inline void default_socket_options(socket_t sock) {
  9264. set_socket_opt(sock, SOL_SOCKET,
  9265. #ifdef SO_REUSEPORT
  9266. SO_REUSEPORT,
  9267. #else
  9268. SO_REUSEADDR,
  9269. #endif
  9270. 1);
  9271. }
  9272. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9273. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9274. sizeof(optval));
  9275. }
  9276. inline std::string get_bearer_token_auth(const Request &req) {
  9277. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9278. // than the prefix carries no token.
  9279. constexpr const char bearer_prefix[] = "Bearer ";
  9280. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9281. auto value = req.get_header_value("Authorization");
  9282. if (value.size() >= bearer_prefix_len &&
  9283. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9284. bearer_prefix)) {
  9285. return value.substr(bearer_prefix_len);
  9286. }
  9287. return "";
  9288. }
  9289. inline const char *status_message(int status) {
  9290. switch (status) {
  9291. case StatusCode::Continue_100: return "Continue";
  9292. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9293. case StatusCode::Processing_102: return "Processing";
  9294. case StatusCode::EarlyHints_103: return "Early Hints";
  9295. case StatusCode::OK_200: return "OK";
  9296. case StatusCode::Created_201: return "Created";
  9297. case StatusCode::Accepted_202: return "Accepted";
  9298. case StatusCode::NonAuthoritativeInformation_203:
  9299. return "Non-Authoritative Information";
  9300. case StatusCode::NoContent_204: return "No Content";
  9301. case StatusCode::ResetContent_205: return "Reset Content";
  9302. case StatusCode::PartialContent_206: return "Partial Content";
  9303. case StatusCode::MultiStatus_207: return "Multi-Status";
  9304. case StatusCode::AlreadyReported_208: return "Already Reported";
  9305. case StatusCode::IMUsed_226: return "IM Used";
  9306. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9307. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9308. case StatusCode::Found_302: return "Found";
  9309. case StatusCode::SeeOther_303: return "See Other";
  9310. case StatusCode::NotModified_304: return "Not Modified";
  9311. case StatusCode::UseProxy_305: return "Use Proxy";
  9312. case StatusCode::unused_306: return "unused";
  9313. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9314. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9315. case StatusCode::BadRequest_400: return "Bad Request";
  9316. case StatusCode::Unauthorized_401: return "Unauthorized";
  9317. case StatusCode::PaymentRequired_402: return "Payment Required";
  9318. case StatusCode::Forbidden_403: return "Forbidden";
  9319. case StatusCode::NotFound_404: return "Not Found";
  9320. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9321. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9322. case StatusCode::ProxyAuthenticationRequired_407:
  9323. return "Proxy Authentication Required";
  9324. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9325. case StatusCode::Conflict_409: return "Conflict";
  9326. case StatusCode::Gone_410: return "Gone";
  9327. case StatusCode::LengthRequired_411: return "Length Required";
  9328. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9329. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9330. case StatusCode::UriTooLong_414: return "URI Too Long";
  9331. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9332. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9333. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9334. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9335. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9336. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9337. case StatusCode::Locked_423: return "Locked";
  9338. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9339. case StatusCode::TooEarly_425: return "Too Early";
  9340. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9341. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9342. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9343. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9344. return "Request Header Fields Too Large";
  9345. case StatusCode::UnavailableForLegalReasons_451:
  9346. return "Unavailable For Legal Reasons";
  9347. case StatusCode::NotImplemented_501: return "Not Implemented";
  9348. case StatusCode::BadGateway_502: return "Bad Gateway";
  9349. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9350. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9351. case StatusCode::HttpVersionNotSupported_505:
  9352. return "HTTP Version Not Supported";
  9353. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9354. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9355. case StatusCode::LoopDetected_508: return "Loop Detected";
  9356. case StatusCode::NotExtended_510: return "Not Extended";
  9357. case StatusCode::NetworkAuthenticationRequired_511:
  9358. return "Network Authentication Required";
  9359. default:
  9360. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9361. }
  9362. }
  9363. inline std::string to_string(const Error error) {
  9364. switch (error) {
  9365. case Error::Success: return "Success (no error)";
  9366. case Error::Unknown: return "Unknown";
  9367. case Error::Connection: return "Could not establish connection";
  9368. case Error::BindIPAddress: return "Failed to bind IP address";
  9369. case Error::Read: return "Failed to read connection";
  9370. case Error::Write: return "Failed to write connection";
  9371. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9372. case Error::Canceled: return "Connection handling canceled";
  9373. case Error::SSLConnection: return "SSL connection failed";
  9374. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9375. case Error::SSLServerVerification: return "SSL server verification failed";
  9376. case Error::SSLServerHostnameVerification:
  9377. return "SSL server hostname verification failed";
  9378. case Error::UnsupportedMultipartBoundaryChars:
  9379. return "Unsupported HTTP multipart boundary characters";
  9380. case Error::Compression: return "Compression failed";
  9381. case Error::ConnectionTimeout: return "Connection timed out";
  9382. case Error::ProxyConnection: return "Proxy connection failed";
  9383. case Error::ConnectionClosed: return "Connection closed by server";
  9384. case Error::Timeout: return "Read timeout";
  9385. case Error::ResourceExhaustion: return "Resource exhaustion";
  9386. case Error::TooManyFormDataFiles: return "Too many form data files";
  9387. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9388. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9389. case Error::ExceedMaxSocketDescriptorCount:
  9390. return "Exceeded maximum socket descriptor count";
  9391. case Error::InvalidRequestLine: return "Invalid request line";
  9392. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9393. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9394. case Error::InvalidHeaders: return "Invalid headers";
  9395. case Error::MultipartParsing: return "Multipart parsing failed";
  9396. case Error::OpenFile: return "Failed to open file";
  9397. case Error::Listen: return "Failed to listen on socket";
  9398. case Error::GetSockName: return "Failed to get socket name";
  9399. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9400. case Error::HTTPParsing: return "HTTP parsing failed";
  9401. case Error::InvalidRangeHeader: return "Invalid Range header";
  9402. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9403. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9404. case Error::UserCallbackException: return "User callback threw an exception";
  9405. default: break;
  9406. }
  9407. return "Invalid";
  9408. }
  9409. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9410. os << to_string(obj);
  9411. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9412. return os;
  9413. }
  9414. inline std::string hosted_at(const std::string &hostname) {
  9415. std::vector<std::string> addrs;
  9416. hosted_at(hostname, addrs);
  9417. if (addrs.empty()) { return std::string(); }
  9418. return addrs[0];
  9419. }
  9420. inline void hosted_at(const std::string &hostname,
  9421. std::vector<std::string> &addrs) {
  9422. struct addrinfo hints;
  9423. struct addrinfo *result;
  9424. memset(&hints, 0, sizeof(struct addrinfo));
  9425. hints.ai_family = AF_UNSPEC;
  9426. hints.ai_socktype = SOCK_STREAM;
  9427. hints.ai_protocol = 0;
  9428. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9429. &result, 0)) {
  9430. #if defined __linux__ && !defined __ANDROID__
  9431. res_init();
  9432. #endif
  9433. return;
  9434. }
  9435. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9436. for (auto rp = result; rp; rp = rp->ai_next) {
  9437. const auto &addr =
  9438. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9439. std::string ip;
  9440. auto dummy = -1;
  9441. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9442. dummy)) {
  9443. addrs.emplace_back(std::move(ip));
  9444. }
  9445. }
  9446. }
  9447. inline std::string encode_uri_component(const std::string &value) {
  9448. std::ostringstream escaped;
  9449. escaped.fill('0');
  9450. escaped << std::hex;
  9451. for (auto c : value) {
  9452. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9453. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9454. escaped << c;
  9455. } else {
  9456. escaped << std::uppercase;
  9457. escaped << '%' << std::setw(2)
  9458. << static_cast<int>(static_cast<unsigned char>(c));
  9459. escaped << std::nouppercase;
  9460. }
  9461. }
  9462. return escaped.str();
  9463. }
  9464. inline std::string encode_uri(const std::string &value) {
  9465. std::ostringstream escaped;
  9466. escaped.fill('0');
  9467. escaped << std::hex;
  9468. for (auto c : value) {
  9469. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9470. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9471. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9472. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9473. escaped << c;
  9474. } else {
  9475. escaped << std::uppercase;
  9476. escaped << '%' << std::setw(2)
  9477. << static_cast<int>(static_cast<unsigned char>(c));
  9478. escaped << std::nouppercase;
  9479. }
  9480. }
  9481. return escaped.str();
  9482. }
  9483. inline std::string decode_uri_component(const std::string &value) {
  9484. std::string result;
  9485. for (size_t i = 0; i < value.size(); i++) {
  9486. if (value[i] == '%' && i + 2 < value.size()) {
  9487. auto val = 0;
  9488. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9489. result += static_cast<char>(val);
  9490. i += 2;
  9491. } else {
  9492. result += value[i];
  9493. }
  9494. } else {
  9495. result += value[i];
  9496. }
  9497. }
  9498. return result;
  9499. }
  9500. inline std::string decode_uri(const std::string &value) {
  9501. std::string result;
  9502. for (size_t i = 0; i < value.size(); i++) {
  9503. if (value[i] == '%' && i + 2 < value.size()) {
  9504. auto val = 0;
  9505. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9506. auto c = static_cast<char>(val);
  9507. // Keep escapes of the reserved characters that encode_uri leaves
  9508. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9509. // delimiter is not promoted into a real one (as with JS decodeURI).
  9510. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9511. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9512. c == '#') {
  9513. result += value[i];
  9514. result += value[i + 1];
  9515. result += value[i + 2];
  9516. } else {
  9517. result += c;
  9518. }
  9519. i += 2;
  9520. } else {
  9521. result += value[i];
  9522. }
  9523. } else {
  9524. result += value[i];
  9525. }
  9526. }
  9527. return result;
  9528. }
  9529. inline std::string encode_path_component(const std::string &component) {
  9530. std::string result;
  9531. result.reserve(component.size() * 3);
  9532. for (size_t i = 0; i < component.size(); i++) {
  9533. auto c = static_cast<unsigned char>(component[i]);
  9534. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9535. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9536. c == '_' || c == '~') {
  9537. result += static_cast<char>(c);
  9538. }
  9539. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9540. // "," / ";" / "="
  9541. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9542. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9543. c == '=') {
  9544. result += static_cast<char>(c);
  9545. }
  9546. // Colon is allowed in path segments except first segment
  9547. else if (c == ':') {
  9548. result += static_cast<char>(c);
  9549. }
  9550. // @ is allowed in path
  9551. else if (c == '@') {
  9552. result += static_cast<char>(c);
  9553. } else {
  9554. result += '%';
  9555. char hex[3];
  9556. snprintf(hex, sizeof(hex), "%02X", c);
  9557. result.append(hex, 2);
  9558. }
  9559. }
  9560. return result;
  9561. }
  9562. inline std::string decode_path_component(const std::string &component) {
  9563. std::string result;
  9564. result.reserve(component.size());
  9565. for (size_t i = 0; i < component.size(); i++) {
  9566. if (component[i] == '%' && i + 1 < component.size()) {
  9567. if (component[i + 1] == 'u') {
  9568. // Unicode %uXXXX encoding
  9569. auto val = 0;
  9570. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9571. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9572. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9573. char buff[4];
  9574. size_t len = detail::to_utf8(val, buff);
  9575. if (len > 0) { result.append(buff, len); }
  9576. i += 5; // 'u0000'
  9577. } else {
  9578. result += component[i];
  9579. }
  9580. } else {
  9581. // Standard %XX encoding
  9582. auto val = 0;
  9583. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9584. // 2 digits hex codes
  9585. result += static_cast<char>(val);
  9586. i += 2; // 'XX'
  9587. } else {
  9588. result += component[i];
  9589. }
  9590. }
  9591. } else {
  9592. result += component[i];
  9593. }
  9594. }
  9595. return result;
  9596. }
  9597. inline std::string encode_query_component(const std::string &component,
  9598. bool space_as_plus) {
  9599. std::string result;
  9600. result.reserve(component.size() * 3);
  9601. for (size_t i = 0; i < component.size(); i++) {
  9602. auto c = static_cast<unsigned char>(component[i]);
  9603. // Unreserved characters per RFC 3986
  9604. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9605. c == '_' || c == '~') {
  9606. result += static_cast<char>(c);
  9607. }
  9608. // Space handling
  9609. else if (c == ' ') {
  9610. if (space_as_plus) {
  9611. result += '+';
  9612. } else {
  9613. result += "%20";
  9614. }
  9615. }
  9616. // Plus sign handling
  9617. else if (c == '+') {
  9618. if (space_as_plus) {
  9619. result += "%2B";
  9620. } else {
  9621. result += static_cast<char>(c);
  9622. }
  9623. }
  9624. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9625. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9626. c == '*' || c == ',' || c == ';') {
  9627. result += static_cast<char>(c);
  9628. }
  9629. // Colon and @ are allowed in query
  9630. else if (c == ':' || c == '@') {
  9631. result += static_cast<char>(c);
  9632. }
  9633. // Forward slash is allowed in query values
  9634. else if (c == '/') {
  9635. result += static_cast<char>(c);
  9636. }
  9637. // Question mark is allowed in query values (after first ?)
  9638. else if (c == '?') {
  9639. result += static_cast<char>(c);
  9640. } else {
  9641. result += '%';
  9642. char hex[3];
  9643. snprintf(hex, sizeof(hex), "%02X", c);
  9644. result.append(hex, 2);
  9645. }
  9646. }
  9647. return result;
  9648. }
  9649. inline std::string decode_query_component(const std::string &component,
  9650. bool plus_as_space) {
  9651. std::string result;
  9652. result.reserve(component.size());
  9653. for (size_t i = 0; i < component.size(); i++) {
  9654. if (component[i] == '%' && i + 2 < component.size()) {
  9655. auto val = 0;
  9656. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9657. result += static_cast<char>(val);
  9658. i += 2;
  9659. } else {
  9660. result += component[i];
  9661. }
  9662. } else if (component[i] == '+' && plus_as_space) {
  9663. result += ' '; // + becomes space in form-urlencoded
  9664. } else {
  9665. result += component[i];
  9666. }
  9667. }
  9668. return result;
  9669. }
  9670. inline std::string sanitize_filename(const std::string &filename) {
  9671. // Extract basename: find the last path separator (/ or \)
  9672. auto pos = filename.find_last_of("/\\");
  9673. auto result =
  9674. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9675. // Strip null bytes
  9676. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9677. // Trim whitespace
  9678. {
  9679. auto start = result.find_first_not_of(" \t");
  9680. auto end = result.find_last_not_of(" \t");
  9681. result = (start == std::string::npos)
  9682. ? ""
  9683. : result.substr(start, end - start + 1);
  9684. }
  9685. // Reject . and ..
  9686. if (result == "." || result == "..") { return ""; }
  9687. return result;
  9688. }
  9689. inline std::string append_query_params(const std::string &path,
  9690. const Params &params) {
  9691. std::string path_with_query = path;
  9692. thread_local const std::regex re("[^?]+\\?.*");
  9693. auto delm = std::regex_match(path, re) ? '&' : '?';
  9694. path_with_query += delm + detail::params_to_query_str(params);
  9695. return path_with_query;
  9696. }
  9697. // Header utilities
  9698. inline std::pair<std::string, std::string>
  9699. make_range_header(const Ranges &ranges) {
  9700. std::string field = "bytes=";
  9701. auto i = 0;
  9702. for (const auto &r : ranges) {
  9703. if (i != 0) { field += ", "; }
  9704. if (r.first != -1) { field += std::to_string(r.first); }
  9705. field += '-';
  9706. if (r.second != -1) { field += std::to_string(r.second); }
  9707. i++;
  9708. }
  9709. return std::make_pair("Range", std::move(field));
  9710. }
  9711. inline std::pair<std::string, std::string>
  9712. make_basic_authentication_header(const std::string &username,
  9713. const std::string &password, bool is_proxy) {
  9714. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9715. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9716. return std::make_pair(key, std::move(field));
  9717. }
  9718. inline std::pair<std::string, std::string>
  9719. make_bearer_token_authentication_header(const std::string &token,
  9720. bool is_proxy = false) {
  9721. auto field = "Bearer " + token;
  9722. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9723. return std::make_pair(key, std::move(field));
  9724. }
  9725. // Request implementation
  9726. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9727. size_t id) const {
  9728. return detail::get_header_value_u64(headers, key, def, id);
  9729. }
  9730. inline bool Request::has_header(const std::string &key) const {
  9731. return detail::has_header(headers, key);
  9732. }
  9733. inline std::string Request::get_header_value(const std::string &key,
  9734. const char *def, size_t id) const {
  9735. return detail::get_header_value(headers, key, def, id);
  9736. }
  9737. inline size_t Request::get_header_value_count(const std::string &key) const {
  9738. return detail::get_header_value_count(headers, key);
  9739. }
  9740. inline void Request::set_header(const std::string &key,
  9741. const std::string &val) {
  9742. detail::set_header(headers, key, val);
  9743. }
  9744. inline bool Request::has_trailer(const std::string &key) const {
  9745. return trailers.find(key) != trailers.end();
  9746. }
  9747. inline std::string Request::get_trailer_value(const std::string &key,
  9748. size_t id) const {
  9749. return detail::get_multimap_value(trailers, key, id);
  9750. }
  9751. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9752. return trailers.count(key);
  9753. }
  9754. inline bool Request::has_param(const std::string &key) const {
  9755. return params.find(key) != params.end();
  9756. }
  9757. inline std::string Request::get_param_value(const std::string &key,
  9758. size_t id) const {
  9759. return detail::get_multimap_value(params, key, id);
  9760. }
  9761. inline std::vector<std::string>
  9762. Request::get_param_values(const std::string &key) const {
  9763. auto rng = params.equal_range(key);
  9764. std::vector<std::string> values;
  9765. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9766. for (auto it = rng.first; it != rng.second; ++it) {
  9767. values.push_back(it->second);
  9768. }
  9769. return values;
  9770. }
  9771. inline size_t Request::get_param_value_count(const std::string &key) const {
  9772. return params.count(key);
  9773. }
  9774. inline bool Request::is_multipart_form_data() const {
  9775. const auto &content_type = get_header_value("Content-Type");
  9776. return detail::extract_media_type(content_type) == "multipart/form-data";
  9777. }
  9778. // Multipart FormData implementation
  9779. inline std::string MultipartFormData::get_field(const std::string &key,
  9780. size_t id) const {
  9781. auto rng = fields.equal_range(key);
  9782. auto it = rng.first;
  9783. std::advance(it, static_cast<ssize_t>(id));
  9784. if (it != rng.second) { return it->second.content; }
  9785. return std::string();
  9786. }
  9787. inline std::vector<std::string>
  9788. MultipartFormData::get_fields(const std::string &key) const {
  9789. std::vector<std::string> values;
  9790. auto rng = fields.equal_range(key);
  9791. for (auto it = rng.first; it != rng.second; it++) {
  9792. values.push_back(it->second.content);
  9793. }
  9794. return values;
  9795. }
  9796. inline bool MultipartFormData::has_field(const std::string &key) const {
  9797. return fields.find(key) != fields.end();
  9798. }
  9799. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9800. return fields.count(key);
  9801. }
  9802. inline FormData MultipartFormData::get_file(const std::string &key,
  9803. size_t id) const {
  9804. return detail::get_multimap_value(files, key, id);
  9805. }
  9806. inline std::vector<FormData>
  9807. MultipartFormData::get_files(const std::string &key) const {
  9808. std::vector<FormData> values;
  9809. auto rng = files.equal_range(key);
  9810. for (auto it = rng.first; it != rng.second; it++) {
  9811. values.push_back(it->second);
  9812. }
  9813. return values;
  9814. }
  9815. inline bool MultipartFormData::has_file(const std::string &key) const {
  9816. return files.find(key) != files.end();
  9817. }
  9818. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9819. return files.count(key);
  9820. }
  9821. // Multipart FormData writer implementation
  9822. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9823. return detail::is_multipart_boundary_chars_valid(boundary);
  9824. }
  9825. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9826. : boundary_(detail::make_multipart_data_boundary()) {}
  9827. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9828. : boundary_(std::move(boundary)) {}
  9829. inline const std::string &MultipartFormDataWriter::boundary() const {
  9830. return boundary_;
  9831. }
  9832. inline std::string MultipartFormDataWriter::content_type() const {
  9833. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9834. }
  9835. inline std::string
  9836. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9837. return detail::serialize_multipart_formdata(items, boundary_);
  9838. }
  9839. inline size_t MultipartFormDataWriter::content_length(
  9840. const UploadFormDataItems &items) const {
  9841. return detail::get_multipart_content_length(items, boundary_);
  9842. }
  9843. inline std::string
  9844. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9845. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9846. }
  9847. inline std::string MultipartFormDataWriter::item_end() {
  9848. return detail::serialize_multipart_formdata_item_end();
  9849. }
  9850. inline std::string MultipartFormDataWriter::finish() const {
  9851. return detail::serialize_multipart_formdata_finish(boundary_);
  9852. }
  9853. // Response implementation
  9854. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9855. size_t id) const {
  9856. return detail::get_header_value_u64(headers, key, def, id);
  9857. }
  9858. inline bool Response::has_header(const std::string &key) const {
  9859. return headers.find(key) != headers.end();
  9860. }
  9861. inline std::string Response::get_header_value(const std::string &key,
  9862. const char *def,
  9863. size_t id) const {
  9864. return detail::get_header_value(headers, key, def, id);
  9865. }
  9866. inline size_t Response::get_header_value_count(const std::string &key) const {
  9867. return detail::get_header_value_count(headers, key);
  9868. }
  9869. inline void Response::set_header(const std::string &key,
  9870. const std::string &val) {
  9871. detail::set_header(headers, key, val);
  9872. }
  9873. inline bool Response::has_trailer(const std::string &key) const {
  9874. return trailers.find(key) != trailers.end();
  9875. }
  9876. inline std::string Response::get_trailer_value(const std::string &key,
  9877. size_t id) const {
  9878. return detail::get_multimap_value(trailers, key, id);
  9879. }
  9880. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9881. return trailers.count(key);
  9882. }
  9883. inline void Response::set_redirect(const std::string &url, int stat) {
  9884. if (detail::fields::is_field_value(url)) {
  9885. set_header("Location", url);
  9886. if (300 <= stat && stat < 400) {
  9887. this->status = stat;
  9888. } else {
  9889. this->status = StatusCode::Found_302;
  9890. }
  9891. }
  9892. }
  9893. inline void Response::set_content(const char *s, size_t n,
  9894. const std::string &content_type) {
  9895. body.assign(s, n);
  9896. auto rng = headers.equal_range("Content-Type");
  9897. headers.erase(rng.first, rng.second);
  9898. set_header("Content-Type", content_type);
  9899. content_coding_ = detail::EncodingType::None;
  9900. }
  9901. inline void Response::set_content(const std::string &s,
  9902. const std::string &content_type) {
  9903. set_content(s.data(), s.size(), content_type);
  9904. }
  9905. inline void Response::set_content(std::string &&s,
  9906. const std::string &content_type) {
  9907. body = std::move(s);
  9908. auto rng = headers.equal_range("Content-Type");
  9909. headers.erase(rng.first, rng.second);
  9910. set_header("Content-Type", content_type);
  9911. content_coding_ = detail::EncodingType::None;
  9912. }
  9913. inline void Response::set_content_provider(
  9914. size_t in_length, const std::string &content_type, ContentProvider provider,
  9915. ContentProviderResourceReleaser resource_releaser) {
  9916. set_header("Content-Type", content_type);
  9917. content_length_ = in_length;
  9918. if (in_length > 0) { content_provider_ = std::move(provider); }
  9919. content_provider_resource_releaser_ = std::move(resource_releaser);
  9920. is_chunked_content_provider_ = false;
  9921. is_file_content_provider_ = false;
  9922. content_coding_ = detail::EncodingType::None;
  9923. }
  9924. inline void Response::set_content_provider(
  9925. const std::string &content_type, ContentProviderWithoutLength provider,
  9926. ContentProviderResourceReleaser resource_releaser) {
  9927. set_header("Content-Type", content_type);
  9928. content_length_ = 0;
  9929. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9930. content_provider_resource_releaser_ = std::move(resource_releaser);
  9931. is_chunked_content_provider_ = false;
  9932. is_file_content_provider_ = false;
  9933. content_coding_ = detail::EncodingType::None;
  9934. }
  9935. inline void Response::set_chunked_content_provider(
  9936. const std::string &content_type, ContentProviderWithoutLength provider,
  9937. ContentProviderResourceReleaser resource_releaser) {
  9938. set_header("Content-Type", content_type);
  9939. content_length_ = 0;
  9940. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9941. content_provider_resource_releaser_ = std::move(resource_releaser);
  9942. is_chunked_content_provider_ = true;
  9943. is_file_content_provider_ = false;
  9944. content_coding_ = detail::EncodingType::None;
  9945. }
  9946. inline void Response::set_file_content(const std::string &path,
  9947. const std::string &content_type) {
  9948. file_content_path_ = path;
  9949. file_content_content_type_ = content_type;
  9950. }
  9951. inline void Response::set_file_content(const std::string &path) {
  9952. file_content_path_ = path;
  9953. }
  9954. // Result implementation
  9955. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9956. size_t def,
  9957. size_t id) const {
  9958. return detail::get_header_value_u64(request_headers_, key, def, id);
  9959. }
  9960. inline bool Result::has_request_header(const std::string &key) const {
  9961. return request_headers_.find(key) != request_headers_.end();
  9962. }
  9963. inline std::string Result::get_request_header_value(const std::string &key,
  9964. const char *def,
  9965. size_t id) const {
  9966. return detail::get_header_value(request_headers_, key, def, id);
  9967. }
  9968. inline size_t
  9969. Result::get_request_header_value_count(const std::string &key) const {
  9970. return request_headers_.count(key);
  9971. }
  9972. // Stream implementation
  9973. inline ssize_t Stream::write(const char *ptr) {
  9974. return write(ptr, strlen(ptr));
  9975. }
  9976. inline ssize_t Stream::write(const std::string &s) {
  9977. return write(s.data(), s.size());
  9978. }
  9979. // BodyReader implementation
  9980. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9981. if (!stream) {
  9982. last_error = Error::Connection;
  9983. return -1;
  9984. }
  9985. if (eof) { return 0; }
  9986. if (!chunked) {
  9987. // Content-Length based reading
  9988. if (has_content_length && bytes_read >= content_length) {
  9989. eof = true;
  9990. return 0;
  9991. }
  9992. auto to_read = len;
  9993. if (has_content_length) {
  9994. auto remaining = content_length - bytes_read;
  9995. to_read = (std::min)(len, remaining);
  9996. }
  9997. auto n = stream->read(buf, to_read);
  9998. if (n < 0) {
  9999. last_error = stream->get_error();
  10000. if (last_error == Error::Success) { last_error = Error::Read; }
  10001. eof = true;
  10002. return n;
  10003. }
  10004. if (n == 0) {
  10005. // Unexpected EOF before content_length
  10006. last_error = stream->get_error();
  10007. if (last_error == Error::Success) { last_error = Error::Read; }
  10008. eof = true;
  10009. return 0;
  10010. }
  10011. bytes_read += static_cast<size_t>(n);
  10012. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10013. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10014. last_error = Error::ExceedMaxPayloadSize;
  10015. eof = true;
  10016. return -1;
  10017. }
  10018. return n;
  10019. }
  10020. // Chunked transfer encoding: delegate to shared decoder instance.
  10021. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10022. size_t chunk_offset = 0;
  10023. size_t chunk_total = 0;
  10024. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10025. if (n < 0) {
  10026. last_error = stream->get_error();
  10027. if (last_error == Error::Success) { last_error = Error::Read; }
  10028. eof = true;
  10029. return n;
  10030. }
  10031. if (n == 0) {
  10032. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10033. eof = true;
  10034. return 0;
  10035. }
  10036. bytes_read += static_cast<size_t>(n);
  10037. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10038. last_error = Error::ExceedMaxPayloadSize;
  10039. eof = true;
  10040. return -1;
  10041. }
  10042. return n;
  10043. }
  10044. // ThreadPool implementation
  10045. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10046. time_t idle_timeout_sec)
  10047. : base_thread_count_(n), max_queued_requests_(mqr),
  10048. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10049. shutdown_(false) {
  10050. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10051. if (max_n != 0 && max_n < n) {
  10052. std::string msg = "max_threads must be >= base_threads";
  10053. throw std::invalid_argument(msg);
  10054. }
  10055. #endif
  10056. max_thread_count_ = max_n == 0 ? n : max_n;
  10057. threads_.reserve(base_thread_count_);
  10058. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10059. try {
  10060. #endif
  10061. for (size_t i = 0; i < base_thread_count_; i++) {
  10062. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10063. }
  10064. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10065. } catch (...) {
  10066. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10067. // signal the workers we already spawned to exit and join them so the
  10068. // vector destructor does not see joinable threads (which would call
  10069. // std::terminate). Then rethrow so the caller learns of the failure.
  10070. {
  10071. std::unique_lock<std::mutex> lock(mutex_);
  10072. shutdown_ = true;
  10073. }
  10074. cond_.notify_all();
  10075. for (auto &t : threads_) {
  10076. if (t.joinable()) { t.join(); }
  10077. }
  10078. throw;
  10079. }
  10080. #endif
  10081. }
  10082. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10083. {
  10084. std::unique_lock<std::mutex> lock(mutex_);
  10085. if (shutdown_) { return false; }
  10086. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10087. return false;
  10088. }
  10089. jobs_.push_back(std::move(fn));
  10090. // Spawn a dynamic thread if no idle threads and under max
  10091. if (idle_thread_count_ == 0 &&
  10092. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10093. cleanup_finished_threads();
  10094. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10095. }
  10096. }
  10097. cond_.notify_one();
  10098. return true;
  10099. }
  10100. inline void ThreadPool::shutdown() {
  10101. {
  10102. std::unique_lock<std::mutex> lock(mutex_);
  10103. shutdown_ = true;
  10104. }
  10105. cond_.notify_all();
  10106. for (auto &t : threads_) {
  10107. if (t.joinable()) { t.join(); }
  10108. }
  10109. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10110. // with worker threads that call move_to_finished() concurrently.
  10111. std::list<std::thread> remaining_dynamic;
  10112. {
  10113. std::unique_lock<std::mutex> lock(mutex_);
  10114. remaining_dynamic = std::move(dynamic_threads_);
  10115. }
  10116. for (auto &t : remaining_dynamic) {
  10117. if (t.joinable()) { t.join(); }
  10118. }
  10119. std::unique_lock<std::mutex> lock(mutex_);
  10120. cleanup_finished_threads();
  10121. }
  10122. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10123. // Must be called with mutex_ held
  10124. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10125. if (it->get_id() == id) {
  10126. finished_threads_.push_back(std::move(*it));
  10127. dynamic_threads_.erase(it);
  10128. return;
  10129. }
  10130. }
  10131. }
  10132. inline void ThreadPool::cleanup_finished_threads() {
  10133. // Must be called with mutex_ held
  10134. for (auto &t : finished_threads_) {
  10135. if (t.joinable()) { t.join(); }
  10136. }
  10137. finished_threads_.clear();
  10138. }
  10139. inline void ThreadPool::worker(bool is_dynamic) {
  10140. for (;;) {
  10141. std::function<void()> fn;
  10142. {
  10143. std::unique_lock<std::mutex> lock(mutex_);
  10144. idle_thread_count_++;
  10145. if (is_dynamic) {
  10146. auto has_work =
  10147. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10148. [&] { return !jobs_.empty() || shutdown_; });
  10149. if (!has_work) {
  10150. // Timed out with no work - exit this dynamic thread
  10151. idle_thread_count_--;
  10152. move_to_finished(std::this_thread::get_id());
  10153. break;
  10154. }
  10155. } else {
  10156. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10157. }
  10158. idle_thread_count_--;
  10159. if (shutdown_ && jobs_.empty()) { break; }
  10160. fn = std::move(jobs_.front());
  10161. jobs_.pop_front();
  10162. }
  10163. assert(true == static_cast<bool>(fn));
  10164. fn();
  10165. }
  10166. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10167. !defined(LIBRESSL_VERSION_NUMBER)
  10168. OPENSSL_thread_stop();
  10169. #endif
  10170. }
  10171. /*
  10172. * Group 1 (continued): detail namespace - Stream implementations
  10173. */
  10174. namespace detail {
  10175. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10176. time_t timeout_sec, time_t timeout_usec,
  10177. time_t &actual_timeout_sec,
  10178. time_t &actual_timeout_usec) {
  10179. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10180. auto actual_timeout_msec =
  10181. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10182. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10183. actual_timeout_sec = actual_timeout_msec / 1000;
  10184. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10185. }
  10186. // Socket stream implementation
  10187. inline SocketStream::SocketStream(
  10188. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10189. time_t write_timeout_sec, time_t write_timeout_usec,
  10190. time_t max_timeout_msec,
  10191. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10192. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10193. read_timeout_usec_(read_timeout_usec),
  10194. write_timeout_sec_(write_timeout_sec),
  10195. write_timeout_usec_(write_timeout_usec),
  10196. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10197. read_buff_(read_buff_size_, 0) {}
  10198. inline SocketStream::~SocketStream() = default;
  10199. inline bool SocketStream::is_readable() const {
  10200. return read_buff_off_ < read_buff_content_size_;
  10201. }
  10202. inline bool SocketStream::wait_readable() const {
  10203. if (max_timeout_msec_ <= 0) {
  10204. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10205. }
  10206. time_t read_timeout_sec;
  10207. time_t read_timeout_usec;
  10208. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10209. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10210. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10211. }
  10212. inline bool SocketStream::wait_writable() const {
  10213. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10214. }
  10215. inline bool SocketStream::ensure_readable() {
  10216. if (readable_hint_) {
  10217. readable_hint_ = false;
  10218. return true;
  10219. }
  10220. return wait_readable();
  10221. }
  10222. inline const char *SocketStream::buffered_data(size_t &size) const {
  10223. size = read_buff_content_size_ - read_buff_off_;
  10224. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10225. }
  10226. inline void SocketStream::consume_buffered(size_t size) {
  10227. assert(size <= read_buff_content_size_ - read_buff_off_);
  10228. read_buff_off_ += size;
  10229. }
  10230. inline bool SocketStream::is_peer_alive() const {
  10231. return detail::is_socket_alive(sock_);
  10232. }
  10233. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10234. #ifdef _WIN32
  10235. size =
  10236. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10237. #else
  10238. size = (std::min)(size,
  10239. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10240. #endif
  10241. if (read_buff_off_ < read_buff_content_size_) {
  10242. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10243. if (size <= remaining_size) {
  10244. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10245. read_buff_off_ += size;
  10246. return static_cast<ssize_t>(size);
  10247. } else {
  10248. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10249. read_buff_off_ += remaining_size;
  10250. return static_cast<ssize_t>(remaining_size);
  10251. }
  10252. }
  10253. if (!ensure_readable()) {
  10254. error_ = Error::Timeout;
  10255. return -1;
  10256. }
  10257. read_buff_off_ = 0;
  10258. read_buff_content_size_ = 0;
  10259. if (size < read_buff_size_) {
  10260. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10261. CPPHTTPLIB_RECV_FLAGS);
  10262. if (n <= 0) {
  10263. if (n == 0) {
  10264. error_ = Error::ConnectionClosed;
  10265. } else {
  10266. error_ = Error::Read;
  10267. }
  10268. return n;
  10269. } else if (n <= static_cast<ssize_t>(size)) {
  10270. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10271. return n;
  10272. } else {
  10273. memcpy(ptr, read_buff_.data(), size);
  10274. read_buff_off_ = size;
  10275. read_buff_content_size_ = static_cast<size_t>(n);
  10276. return static_cast<ssize_t>(size);
  10277. }
  10278. } else {
  10279. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10280. if (n <= 0) {
  10281. if (n == 0) {
  10282. error_ = Error::ConnectionClosed;
  10283. } else {
  10284. error_ = Error::Read;
  10285. }
  10286. }
  10287. return n;
  10288. }
  10289. }
  10290. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10291. if (!wait_writable()) { return -1; }
  10292. #if defined(_WIN32) && !defined(_WIN64)
  10293. size =
  10294. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10295. #endif
  10296. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10297. }
  10298. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10299. int &port) const {
  10300. return detail::get_remote_ip_and_port(sock_, ip, port);
  10301. }
  10302. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10303. int &port) const {
  10304. return detail::get_local_ip_and_port(sock_, ip, port);
  10305. }
  10306. inline socket_t SocketStream::socket() const { return sock_; }
  10307. inline time_t SocketStream::duration() const {
  10308. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10309. std::chrono::steady_clock::now() - start_time_)
  10310. .count();
  10311. }
  10312. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10313. read_timeout_sec_ = sec;
  10314. read_timeout_usec_ = usec;
  10315. }
  10316. // Buffer stream implementation
  10317. inline bool BufferStream::is_readable() const { return true; }
  10318. inline bool BufferStream::wait_readable() const { return true; }
  10319. inline bool BufferStream::wait_writable() const { return true; }
  10320. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10321. #if defined(_MSC_VER) && _MSC_VER < 1910
  10322. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10323. #else
  10324. auto len_read = buffer.copy(ptr, size, position);
  10325. #endif
  10326. position += static_cast<size_t>(len_read);
  10327. return static_cast<ssize_t>(len_read);
  10328. }
  10329. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10330. buffer.append(ptr, size);
  10331. return static_cast<ssize_t>(size);
  10332. }
  10333. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10334. int & /*port*/) const {}
  10335. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10336. int & /*port*/) const {}
  10337. inline socket_t BufferStream::socket() const { return 0; }
  10338. inline time_t BufferStream::duration() const { return 0; }
  10339. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10340. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10341. : MatcherBase(pattern) {
  10342. constexpr const char marker[] = "/:";
  10343. // One past the last ending position of a path param substring
  10344. std::size_t last_param_end = 0;
  10345. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10346. // Needed to ensure that parameter names are unique during matcher
  10347. // construction
  10348. // If exceptions are disabled, only last duplicate path
  10349. // parameter will be set
  10350. std::unordered_set<std::string> param_name_set;
  10351. #endif
  10352. while (true) {
  10353. const auto marker_pos = pattern.find(
  10354. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10355. if (marker_pos == std::string::npos) { break; }
  10356. static_fragments_.push_back(
  10357. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10358. const auto param_name_start = marker_pos + str_len(marker);
  10359. auto sep_pos = pattern.find(separator, param_name_start);
  10360. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10361. auto param_name =
  10362. pattern.substr(param_name_start, sep_pos - param_name_start);
  10363. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10364. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10365. std::string msg = "Encountered path parameter '" + param_name +
  10366. "' multiple times in route pattern '" + pattern + "'.";
  10367. throw std::invalid_argument(msg);
  10368. }
  10369. #endif
  10370. param_names_.push_back(std::move(param_name));
  10371. last_param_end = sep_pos + 1;
  10372. }
  10373. if (last_param_end < pattern.length()) {
  10374. static_fragments_.push_back(pattern.substr(last_param_end));
  10375. }
  10376. }
  10377. inline bool PathParamsMatcher::match(Request &request) const {
  10378. request.matches = std::smatch();
  10379. request.path_params.clear();
  10380. // A pattern without parameters is just a literal path to compare against
  10381. if (param_names_.empty()) { return request.path == pattern(); }
  10382. request.path_params.reserve(param_names_.size());
  10383. // One past the position at which the path matched the pattern last time
  10384. std::size_t starting_pos = 0;
  10385. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10386. const auto &fragment = static_fragments_[i];
  10387. if (starting_pos + fragment.length() > request.path.length()) {
  10388. return false;
  10389. }
  10390. // Avoid unnecessary allocation by using strncmp instead of substr +
  10391. // comparison
  10392. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10393. fragment.length()) != 0) {
  10394. return false;
  10395. }
  10396. starting_pos += fragment.length();
  10397. // Should only happen when we have a static fragment after a param
  10398. // Example: '/users/:id/subscriptions'
  10399. // The 'subscriptions' fragment here does not have a corresponding param
  10400. if (i >= param_names_.size()) { continue; }
  10401. auto sep_pos = request.path.find(separator, starting_pos);
  10402. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10403. const auto &param_name = param_names_[i];
  10404. request.path_params.emplace(
  10405. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10406. // Mark everything up to '/' as matched
  10407. starting_pos = sep_pos + 1;
  10408. }
  10409. // Returns false if the path is longer than the pattern
  10410. return starting_pos >= request.path.length();
  10411. }
  10412. inline bool RegexMatcher::match(Request &request) const {
  10413. request.path_params.clear();
  10414. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10415. // a non-match rather than risking a stack overflow in std::regex_match.
  10416. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10417. return false;
  10418. }
  10419. return std::regex_match(request.path, request.matches, regex_);
  10420. }
  10421. // Enclose IPv6 address in brackets if needed
  10422. inline std::string prepare_host_string(const std::string &host) {
  10423. // Enclose IPv6 address in brackets (but not if already enclosed)
  10424. if (host.find(':') == std::string::npos ||
  10425. (!host.empty() && host[0] == '[')) {
  10426. // IPv4, hostname, or already bracketed IPv6
  10427. return host;
  10428. } else {
  10429. // IPv6 address without brackets
  10430. return "[" + host + "]";
  10431. }
  10432. }
  10433. inline std::string make_host_and_port_string(const std::string &host, int port,
  10434. bool is_ssl) {
  10435. auto result = prepare_host_string(host);
  10436. // Append port if not default
  10437. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10438. ; // do nothing
  10439. } else {
  10440. result += ":" + std::to_string(port);
  10441. }
  10442. return result;
  10443. }
  10444. // Create "host:port" string always including port number (for CONNECT method)
  10445. inline std::string
  10446. make_host_and_port_string_always_port(const std::string &host, int port) {
  10447. return prepare_host_string(host) + ":" + std::to_string(port);
  10448. }
  10449. // Value for the Host header a client sends when the caller supplied none.
  10450. // Only the value: callers decide where in their header list it goes.
  10451. inline std::string make_default_host_header_value(const std::string &host,
  10452. int port, bool is_ssl,
  10453. int address_family) {
  10454. if (address_family == AF_UNIX) { return "localhost"; }
  10455. return make_host_and_port_string(host, port, is_ssl);
  10456. }
  10457. inline void add_default_user_agent_header(Request &req) {
  10458. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10459. if (!req.has_header("User-Agent")) {
  10460. req.set_header("User-Agent",
  10461. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10462. }
  10463. #else
  10464. (void)req;
  10465. #endif
  10466. }
  10467. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10468. NormalizedTarget normalize_target(const std::string &host);
  10469. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10470. bool host_matches_no_proxy(const NormalizedTarget &target,
  10471. const std::vector<NoProxyEntry> &entries);
  10472. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10473. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10474. if (prefix_bits == 0) { return true; }
  10475. int full_bytes = prefix_bits / 8;
  10476. int rem_bits = prefix_bits % 8;
  10477. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10478. static_cast<size_t>(full_bytes)) != 0) {
  10479. return false;
  10480. }
  10481. if (rem_bits == 0) { return true; }
  10482. auto i = static_cast<size_t>(full_bytes);
  10483. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10484. return (ip[i] & mask) == (net[i] & mask);
  10485. }
  10486. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10487. if (token.empty()) { return false; }
  10488. if (token == "*") {
  10489. out.kind = NoProxyKind::Wildcard;
  10490. return true;
  10491. }
  10492. auto slash = token.find('/');
  10493. std::string addr_part =
  10494. (slash == std::string::npos) ? token : token.substr(0, slash);
  10495. std::string prefix_part =
  10496. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10497. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10498. // don't silently treat it as a /32 (or /128).
  10499. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10500. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10501. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10502. // when brackets are present.
  10503. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10504. addr_part.back() == ']';
  10505. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10506. if (!bracketed) {
  10507. struct in_addr v4;
  10508. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10509. int prefix = 32;
  10510. if (!prefix_part.empty() &&
  10511. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10512. prefix)) {
  10513. return false;
  10514. }
  10515. out.kind = NoProxyKind::IPv4Cidr;
  10516. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10517. out.prefix_bits = prefix;
  10518. return true;
  10519. }
  10520. }
  10521. struct in6_addr v6;
  10522. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10523. int prefix = 128;
  10524. if (!prefix_part.empty() &&
  10525. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10526. prefix)) {
  10527. return false;
  10528. }
  10529. out.kind = NoProxyKind::IPv6Cidr;
  10530. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10531. out.prefix_bits = prefix;
  10532. return true;
  10533. }
  10534. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10535. // the entry is malformed — don't fall through to the hostname branch.
  10536. if (bracketed) { return false; }
  10537. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10538. if (slash != std::string::npos) { return false; }
  10539. // Port-specific entries (host:port) are not supported.
  10540. if (token.find(':') != std::string::npos) { return false; }
  10541. std::string hostname = case_ignore::to_lower(token);
  10542. while (!hostname.empty() && hostname.front() == '.') {
  10543. hostname.erase(hostname.begin());
  10544. }
  10545. while (!hostname.empty() && hostname.back() == '.') {
  10546. hostname.pop_back();
  10547. }
  10548. if (hostname.empty()) { return false; }
  10549. out.kind = NoProxyKind::HostnameSuffix;
  10550. out.hostname_pattern = std::move(hostname);
  10551. return true;
  10552. }
  10553. inline NormalizedTarget normalize_target(const std::string &host) {
  10554. NormalizedTarget t;
  10555. std::string h = host;
  10556. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10557. h = h.substr(1, h.size() - 2);
  10558. }
  10559. // Strip a single trailing dot so "example.com." canonicalizes to
  10560. // "example.com".
  10561. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10562. t.hostname = case_ignore::to_lower(h);
  10563. if (!t.hostname.empty()) {
  10564. struct in_addr v4;
  10565. struct in6_addr v6;
  10566. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10567. t.is_ipv4 = true;
  10568. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10569. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10570. t.is_ipv6 = true;
  10571. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10572. }
  10573. }
  10574. return t;
  10575. }
  10576. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10577. const std::vector<NoProxyEntry> &entries) {
  10578. if (target.hostname.empty()) { return false; }
  10579. for (const auto &e : entries) {
  10580. switch (e.kind) {
  10581. case NoProxyKind::Wildcard: return true;
  10582. case NoProxyKind::IPv4Cidr:
  10583. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10584. return true;
  10585. }
  10586. break;
  10587. case NoProxyKind::IPv6Cidr:
  10588. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10589. return true;
  10590. }
  10591. break;
  10592. case NoProxyKind::HostnameSuffix:
  10593. if (target.is_ipv4 || target.is_ipv6) { break; }
  10594. if (target.hostname == e.hostname_pattern) { return true; }
  10595. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10596. // an entry of "example.com".
  10597. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10598. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10599. if (target.hostname[offset - 1] == '.' &&
  10600. target.hostname.compare(offset, e.hostname_pattern.size(),
  10601. e.hostname_pattern) == 0) {
  10602. return true;
  10603. }
  10604. }
  10605. break;
  10606. }
  10607. }
  10608. return false;
  10609. }
  10610. template <typename T>
  10611. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10612. T header_writer, Error &error) {
  10613. for (const auto &h : headers) {
  10614. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10615. error = Error::InvalidHeaders;
  10616. return false;
  10617. }
  10618. }
  10619. if (header_writer(strm, headers) <= 0) {
  10620. error = Error::Write;
  10621. return false;
  10622. }
  10623. return true;
  10624. }
  10625. } // namespace detail
  10626. /*
  10627. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10628. */
  10629. #ifdef CPPHTTPLIB_SSL_ENABLED
  10630. namespace detail {
  10631. // SSL socket stream implementation
  10632. inline SSLSocketStream::SSLSocketStream(
  10633. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10634. time_t read_timeout_usec, time_t write_timeout_sec,
  10635. time_t write_timeout_usec, time_t max_timeout_msec,
  10636. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10637. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10638. read_timeout_usec_(read_timeout_usec),
  10639. write_timeout_sec_(write_timeout_sec),
  10640. write_timeout_usec_(write_timeout_usec),
  10641. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10642. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10643. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10644. // Note: create_session() also clears this, but SSLClient currently
  10645. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10646. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10647. // SSL session was created.
  10648. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10649. #endif
  10650. }
  10651. inline SSLSocketStream::~SSLSocketStream() = default;
  10652. inline bool SSLSocketStream::is_readable() const {
  10653. return tls::pending(session_) > 0;
  10654. }
  10655. inline bool SSLSocketStream::wait_readable() const {
  10656. if (max_timeout_msec_ <= 0) {
  10657. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10658. }
  10659. time_t read_timeout_sec;
  10660. time_t read_timeout_usec;
  10661. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10662. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10663. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10664. }
  10665. inline bool SSLSocketStream::wait_writable() const {
  10666. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10667. !tls::is_peer_closed(session_, sock_);
  10668. }
  10669. inline bool SSLSocketStream::ensure_readable() {
  10670. if (readable_hint_) {
  10671. readable_hint_ = false;
  10672. return true;
  10673. }
  10674. return wait_readable();
  10675. }
  10676. inline bool SSLSocketStream::is_peer_alive() const {
  10677. return !tls::is_peer_closed(session_, sock_);
  10678. }
  10679. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10680. if (tls::pending(session_) > 0) {
  10681. tls::TlsError err;
  10682. auto ret = tls::read(session_, ptr, size, err);
  10683. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10684. error_ = Error::ConnectionClosed;
  10685. }
  10686. return ret;
  10687. } else if (ensure_readable()) {
  10688. tls::TlsError err;
  10689. auto ret = tls::read(session_, ptr, size, err);
  10690. if (ret < 0) {
  10691. auto n = 1000;
  10692. #ifdef _WIN32
  10693. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10694. (err.code == tls::ErrorCode::SyscallError &&
  10695. WSAGetLastError() == WSAETIMEDOUT))) {
  10696. #else
  10697. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10698. #endif
  10699. if (tls::pending(session_) > 0) {
  10700. return tls::read(session_, ptr, size, err);
  10701. } else if (wait_readable()) {
  10702. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10703. ret = tls::read(session_, ptr, size, err);
  10704. if (ret >= 0) { return ret; }
  10705. } else {
  10706. break;
  10707. }
  10708. }
  10709. assert(ret < 0);
  10710. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10711. error_ = Error::ConnectionClosed;
  10712. }
  10713. return ret;
  10714. } else {
  10715. error_ = Error::Timeout;
  10716. return -1;
  10717. }
  10718. }
  10719. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10720. if (wait_writable()) {
  10721. auto handle_size =
  10722. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10723. tls::TlsError err;
  10724. auto ret = tls::write(session_, ptr, handle_size, err);
  10725. if (ret < 0) {
  10726. auto n = 1000;
  10727. #ifdef _WIN32
  10728. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10729. (err.code == tls::ErrorCode::SyscallError &&
  10730. WSAGetLastError() == WSAETIMEDOUT))) {
  10731. #else
  10732. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10733. #endif
  10734. if (wait_writable()) {
  10735. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10736. ret = tls::write(session_, ptr, handle_size, err);
  10737. if (ret >= 0) { return ret; }
  10738. } else {
  10739. break;
  10740. }
  10741. }
  10742. assert(ret < 0);
  10743. }
  10744. return ret;
  10745. }
  10746. return -1;
  10747. }
  10748. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10749. int &port) const {
  10750. detail::get_remote_ip_and_port(sock_, ip, port);
  10751. }
  10752. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10753. int &port) const {
  10754. detail::get_local_ip_and_port(sock_, ip, port);
  10755. }
  10756. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10757. inline time_t SSLSocketStream::duration() const {
  10758. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10759. std::chrono::steady_clock::now() - start_time_)
  10760. .count();
  10761. }
  10762. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10763. read_timeout_sec_ = sec;
  10764. read_timeout_usec_ = usec;
  10765. }
  10766. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10767. tls::session_t session,
  10768. time_t read_timeout_sec,
  10769. time_t read_timeout_usec,
  10770. time_t write_timeout_sec,
  10771. time_t write_timeout_usec)
  10772. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10773. read_timeout_usec_(read_timeout_usec),
  10774. write_timeout_sec_(write_timeout_sec),
  10775. write_timeout_usec_(write_timeout_usec),
  10776. start_time_(std::chrono::steady_clock::now()) {
  10777. // The receive and send paths run on different threads, so each TLS call is
  10778. // driven in non-blocking mode and readiness is awaited with select()
  10779. // outside the session lock. Set the socket non-blocking once here; it is
  10780. // never flipped back, so no thread races on the flag.
  10781. detail::set_nonblocking(sock_, true);
  10782. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10783. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10784. #endif
  10785. }
  10786. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10787. inline bool WebSocketSSLStream::is_readable() const {
  10788. std::lock_guard<std::mutex> guard(session_mutex_);
  10789. return tls::pending(session_) > 0;
  10790. }
  10791. inline bool WebSocketSSLStream::wait_readable() const {
  10792. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10793. }
  10794. inline bool WebSocketSSLStream::wait_writable() const {
  10795. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10796. // that probe toggles the socket's blocking flag, which would race with the
  10797. // concurrent reader on a permanently non-blocking socket.
  10798. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10799. }
  10800. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10801. tls::TlsError err;
  10802. auto n = 1000;
  10803. while (--n >= 0) {
  10804. {
  10805. std::lock_guard<std::mutex> guard(session_mutex_);
  10806. auto ret = tls::read(session_, ptr, size, err);
  10807. if (ret > 0) { return ret; }
  10808. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10809. error_ = Error::ConnectionClosed;
  10810. return ret;
  10811. }
  10812. }
  10813. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10814. // direction: the send path shares this session, so output it left pending
  10815. // has to be flushed before more input can be decrypted. Anything else is
  10816. // a hard error.
  10817. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10818. #ifdef _WIN32
  10819. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10820. needs_readable =
  10821. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10822. WSAGetLastError() == WSAETIMEDOUT);
  10823. #endif
  10824. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10825. error_ = Error::Read;
  10826. return -1;
  10827. }
  10828. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10829. error_ = Error::Timeout;
  10830. return -1;
  10831. }
  10832. }
  10833. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10834. // to tell a timeout from a close would otherwise see whatever the previous
  10835. // failure left behind (error_ is never cleared on success).
  10836. error_ = Error::Read;
  10837. return -1;
  10838. }
  10839. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10840. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10841. tls::TlsError err;
  10842. auto n = 1000;
  10843. while (--n >= 0) {
  10844. {
  10845. std::lock_guard<std::mutex> guard(session_mutex_);
  10846. auto ret = tls::write(session_, ptr, handle_size, err);
  10847. if (ret >= 0) { return ret; }
  10848. }
  10849. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10850. // or a post-handshake message must be consumed before the record goes
  10851. // out. Anything else is a hard error.
  10852. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10853. #ifdef _WIN32
  10854. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10855. needs_writable =
  10856. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10857. WSAGetLastError() == WSAETIMEDOUT);
  10858. #endif
  10859. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10860. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10861. }
  10862. return -1;
  10863. }
  10864. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10865. int &port) const {
  10866. detail::get_remote_ip_and_port(sock_, ip, port);
  10867. }
  10868. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10869. int &port) const {
  10870. detail::get_local_ip_and_port(sock_, ip, port);
  10871. }
  10872. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10873. inline time_t WebSocketSSLStream::duration() const {
  10874. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10875. std::chrono::steady_clock::now() - start_time_)
  10876. .count();
  10877. }
  10878. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10879. read_timeout_sec_ = sec;
  10880. read_timeout_usec_ = usec;
  10881. }
  10882. } // namespace detail
  10883. #endif // CPPHTTPLIB_SSL_ENABLED
  10884. /*
  10885. * Group 4: Server implementation
  10886. */
  10887. // HTTP server implementation
  10888. inline Server::Server()
  10889. : new_task_queue([] {
  10890. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10891. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10892. }) {
  10893. #ifndef _WIN32
  10894. signal(SIGPIPE, SIG_IGN);
  10895. #endif
  10896. }
  10897. inline Server::~Server() = default;
  10898. inline std::unique_ptr<detail::MatcherBase>
  10899. Server::make_matcher(const std::string &pattern) {
  10900. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10901. // a path params pattern
  10902. if (pattern.find("/:") != std::string::npos) {
  10903. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10904. }
  10905. // A pattern with no regex metacharacter only has to be compared literally,
  10906. // which is what PathParamsMatcher already does when it captures no
  10907. // parameter, so std::regex is only worth building for the patterns that
  10908. // actually need it
  10909. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10910. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10911. }
  10912. return detail::make_unique<detail::RegexMatcher>(pattern);
  10913. }
  10914. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10915. return add_handler(get_handlers_, pattern, std::move(handler));
  10916. }
  10917. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10918. return add_handler(post_handlers_, pattern, std::move(handler));
  10919. }
  10920. inline Server &Server::Post(const std::string &pattern,
  10921. HandlerWithContentReader handler) {
  10922. return add_handler(post_handlers_for_content_reader_, pattern,
  10923. std::move(handler));
  10924. }
  10925. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10926. return add_handler(put_handlers_, pattern, std::move(handler));
  10927. }
  10928. inline Server &Server::Put(const std::string &pattern,
  10929. HandlerWithContentReader handler) {
  10930. return add_handler(put_handlers_for_content_reader_, pattern,
  10931. std::move(handler));
  10932. }
  10933. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10934. return add_handler(patch_handlers_, pattern, std::move(handler));
  10935. }
  10936. inline Server &Server::Patch(const std::string &pattern,
  10937. HandlerWithContentReader handler) {
  10938. return add_handler(patch_handlers_for_content_reader_, pattern,
  10939. std::move(handler));
  10940. }
  10941. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10942. return add_handler(delete_handlers_, pattern, std::move(handler));
  10943. }
  10944. inline Server &Server::Delete(const std::string &pattern,
  10945. HandlerWithContentReader handler) {
  10946. return add_handler(delete_handlers_for_content_reader_, pattern,
  10947. std::move(handler));
  10948. }
  10949. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10950. return add_handler(options_handlers_, pattern, std::move(handler));
  10951. }
  10952. inline const std::set<std::string> &Server::builtin_methods() {
  10953. thread_local const std::set<std::string> methods{
  10954. "GET", "HEAD", "POST", "PUT", "DELETE",
  10955. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10956. return methods;
  10957. }
  10958. inline Server::CustomHandlerEntry *
  10959. Server::custom_entry_for_registration(const std::string &method) {
  10960. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10961. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10962. // routing() before the custom tables are consulted, so a route registered
  10963. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10964. // there and would be reachable, but they carry protocol-level meaning
  10965. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10966. // library does not route.
  10967. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10968. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10969. has_invalid_registration_ = true;
  10970. return nullptr;
  10971. }
  10972. return &custom_handlers_[method];
  10973. }
  10974. inline Server &Server::CustomRoute(const std::string &method,
  10975. const std::string &pattern,
  10976. Handler handler) {
  10977. auto *entry = custom_entry_for_registration(method);
  10978. if (!entry) { return *this; }
  10979. return add_handler(entry->handlers, pattern, std::move(handler));
  10980. }
  10981. inline Server &Server::CustomRoute(const std::string &method,
  10982. const std::string &pattern,
  10983. HandlerWithContentReader handler) {
  10984. auto *entry = custom_entry_for_registration(method);
  10985. if (!entry) { return *this; }
  10986. return add_handler(entry->handlers_for_content_reader, pattern,
  10987. std::move(handler));
  10988. }
  10989. inline const Server::CustomHandlerEntry *
  10990. Server::find_custom_entry(const std::string &method) const {
  10991. // find() alone would be correct here. The empty() check is what keeps the
  10992. // per-request cost off servers that never call CustomRoute(), which is the
  10993. // overwhelmingly common case; keep it rather than walking into the tree.
  10994. if (custom_handlers_.empty()) { return nullptr; }
  10995. auto it = custom_handlers_.find(method);
  10996. return it == custom_handlers_.end() ? nullptr : &it->second;
  10997. }
  10998. inline Server &Server::WebSocket(const std::string &pattern,
  10999. WebSocketHandler handler) {
  11000. websocket_handlers_.push_back(
  11001. {make_matcher(pattern), std::move(handler), nullptr});
  11002. return *this;
  11003. }
  11004. inline Server &Server::WebSocket(const std::string &pattern,
  11005. WebSocketHandler handler,
  11006. SubProtocolSelector sub_protocol_selector) {
  11007. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11008. std::move(sub_protocol_selector)});
  11009. return *this;
  11010. }
  11011. inline bool Server::set_base_dir(const std::string &dir,
  11012. const std::string &mount_point) {
  11013. return set_mount_point(mount_point, dir);
  11014. }
  11015. inline bool Server::set_mount_point(const std::string &mount_point,
  11016. const std::string &dir, Headers headers) {
  11017. detail::FileStat stat(dir);
  11018. if (stat.is_dir()) {
  11019. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11020. if (!mnt.empty() && mnt[0] == '/') {
  11021. std::string resolved_base;
  11022. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11023. #if defined(_WIN32)
  11024. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11025. resolved_base += '\\';
  11026. }
  11027. #else
  11028. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11029. #endif
  11030. }
  11031. base_dirs_.push_back(
  11032. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11033. return true;
  11034. }
  11035. }
  11036. return false;
  11037. }
  11038. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11039. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11040. if (it->mount_point == mount_point) {
  11041. base_dirs_.erase(it);
  11042. return true;
  11043. }
  11044. }
  11045. return false;
  11046. }
  11047. inline Server &
  11048. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11049. const std::string &mime) {
  11050. file_extension_and_mimetype_map_[ext] = mime;
  11051. return *this;
  11052. }
  11053. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11054. default_file_mimetype_ = mime;
  11055. return *this;
  11056. }
  11057. inline Server &Server::set_file_request_handler(Handler handler) {
  11058. file_request_handler_ = std::move(handler);
  11059. return *this;
  11060. }
  11061. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11062. std::true_type) {
  11063. error_handler_ = std::move(handler);
  11064. return *this;
  11065. }
  11066. inline Server &Server::set_error_handler_core(Handler handler,
  11067. std::false_type) {
  11068. error_handler_ = [handler](const Request &req, Response &res) {
  11069. handler(req, res);
  11070. return HandlerResponse::Handled;
  11071. };
  11072. return *this;
  11073. }
  11074. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11075. exception_handler_ = std::move(handler);
  11076. return *this;
  11077. }
  11078. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11079. pre_routing_handler_ = std::move(handler);
  11080. return *this;
  11081. }
  11082. inline Server &Server::set_post_routing_handler(Handler handler) {
  11083. post_routing_handler_ = std::move(handler);
  11084. return *this;
  11085. }
  11086. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11087. pre_request_handler_ = std::move(handler);
  11088. return *this;
  11089. }
  11090. inline Server &Server::set_logger(Logger logger) {
  11091. logger_ = std::move(logger);
  11092. return *this;
  11093. }
  11094. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11095. error_logger_ = std::move(error_logger);
  11096. return *this;
  11097. }
  11098. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11099. pre_compression_logger_ = std::move(logger);
  11100. return *this;
  11101. }
  11102. inline Server &
  11103. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11104. expect_100_continue_handler_ = std::move(handler);
  11105. return *this;
  11106. }
  11107. inline Server &Server::set_start_handler(StartHandler handler) {
  11108. start_handler_ = std::move(handler);
  11109. return *this;
  11110. }
  11111. inline Server &Server::set_address_family(int family) {
  11112. address_family_ = family;
  11113. return *this;
  11114. }
  11115. inline Server &Server::set_tcp_nodelay(bool on) {
  11116. tcp_nodelay_ = on;
  11117. return *this;
  11118. }
  11119. inline Server &Server::set_ipv6_v6only(bool on) {
  11120. ipv6_v6only_ = on;
  11121. return *this;
  11122. }
  11123. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11124. socket_options_ = std::move(socket_options);
  11125. return *this;
  11126. }
  11127. inline Server &Server::set_default_headers(Headers headers) {
  11128. default_headers_ = std::move(headers);
  11129. return *this;
  11130. }
  11131. inline Server &Server::set_header_writer(
  11132. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11133. header_writer_ = writer;
  11134. return *this;
  11135. }
  11136. inline Server &
  11137. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11138. trusted_proxies_ = proxies;
  11139. return *this;
  11140. }
  11141. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11142. keep_alive_max_count_ = count;
  11143. return *this;
  11144. }
  11145. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11146. keep_alive_timeout_sec_ = sec;
  11147. return *this;
  11148. }
  11149. template <class Rep, class Period>
  11150. inline Server &Server::set_keep_alive_timeout(
  11151. const std::chrono::duration<Rep, Period> &duration) {
  11152. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11153. set_keep_alive_timeout(sec);
  11154. });
  11155. return *this;
  11156. }
  11157. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11158. read_timeout_sec_ = sec;
  11159. read_timeout_usec_ = usec;
  11160. return *this;
  11161. }
  11162. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11163. write_timeout_sec_ = sec;
  11164. write_timeout_usec_ = usec;
  11165. return *this;
  11166. }
  11167. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11168. idle_interval_sec_ = sec;
  11169. idle_interval_usec_ = usec;
  11170. return *this;
  11171. }
  11172. inline Server &Server::set_payload_max_length(size_t length) {
  11173. payload_max_length_ = length;
  11174. return *this;
  11175. }
  11176. inline Server &Server::set_static_file_compression(bool on) {
  11177. static_file_compression_ = on;
  11178. return *this;
  11179. }
  11180. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11181. static_file_compression_min_length_ = length;
  11182. return *this;
  11183. }
  11184. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11185. static_file_compression_max_length_ = length;
  11186. return *this;
  11187. }
  11188. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11189. websocket_max_missed_pongs_ = count;
  11190. return *this;
  11191. }
  11192. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11193. websocket_ping_interval_sec_ = sec;
  11194. return *this;
  11195. }
  11196. template <class Rep, class Period>
  11197. inline Server &Server::set_websocket_ping_interval(
  11198. const std::chrono::duration<Rep, Period> &duration) {
  11199. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11200. set_websocket_ping_interval(sec);
  11201. });
  11202. return *this;
  11203. }
  11204. inline bool Server::bind_to_port(const std::string &host, int port,
  11205. int socket_flags) {
  11206. auto ret = bind_internal(host, port, socket_flags);
  11207. if (ret == -1) { is_decommissioned = true; }
  11208. return ret >= 0;
  11209. }
  11210. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11211. auto ret = bind_internal(host, 0, socket_flags);
  11212. if (ret == -1) { is_decommissioned = true; }
  11213. return ret;
  11214. }
  11215. inline bool Server::listen_after_bind() { return listen_internal(); }
  11216. inline bool Server::listen(const std::string &host, int port,
  11217. int socket_flags) {
  11218. return bind_to_port(host, port, socket_flags) && listen_internal();
  11219. }
  11220. inline bool Server::is_running() const { return is_running_; }
  11221. inline void Server::wait_until_ready() const {
  11222. while (!is_running_ && !is_decommissioned) {
  11223. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11224. }
  11225. }
  11226. inline void Server::stop() noexcept {
  11227. // Release the listening socket whether or not the accept loop is running:
  11228. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11229. // exchange is what makes this safe to call concurrently with the accept loop.
  11230. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11231. if (sock != INVALID_SOCKET) {
  11232. detail::shutdown_socket(sock);
  11233. detail::close_socket(sock);
  11234. }
  11235. is_decommissioned = false;
  11236. }
  11237. inline void Server::decommission() { is_decommissioned = true; }
  11238. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11239. auto len = strlen(s);
  11240. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11241. len -= 2;
  11242. {
  11243. size_t count = 0;
  11244. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11245. switch (count) {
  11246. case 0: req.method = std::string(b, e); break;
  11247. case 1: req.target = std::string(b, e); break;
  11248. case 2: req.version = std::string(b, e); break;
  11249. default: break;
  11250. }
  11251. count++;
  11252. });
  11253. if (count != 3) { return false; }
  11254. }
  11255. // A method outside the built-in set is accepted only when a handler has been
  11256. // registered for it with CustomRoute().
  11257. const auto &methods = builtin_methods();
  11258. if (methods.find(req.method) == methods.end() &&
  11259. !find_custom_entry(req.method)) {
  11260. output_error_log(Error::InvalidHTTPMethod, &req);
  11261. return false;
  11262. }
  11263. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11264. output_error_log(Error::InvalidHTTPVersion, &req);
  11265. return false;
  11266. }
  11267. if (!detail::fields::is_request_target(req.target)) { return false; }
  11268. {
  11269. // Skip URL fragment
  11270. for (size_t i = 0; i < req.target.size(); i++) {
  11271. if (req.target[i] == '#') {
  11272. req.target.erase(i);
  11273. break;
  11274. }
  11275. }
  11276. detail::divide(req.target, '?',
  11277. [&](const char *lhs_data, std::size_t lhs_size,
  11278. const char *rhs_data, std::size_t rhs_size) {
  11279. req.path =
  11280. decode_path_component(std::string(lhs_data, lhs_size));
  11281. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11282. });
  11283. }
  11284. return true;
  11285. }
  11286. inline bool Server::write_response(Stream &strm, bool close_connection,
  11287. Request &req, Response &res) {
  11288. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11289. // incorrectly to the error content.
  11290. req.ranges.clear();
  11291. return write_response_core(strm, close_connection, req, res, false);
  11292. }
  11293. inline bool Server::write_response_with_content(Stream &strm,
  11294. bool close_connection,
  11295. const Request &req,
  11296. Response &res) {
  11297. return write_response_core(strm, close_connection, req, res, true);
  11298. }
  11299. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11300. const Request &req, Response &res,
  11301. bool need_apply_ranges) {
  11302. assert(res.status != -1);
  11303. if (400 <= res.status && error_handler_ &&
  11304. error_handler_(req, res) == HandlerResponse::Handled) {
  11305. need_apply_ranges = true;
  11306. }
  11307. std::string content_type;
  11308. std::string boundary;
  11309. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11310. // Prepare additional headers
  11311. if (close_connection ||
  11312. detail::has_header_token(req.headers, "Connection", "close") ||
  11313. 400 <= res.status || // Don't leave connections open after errors
  11314. // The client withholds the body until `100 Continue`, which was never
  11315. // sent, so whether and when the body follows is unknown.
  11316. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11317. res.set_header("Connection", "close");
  11318. } else {
  11319. std::string s = "timeout=";
  11320. s += std::to_string(keep_alive_timeout_sec_);
  11321. s += ", max=";
  11322. s += std::to_string(keep_alive_max_count_);
  11323. res.set_header("Keep-Alive", s);
  11324. }
  11325. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11326. !res.has_header("Content-Type")) {
  11327. res.set_header("Content-Type", "text/plain");
  11328. }
  11329. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11330. !res.has_header("Content-Length")) {
  11331. res.set_header("Content-Length", "0");
  11332. }
  11333. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11334. res.set_header("Accept-Ranges", "bytes");
  11335. }
  11336. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11337. // Response line and headers
  11338. detail::BufferStream bstrm;
  11339. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11340. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11341. // Combine a small body with the headers so the whole response leaves in a
  11342. // single write. A large body is written on its own instead: a copy of it
  11343. // costs more than the extra write saves.
  11344. auto send_body = req.method != "HEAD";
  11345. auto body_is_separate = false;
  11346. auto provider_done = false;
  11347. if (send_body && !res.body.empty() && !res.content_provider_) {
  11348. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11349. bstrm.write(res.body.data(), res.body.size());
  11350. } else {
  11351. body_is_separate = true;
  11352. }
  11353. } else if (send_body && res.content_provider_ &&
  11354. res.is_file_content_provider_ &&
  11355. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11356. // A small file is read into the same buffer. Other providers may produce
  11357. // their data over time, so they are never held back.
  11358. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11359. return false;
  11360. }
  11361. provider_done = true;
  11362. }
  11363. // Log before writing to avoid race condition with client-side code that
  11364. // accesses logger-captured data immediately after receiving the response.
  11365. output_log(req, res);
  11366. // Flush buffer
  11367. auto &data = bstrm.get_buffer();
  11368. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11369. if (body_is_separate) {
  11370. return detail::write_data(strm, res.body.data(), res.body.size());
  11371. }
  11372. // Streaming body
  11373. if (send_body && res.content_provider_) {
  11374. if (!provider_done &&
  11375. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11376. return false;
  11377. }
  11378. res.content_provider_success_ = true;
  11379. }
  11380. return true;
  11381. }
  11382. inline bool
  11383. Server::write_content_with_provider(Stream &strm, const Request &req,
  11384. Response &res, const std::string &boundary,
  11385. const std::string &content_type) {
  11386. auto is_shutting_down = [this]() {
  11387. return this->svr_sock_ == INVALID_SOCKET;
  11388. };
  11389. if (res.content_length_ > 0) {
  11390. // Only a 206 response is served as a partial representation, matching the
  11391. // condition `apply_ranges()` used to decide the Content-Length and the
  11392. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11393. // only for a 2xx status, slicing under any other status would write a body
  11394. // that disagrees with the header already sent, from an unchecked offset.
  11395. auto is_partial =
  11396. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11397. if (!is_partial) {
  11398. return detail::write_content(strm, res.content_provider_, 0,
  11399. res.content_length_, is_shutting_down);
  11400. } else if (req.ranges.size() == 1) {
  11401. auto offset_and_length = detail::get_range_offset_and_length(
  11402. req.ranges[0], res.content_length_);
  11403. return detail::write_content(strm, res.content_provider_,
  11404. offset_and_length.first,
  11405. offset_and_length.second, is_shutting_down);
  11406. } else {
  11407. return detail::write_multipart_ranges_data(
  11408. strm, req, res, boundary, content_type, res.content_length_,
  11409. is_shutting_down);
  11410. }
  11411. } else {
  11412. if (res.is_chunked_content_provider_) {
  11413. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11414. // re-negotiating here would disagree with them, e.g. once a handler's
  11415. // own Content-Encoding header suppresses the negotiation.
  11416. auto compressor = detail::make_compressor(res.content_coding_);
  11417. if (!compressor) {
  11418. compressor = detail::make_unique<detail::nocompressor>();
  11419. }
  11420. return detail::write_content_chunked(strm, res.content_provider_,
  11421. is_shutting_down, *compressor);
  11422. } else {
  11423. return detail::write_content_without_length(strm, res.content_provider_,
  11424. is_shutting_down);
  11425. }
  11426. }
  11427. }
  11428. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11429. FormFields::iterator cur_field;
  11430. FormFiles::iterator cur_file;
  11431. auto is_text_field = false;
  11432. size_t count = 0;
  11433. if (read_content_core(
  11434. strm, req, res,
  11435. // Regular
  11436. [&](const char *buf, size_t n) {
  11437. // Prevent arithmetic overflow when checking sizes.
  11438. // Avoid computing (req.body.size() + n) directly because
  11439. // adding two unsigned `size_t` values can wrap around and
  11440. // produce a small result instead of indicating overflow.
  11441. // Instead, check using subtraction: ensure `n` does not
  11442. // exceed the remaining capacity `max_size() - size()`.
  11443. if (req.body.size() >= req.body.max_size() ||
  11444. n > req.body.max_size() - req.body.size()) {
  11445. return false;
  11446. }
  11447. // Limit decompressed body size to payload_max_length_ to protect
  11448. // against "zip bomb" attacks where a small compressed payload
  11449. // decompresses to a massive size.
  11450. if (payload_max_length_ > 0 &&
  11451. (req.body.size() >= payload_max_length_ ||
  11452. n > payload_max_length_ - req.body.size())) {
  11453. return false;
  11454. }
  11455. req.body.append(buf, n);
  11456. return true;
  11457. },
  11458. // Multipart FormData
  11459. [&](const FormData &file) {
  11460. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11461. output_error_log(Error::TooManyFormDataFiles, &req);
  11462. return false;
  11463. }
  11464. if (file.filename.empty()) {
  11465. cur_field = req.form.fields.emplace(
  11466. file.name, FormField{file.name, file.content, file.headers});
  11467. is_text_field = true;
  11468. } else {
  11469. cur_file = req.form.files.emplace(file.name, file);
  11470. is_text_field = false;
  11471. }
  11472. return true;
  11473. },
  11474. [&](const char *buf, size_t n) {
  11475. if (is_text_field) {
  11476. auto &content = cur_field->second.content;
  11477. if (content.size() + n > content.max_size()) { return false; }
  11478. content.append(buf, n);
  11479. } else {
  11480. auto &content = cur_file->second.content;
  11481. if (content.size() + n > content.max_size()) { return false; }
  11482. content.append(buf, n);
  11483. }
  11484. return true;
  11485. })) {
  11486. const auto &content_type = req.get_header_value("Content-Type");
  11487. if (detail::extract_media_type(content_type) ==
  11488. "application/x-www-form-urlencoded") {
  11489. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11490. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11491. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11492. return false;
  11493. }
  11494. detail::parse_query_text(req.body, req.params);
  11495. }
  11496. return true;
  11497. }
  11498. return false;
  11499. }
  11500. inline bool Server::read_content_with_content_receiver(
  11501. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11502. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11503. return read_content_core(strm, req, res, std::move(receiver),
  11504. std::move(multipart_header),
  11505. std::move(multipart_receiver));
  11506. }
  11507. inline bool Server::read_content_core(
  11508. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11509. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11510. detail::FormDataParser multipart_form_data_parser;
  11511. ContentReceiverWithProgress out;
  11512. if (req.is_multipart_form_data()) {
  11513. const auto &content_type = req.get_header_value("Content-Type");
  11514. std::string boundary;
  11515. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11516. res.status = StatusCode::BadRequest_400;
  11517. output_error_log(Error::MultipartParsing, &req);
  11518. return false;
  11519. }
  11520. multipart_form_data_parser.set_boundary(std::move(boundary));
  11521. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11522. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11523. multipart_receiver);
  11524. };
  11525. } else {
  11526. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11527. size_t /*len*/) { return receiver(buf, n); };
  11528. }
  11529. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11530. // For non-SSL builds we still scan non-persistent connections for stray
  11531. // body bytes so the payload limit is enforced (413). On keep-alive,
  11532. // pending bytes may be the next request (issue #2450), so skip.
  11533. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11534. if (!req.has_header("Content-Length") &&
  11535. !detail::is_chunked_transfer_encoding(req.headers)) {
  11536. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11537. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11538. auto has_data = strm.is_readable();
  11539. if (!has_data) {
  11540. auto s = strm.socket();
  11541. if (s != INVALID_SOCKET) {
  11542. has_data = detail::select_read(s, 0, 0) > 0;
  11543. }
  11544. }
  11545. if (has_data) {
  11546. // Route through the same decompressing reader used by the
  11547. // length-framed and chunked paths below, so payload_max_length_ is
  11548. // enforced on the decompressed size here too instead of only on the
  11549. // compressed wire bytes.
  11550. return detail::read_content(strm, req, payload_max_length_, res.status,
  11551. nullptr, out, true);
  11552. }
  11553. }
  11554. return true;
  11555. }
  11556. #else
  11557. if (!req.has_header("Content-Length") &&
  11558. !detail::is_chunked_transfer_encoding(req.headers)) {
  11559. return true;
  11560. }
  11561. #endif
  11562. // The client is waiting for this before it sends the body.
  11563. if (req.expect_100_continue_pending_) {
  11564. req.expect_100_continue_pending_ = false;
  11565. detail::write_response_line(strm, StatusCode::Continue_100);
  11566. strm.write("\r\n");
  11567. }
  11568. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11569. out, true)) {
  11570. return false;
  11571. }
  11572. req.body_consumed_ = true;
  11573. if (req.is_multipart_form_data()) {
  11574. if (!multipart_form_data_parser.is_valid()) {
  11575. res.status = StatusCode::BadRequest_400;
  11576. output_error_log(Error::MultipartParsing, &req);
  11577. return false;
  11578. }
  11579. }
  11580. return true;
  11581. }
  11582. inline bool Server::handle_file_request(Request &req, Response &res) {
  11583. for (const auto &entry : base_dirs_) {
  11584. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11585. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11586. // One that already ends in '/' (the root mount among them) carries its own
  11587. // boundary; set_mount_point() guarantees the mount point is not empty.
  11588. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11589. (entry.mount_point.back() == '/' ||
  11590. req.path.size() == entry.mount_point.size() ||
  11591. req.path[entry.mount_point.size()] == '/')) {
  11592. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11593. if (detail::is_valid_path(sub_path)) {
  11594. auto path = entry.base_dir + sub_path;
  11595. if (path.back() == '/') { path += "index.html"; }
  11596. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11597. // but symlinks/junctions can still escape the base directory.
  11598. if (!entry.resolved_base_dir.empty()) {
  11599. std::string resolved_path;
  11600. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11601. !detail::is_path_within_base(resolved_path,
  11602. entry.resolved_base_dir)) {
  11603. res.status = StatusCode::Forbidden_403;
  11604. return true;
  11605. }
  11606. }
  11607. detail::FileStat stat(path);
  11608. if (stat.is_dir()) {
  11609. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11610. return true;
  11611. }
  11612. if (stat.is_file()) {
  11613. for (const auto &kv : entry.headers) {
  11614. res.set_header(kv.first, kv.second);
  11615. }
  11616. auto content_type_of = [&]() {
  11617. return detail::find_content_type(
  11618. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11619. };
  11620. // Only the ETag needs the content type this early, and only to name
  11621. // the coding. Deciding it here would otherwise put a regex in front
  11622. // of the 304 below, which serving a file never used to pay for.
  11623. std::string content_type;
  11624. auto encoding = detail::EncodingType::None;
  11625. if (static_file_compression_) {
  11626. content_type = content_type_of();
  11627. encoding =
  11628. static_file_encoding(req, res, content_type, stat.size());
  11629. }
  11630. // The ETag names the representation actually sent, so a client that
  11631. // cached the compressed form revalidates against the compressed ETag
  11632. // and still gets a 304, while one that took identity keeps the plain
  11633. // ETag.
  11634. auto etag = detail::compute_etag(
  11635. stat, encoding == detail::EncodingType::None
  11636. ? std::string()
  11637. : std::string("-") + detail::encoding_name(encoding));
  11638. if (!etag.empty()) { res.set_header("ETag", etag); }
  11639. auto mtime = stat.mtime();
  11640. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11641. if (!last_modified.empty()) {
  11642. res.set_header("Last-Modified", last_modified);
  11643. }
  11644. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11645. check_if_range(req, etag, mtime);
  11646. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11647. if (!mm->is_open()) {
  11648. output_error_log(Error::OpenFile, &req);
  11649. return false;
  11650. }
  11651. if (!static_file_compression_) { content_type = content_type_of(); }
  11652. detail::set_file_content_provider(res, mm, content_type, encoding);
  11653. if (req.method != "HEAD" && file_request_handler_) {
  11654. file_request_handler_(req, res);
  11655. }
  11656. return true;
  11657. } else {
  11658. output_error_log(Error::OpenFile, &req);
  11659. }
  11660. }
  11661. }
  11662. }
  11663. return false;
  11664. }
  11665. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11666. const std::string &etag,
  11667. time_t mtime) const {
  11668. // Handle conditional GET:
  11669. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11670. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11671. if (req.has_header("If-None-Match")) {
  11672. if (!etag.empty()) {
  11673. auto val =
  11674. detail::get_combined_header_value(req.headers, "If-None-Match");
  11675. // NOTE: We use exact string matching here. This works correctly
  11676. // because our server always generates weak ETags (W/"..."), and
  11677. // clients typically send back the same ETag they received.
  11678. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11679. // If-None-Match, where W/"x" and "x" would match, but this
  11680. // simplified implementation requires exact matches.
  11681. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11682. [&](const char *b, const char *e) {
  11683. auto seg_len = static_cast<size_t>(e - b);
  11684. return (seg_len == 1 && *b == '*') ||
  11685. (seg_len == etag.size() &&
  11686. std::equal(b, e, etag.begin()));
  11687. });
  11688. if (ret) {
  11689. res.status = StatusCode::NotModified_304;
  11690. return true;
  11691. }
  11692. }
  11693. } else if (req.has_header("If-Modified-Since")) {
  11694. auto val = req.get_header_value("If-Modified-Since");
  11695. auto t = detail::parse_http_date(val);
  11696. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11697. res.status = StatusCode::NotModified_304;
  11698. return true;
  11699. }
  11700. }
  11701. return false;
  11702. }
  11703. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11704. time_t mtime) const {
  11705. // Handle If-Range for partial content requests (RFC 9110
  11706. // Section 13.1.5). If-Range is only evaluated when Range header is
  11707. // present. If the validator matches, serve partial content; otherwise
  11708. // serve full content.
  11709. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11710. auto val = req.get_header_value("If-Range");
  11711. auto is_valid_range = [&]() {
  11712. if (detail::is_strong_etag(val)) {
  11713. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11714. // comparison.
  11715. return (!etag.empty() && val == etag);
  11716. } else if (detail::is_weak_etag(val)) {
  11717. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11718. return false;
  11719. } else {
  11720. // HTTP-date comparison
  11721. auto t = detail::parse_http_date(val);
  11722. return (t != static_cast<time_t>(-1) && mtime <= t);
  11723. }
  11724. };
  11725. if (!is_valid_range()) {
  11726. // Validator doesn't match: ignore Range and serve full content
  11727. req.ranges.clear();
  11728. return false;
  11729. }
  11730. }
  11731. return true;
  11732. }
  11733. inline socket_t
  11734. Server::create_server_socket(const std::string &host, int port,
  11735. int socket_flags,
  11736. SocketOptions socket_options) const {
  11737. return detail::create_socket(
  11738. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11739. ipv6_v6only_, std::move(socket_options),
  11740. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11741. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11742. output_error_log(Error::BindIPAddress, nullptr);
  11743. return false;
  11744. }
  11745. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11746. output_error_log(Error::Listen, nullptr);
  11747. return false;
  11748. }
  11749. return true;
  11750. });
  11751. }
  11752. inline int Server::bind_internal(const std::string &host, int port,
  11753. int socket_flags) {
  11754. if (is_decommissioned) { return -1; }
  11755. if (!is_valid()) { return -1; }
  11756. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11757. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11758. if (port == 0) {
  11759. struct sockaddr_storage addr;
  11760. socklen_t addr_len = sizeof(addr);
  11761. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11762. &addr_len) == -1) {
  11763. output_error_log(Error::GetSockName, nullptr);
  11764. return -1;
  11765. }
  11766. if (addr.ss_family == AF_INET) {
  11767. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11768. } else if (addr.ss_family == AF_INET6) {
  11769. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11770. } else {
  11771. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11772. return -1;
  11773. }
  11774. } else {
  11775. return port;
  11776. }
  11777. }
  11778. inline bool Server::listen_internal() {
  11779. // A stop() between bind and listen leaves nothing to accept on. Report
  11780. // failure instead of returning success without ever serving, and mark the
  11781. // server decommissioned the way any failed listen does so that a concurrent
  11782. // wait_until_ready() wakes up instead of spinning forever.
  11783. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11784. is_decommissioned = true;
  11785. return false;
  11786. }
  11787. auto ret = true;
  11788. is_running_ = true;
  11789. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11790. if (start_handler_) { start_handler_(); }
  11791. {
  11792. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11793. while (svr_sock_ != INVALID_SOCKET) {
  11794. #ifndef _WIN32
  11795. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11796. #endif
  11797. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11798. idle_interval_usec_);
  11799. if (val == 0) { // Timeout
  11800. task_queue->on_idle();
  11801. continue;
  11802. }
  11803. #ifndef _WIN32
  11804. }
  11805. #endif
  11806. #if defined _WIN32
  11807. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11808. // OVERLAPPED
  11809. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11810. #elif defined SOCK_CLOEXEC
  11811. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11812. #else
  11813. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11814. #endif
  11815. if (sock == INVALID_SOCKET) {
  11816. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11817. // touches the CRT errno, so the two have to be asked platform by
  11818. // platform rather than by testing errno here.
  11819. if (detail::is_accept_resource_error()) {
  11820. // The per-process descriptor limit or the network stack's buffer
  11821. // space has been reached. Try to accept new connections after a
  11822. // short sleep.
  11823. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11824. continue;
  11825. } else if (detail::is_accept_transient_error()) {
  11826. continue;
  11827. }
  11828. // Take the descriptor out of svr_sock_ before closing it: a later
  11829. // stop() would otherwise shutdown()/close() a value the OS may have
  11830. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11831. // gone. The exchange also settles the race with a concurrent stop(),
  11832. // since whichever side takes the descriptor closes it exactly once.
  11833. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11834. if (listen_sock != INVALID_SOCKET) {
  11835. detail::close_socket(listen_sock);
  11836. ret = false;
  11837. output_error_log(Error::Connection, nullptr);
  11838. } else {
  11839. ; // The server socket was closed by user.
  11840. }
  11841. break;
  11842. }
  11843. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11844. read_timeout_sec_, read_timeout_usec_);
  11845. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11846. write_timeout_sec_, write_timeout_usec_);
  11847. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11848. if (!task_queue->enqueue(
  11849. [this, sock]() { process_and_close_socket(sock); })) {
  11850. output_error_log(Error::ResourceExhaustion, nullptr);
  11851. detail::shutdown_socket(sock);
  11852. detail::close_socket(sock);
  11853. }
  11854. }
  11855. task_queue->shutdown();
  11856. }
  11857. is_decommissioned = !ret;
  11858. return ret;
  11859. }
  11860. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11861. if (pre_routing_handler_ &&
  11862. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11863. return true;
  11864. }
  11865. // File handler
  11866. if ((req.method == "GET" || req.method == "HEAD") &&
  11867. handle_file_request(req, res)) {
  11868. return true;
  11869. }
  11870. const auto *custom = find_custom_entry(req.method);
  11871. // The second clause mirrors what expect_content() does unconditionally for
  11872. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11873. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11874. // `allprop`) would skip its handler and fall through to 404.
  11875. if (detail::expect_content(req) ||
  11876. (custom && !custom->handlers_for_content_reader.empty())) {
  11877. // Content reader handler
  11878. {
  11879. // Track whether the ContentReader was aborted due to the decompressed
  11880. // payload exceeding `payload_max_length_`.
  11881. // The user handler runs after the lambda returns, so we must restore the
  11882. // 413 status if the handler overwrites it.
  11883. bool content_reader_payload_too_large = false;
  11884. ContentReader reader(
  11885. [&](ContentReceiver receiver) {
  11886. auto result = read_content_with_content_receiver(
  11887. strm, req, res, std::move(receiver), nullptr, nullptr);
  11888. if (!result) {
  11889. output_error_log(Error::Read, &req);
  11890. if (res.status == StatusCode::PayloadTooLarge_413) {
  11891. content_reader_payload_too_large = true;
  11892. }
  11893. }
  11894. return result;
  11895. },
  11896. [&](FormDataHeader header, ContentReceiver receiver) {
  11897. auto result = read_content_with_content_receiver(
  11898. strm, req, res, nullptr, std::move(header),
  11899. std::move(receiver));
  11900. if (!result) {
  11901. output_error_log(Error::Read, &req);
  11902. if (res.status == StatusCode::PayloadTooLarge_413) {
  11903. content_reader_payload_too_large = true;
  11904. }
  11905. }
  11906. return result;
  11907. });
  11908. bool dispatched = false;
  11909. if (req.method == "POST") {
  11910. dispatched = dispatch_request_for_content_reader(
  11911. req, res, std::move(reader), post_handlers_for_content_reader_);
  11912. } else if (req.method == "PUT") {
  11913. dispatched = dispatch_request_for_content_reader(
  11914. req, res, std::move(reader), put_handlers_for_content_reader_);
  11915. } else if (req.method == "PATCH") {
  11916. dispatched = dispatch_request_for_content_reader(
  11917. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11918. } else if (req.method == "DELETE") {
  11919. dispatched = dispatch_request_for_content_reader(
  11920. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11921. } else if (custom) {
  11922. dispatched = dispatch_request_for_content_reader(
  11923. req, res, std::move(reader), custom->handlers_for_content_reader);
  11924. }
  11925. if (dispatched) {
  11926. if (content_reader_payload_too_large) {
  11927. // Enforce the limit: override any status the handler may have set
  11928. // and return false so the error path sends a plain 413 response.
  11929. res.status = StatusCode::PayloadTooLarge_413;
  11930. res.body.clear();
  11931. res.content_length_ = 0;
  11932. res.content_provider_ = nullptr;
  11933. return false;
  11934. }
  11935. return true;
  11936. }
  11937. }
  11938. // NOTE: `req.body` is not read here. For a regular handler the body is
  11939. // read inside dispatch_request(), after the route has matched and the
  11940. // pre-request handler has approved the request, so that a rejected
  11941. // request (e.g. failed authentication) never forces us to buffer a
  11942. // potentially large body.
  11943. }
  11944. // Regular handler
  11945. if (req.method == "GET" || req.method == "HEAD") {
  11946. return dispatch_request(req, res, get_handlers_, strm);
  11947. } else if (req.method == "POST") {
  11948. return dispatch_request(req, res, post_handlers_, strm);
  11949. } else if (req.method == "PUT") {
  11950. return dispatch_request(req, res, put_handlers_, strm);
  11951. } else if (req.method == "DELETE") {
  11952. return dispatch_request(req, res, delete_handlers_, strm);
  11953. } else if (req.method == "OPTIONS") {
  11954. return dispatch_request(req, res, options_handlers_, strm);
  11955. } else if (req.method == "PATCH") {
  11956. return dispatch_request(req, res, patch_handlers_, strm);
  11957. } else if (custom) {
  11958. return dispatch_request(req, res, custom->handlers, strm);
  11959. }
  11960. res.status = StatusCode::BadRequest_400;
  11961. return false;
  11962. }
  11963. inline bool Server::dispatch_request(Request &req, Response &res,
  11964. const Handlers &handlers, Stream &strm) {
  11965. for (const auto &x : handlers) {
  11966. const auto &matcher = x.first;
  11967. const auto &handler = x.second;
  11968. if (matcher->match(req)) {
  11969. req.matched_route = matcher->pattern();
  11970. // Run the pre-request handler before reading the body so a rejected
  11971. // request (e.g. failed authentication) never forces us to buffer a
  11972. // potentially large body. `req.matched_route` is available here.
  11973. if (pre_request_handler_ &&
  11974. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11975. return true;
  11976. }
  11977. // The route matched and the request was approved; read the body now.
  11978. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11979. output_error_log(Error::Read, &req);
  11980. return false;
  11981. }
  11982. handler(req, res);
  11983. return true;
  11984. }
  11985. }
  11986. return false;
  11987. }
  11988. // Decides the content coding for a response served straight from a file. Both
  11989. // the ETag, which has to name the representation actually sent, and
  11990. // `apply_static_file_compression()` go through this, so the two cannot drift
  11991. // apart.
  11992. inline detail::EncodingType
  11993. Server::static_file_encoding(const Request &req, const Response &res,
  11994. const std::string &content_type,
  11995. size_t length) const {
  11996. if (!static_file_compression_) { return detail::EncodingType::None; }
  11997. // Nothing to compress, and an empty file already answers with
  11998. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11999. // turn an empty body into a 20-byte gzip stream.
  12000. if (length == 0) { return detail::EncodingType::None; }
  12001. // A file that already fits in a single packet gains nothing from being made
  12002. // smaller, since it still travels in that one segment, and a file of a few
  12003. // bytes comes out larger than it went in.
  12004. if (length < static_file_compression_min_length_) {
  12005. return detail::EncodingType::None;
  12006. }
  12007. // RFC 9110 applies Range to the representation after content coding, so a
  12008. // compressed 206 would mean compressing the whole file and then slicing it.
  12009. // Serve ranges from the identity representation instead.
  12010. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12011. if (static_file_compression_max_length_ > 0 &&
  12012. length > static_file_compression_max_length_) {
  12013. return detail::EncodingType::None;
  12014. }
  12015. return detail::encoding_type(req, res, content_type);
  12016. }
  12017. // Compresses a file-backed content provider into `res.body` and takes over the
  12018. // framing headers. Returns false when the response is left untouched.
  12019. inline bool Server::apply_static_file_compression(const Request &req,
  12020. Response &res) const {
  12021. auto type = res.content_coding_;
  12022. if (type == detail::EncodingType::None || !res.content_provider_) {
  12023. return false;
  12024. }
  12025. auto compressor = detail::make_compressor(type);
  12026. if (!compressor) { return false; }
  12027. output_pre_compression_log(req, res);
  12028. std::string compressed;
  12029. if (!detail::compress_content_provider(res.content_provider_,
  12030. res.content_length_, *compressor,
  12031. compressed)) {
  12032. return false;
  12033. }
  12034. res.body.swap(compressed);
  12035. // The provider was consumed in full, so a resource releaser registered with
  12036. // it should hear about a success when the response goes away.
  12037. res.content_provider_success_ = true;
  12038. res.content_provider_ = nullptr;
  12039. res.content_length_ = 0;
  12040. res.content_coding_ = detail::EncodingType::None;
  12041. res.set_header("Content-Encoding", detail::encoding_name(type));
  12042. res.set_header("Vary", "Accept-Encoding");
  12043. res.set_header("Content-Length", std::to_string(res.body.size()));
  12044. return true;
  12045. }
  12046. inline void Server::apply_ranges(const Request &req, Response &res,
  12047. std::string &content_type,
  12048. std::string &boundary) const {
  12049. // A known-length content provider leaves `res.body` empty, so the compressor
  12050. // at the end of this function never runs for one (issue #2545). A file-backed
  12051. // provider is fully readable right here, so compress it and answer with an
  12052. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12053. // takes the same path as `set_content()` from here on. Range requests never
  12054. // get a content coding, so `Content-Range` still names identity bytes and
  12055. // none of the framing below applies.
  12056. if (apply_static_file_compression(req, res)) { return; }
  12057. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12058. auto it = res.headers.find("Content-Type");
  12059. if (it != res.headers.end()) {
  12060. content_type = it->second;
  12061. res.headers.erase(it);
  12062. }
  12063. boundary = detail::make_multipart_data_boundary();
  12064. res.set_header("Content-Type",
  12065. "multipart/byteranges; boundary=" + boundary);
  12066. }
  12067. auto type = detail::encoding_type(req, res);
  12068. if (res.body.empty()) {
  12069. if (res.content_length_ > 0) {
  12070. size_t length = 0;
  12071. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12072. length = res.content_length_;
  12073. } else if (req.ranges.size() == 1) {
  12074. auto offset_and_length = detail::get_range_offset_and_length(
  12075. req.ranges[0], res.content_length_);
  12076. length = offset_and_length.second;
  12077. auto content_range = detail::make_content_range_header_field(
  12078. offset_and_length, res.content_length_);
  12079. res.set_header("Content-Range", content_range);
  12080. } else {
  12081. length = detail::get_multipart_ranges_data_length(
  12082. req, boundary, content_type, res.content_length_);
  12083. }
  12084. res.set_header("Content-Length", std::to_string(length));
  12085. } else {
  12086. if (res.content_provider_) {
  12087. if (res.is_chunked_content_provider_) {
  12088. res.set_header("Transfer-Encoding", "chunked");
  12089. res.content_coding_ = type;
  12090. if (type != detail::EncodingType::None) {
  12091. res.set_header("Content-Encoding", detail::encoding_name(type));
  12092. res.set_header("Vary", "Accept-Encoding");
  12093. }
  12094. }
  12095. }
  12096. }
  12097. } else {
  12098. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12099. ;
  12100. } else if (req.ranges.size() == 1) {
  12101. auto offset_and_length =
  12102. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12103. auto offset = offset_and_length.first;
  12104. auto length = offset_and_length.second;
  12105. auto content_range = detail::make_content_range_header_field(
  12106. offset_and_length, res.body.size());
  12107. res.set_header("Content-Range", content_range);
  12108. assert(offset + length <= res.body.size());
  12109. res.body = res.body.substr(offset, length);
  12110. } else {
  12111. std::string data;
  12112. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12113. res.body.size(), data);
  12114. res.body.swap(data);
  12115. }
  12116. if (type != detail::EncodingType::None) {
  12117. output_pre_compression_log(req, res);
  12118. if (auto compressor = detail::make_compressor(type)) {
  12119. std::string compressed;
  12120. if (compressor->compress(res.body.data(), res.body.size(), true,
  12121. [&](const char *data, size_t data_len) {
  12122. compressed.append(data, data_len);
  12123. return true;
  12124. })) {
  12125. res.body.swap(compressed);
  12126. res.set_header("Content-Encoding", detail::encoding_name(type));
  12127. res.set_header("Vary", "Accept-Encoding");
  12128. }
  12129. }
  12130. }
  12131. res.content_length_ = res.body.size();
  12132. res.set_header("Content-Length", std::to_string(res.content_length_));
  12133. }
  12134. }
  12135. inline bool Server::dispatch_request_for_content_reader(
  12136. Request &req, Response &res, ContentReader content_reader,
  12137. const HandlersForContentReader &handlers) const {
  12138. for (const auto &x : handlers) {
  12139. const auto &matcher = x.first;
  12140. const auto &handler = x.second;
  12141. if (matcher->match(req)) {
  12142. req.matched_route = matcher->pattern();
  12143. if (!pre_request_handler_ ||
  12144. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12145. handler(req, res, content_reader);
  12146. }
  12147. return true;
  12148. }
  12149. }
  12150. return false;
  12151. }
  12152. inline std::string
  12153. get_client_ip(const std::string &x_forwarded_for,
  12154. const std::vector<std::string> &trusted_proxies) {
  12155. // X-Forwarded-For is a comma-separated list per RFC 7239
  12156. std::vector<std::string> ip_list;
  12157. detail::split(x_forwarded_for.data(),
  12158. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12159. [&](const char *b, const char *e) {
  12160. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12161. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12162. });
  12163. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12164. // no segments. Signal "no client IP derived" with an empty string so the
  12165. // caller can fall back to the connection-level remote address.
  12166. if (ip_list.empty()) { return std::string(); }
  12167. // Each hop appends the address it received the request from, so the rightmost
  12168. // entries are the ones written by our own infrastructure while the leftmost
  12169. // are whatever the original client chose to send. Walk from the right and
  12170. // skip trusted proxies; the first address that is not a trusted proxy is the
  12171. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12172. // from the left instead lets a client forge an arbitrary address by following
  12173. // it with a trusted proxy's address, which the left-to-right scan then
  12174. // returned as the client.
  12175. for (size_t i = ip_list.size(); i-- > 0;) {
  12176. const auto &ip = ip_list[i];
  12177. auto is_trusted_proxy =
  12178. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12179. [&](const std::string &proxy) { return ip == proxy; });
  12180. if (!is_trusted_proxy) { return ip; }
  12181. }
  12182. // Every hop was a trusted proxy; fall back to the first entry.
  12183. return ip_list.front();
  12184. }
  12185. inline bool
  12186. Server::process_request(Stream &strm, const std::string &remote_addr,
  12187. int remote_port, const std::string &local_addr,
  12188. int local_port, bool close_connection,
  12189. bool &connection_closed,
  12190. const std::function<void(Request &)> &setup_request,
  12191. bool *websocket_upgraded) {
  12192. std::array<char, 2048> buf{};
  12193. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12194. // Connection has been closed on client
  12195. if (!line_reader.getline()) { return false; }
  12196. Request req;
  12197. req.start_time_ = std::chrono::steady_clock::now();
  12198. req.remote_addr = remote_addr;
  12199. req.remote_port = remote_port;
  12200. req.local_addr = local_addr;
  12201. req.local_port = local_port;
  12202. Response res;
  12203. res.version = "HTTP/1.1";
  12204. res.headers = default_headers_;
  12205. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12206. // close the connection after that response, whichever path wrote it (an
  12207. // error status, a handler, or a rejected request). Reading on would also
  12208. // parse whatever the client sent next on a connection it considers done.
  12209. auto honor_connection_close = detail::scope_exit([&] {
  12210. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12211. connection_closed = true;
  12212. }
  12213. });
  12214. // Request line and headers. A rejected message leaves the rest of it (and
  12215. // any body) unread, so the connection cannot be reused: the leftover bytes
  12216. // would be parsed as the next request.
  12217. if (!parse_request_line(line_reader.ptr(), req)) {
  12218. connection_closed = true;
  12219. res.status = StatusCode::BadRequest_400;
  12220. output_error_log(Error::InvalidRequestLine, &req);
  12221. return write_response(strm, close_connection, req, res);
  12222. }
  12223. // Request headers
  12224. if (!detail::read_headers(strm, req.headers)) {
  12225. connection_closed = true;
  12226. res.status = StatusCode::BadRequest_400;
  12227. output_error_log(Error::InvalidHeaders, &req);
  12228. return write_response(strm, close_connection, req, res);
  12229. }
  12230. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12231. // which would otherwise let an intermediary and this parser disagree on
  12232. // where the body ends and enable request smuggling. Three cases: a
  12233. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12234. // or empty), which would otherwise be read as "no body"; a non-zero
  12235. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12236. // tolerated for compatibility with existing clients); and a
  12237. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12238. // length undeterminable. None of them may fall through to the "no body"
  12239. // path, or the body bytes are parsed as the next request on a persistent
  12240. // connection.
  12241. auto is_invalid_content_length = false;
  12242. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12243. is_invalid_content_length);
  12244. if (is_invalid_content_length ||
  12245. detail::has_conflicting_content_length(req.headers) ||
  12246. (req.has_header("Transfer-Encoding") &&
  12247. !detail::is_chunked_transfer_encoding(req.headers))) {
  12248. connection_closed = true;
  12249. res.status = StatusCode::BadRequest_400;
  12250. return write_response(strm, close_connection, req, res);
  12251. }
  12252. // Check if the request URI doesn't exceed the limit
  12253. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12254. connection_closed = true;
  12255. res.status = StatusCode::UriTooLong_414;
  12256. output_error_log(Error::ExceedUriMaxLength, &req);
  12257. return write_response(strm, close_connection, req, res);
  12258. }
  12259. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12260. connection_closed = true;
  12261. }
  12262. if (req.version == "HTTP/1.0" &&
  12263. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12264. connection_closed = true;
  12265. }
  12266. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12267. // itself a trusted proxy. Otherwise any direct client could spoof
  12268. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12269. auto is_trusted_peer = std::any_of(
  12270. trusted_proxies_.begin(), trusted_proxies_.end(),
  12271. [&](const std::string &proxy) { return proxy == remote_addr; });
  12272. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12273. // Some proxies append the address they observed as a separate
  12274. // X-Forwarded-For field line instead of extending the one the client sent
  12275. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12276. // be scanned. Reading only the first occurrence would hand back the
  12277. // client-supplied, and therefore forgeable, value.
  12278. auto x_forwarded_for =
  12279. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12280. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12281. req.remote_addr = derived.empty() ? remote_addr : derived;
  12282. } else {
  12283. req.remote_addr = remote_addr;
  12284. }
  12285. req.remote_port = remote_port;
  12286. req.local_addr = local_addr;
  12287. req.local_port = local_port;
  12288. if (req.has_header("Accept")) {
  12289. auto accept_header =
  12290. detail::get_combined_header_value(req.headers, "Accept");
  12291. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12292. connection_closed = true;
  12293. res.status = StatusCode::BadRequest_400;
  12294. output_error_log(Error::HTTPParsing, &req);
  12295. return write_response(strm, close_connection, req, res);
  12296. }
  12297. }
  12298. if (req.has_header("Range")) {
  12299. const auto &range_header_value = req.get_header_value("Range");
  12300. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12301. connection_closed = true;
  12302. res.status = StatusCode::RangeNotSatisfiable_416;
  12303. output_error_log(Error::InvalidRangeHeader, &req);
  12304. return write_response(strm, close_connection, req, res);
  12305. }
  12306. }
  12307. if (setup_request) { setup_request(req); }
  12308. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12309. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12310. // must be ignored. An expectation we do not recognize is left alone; the
  12311. // 417 the section allows for one is a MAY, not a requirement.
  12312. //
  12313. // `100 Continue` itself is deferred until the body is actually read (see
  12314. // read_content_core), so a request rejected by a later handler never
  12315. // invites the client to send a body nobody will read.
  12316. if (req.version != "HTTP/1.0" &&
  12317. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12318. int status = StatusCode::Continue_100;
  12319. if (expect_100_continue_handler_) {
  12320. status = expect_100_continue_handler_(req, res);
  12321. }
  12322. if (status == StatusCode::Continue_100) {
  12323. req.expect_100_continue_pending_ = true;
  12324. } else {
  12325. if (res.status == -1) { res.status = status; }
  12326. connection_closed = true;
  12327. return write_response(strm, true, req, res);
  12328. }
  12329. }
  12330. // Setup `is_connection_closed` method
  12331. auto sock = strm.socket();
  12332. req.is_connection_closed = [sock]() {
  12333. return !detail::is_socket_alive(sock);
  12334. };
  12335. // WebSocket upgrade
  12336. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12337. // that authentication and other middleware can reject the request with an
  12338. // HTTP response (e.g., 401) before the protocol switches.
  12339. if (detail::is_websocket_upgrade(req)) {
  12340. if (pre_routing_handler_ &&
  12341. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12342. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12343. return write_response_with_content(strm, close_connection, req, res);
  12344. }
  12345. // Find matching WebSocket handler
  12346. for (const auto &entry : websocket_handlers_) {
  12347. if (entry.matcher->match(req)) {
  12348. req.matched_route = entry.matcher->pattern();
  12349. if (pre_request_handler_ &&
  12350. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12351. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12352. return write_response_with_content(strm, close_connection, req, res);
  12353. }
  12354. // Compute accept key
  12355. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12356. auto accept_key = detail::websocket_accept_key(client_key);
  12357. // Negotiate subprotocol
  12358. std::string selected_subprotocol;
  12359. if (entry.sub_protocol_selector) {
  12360. auto protocol_header = detail::get_combined_header_value(
  12361. req.headers, "Sec-WebSocket-Protocol");
  12362. if (!protocol_header.empty()) {
  12363. std::vector<std::string> protocols;
  12364. detail::split(protocol_header.data(),
  12365. protocol_header.data() + protocol_header.size(), ',',
  12366. [&](const char *b, const char *e) {
  12367. protocols.emplace_back(b, e);
  12368. });
  12369. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12370. }
  12371. }
  12372. // Send 101 Switching Protocols
  12373. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12374. "Upgrade: websocket\r\n"
  12375. "Connection: Upgrade\r\n"
  12376. "Sec-WebSocket-Accept: " +
  12377. accept_key + "\r\n";
  12378. if (!selected_subprotocol.empty()) {
  12379. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12380. return false;
  12381. }
  12382. handshake_response +=
  12383. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12384. }
  12385. handshake_response += "\r\n";
  12386. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12387. 0) {
  12388. return false;
  12389. }
  12390. connection_closed = true;
  12391. if (websocket_upgraded) { *websocket_upgraded = true; }
  12392. {
  12393. #ifdef CPPHTTPLIB_SSL_ENABLED
  12394. if (req.ssl) {
  12395. // wss: the heartbeat ping thread and the read path enter the same
  12396. // TLS session from different threads. Hand the WebSocket a stream
  12397. // that serializes every TLS call, so the shared SSLSocketStream on
  12398. // the plain HTTP/HTTPS paths stays untouched.
  12399. auto ws_strm =
  12400. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12401. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12402. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12403. write_timeout_sec_, write_timeout_usec_));
  12404. ws::WebSocket ws(std::move(ws_strm), req, true,
  12405. websocket_ping_interval_sec_,
  12406. websocket_max_missed_pongs_);
  12407. entry.handler(req, ws);
  12408. return true;
  12409. }
  12410. #endif
  12411. // Use WebSocket-specific read timeout instead of HTTP timeout
  12412. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12413. 0);
  12414. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12415. websocket_max_missed_pongs_);
  12416. entry.handler(req, ws);
  12417. }
  12418. return true;
  12419. }
  12420. }
  12421. // No matching handler - fall through to 404
  12422. }
  12423. // Routing
  12424. auto routed = false;
  12425. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12426. routed = routing(req, res, strm);
  12427. #else
  12428. try {
  12429. routed = routing(req, res, strm);
  12430. } catch (std::exception &) {
  12431. if (exception_handler_) {
  12432. auto ep = std::current_exception();
  12433. exception_handler_(req, res, ep);
  12434. routed = true;
  12435. } else {
  12436. res.status = StatusCode::InternalServerError_500;
  12437. }
  12438. } catch (...) {
  12439. if (exception_handler_) {
  12440. auto ep = std::current_exception();
  12441. exception_handler_(req, res, ep);
  12442. routed = true;
  12443. } else {
  12444. res.status = StatusCode::InternalServerError_500;
  12445. }
  12446. }
  12447. #endif
  12448. auto ret = false;
  12449. if (routed) {
  12450. if (res.status == -1) {
  12451. res.status = req.ranges.empty() ? StatusCode::OK_200
  12452. : StatusCode::PartialContent_206;
  12453. }
  12454. // Serve file content by using a content provider
  12455. auto file_open_error = false;
  12456. if (!res.file_content_path_.empty()) {
  12457. const auto &path = res.file_content_path_;
  12458. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12459. if (!mm->is_open()) {
  12460. res.body.clear();
  12461. res.content_length_ = 0;
  12462. res.content_provider_ = nullptr;
  12463. res.status = StatusCode::NotFound_404;
  12464. output_error_log(Error::OpenFile, &req);
  12465. file_open_error = true;
  12466. } else {
  12467. auto content_type = res.file_content_content_type_;
  12468. if (content_type.empty()) {
  12469. content_type = detail::find_content_type(
  12470. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12471. }
  12472. detail::set_file_content_provider(
  12473. res, mm, content_type,
  12474. static_file_encoding(req, res, content_type, mm->size()));
  12475. }
  12476. }
  12477. if (file_open_error) {
  12478. ret = write_response(strm, close_connection, req, res);
  12479. } else if (detail::range_error(req, res)) {
  12480. res.body.clear();
  12481. res.content_length_ = 0;
  12482. res.content_provider_ = nullptr;
  12483. res.status = StatusCode::RangeNotSatisfiable_416;
  12484. ret = write_response(strm, close_connection, req, res);
  12485. } else {
  12486. ret = write_response_with_content(strm, close_connection, req, res);
  12487. }
  12488. } else {
  12489. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12490. ret = write_response(strm, close_connection, req, res);
  12491. }
  12492. // Drain any unconsumed framed body to prevent request smuggling on
  12493. // keep-alive. Without framing there is no body to drain — reading would
  12494. // consume the next request (issue #2450). If the response has committed the
  12495. // connection to close, there is no next request to protect.
  12496. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12497. !detail::has_header_token(res.headers, "Connection", "close")) {
  12498. int dummy_status;
  12499. if (!detail::read_content(
  12500. strm, req, payload_max_length_, dummy_status, nullptr,
  12501. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12502. connection_closed = true;
  12503. }
  12504. }
  12505. return ret;
  12506. }
  12507. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12508. inline bool Server::process_and_close_socket(socket_t sock) {
  12509. std::string remote_addr;
  12510. int remote_port = 0;
  12511. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12512. std::string local_addr;
  12513. int local_port = 0;
  12514. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12515. bool websocket_upgraded = false;
  12516. auto ret = serve_guarded([&]() {
  12517. return detail::process_server_socket(
  12518. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12519. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12520. write_timeout_usec_,
  12521. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12522. return process_request(strm, remote_addr, remote_port, local_addr,
  12523. local_port, close_connection,
  12524. connection_closed, nullptr,
  12525. &websocket_upgraded);
  12526. });
  12527. });
  12528. detail::drain_and_close_socket(sock);
  12529. return ret;
  12530. }
  12531. inline void Server::output_log(const Request &req, const Response &res) const {
  12532. if (logger_) {
  12533. std::lock_guard<std::mutex> guard(logger_mutex_);
  12534. logger_(req, res);
  12535. }
  12536. }
  12537. inline void Server::output_pre_compression_log(const Request &req,
  12538. const Response &res) const {
  12539. if (pre_compression_logger_) {
  12540. std::lock_guard<std::mutex> guard(logger_mutex_);
  12541. pre_compression_logger_(req, res);
  12542. }
  12543. }
  12544. inline void Server::output_error_log(const Error &err,
  12545. const Request *req) const {
  12546. if (error_logger_) {
  12547. std::lock_guard<std::mutex> guard(logger_mutex_);
  12548. error_logger_(err, req);
  12549. }
  12550. }
  12551. /*
  12552. * Group 5: ClientImpl and Client (Universal) implementation
  12553. */
  12554. // HTTP client implementation
  12555. inline ClientImpl::ClientImpl(const std::string &host)
  12556. : ClientImpl(host, 80, std::string(), std::string()) {}
  12557. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12558. : ClientImpl(host, port, std::string(), std::string()) {}
  12559. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12560. const std::string &client_cert_path,
  12561. const std::string &client_key_path)
  12562. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12563. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12564. inline ClientImpl::~ClientImpl() {
  12565. // Wait until all the requests in flight are handled.
  12566. size_t retry_count = 10;
  12567. while (retry_count-- > 0) {
  12568. {
  12569. std::lock_guard<std::mutex> guard(socket_mutex_);
  12570. if (socket_requests_in_flight_ == 0) { break; }
  12571. }
  12572. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12573. }
  12574. std::lock_guard<std::mutex> guard(socket_mutex_);
  12575. shutdown_socket(socket_);
  12576. close_socket(socket_);
  12577. }
  12578. inline bool ClientImpl::is_valid() const { return true; }
  12579. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12580. client_cert_path_ = rhs.client_cert_path_;
  12581. client_key_path_ = rhs.client_key_path_;
  12582. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12583. read_timeout_sec_ = rhs.read_timeout_sec_;
  12584. read_timeout_usec_ = rhs.read_timeout_usec_;
  12585. write_timeout_sec_ = rhs.write_timeout_sec_;
  12586. write_timeout_usec_ = rhs.write_timeout_usec_;
  12587. max_timeout_msec_ = rhs.max_timeout_msec_;
  12588. basic_auth_username_ = rhs.basic_auth_username_;
  12589. basic_auth_password_ = rhs.basic_auth_password_;
  12590. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12591. keep_alive_ = rhs.keep_alive_;
  12592. follow_location_ = rhs.follow_location_;
  12593. path_encode_ = rhs.path_encode_;
  12594. address_family_ = rhs.address_family_;
  12595. tcp_nodelay_ = rhs.tcp_nodelay_;
  12596. ipv6_v6only_ = rhs.ipv6_v6only_;
  12597. socket_options_ = rhs.socket_options_;
  12598. compress_ = rhs.compress_;
  12599. decompress_ = rhs.decompress_;
  12600. payload_max_length_ = rhs.payload_max_length_;
  12601. has_payload_max_length_ = rhs.has_payload_max_length_;
  12602. interface_ = rhs.interface_;
  12603. proxy_host_ = rhs.proxy_host_;
  12604. proxy_port_ = rhs.proxy_port_;
  12605. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12606. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12607. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12608. no_proxy_entries_ = rhs.no_proxy_entries_;
  12609. logger_ = rhs.logger_;
  12610. error_logger_ = rhs.error_logger_;
  12611. #ifdef CPPHTTPLIB_SSL_ENABLED
  12612. digest_auth_username_ = rhs.digest_auth_username_;
  12613. digest_auth_password_ = rhs.digest_auth_password_;
  12614. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12615. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12616. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12617. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12618. server_certificate_verification_ = rhs.server_certificate_verification_;
  12619. server_hostname_verification_ = rhs.server_hostname_verification_;
  12620. system_ca_mode_ = rhs.system_ca_mode_;
  12621. #endif
  12622. }
  12623. inline bool
  12624. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12625. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12626. if (no_proxy_entries_.empty()) { return true; }
  12627. // host_ is const so its normalized form is invariant; cache it. The
  12628. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12629. if (host == host_) {
  12630. if (!host_normalized_valid_) {
  12631. host_normalized_ = detail::normalize_target(host_);
  12632. host_normalized_valid_ = true;
  12633. }
  12634. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12635. }
  12636. auto target = detail::normalize_target(host);
  12637. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12638. }
  12639. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12640. if (is_proxy_enabled_for_host(host_)) {
  12641. return detail::create_client_socket(
  12642. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12643. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12644. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12645. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12646. }
  12647. // Check is custom IP or hostname specified for host_
  12648. std::string connect_host;
  12649. std::string ip;
  12650. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12651. return detail::create_client_socket(
  12652. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12653. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12654. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12655. write_timeout_usec_, interface_, error);
  12656. }
  12657. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12658. Error &error) {
  12659. auto sock = create_client_socket(error);
  12660. if (sock == INVALID_SOCKET) { return false; }
  12661. socket.sock = sock;
  12662. return true;
  12663. }
  12664. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12665. return create_and_connect_socket(socket, error);
  12666. }
  12667. inline bool ClientImpl::setup_proxy_connection(
  12668. Socket & /*socket*/,
  12669. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12670. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12671. return true;
  12672. }
  12673. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12674. bool /*shutdown_gracefully*/) {
  12675. // If there are any requests in flight from threads other than us, then it's
  12676. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12677. assert(socket_requests_in_flight_ == 0 ||
  12678. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12679. }
  12680. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12681. if (socket.sock == INVALID_SOCKET) { return; }
  12682. detail::shutdown_socket(socket.sock);
  12683. }
  12684. inline void ClientImpl::close_socket(Socket &socket) {
  12685. // If there are requests in flight in another thread, usually closing
  12686. // the socket will be fine and they will simply receive an error when
  12687. // using the closed socket, but it is still a bug since rarely the OS
  12688. // may reassign the socket id to be used for a new socket, and then
  12689. // suddenly they will be operating on a live socket that is different
  12690. // than the one they intended!
  12691. assert(socket_requests_in_flight_ == 0 ||
  12692. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12693. // It is also a bug if this happens while SSL is still active
  12694. #ifdef CPPHTTPLIB_SSL_ENABLED
  12695. assert(socket.ssl == nullptr);
  12696. #endif
  12697. if (socket.sock == INVALID_SOCKET) { return; }
  12698. detail::close_socket(socket.sock);
  12699. socket.sock = INVALID_SOCKET;
  12700. }
  12701. inline void ClientImpl::disconnect(bool gracefully) {
  12702. shutdown_ssl(socket_, gracefully);
  12703. shutdown_socket(socket_);
  12704. close_socket(socket_);
  12705. }
  12706. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12707. Response &res,
  12708. bool skip_100_continue) const {
  12709. std::array<char, 2048> buf{};
  12710. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12711. if (!line_reader.getline()) { return false; }
  12712. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12713. res.reason)) {
  12714. return req.method == "CONNECT";
  12715. }
  12716. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12717. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12718. if (!line_reader.getline()) { return false; } // CRLF
  12719. if (!line_reader.getline()) { return false; } // next response line
  12720. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12721. res.reason)) {
  12722. return false;
  12723. }
  12724. }
  12725. return true;
  12726. }
  12727. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12728. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12729. auto ret = send_(req, res, error);
  12730. if (error == Error::SSLPeerCouldBeClosed_) {
  12731. assert(!ret);
  12732. ret = send_(req, res, error);
  12733. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12734. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12735. }
  12736. return ret;
  12737. }
  12738. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12739. {
  12740. std::lock_guard<std::mutex> guard(socket_mutex_);
  12741. // Set this to false immediately - if it ever gets set to true by the end
  12742. // of the request, we know another thread instructed us to close the
  12743. // socket.
  12744. socket_should_be_closed_when_request_is_done_ = false;
  12745. auto is_alive = false;
  12746. if (socket_.is_open()) {
  12747. is_alive = detail::is_socket_alive(socket_.sock);
  12748. #ifdef CPPHTTPLIB_SSL_ENABLED
  12749. if (is_alive && is_ssl()) {
  12750. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12751. is_alive = false;
  12752. }
  12753. }
  12754. #endif
  12755. if (!is_alive) {
  12756. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12757. disconnect(/*gracefully=*/false);
  12758. }
  12759. }
  12760. if (!is_alive) {
  12761. if (!ensure_socket_connection(socket_, error)) {
  12762. output_error_log(error, &req);
  12763. return false;
  12764. }
  12765. {
  12766. auto success = true;
  12767. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12768. error)) {
  12769. if (!success) { output_error_log(error, &req); }
  12770. return success;
  12771. }
  12772. }
  12773. }
  12774. // Mark the current socket as being in use so that it cannot be closed by
  12775. // anyone else while this request is ongoing, even though we will be
  12776. // releasing the mutex.
  12777. if (socket_requests_in_flight_ > 1) {
  12778. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12779. }
  12780. socket_requests_in_flight_ += 1;
  12781. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12782. }
  12783. for (const auto &header : default_headers_) {
  12784. if (req.headers.find(header.first) == req.headers.end()) {
  12785. req.headers.insert(header);
  12786. }
  12787. }
  12788. auto ret = false;
  12789. auto close_connection = !keep_alive_;
  12790. auto se = detail::scope_exit([&]() {
  12791. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12792. std::lock_guard<std::mutex> guard(socket_mutex_);
  12793. socket_requests_in_flight_ -= 1;
  12794. if (socket_requests_in_flight_ <= 0) {
  12795. assert(socket_requests_in_flight_ == 0);
  12796. socket_requests_are_from_thread_ = std::thread::id();
  12797. }
  12798. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12799. !ret) {
  12800. disconnect(/*gracefully=*/true);
  12801. }
  12802. });
  12803. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12804. return handle_request(strm, req, res, close_connection, error);
  12805. });
  12806. if (!ret) {
  12807. if (error == Error::Success) {
  12808. error = Error::Unknown;
  12809. output_error_log(error, &req);
  12810. }
  12811. }
  12812. return ret;
  12813. }
  12814. inline Result ClientImpl::send(const Request &req) {
  12815. auto req2 = req;
  12816. return send_(std::move(req2));
  12817. }
  12818. inline Result ClientImpl::send_(Request &&req) {
  12819. auto res = detail::make_unique<Response>();
  12820. auto error = Error::Success;
  12821. auto ret = send(req, *res, error);
  12822. #ifdef CPPHTTPLIB_SSL_ENABLED
  12823. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12824. last_ssl_error_, last_backend_error_};
  12825. #else
  12826. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12827. #endif
  12828. }
  12829. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12830. const std::string &ct) {
  12831. (void)for_stream;
  12832. // Default headers are meant for the origin and may carry its credentials, so
  12833. // keep them off the CONNECT request the proxy reads.
  12834. if (r.method != "CONNECT") {
  12835. for (const auto &header : default_headers_) {
  12836. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12837. }
  12838. }
  12839. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12840. // prepend it rather than appending it after the caller's own fields.
  12841. if (!r.has_header("Host")) {
  12842. r.headers.emplace_front(
  12843. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12844. address_family_));
  12845. }
  12846. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12847. if (!r.content_receiver) {
  12848. if (!r.has_header("Accept-Encoding")) {
  12849. std::string accept_encoding;
  12850. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12851. accept_encoding = "br";
  12852. #endif
  12853. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12854. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12855. accept_encoding += "gzip, deflate";
  12856. #endif
  12857. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12858. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12859. accept_encoding += "zstd";
  12860. #endif
  12861. r.set_header("Accept-Encoding", accept_encoding);
  12862. }
  12863. detail::add_default_user_agent_header(r);
  12864. }
  12865. if (!r.body.empty()) {
  12866. if (!ct.empty() && !r.has_header("Content-Type")) {
  12867. r.headers.emplace("Content-Type", ct);
  12868. }
  12869. if (!r.has_header("Content-Length")) {
  12870. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12871. }
  12872. }
  12873. }
  12874. inline ClientImpl::StreamHandle
  12875. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12876. const Params &params, const Headers &headers,
  12877. const std::string &body,
  12878. const std::string &content_type) {
  12879. StreamHandle handle;
  12880. handle.response = detail::make_unique<Response>();
  12881. handle.error = Error::Success;
  12882. // Encode the target exactly like the buffered send path does, so that the
  12883. // same `path` produces the same request line through either API.
  12884. auto raw_query_path =
  12885. params.empty() ? path : append_query_params(path, params);
  12886. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12887. handle.connection_ = detail::make_unique<ClientConnection>();
  12888. {
  12889. std::lock_guard<std::mutex> guard(socket_mutex_);
  12890. auto is_alive = false;
  12891. if (socket_.is_open()) {
  12892. is_alive = detail::is_socket_alive(socket_.sock);
  12893. #ifdef CPPHTTPLIB_SSL_ENABLED
  12894. if (is_alive && is_ssl()) {
  12895. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12896. is_alive = false;
  12897. }
  12898. }
  12899. #endif
  12900. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12901. }
  12902. if (!is_alive) {
  12903. if (!ensure_socket_connection(socket_, handle.error)) {
  12904. handle.response.reset();
  12905. return handle;
  12906. }
  12907. {
  12908. auto success = true;
  12909. auto start_time = std::chrono::steady_clock::now();
  12910. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12911. success, handle.error)) {
  12912. if (!success) { handle.response.reset(); }
  12913. return handle;
  12914. }
  12915. }
  12916. }
  12917. transfer_socket_ownership_to_handle(handle);
  12918. }
  12919. #ifdef CPPHTTPLIB_SSL_ENABLED
  12920. if (is_ssl() && handle.connection_->session) {
  12921. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12922. handle.connection_->sock, handle.connection_->session,
  12923. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12924. write_timeout_usec_);
  12925. } else {
  12926. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12927. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12928. write_timeout_sec_, write_timeout_usec_);
  12929. }
  12930. #else
  12931. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12932. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12933. write_timeout_sec_, write_timeout_usec_);
  12934. #endif
  12935. handle.stream_ = handle.socket_stream_.get();
  12936. Request req;
  12937. req.method = method;
  12938. req.path = query_path;
  12939. req.headers = headers;
  12940. req.body = body;
  12941. prepare_default_headers(req, true, content_type);
  12942. auto &strm = *handle.stream_;
  12943. // Build the request line and headers in memory first, like write_request()
  12944. // does, so that a rejected header leaves nothing on the wire.
  12945. {
  12946. detail::BufferStream bstrm;
  12947. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12948. handle.error = Error::Write;
  12949. handle.response.reset();
  12950. return handle;
  12951. }
  12952. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12953. handle.error)) {
  12954. handle.response.reset();
  12955. return handle;
  12956. }
  12957. const auto &data = bstrm.get_buffer();
  12958. if (!detail::write_data(strm, data.data(), data.size())) {
  12959. handle.error = Error::Write;
  12960. handle.response.reset();
  12961. return handle;
  12962. }
  12963. }
  12964. if (!body.empty()) {
  12965. if (strm.write(body.data(), body.size()) < 0) {
  12966. handle.error = Error::Write;
  12967. handle.response.reset();
  12968. return handle;
  12969. }
  12970. }
  12971. if (!read_response_line(strm, req, *handle.response) ||
  12972. !detail::read_headers(strm, handle.response->headers)) {
  12973. handle.error = Error::Read;
  12974. handle.response.reset();
  12975. return handle;
  12976. }
  12977. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  12978. // (204/304) response legitimately carries framing headers with no body.
  12979. if (method != "HEAD" &&
  12980. handle.response->status != StatusCode::NoContent_204 &&
  12981. handle.response->status != StatusCode::NotModified_304 &&
  12982. detail::has_conflicting_content_length(handle.response->headers)) {
  12983. handle.error = Error::Read;
  12984. handle.response.reset();
  12985. return handle;
  12986. }
  12987. handle.body_reader_.stream = handle.stream_;
  12988. handle.body_reader_.payload_max_length = payload_max_length_;
  12989. if (handle.response->has_header("Content-Length")) {
  12990. bool is_invalid = false;
  12991. auto content_length = detail::get_header_value_u64(
  12992. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12993. if (is_invalid) {
  12994. handle.error = Error::Read;
  12995. handle.response.reset();
  12996. return handle;
  12997. }
  12998. handle.body_reader_.has_content_length = true;
  12999. handle.body_reader_.content_length = content_length;
  13000. }
  13001. handle.body_reader_.chunked =
  13002. detail::is_chunked_transfer_encoding(handle.response->headers);
  13003. auto content_encoding = detail::get_combined_header_value(
  13004. handle.response->headers, "Content-Encoding");
  13005. if (!content_encoding.empty()) {
  13006. // Same policy as prepare_content_receiver(): reject a coding we know about
  13007. // but were not built with, pass an unrecognized one through as-is.
  13008. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13009. if (!handle.decompressor_) {
  13010. if (detail::is_known_content_encoding(content_encoding)) {
  13011. handle.error = Error::UnsupportedContentEncoding;
  13012. handle.response.reset();
  13013. return handle;
  13014. }
  13015. } else if (!handle.decompressor_->is_valid()) {
  13016. handle.error = Error::Compression;
  13017. handle.response.reset();
  13018. return handle;
  13019. }
  13020. }
  13021. return handle;
  13022. }
  13023. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13024. if (!is_valid() || !response) { return -1; }
  13025. if (decompressor_) { return read_with_decompression(buf, len); }
  13026. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13027. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13028. trailers_parsed_ = true;
  13029. if (body_reader_.chunked_decoder) {
  13030. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13031. response->trailers, response->headers)) {
  13032. return n;
  13033. }
  13034. } else {
  13035. detail::ChunkedDecoder dec(*stream_);
  13036. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13037. return n;
  13038. }
  13039. }
  13040. }
  13041. return n;
  13042. }
  13043. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13044. size_t len) {
  13045. if (decompress_offset_ < decompress_buffer_.size()) {
  13046. auto available = decompress_buffer_.size() - decompress_offset_;
  13047. auto to_copy = (std::min)(len, available);
  13048. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13049. decompress_offset_ += to_copy;
  13050. decompressed_bytes_read_ += to_copy;
  13051. return static_cast<ssize_t>(to_copy);
  13052. }
  13053. decompress_buffer_.clear();
  13054. decompress_offset_ = 0;
  13055. constexpr size_t kDecompressionBufferSize = 8192;
  13056. char compressed_buf[kDecompressionBufferSize];
  13057. while (true) {
  13058. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13059. sizeof(compressed_buf));
  13060. if (n <= 0) { return n; }
  13061. bool decompress_ok = decompressor_->decompress(
  13062. compressed_buf, static_cast<size_t>(n),
  13063. [this](const char *data, size_t data_len) {
  13064. decompress_buffer_.append(data, data_len);
  13065. auto limit = body_reader_.payload_max_length;
  13066. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13067. return false;
  13068. }
  13069. return true;
  13070. });
  13071. if (!decompress_ok) {
  13072. body_reader_.last_error = Error::Read;
  13073. return -1;
  13074. }
  13075. if (!decompress_buffer_.empty()) { break; }
  13076. }
  13077. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13078. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13079. decompress_offset_ = to_copy;
  13080. decompressed_bytes_read_ += to_copy;
  13081. return static_cast<ssize_t>(to_copy);
  13082. }
  13083. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13084. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13085. return;
  13086. }
  13087. trailers_parsed_ = true;
  13088. const auto bufsiz = 128;
  13089. char line_buf[bufsiz];
  13090. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13091. if (!line_reader.getline()) { return; }
  13092. if (!detail::parse_trailers(line_reader, response->trailers,
  13093. response->headers)) {
  13094. return;
  13095. }
  13096. }
  13097. namespace detail {
  13098. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13099. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13100. size_t &out_chunk_offset,
  13101. size_t &out_chunk_total) {
  13102. if (finished) { return 0; }
  13103. if (chunk_remaining == 0) {
  13104. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13105. if (!lr.getline()) { return -1; }
  13106. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13107. // the line terminator is never mistaken for line content.
  13108. const char *eol = lr.ptr() + lr.size();
  13109. if (lr.end_with_crlf()) {
  13110. eol -= 2;
  13111. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13112. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13113. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13114. // has to come off here or the check below would reject the line.
  13115. eol -= 1;
  13116. }
  13117. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13118. const char *p = lr.ptr();
  13119. int v = 0;
  13120. if (p == eol || !is_hex(*p, v)) { return -1; }
  13121. size_t chunk_len = 0;
  13122. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13123. for (; p < eol && is_hex(*p, v); ++p) {
  13124. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13125. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13126. }
  13127. while (p < eol && is_space_or_tab(*p)) {
  13128. ++p;
  13129. }
  13130. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13131. // terminator, and it is built from tokens and quoted-strings, so it never
  13132. // holds a CR, LF or any other control character. getline() reads up to the
  13133. // CRLF, so a bare LF left in here would be swallowed as extension text
  13134. // while an intermediary that ends the line on it delimits the chunks
  13135. // differently, and the two disagree on where the body ends (request
  13136. // smuggling).
  13137. if (p < eol && *p != ';') { return -1; }
  13138. for (; p < eol; ++p) {
  13139. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13140. }
  13141. if (chunk_len == 0) {
  13142. chunk_remaining = 0;
  13143. finished = true;
  13144. out_chunk_offset = 0;
  13145. out_chunk_total = 0;
  13146. return 0;
  13147. }
  13148. chunk_remaining = chunk_len;
  13149. last_chunk_total = chunk_remaining;
  13150. last_chunk_offset = 0;
  13151. }
  13152. auto to_read = (std::min)(chunk_remaining, len);
  13153. auto n = strm.read(buf, to_read);
  13154. if (n <= 0) { return -1; }
  13155. auto offset_before = last_chunk_offset;
  13156. last_chunk_offset += static_cast<size_t>(n);
  13157. chunk_remaining -= static_cast<size_t>(n);
  13158. out_chunk_offset = offset_before;
  13159. out_chunk_total = last_chunk_total;
  13160. if (chunk_remaining == 0) {
  13161. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13162. if (!lr.getline()) { return -1; }
  13163. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13164. }
  13165. return n;
  13166. }
  13167. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13168. const Headers &src_headers) {
  13169. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13170. if (!lr.getline()) { return false; }
  13171. return parse_trailers(lr, dest, src_headers);
  13172. }
  13173. } // namespace detail
  13174. inline void
  13175. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13176. handle.connection_->sock = socket_.sock;
  13177. #ifdef CPPHTTPLIB_SSL_ENABLED
  13178. handle.connection_->session = socket_.ssl;
  13179. socket_.ssl = nullptr;
  13180. #endif
  13181. socket_.sock = INVALID_SOCKET;
  13182. }
  13183. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13184. Response &res, bool close_connection,
  13185. Error &error) {
  13186. if (req.path.empty()) {
  13187. error = Error::Connection;
  13188. output_error_log(error, &req);
  13189. return false;
  13190. }
  13191. auto req_save = req;
  13192. bool ret;
  13193. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13194. auto req2 = req;
  13195. req2.path = "http://" +
  13196. detail::make_host_and_port_string(host_, port_, false) +
  13197. req.path;
  13198. ret = process_request(strm, req2, res, close_connection, error);
  13199. req = std::move(req2);
  13200. req.path = req_save.path;
  13201. } else {
  13202. ret = process_request(strm, req, res, close_connection, error);
  13203. }
  13204. if (!ret) { return false; }
  13205. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13206. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13207. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13208. // for this to be safe.
  13209. // This is safe to call because handle_request is only called by send_
  13210. // which locks the request mutex during the process. It would be a bug
  13211. // to call it from a different thread since it's a thread-safety issue
  13212. // to do these things to the socket if another thread is using the socket.
  13213. std::lock_guard<std::mutex> guard(socket_mutex_);
  13214. disconnect(/*gracefully=*/true);
  13215. }
  13216. if (300 < res.status && res.status < 400 && follow_location_) {
  13217. req = std::move(req_save);
  13218. ret = redirect(req, res, error);
  13219. }
  13220. #ifdef CPPHTTPLIB_SSL_ENABLED
  13221. if ((res.status == StatusCode::Unauthorized_401 ||
  13222. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13223. req.authorization_count_ < 5) {
  13224. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13225. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13226. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13227. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13228. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13229. return ret;
  13230. }
  13231. const auto &username =
  13232. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13233. const auto &password =
  13234. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13235. if (!username.empty() && !password.empty()) {
  13236. std::map<std::string, std::string> auth;
  13237. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13238. Request new_req = req;
  13239. new_req.authorization_count_ += 1;
  13240. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13241. : "Authorization");
  13242. new_req.headers.insert(detail::make_digest_authentication_header(
  13243. req, auth, new_req.authorization_count_, detail::random_string(10),
  13244. username, password, is_proxy));
  13245. Response new_res;
  13246. ret = send(new_req, new_res, error);
  13247. if (ret) { res = std::move(new_res); }
  13248. }
  13249. }
  13250. }
  13251. #endif
  13252. return ret;
  13253. }
  13254. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13255. if (req.redirect_count_ == 0) {
  13256. error = Error::ExceedRedirectCount;
  13257. output_error_log(error, &req);
  13258. return false;
  13259. }
  13260. auto location = res.get_header_value("location");
  13261. if (location.empty()) { return false; }
  13262. detail::UrlComponents uc;
  13263. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13264. uc)) {
  13265. return false;
  13266. }
  13267. // Only follow http/https redirects
  13268. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13269. return false;
  13270. }
  13271. auto scheme = is_ssl() ? "https" : "http";
  13272. auto next_scheme = std::move(uc.scheme);
  13273. auto next_host = std::move(uc.host);
  13274. auto port_str = std::move(uc.port);
  13275. auto next_path = std::move(uc.path);
  13276. auto next_query = std::move(uc.query);
  13277. auto next_port = port_;
  13278. if (!port_str.empty()) {
  13279. if (!detail::parse_port(port_str, next_port)) { return false; }
  13280. } else if (!next_scheme.empty()) {
  13281. next_port = next_scheme == "https" ? 443 : 80;
  13282. }
  13283. if (next_scheme.empty()) { next_scheme = scheme; }
  13284. if (next_host.empty()) { next_host = host_; }
  13285. if (next_path.empty()) { next_path = "/"; }
  13286. auto path = decode_path_component(next_path) + next_query;
  13287. // Same host redirect - use current client
  13288. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13289. return detail::redirect(*this, req, res, path, location, error);
  13290. }
  13291. // Cross-host/scheme redirect - create new client with robust setup
  13292. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13293. path, location, error);
  13294. }
  13295. // New method for robust redirect client creation
  13296. inline bool ClientImpl::create_redirect_client(
  13297. const std::string &scheme, const std::string &host, int port, Request &req,
  13298. Response &res, const std::string &path, const std::string &location,
  13299. Error &error) {
  13300. // Determine if we need SSL
  13301. auto need_ssl = (scheme == "https");
  13302. // Clean up request headers that are host/client specific
  13303. // Remove headers that should not be carried over to new host
  13304. auto headers_to_remove = std::vector<std::string>{
  13305. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13306. for (const auto &header_name : headers_to_remove) {
  13307. auto it = req.headers.find(header_name);
  13308. while (it != req.headers.end()) {
  13309. it = req.headers.erase(it);
  13310. it = req.headers.find(header_name);
  13311. }
  13312. }
  13313. // Create appropriate client type and handle redirect
  13314. if (need_ssl) {
  13315. #ifdef CPPHTTPLIB_SSL_ENABLED
  13316. // Create SSL client for HTTPS redirect
  13317. SSLClient redirect_client(host, port);
  13318. // Setup basic client configuration first
  13319. setup_redirect_client(redirect_client);
  13320. redirect_client.enable_server_certificate_verification(
  13321. server_certificate_verification_);
  13322. redirect_client.enable_server_hostname_verification(
  13323. server_hostname_verification_);
  13324. redirect_client.system_ca_mode_ = system_ca_mode_;
  13325. // Transfer CA certificate to redirect client
  13326. if (!ca_cert_pem_.empty()) {
  13327. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13328. ca_cert_pem_.size());
  13329. }
  13330. if (!ca_cert_file_path_.empty()) {
  13331. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13332. }
  13333. // Client certificates are set through constructor for SSLClient
  13334. // NOTE: SSLClient constructor already takes client_cert_path and
  13335. // client_key_path so we need to create it properly if client certs are
  13336. // needed
  13337. // Execute the redirect
  13338. return detail::redirect(redirect_client, req, res, path, location, error);
  13339. #else
  13340. // SSL not supported - set appropriate error
  13341. error = Error::SSLConnection;
  13342. output_error_log(error, &req);
  13343. return false;
  13344. #endif
  13345. } else {
  13346. // HTTP redirect
  13347. ClientImpl redirect_client(host, port);
  13348. // Setup client with robust configuration
  13349. setup_redirect_client(redirect_client);
  13350. // Execute the redirect
  13351. return detail::redirect(redirect_client, req, res, path, location, error);
  13352. }
  13353. }
  13354. // New method for robust client setup (based on basic_manual_redirect.cpp
  13355. // logic)
  13356. template <typename ClientType>
  13357. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13358. // Copy basic settings first
  13359. client.set_connection_timeout(connection_timeout_sec_);
  13360. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13361. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13362. client.set_keep_alive(keep_alive_);
  13363. client.set_follow_location(
  13364. true); // Enable redirects to handle multi-step redirects
  13365. client.set_path_encode(path_encode_);
  13366. client.set_compress(compress_);
  13367. client.set_decompress(decompress_);
  13368. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13369. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13370. // 15.4, credentials must not be forwarded when redirecting to a different
  13371. // host. This function is only called for cross-host redirects; same-host
  13372. // redirects are handled directly in ClientImpl::redirect().
  13373. // Copy the proxy configuration unconditionally; the per-target bypass is
  13374. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13375. // still use the proxy.
  13376. client.no_proxy_entries_ = no_proxy_entries_;
  13377. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13378. client.set_proxy(proxy_host_, proxy_port_);
  13379. if (!proxy_basic_auth_username_.empty()) {
  13380. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13381. proxy_basic_auth_password_);
  13382. }
  13383. if (!proxy_bearer_token_auth_token_.empty()) {
  13384. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13385. }
  13386. #ifdef CPPHTTPLIB_SSL_ENABLED
  13387. if (!proxy_digest_auth_username_.empty()) {
  13388. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13389. proxy_digest_auth_password_);
  13390. }
  13391. #endif
  13392. }
  13393. // Copy network and socket settings
  13394. client.set_address_family(address_family_);
  13395. client.set_tcp_nodelay(tcp_nodelay_);
  13396. client.set_ipv6_v6only(ipv6_v6only_);
  13397. if (socket_options_) { client.set_socket_options(socket_options_); }
  13398. if (!interface_.empty()) { client.set_interface(interface_); }
  13399. // Copy logging and headers
  13400. if (logger_) { client.set_logger(logger_); }
  13401. if (error_logger_) { client.set_error_logger(error_logger_); }
  13402. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13403. // Each new client should generate its own headers based on its target host
  13404. }
  13405. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13406. const Request &req,
  13407. Error &error) const {
  13408. auto is_shutting_down = []() { return false; };
  13409. if (req.is_chunked_content_provider_) {
  13410. auto compressor = compress_ ? detail::create_compressor().first
  13411. : std::unique_ptr<detail::compressor>();
  13412. if (!compressor) {
  13413. compressor = detail::make_unique<detail::nocompressor>();
  13414. }
  13415. return detail::write_content_chunked(strm, req.content_provider_,
  13416. is_shutting_down, *compressor, error);
  13417. } else {
  13418. return detail::write_content_with_progress(
  13419. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13420. req.upload_progress, error);
  13421. }
  13422. }
  13423. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13424. bool close_connection, Error &error,
  13425. bool skip_body, bool &rejected_locally) {
  13426. rejected_locally = false;
  13427. // Prepare additional headers
  13428. if (close_connection) {
  13429. if (!req.has_header("Connection")) {
  13430. req.set_header("Connection", "close");
  13431. }
  13432. }
  13433. std::string ct_for_defaults;
  13434. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13435. ct_for_defaults = "text/plain";
  13436. }
  13437. prepare_default_headers(req, false, ct_for_defaults);
  13438. if (req.body.empty()) {
  13439. if (req.content_provider_) {
  13440. if (!req.is_chunked_content_provider_) {
  13441. if (!req.has_header("Content-Length")) {
  13442. auto length = std::to_string(req.content_length_);
  13443. req.set_header("Content-Length", length);
  13444. }
  13445. }
  13446. } else {
  13447. if (req.method == "POST" || req.method == "PUT" ||
  13448. req.method == "PATCH") {
  13449. req.set_header("Content-Length", "0");
  13450. }
  13451. }
  13452. }
  13453. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13454. // it opens is read by the origin. Each credential goes only to its own hop.
  13455. auto is_connect = req.method == "CONNECT";
  13456. if (!is_connect && !req.has_header("Authorization")) {
  13457. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13458. req.headers.insert(make_basic_authentication_header(
  13459. basic_auth_username_, basic_auth_password_, false));
  13460. } else if (!bearer_token_auth_token_.empty()) {
  13461. req.headers.insert(make_bearer_token_authentication_header(
  13462. bearer_token_auth_token_, false));
  13463. }
  13464. }
  13465. // Proxy-Authorization is only sent when the proxy reads this message —
  13466. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13467. // would leak proxy credentials to the destination server.
  13468. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13469. if (!proxy_basic_auth_username_.empty() &&
  13470. !proxy_basic_auth_password_.empty() &&
  13471. !req.has_header("Proxy-Authorization")) {
  13472. req.headers.insert(make_basic_authentication_header(
  13473. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13474. }
  13475. if (!proxy_bearer_token_auth_token_.empty() &&
  13476. !req.has_header("Proxy-Authorization")) {
  13477. req.headers.insert(make_bearer_token_authentication_header(
  13478. proxy_bearer_token_auth_token_, true));
  13479. }
  13480. }
  13481. // Request line and headers
  13482. {
  13483. detail::BufferStream bstrm;
  13484. // Extract the query from req.path. The encoding itself is delegated to
  13485. // `encode_request_target`; the raw query is still needed here to decide
  13486. // between populating `req.params` from it and falling back to building a
  13487. // query out of caller-supplied `req.params`.
  13488. auto query_pos = req.path.find('?');
  13489. auto query_part = query_pos == std::string::npos
  13490. ? std::string()
  13491. : req.path.substr(query_pos + 1);
  13492. auto path_with_query =
  13493. detail::encode_request_target(req.path, path_encode_);
  13494. if (!query_part.empty()) {
  13495. // The query already came in through `req.path`; still populate
  13496. // `req.params` for handlers/users who read them.
  13497. detail::parse_query_text(query_part, req.params);
  13498. } else if (!req.params.empty()) {
  13499. // No query in `req.path`; build one from `req.params` so existing
  13500. // callers that pass `Params` separately continue to work.
  13501. path_with_query = append_query_params(path_with_query, req.params);
  13502. }
  13503. // Write request line and headers
  13504. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13505. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13506. // CR/LF smuggled in via a decoded redirect Location under
  13507. // set_path_encode(false)) must fail the request cleanly instead of
  13508. // emitting a request-line-less, header-injecting request.
  13509. error = Error::Write;
  13510. rejected_locally = true;
  13511. output_error_log(error, &req);
  13512. return false;
  13513. }
  13514. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13515. error)) {
  13516. rejected_locally = true;
  13517. output_error_log(error, &req);
  13518. return false;
  13519. }
  13520. // Flush buffer
  13521. auto &data = bstrm.get_buffer();
  13522. if (!detail::write_data(strm, data.data(), data.size())) {
  13523. error = Error::Write;
  13524. output_error_log(error, &req);
  13525. return false;
  13526. }
  13527. }
  13528. // After sending request line and headers, wait briefly for an early server
  13529. // response (e.g. 4xx) and avoid sending a potentially large request body
  13530. // unnecessarily. This workaround is only enabled on Windows because Unix
  13531. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13532. // buffering can accept large writes even when the peer already responded.
  13533. // Check the stream first (which covers SSL via `is_readable()`), then
  13534. // fall back to select on the socket. Only perform the wait for very large
  13535. // request bodies to avoid interfering with normal small requests and
  13536. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13537. // response. Skip this check when using Expect: 100-continue, as the protocol
  13538. // handles early responses properly.
  13539. #if defined(_WIN32)
  13540. if (!skip_body &&
  13541. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13542. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13543. auto start = std::chrono::high_resolution_clock::now();
  13544. for (;;) {
  13545. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13546. // from SSL internals. If the underlying socket is readable, assume an
  13547. // early response may be present.
  13548. auto sock = strm.socket();
  13549. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13550. return false;
  13551. }
  13552. // Fallback to stream-level check for non-socket streams or when the
  13553. // socket isn't reporting readable. Avoid using `is_readable()` for
  13554. // SSL, since `SSL_pending()` may report buffered records that do not
  13555. // indicate a complete application-level response yet.
  13556. if (!is_ssl() && strm.is_readable()) { return false; }
  13557. auto now = std::chrono::high_resolution_clock::now();
  13558. auto elapsed =
  13559. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13560. .count();
  13561. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13562. break;
  13563. }
  13564. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13565. }
  13566. }
  13567. #endif
  13568. // Body
  13569. if (skip_body) { return true; }
  13570. return write_request_body(strm, req, error);
  13571. }
  13572. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13573. Error &error) {
  13574. if (req.body.empty()) {
  13575. return write_content_with_provider(strm, req, error);
  13576. }
  13577. if (req.upload_progress) {
  13578. auto body_size = req.body.size();
  13579. size_t written = 0;
  13580. auto data = req.body.data();
  13581. while (written < body_size) {
  13582. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13583. if (!detail::write_data(strm, data + written, to_write)) {
  13584. error = Error::Write;
  13585. output_error_log(error, &req);
  13586. return false;
  13587. }
  13588. written += to_write;
  13589. if (!req.upload_progress(written, body_size)) {
  13590. error = Error::Canceled;
  13591. output_error_log(error, &req);
  13592. return false;
  13593. }
  13594. }
  13595. } else {
  13596. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13597. error = Error::Write;
  13598. output_error_log(error, &req);
  13599. return false;
  13600. }
  13601. }
  13602. return true;
  13603. }
  13604. inline std::unique_ptr<Response>
  13605. ClientImpl::send_with_content_provider_and_receiver(
  13606. Request &req, const char *body, size_t content_length,
  13607. ContentProvider content_provider,
  13608. ContentProviderWithoutLength content_provider_without_length,
  13609. const std::string &content_type, ContentReceiver content_receiver,
  13610. Error &error) {
  13611. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13612. auto enc = compress_
  13613. ? detail::create_compressor()
  13614. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13615. nullptr, nullptr);
  13616. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13617. if (enc.first && !content_provider_without_length) {
  13618. auto &compressor = enc.first;
  13619. if (content_provider) {
  13620. auto ok = true;
  13621. auto finished = false;
  13622. size_t offset = 0;
  13623. DataSink data_sink;
  13624. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13625. if (ok) {
  13626. auto last = offset + data_len == content_length;
  13627. auto ret = compressor->compress(
  13628. data, data_len, last,
  13629. [&](const char *compressed_data, size_t compressed_data_len) {
  13630. req.body.append(compressed_data, compressed_data_len);
  13631. return true;
  13632. });
  13633. if (ret) {
  13634. offset += data_len;
  13635. } else {
  13636. ok = false;
  13637. }
  13638. }
  13639. return ok;
  13640. };
  13641. // As in detail::write_content_with_progress(): the body is framed by
  13642. // content_length, so a provider that finishes early has truncated it.
  13643. // Stop and report that instead of calling the provider forever.
  13644. data_sink.done = [&]() { finished = true; };
  13645. while (ok && !finished && offset < content_length) {
  13646. if (!content_provider(offset, content_length - offset, data_sink)) {
  13647. error = Error::Canceled;
  13648. output_error_log(error, &req);
  13649. return nullptr;
  13650. }
  13651. }
  13652. // A short body here means either the provider stopped early or the
  13653. // compressor gave up. The branch below reports a failing compressor as
  13654. // Error::Compression, so keep the two distinguishable.
  13655. if (offset < content_length) {
  13656. error = ok ? Error::Write : Error::Compression;
  13657. output_error_log(error, &req);
  13658. return nullptr;
  13659. }
  13660. } else {
  13661. if (!compressor->compress(body, content_length, true,
  13662. [&](const char *data, size_t data_len) {
  13663. req.body.append(data, data_len);
  13664. return true;
  13665. })) {
  13666. error = Error::Compression;
  13667. output_error_log(error, &req);
  13668. return nullptr;
  13669. }
  13670. }
  13671. } else {
  13672. if (content_provider) {
  13673. req.content_length_ = content_length;
  13674. req.content_provider_ = std::move(content_provider);
  13675. req.is_chunked_content_provider_ = false;
  13676. } else if (content_provider_without_length) {
  13677. req.content_length_ = 0;
  13678. req.content_provider_ = detail::ContentProviderAdapter(
  13679. std::move(content_provider_without_length));
  13680. req.is_chunked_content_provider_ = true;
  13681. req.set_header("Transfer-Encoding", "chunked");
  13682. } else {
  13683. req.body.assign(body, content_length);
  13684. }
  13685. }
  13686. if (content_receiver) {
  13687. req.content_receiver =
  13688. [content_receiver](const char *data, size_t data_length,
  13689. size_t /*offset*/, size_t /*total_length*/) {
  13690. return content_receiver(data, data_length);
  13691. };
  13692. }
  13693. auto res = detail::make_unique<Response>();
  13694. return send(req, *res, error) ? std::move(res) : nullptr;
  13695. }
  13696. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13697. const std::string &method, const std::string &path, const Headers &headers,
  13698. const char *body, size_t content_length, ContentProvider content_provider,
  13699. ContentProviderWithoutLength content_provider_without_length,
  13700. const std::string &content_type, ContentReceiver content_receiver,
  13701. UploadProgress progress) {
  13702. Request req;
  13703. req.method = method;
  13704. req.headers = headers;
  13705. req.path = path;
  13706. req.upload_progress = std::move(progress);
  13707. if (max_timeout_msec_ > 0) {
  13708. req.start_time_ = std::chrono::steady_clock::now();
  13709. }
  13710. auto error = Error::Success;
  13711. auto res = send_with_content_provider_and_receiver(
  13712. req, body, content_length, std::move(content_provider),
  13713. std::move(content_provider_without_length), content_type,
  13714. std::move(content_receiver), error);
  13715. #ifdef CPPHTTPLIB_SSL_ENABLED
  13716. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13717. last_backend_error_};
  13718. #else
  13719. return Result{std::move(res), error, std::move(req.headers)};
  13720. #endif
  13721. }
  13722. inline void ClientImpl::output_log(const Request &req,
  13723. const Response &res) const {
  13724. if (logger_) {
  13725. std::lock_guard<std::mutex> guard(logger_mutex_);
  13726. logger_(req, res);
  13727. }
  13728. }
  13729. inline void ClientImpl::output_error_log(const Error &err,
  13730. const Request *req) const {
  13731. if (error_logger_) {
  13732. std::lock_guard<std::mutex> guard(logger_mutex_);
  13733. error_logger_(err, req);
  13734. }
  13735. }
  13736. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13737. Response &res, bool close_connection,
  13738. Error &error) {
  13739. // Auto-add Expect: 100-continue for large bodies
  13740. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13741. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13742. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13743. req.set_header("Expect", "100-continue");
  13744. }
  13745. }
  13746. // Check for Expect: 100-continue
  13747. auto expect_100_continue =
  13748. detail::has_header_token(req.headers, "Expect", "100-continue");
  13749. // Send request (skip body if using Expect: 100-continue)
  13750. auto rejected_locally = false;
  13751. auto write_request_success =
  13752. write_request(strm, req, close_connection, error, expect_100_continue,
  13753. rejected_locally);
  13754. // A failed write normally still reads the response below, since the server
  13755. // may have answered early (e.g. 413/414) and closed while the body was being
  13756. // sent. A request rejected before any byte reached the socket gets no such
  13757. // response, and waiting for one would block until the read timeout.
  13758. if (rejected_locally) { return false; }
  13759. #ifdef CPPHTTPLIB_SSL_ENABLED
  13760. if (is_ssl() && !expect_100_continue) {
  13761. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13762. if (!is_proxy_enabled) {
  13763. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13764. error = Error::SSLPeerCouldBeClosed_;
  13765. output_error_log(error, &req);
  13766. return false;
  13767. }
  13768. }
  13769. }
  13770. #endif
  13771. // Handle Expect: 100-continue.
  13772. //
  13773. // Wait for an interim/early response by attempting to read the status line
  13774. // under a short timeout, instead of trusting raw socket readability. Over
  13775. // TLS, post-handshake records (e.g. session tickets) make the socket
  13776. // readable without any HTTP response being available; relying on
  13777. // `select_read` there caused the body to be withheld forever and the
  13778. // request to fail with `Read` (#2458). If no status line arrives within the
  13779. // timeout, send the body anyway (matching curl's behavior).
  13780. auto status_line_read = false;
  13781. if (expect_100_continue && write_request_success) {
  13782. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13783. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13784. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13785. strm.set_read_timeout(sec, usec);
  13786. status_line_read = read_response_line(strm, req, res, false);
  13787. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13788. }
  13789. if (!status_line_read) {
  13790. // No interim response within the timeout: send the body and handle the
  13791. // response as usual.
  13792. if (!write_request_body(strm, req, error)) { return false; }
  13793. expect_100_continue = false; // Switch to normal response handling
  13794. }
  13795. }
  13796. // Receive response and headers
  13797. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13798. if ((!status_line_read &&
  13799. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13800. !detail::read_headers(strm, res.headers)) {
  13801. if (write_request_success) { error = Error::Read; }
  13802. output_error_log(error, &req);
  13803. return false;
  13804. }
  13805. if (!write_request_success) { return false; }
  13806. // Handle Expect: 100-continue response
  13807. if (expect_100_continue) {
  13808. if (res.status == StatusCode::Continue_100) {
  13809. // Server accepted, send the body
  13810. if (!write_request_body(strm, req, error)) { return false; }
  13811. // Read the actual response
  13812. res.headers.clear();
  13813. res.body.clear();
  13814. if (!read_response_line(strm, req, res) ||
  13815. !detail::read_headers(strm, res.headers)) {
  13816. error = Error::Read;
  13817. output_error_log(error, &req);
  13818. return false;
  13819. }
  13820. }
  13821. // If not 100 Continue, server returned an error; proceed with that response
  13822. }
  13823. // Body
  13824. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13825. req.method != "CONNECT") {
  13826. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13827. // whose final transfer coding is not chunked is not ambiguous: its body
  13828. // runs until the server closes the connection, so it is not rejected.
  13829. // HEAD/204 are excluded above and a 304 carries no body.
  13830. if (res.status != StatusCode::NotModified_304 &&
  13831. detail::has_conflicting_content_length(res.headers)) {
  13832. error = Error::Read;
  13833. output_error_log(error, &req);
  13834. return false;
  13835. }
  13836. auto redirect = 300 < res.status && res.status < 400 &&
  13837. res.status != StatusCode::NotModified_304 &&
  13838. follow_location_;
  13839. if (req.response_handler && !redirect) {
  13840. if (!req.response_handler(res)) {
  13841. error = Error::Canceled;
  13842. output_error_log(error, &req);
  13843. return false;
  13844. }
  13845. }
  13846. auto out =
  13847. req.content_receiver
  13848. ? static_cast<ContentReceiverWithProgress>(
  13849. [&](const char *buf, size_t n, size_t off, size_t len) {
  13850. if (redirect) { return true; }
  13851. auto ret = req.content_receiver(buf, n, off, len);
  13852. if (!ret) {
  13853. error = Error::Canceled;
  13854. output_error_log(error, &req);
  13855. }
  13856. return ret;
  13857. })
  13858. : static_cast<ContentReceiverWithProgress>(
  13859. [&](const char *buf, size_t n, size_t /*off*/,
  13860. size_t /*len*/) {
  13861. assert(res.body.size() + n <= res.body.max_size());
  13862. if (payload_max_length_ > 0 &&
  13863. (res.body.size() >= payload_max_length_ ||
  13864. n > payload_max_length_ - res.body.size())) {
  13865. return false;
  13866. }
  13867. res.body.append(buf, n);
  13868. return true;
  13869. });
  13870. auto progress = [&](size_t current, size_t total) {
  13871. if (!req.download_progress || redirect) { return true; }
  13872. auto ret = req.download_progress(current, total);
  13873. if (!ret) {
  13874. error = Error::Canceled;
  13875. output_error_log(error, &req);
  13876. }
  13877. return ret;
  13878. };
  13879. if (res.has_header("Content-Length")) {
  13880. if (!req.content_receiver) {
  13881. auto len = res.get_header_value_u64("Content-Length");
  13882. if (len > res.body.max_size()) {
  13883. error = Error::Read;
  13884. output_error_log(error, &req);
  13885. return false;
  13886. }
  13887. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13888. // hostile or malformed server sends an enormous Content-Length.
  13889. // The actual body read below is bounded by payload_max_length_,
  13890. // so reserving more than that is never useful.
  13891. auto reserve_len = static_cast<size_t>(len);
  13892. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13893. reserve_len = payload_max_length_;
  13894. }
  13895. res.body.reserve(reserve_len);
  13896. }
  13897. }
  13898. if (res.status != StatusCode::NotModified_304) {
  13899. auto content_status = 0;
  13900. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13901. ? (std::numeric_limits<size_t>::max)()
  13902. : payload_max_length_;
  13903. if (!detail::read_content(strm, res, max_length, content_status,
  13904. std::move(progress), std::move(out),
  13905. decompress_)) {
  13906. if (error != Error::Canceled) {
  13907. // Tell the caller apart from a plain read failure when the body could
  13908. // not be decoded because of its Content-Encoding.
  13909. switch (content_status) {
  13910. case StatusCode::UnsupportedMediaType_415:
  13911. error = Error::UnsupportedContentEncoding;
  13912. break;
  13913. case StatusCode::InternalServerError_500:
  13914. error = Error::Compression;
  13915. break;
  13916. default: error = Error::Read; break;
  13917. }
  13918. }
  13919. output_error_log(error, &req);
  13920. return false;
  13921. }
  13922. }
  13923. }
  13924. // Log
  13925. output_log(req, res);
  13926. return true;
  13927. }
  13928. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13929. const std::string &boundary, const UploadFormDataItems &items,
  13930. const FormDataProviderItems &provider_items) const {
  13931. size_t cur_item = 0;
  13932. size_t cur_start = 0;
  13933. // cur_item and cur_start are copied to within the std::function and
  13934. // maintain state between successive calls
  13935. return [&, cur_item, cur_start](size_t offset,
  13936. DataSink &sink) mutable -> bool {
  13937. if (!offset && !items.empty()) {
  13938. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13939. return true;
  13940. } else if (cur_item < provider_items.size()) {
  13941. if (!cur_start) {
  13942. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13943. provider_items[cur_item], boundary);
  13944. offset += begin.size();
  13945. cur_start = offset;
  13946. sink.os << begin;
  13947. }
  13948. DataSink cur_sink;
  13949. auto has_data = true;
  13950. cur_sink.write = sink.write;
  13951. // Forward is_writable so a provider item asking whether it may keep
  13952. // going gets the outer sink's answer rather than the default `true`.
  13953. cur_sink.is_writable = sink.is_writable;
  13954. cur_sink.done = [&]() { has_data = false; };
  13955. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13956. return false;
  13957. }
  13958. if (!has_data) {
  13959. sink.os << detail::serialize_multipart_formdata_item_end();
  13960. cur_item++;
  13961. cur_start = 0;
  13962. }
  13963. return true;
  13964. } else {
  13965. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13966. sink.done();
  13967. return true;
  13968. }
  13969. };
  13970. }
  13971. inline bool ClientImpl::process_socket(
  13972. const Socket &socket,
  13973. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13974. std::function<bool(Stream &strm)> callback) {
  13975. return detail::process_client_socket(
  13976. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13977. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13978. }
  13979. inline bool ClientImpl::is_ssl() const { return false; }
  13980. inline Result ClientImpl::Get(const std::string &path,
  13981. DownloadProgress progress) {
  13982. return Get(path, Headers(), std::move(progress));
  13983. }
  13984. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13985. DownloadProgress progress) {
  13986. return Get(path, params, Headers(), std::move(progress));
  13987. }
  13988. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13989. const Headers &headers,
  13990. DownloadProgress progress) {
  13991. if (params.empty()) { return Get(path, headers); }
  13992. std::string path_with_query = append_query_params(path, params);
  13993. return Get(path_with_query, headers, std::move(progress));
  13994. }
  13995. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13996. DownloadProgress progress) {
  13997. Request req;
  13998. req.method = "GET";
  13999. req.path = path;
  14000. req.headers = headers;
  14001. req.download_progress = std::move(progress);
  14002. if (max_timeout_msec_ > 0) {
  14003. req.start_time_ = std::chrono::steady_clock::now();
  14004. }
  14005. return send_(std::move(req));
  14006. }
  14007. inline Result ClientImpl::Get(const std::string &path,
  14008. ContentReceiver content_receiver,
  14009. DownloadProgress progress) {
  14010. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14011. std::move(progress));
  14012. }
  14013. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14014. ContentReceiver content_receiver,
  14015. DownloadProgress progress) {
  14016. return Get(path, headers, nullptr, std::move(content_receiver),
  14017. std::move(progress));
  14018. }
  14019. inline Result ClientImpl::Get(const std::string &path,
  14020. ResponseHandler response_handler,
  14021. ContentReceiver content_receiver,
  14022. DownloadProgress progress) {
  14023. return Get(path, Headers(), std::move(response_handler),
  14024. std::move(content_receiver), std::move(progress));
  14025. }
  14026. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14027. ResponseHandler response_handler,
  14028. ContentReceiver content_receiver,
  14029. DownloadProgress progress) {
  14030. Request req;
  14031. req.method = "GET";
  14032. req.path = path;
  14033. req.headers = headers;
  14034. req.response_handler = std::move(response_handler);
  14035. req.content_receiver =
  14036. [content_receiver](const char *data, size_t data_length,
  14037. size_t /*offset*/, size_t /*total_length*/) {
  14038. return content_receiver(data, data_length);
  14039. };
  14040. req.download_progress = std::move(progress);
  14041. if (max_timeout_msec_ > 0) {
  14042. req.start_time_ = std::chrono::steady_clock::now();
  14043. }
  14044. return send_(std::move(req));
  14045. }
  14046. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14047. const Headers &headers,
  14048. ContentReceiver content_receiver,
  14049. DownloadProgress progress) {
  14050. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14051. std::move(progress));
  14052. }
  14053. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14054. const Headers &headers,
  14055. ResponseHandler response_handler,
  14056. ContentReceiver content_receiver,
  14057. DownloadProgress progress) {
  14058. if (params.empty()) {
  14059. return Get(path, headers, std::move(response_handler),
  14060. std::move(content_receiver), std::move(progress));
  14061. }
  14062. std::string path_with_query = append_query_params(path, params);
  14063. return Get(path_with_query, headers, std::move(response_handler),
  14064. std::move(content_receiver), std::move(progress));
  14065. }
  14066. inline Result ClientImpl::Head(const std::string &path) {
  14067. return Head(path, Headers());
  14068. }
  14069. inline Result ClientImpl::Head(const std::string &path,
  14070. const Headers &headers) {
  14071. Request req;
  14072. req.method = "HEAD";
  14073. req.headers = headers;
  14074. req.path = path;
  14075. if (max_timeout_msec_ > 0) {
  14076. req.start_time_ = std::chrono::steady_clock::now();
  14077. }
  14078. return send_(std::move(req));
  14079. }
  14080. inline Result ClientImpl::Post(const std::string &path) {
  14081. return Post(path, std::string(), std::string());
  14082. }
  14083. inline Result ClientImpl::Post(const std::string &path,
  14084. const Headers &headers) {
  14085. return Post(path, headers, nullptr, 0, std::string());
  14086. }
  14087. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14088. size_t content_length,
  14089. const std::string &content_type,
  14090. UploadProgress progress) {
  14091. return Post(path, Headers(), body, content_length, content_type, progress);
  14092. }
  14093. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14094. const std::string &content_type,
  14095. UploadProgress progress) {
  14096. return Post(path, Headers(), body, content_type, progress);
  14097. }
  14098. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14099. return Post(path, Headers(), params);
  14100. }
  14101. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14102. ContentProvider content_provider,
  14103. const std::string &content_type,
  14104. UploadProgress progress) {
  14105. return Post(path, Headers(), content_length, std::move(content_provider),
  14106. content_type, progress);
  14107. }
  14108. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14109. ContentProvider content_provider,
  14110. const std::string &content_type,
  14111. ContentReceiver content_receiver,
  14112. UploadProgress progress) {
  14113. return Post(path, Headers(), content_length, std::move(content_provider),
  14114. content_type, std::move(content_receiver), progress);
  14115. }
  14116. inline Result ClientImpl::Post(const std::string &path,
  14117. ContentProviderWithoutLength content_provider,
  14118. const std::string &content_type,
  14119. UploadProgress progress) {
  14120. return Post(path, Headers(), std::move(content_provider), content_type,
  14121. progress);
  14122. }
  14123. inline Result ClientImpl::Post(const std::string &path,
  14124. ContentProviderWithoutLength content_provider,
  14125. const std::string &content_type,
  14126. ContentReceiver content_receiver,
  14127. UploadProgress progress) {
  14128. return Post(path, Headers(), std::move(content_provider), content_type,
  14129. std::move(content_receiver), progress);
  14130. }
  14131. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14132. const Params &params) {
  14133. auto query = detail::params_to_query_str(params);
  14134. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14135. }
  14136. inline Result ClientImpl::Post(const std::string &path,
  14137. const UploadFormDataItems &items,
  14138. UploadProgress progress) {
  14139. return Post(path, Headers(), items, progress);
  14140. }
  14141. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14142. const UploadFormDataItems &items,
  14143. UploadProgress progress) {
  14144. const auto &boundary = detail::make_multipart_data_boundary();
  14145. const auto &content_type =
  14146. detail::serialize_multipart_formdata_get_content_type(boundary);
  14147. auto content_length = detail::get_multipart_content_length(items, boundary);
  14148. return Post(path, headers, content_length,
  14149. detail::make_multipart_content_provider(items, boundary),
  14150. content_type, progress);
  14151. }
  14152. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14153. const UploadFormDataItems &items,
  14154. const std::string &boundary,
  14155. UploadProgress progress) {
  14156. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14157. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14158. }
  14159. const auto &content_type =
  14160. detail::serialize_multipart_formdata_get_content_type(boundary);
  14161. auto content_length = detail::get_multipart_content_length(items, boundary);
  14162. return Post(path, headers, content_length,
  14163. detail::make_multipart_content_provider(items, boundary),
  14164. content_type, progress);
  14165. }
  14166. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14167. const char *body, size_t content_length,
  14168. const std::string &content_type,
  14169. UploadProgress progress) {
  14170. return send_with_content_provider_and_receiver(
  14171. "POST", path, headers, body, content_length, nullptr, nullptr,
  14172. content_type, nullptr, progress);
  14173. }
  14174. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14175. const std::string &body,
  14176. const std::string &content_type,
  14177. UploadProgress progress) {
  14178. return send_with_content_provider_and_receiver(
  14179. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14180. content_type, nullptr, progress);
  14181. }
  14182. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14183. size_t content_length,
  14184. ContentProvider content_provider,
  14185. const std::string &content_type,
  14186. UploadProgress progress) {
  14187. return send_with_content_provider_and_receiver(
  14188. "POST", path, headers, nullptr, content_length,
  14189. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14190. }
  14191. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14192. size_t content_length,
  14193. ContentProvider content_provider,
  14194. const std::string &content_type,
  14195. ContentReceiver content_receiver,
  14196. DownloadProgress progress) {
  14197. return send_with_content_provider_and_receiver(
  14198. "POST", path, headers, nullptr, content_length,
  14199. std::move(content_provider), nullptr, content_type,
  14200. std::move(content_receiver), std::move(progress));
  14201. }
  14202. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14203. ContentProviderWithoutLength content_provider,
  14204. const std::string &content_type,
  14205. UploadProgress progress) {
  14206. return send_with_content_provider_and_receiver(
  14207. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14208. content_type, nullptr, progress);
  14209. }
  14210. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14211. ContentProviderWithoutLength content_provider,
  14212. const std::string &content_type,
  14213. ContentReceiver content_receiver,
  14214. DownloadProgress progress) {
  14215. return send_with_content_provider_and_receiver(
  14216. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14217. content_type, std::move(content_receiver), std::move(progress));
  14218. }
  14219. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14220. const UploadFormDataItems &items,
  14221. const FormDataProviderItems &provider_items,
  14222. UploadProgress progress) {
  14223. const auto &boundary = detail::make_multipart_data_boundary();
  14224. const auto &content_type =
  14225. detail::serialize_multipart_formdata_get_content_type(boundary);
  14226. return send_with_content_provider_and_receiver(
  14227. "POST", path, headers, nullptr, 0, nullptr,
  14228. get_multipart_content_provider(boundary, items, provider_items),
  14229. content_type, nullptr, progress);
  14230. }
  14231. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14232. const std::string &body,
  14233. const std::string &content_type,
  14234. ContentReceiver content_receiver,
  14235. DownloadProgress progress) {
  14236. Request req;
  14237. req.method = "POST";
  14238. req.path = path;
  14239. req.headers = headers;
  14240. req.body = body;
  14241. req.content_receiver =
  14242. [content_receiver](const char *data, size_t data_length,
  14243. size_t /*offset*/, size_t /*total_length*/) {
  14244. return content_receiver(data, data_length);
  14245. };
  14246. req.download_progress = std::move(progress);
  14247. if (max_timeout_msec_ > 0) {
  14248. req.start_time_ = std::chrono::steady_clock::now();
  14249. }
  14250. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14251. return send_(std::move(req));
  14252. }
  14253. inline Result ClientImpl::Put(const std::string &path) {
  14254. return Put(path, std::string(), std::string());
  14255. }
  14256. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14257. return Put(path, headers, nullptr, 0, std::string());
  14258. }
  14259. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14260. size_t content_length,
  14261. const std::string &content_type,
  14262. UploadProgress progress) {
  14263. return Put(path, Headers(), body, content_length, content_type, progress);
  14264. }
  14265. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14266. const std::string &content_type,
  14267. UploadProgress progress) {
  14268. return Put(path, Headers(), body, content_type, progress);
  14269. }
  14270. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14271. return Put(path, Headers(), params);
  14272. }
  14273. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14274. ContentProvider content_provider,
  14275. const std::string &content_type,
  14276. UploadProgress progress) {
  14277. return Put(path, Headers(), content_length, std::move(content_provider),
  14278. content_type, progress);
  14279. }
  14280. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14281. ContentProvider content_provider,
  14282. const std::string &content_type,
  14283. ContentReceiver content_receiver,
  14284. UploadProgress progress) {
  14285. return Put(path, Headers(), content_length, std::move(content_provider),
  14286. content_type, std::move(content_receiver), progress);
  14287. }
  14288. inline Result ClientImpl::Put(const std::string &path,
  14289. ContentProviderWithoutLength content_provider,
  14290. const std::string &content_type,
  14291. UploadProgress progress) {
  14292. return Put(path, Headers(), std::move(content_provider), content_type,
  14293. progress);
  14294. }
  14295. inline Result ClientImpl::Put(const std::string &path,
  14296. ContentProviderWithoutLength content_provider,
  14297. const std::string &content_type,
  14298. ContentReceiver content_receiver,
  14299. UploadProgress progress) {
  14300. return Put(path, Headers(), std::move(content_provider), content_type,
  14301. std::move(content_receiver), progress);
  14302. }
  14303. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14304. const Params &params) {
  14305. auto query = detail::params_to_query_str(params);
  14306. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14307. }
  14308. inline Result ClientImpl::Put(const std::string &path,
  14309. const UploadFormDataItems &items,
  14310. UploadProgress progress) {
  14311. return Put(path, Headers(), items, progress);
  14312. }
  14313. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14314. const UploadFormDataItems &items,
  14315. UploadProgress progress) {
  14316. const auto &boundary = detail::make_multipart_data_boundary();
  14317. const auto &content_type =
  14318. detail::serialize_multipart_formdata_get_content_type(boundary);
  14319. auto content_length = detail::get_multipart_content_length(items, boundary);
  14320. return Put(path, headers, content_length,
  14321. detail::make_multipart_content_provider(items, boundary),
  14322. content_type, progress);
  14323. }
  14324. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14325. const UploadFormDataItems &items,
  14326. const std::string &boundary,
  14327. UploadProgress progress) {
  14328. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14329. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14330. }
  14331. const auto &content_type =
  14332. detail::serialize_multipart_formdata_get_content_type(boundary);
  14333. auto content_length = detail::get_multipart_content_length(items, boundary);
  14334. return Put(path, headers, content_length,
  14335. detail::make_multipart_content_provider(items, boundary),
  14336. content_type, progress);
  14337. }
  14338. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14339. const char *body, size_t content_length,
  14340. const std::string &content_type,
  14341. UploadProgress progress) {
  14342. return send_with_content_provider_and_receiver(
  14343. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14344. content_type, nullptr, progress);
  14345. }
  14346. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14347. const std::string &body,
  14348. const std::string &content_type,
  14349. UploadProgress progress) {
  14350. return send_with_content_provider_and_receiver(
  14351. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14352. content_type, nullptr, progress);
  14353. }
  14354. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14355. size_t content_length,
  14356. ContentProvider content_provider,
  14357. const std::string &content_type,
  14358. UploadProgress progress) {
  14359. return send_with_content_provider_and_receiver(
  14360. "PUT", path, headers, nullptr, content_length,
  14361. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14362. }
  14363. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14364. size_t content_length,
  14365. ContentProvider content_provider,
  14366. const std::string &content_type,
  14367. ContentReceiver content_receiver,
  14368. UploadProgress progress) {
  14369. return send_with_content_provider_and_receiver(
  14370. "PUT", path, headers, nullptr, content_length,
  14371. std::move(content_provider), nullptr, content_type,
  14372. std::move(content_receiver), progress);
  14373. }
  14374. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14375. ContentProviderWithoutLength content_provider,
  14376. const std::string &content_type,
  14377. UploadProgress progress) {
  14378. return send_with_content_provider_and_receiver(
  14379. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14380. content_type, nullptr, progress);
  14381. }
  14382. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14383. ContentProviderWithoutLength content_provider,
  14384. const std::string &content_type,
  14385. ContentReceiver content_receiver,
  14386. UploadProgress progress) {
  14387. return send_with_content_provider_and_receiver(
  14388. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14389. content_type, std::move(content_receiver), progress);
  14390. }
  14391. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14392. const UploadFormDataItems &items,
  14393. const FormDataProviderItems &provider_items,
  14394. UploadProgress progress) {
  14395. const auto &boundary = detail::make_multipart_data_boundary();
  14396. const auto &content_type =
  14397. detail::serialize_multipart_formdata_get_content_type(boundary);
  14398. return send_with_content_provider_and_receiver(
  14399. "PUT", path, headers, nullptr, 0, nullptr,
  14400. get_multipart_content_provider(boundary, items, provider_items),
  14401. content_type, nullptr, progress);
  14402. }
  14403. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14404. const std::string &body,
  14405. const std::string &content_type,
  14406. ContentReceiver content_receiver,
  14407. DownloadProgress progress) {
  14408. Request req;
  14409. req.method = "PUT";
  14410. req.path = path;
  14411. req.headers = headers;
  14412. req.body = body;
  14413. req.content_receiver =
  14414. [content_receiver](const char *data, size_t data_length,
  14415. size_t /*offset*/, size_t /*total_length*/) {
  14416. return content_receiver(data, data_length);
  14417. };
  14418. req.download_progress = std::move(progress);
  14419. if (max_timeout_msec_ > 0) {
  14420. req.start_time_ = std::chrono::steady_clock::now();
  14421. }
  14422. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14423. return send_(std::move(req));
  14424. }
  14425. inline Result ClientImpl::Patch(const std::string &path) {
  14426. return Patch(path, std::string(), std::string());
  14427. }
  14428. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14429. UploadProgress progress) {
  14430. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14431. }
  14432. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14433. size_t content_length,
  14434. const std::string &content_type,
  14435. UploadProgress progress) {
  14436. return Patch(path, Headers(), body, content_length, content_type, progress);
  14437. }
  14438. inline Result ClientImpl::Patch(const std::string &path,
  14439. const std::string &body,
  14440. const std::string &content_type,
  14441. UploadProgress progress) {
  14442. return Patch(path, Headers(), body, content_type, progress);
  14443. }
  14444. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14445. return Patch(path, Headers(), params);
  14446. }
  14447. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14448. ContentProvider content_provider,
  14449. const std::string &content_type,
  14450. UploadProgress progress) {
  14451. return Patch(path, Headers(), content_length, std::move(content_provider),
  14452. content_type, progress);
  14453. }
  14454. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14455. ContentProvider content_provider,
  14456. const std::string &content_type,
  14457. ContentReceiver content_receiver,
  14458. UploadProgress progress) {
  14459. return Patch(path, Headers(), content_length, std::move(content_provider),
  14460. content_type, std::move(content_receiver), progress);
  14461. }
  14462. inline Result ClientImpl::Patch(const std::string &path,
  14463. ContentProviderWithoutLength content_provider,
  14464. const std::string &content_type,
  14465. UploadProgress progress) {
  14466. return Patch(path, Headers(), std::move(content_provider), content_type,
  14467. progress);
  14468. }
  14469. inline Result ClientImpl::Patch(const std::string &path,
  14470. ContentProviderWithoutLength content_provider,
  14471. const std::string &content_type,
  14472. ContentReceiver content_receiver,
  14473. UploadProgress progress) {
  14474. return Patch(path, Headers(), std::move(content_provider), content_type,
  14475. std::move(content_receiver), progress);
  14476. }
  14477. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14478. const Params &params) {
  14479. auto query = detail::params_to_query_str(params);
  14480. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14481. }
  14482. inline Result ClientImpl::Patch(const std::string &path,
  14483. const UploadFormDataItems &items,
  14484. UploadProgress progress) {
  14485. return Patch(path, Headers(), items, progress);
  14486. }
  14487. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14488. const UploadFormDataItems &items,
  14489. UploadProgress progress) {
  14490. const auto &boundary = detail::make_multipart_data_boundary();
  14491. const auto &content_type =
  14492. detail::serialize_multipart_formdata_get_content_type(boundary);
  14493. auto content_length = detail::get_multipart_content_length(items, boundary);
  14494. return Patch(path, headers, content_length,
  14495. detail::make_multipart_content_provider(items, boundary),
  14496. content_type, progress);
  14497. }
  14498. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14499. const UploadFormDataItems &items,
  14500. const std::string &boundary,
  14501. UploadProgress progress) {
  14502. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14503. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14504. }
  14505. const auto &content_type =
  14506. detail::serialize_multipart_formdata_get_content_type(boundary);
  14507. auto content_length = detail::get_multipart_content_length(items, boundary);
  14508. return Patch(path, headers, content_length,
  14509. detail::make_multipart_content_provider(items, boundary),
  14510. content_type, progress);
  14511. }
  14512. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14513. const char *body, size_t content_length,
  14514. const std::string &content_type,
  14515. UploadProgress progress) {
  14516. return send_with_content_provider_and_receiver(
  14517. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14518. content_type, nullptr, progress);
  14519. }
  14520. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14521. const std::string &body,
  14522. const std::string &content_type,
  14523. UploadProgress progress) {
  14524. return send_with_content_provider_and_receiver(
  14525. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14526. content_type, nullptr, progress);
  14527. }
  14528. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14529. size_t content_length,
  14530. ContentProvider content_provider,
  14531. const std::string &content_type,
  14532. UploadProgress progress) {
  14533. return send_with_content_provider_and_receiver(
  14534. "PATCH", path, headers, nullptr, content_length,
  14535. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14536. }
  14537. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14538. size_t content_length,
  14539. ContentProvider content_provider,
  14540. const std::string &content_type,
  14541. ContentReceiver content_receiver,
  14542. UploadProgress progress) {
  14543. return send_with_content_provider_and_receiver(
  14544. "PATCH", path, headers, nullptr, content_length,
  14545. std::move(content_provider), nullptr, content_type,
  14546. std::move(content_receiver), progress);
  14547. }
  14548. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14549. ContentProviderWithoutLength content_provider,
  14550. const std::string &content_type,
  14551. UploadProgress progress) {
  14552. return send_with_content_provider_and_receiver(
  14553. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14554. content_type, nullptr, progress);
  14555. }
  14556. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14557. ContentProviderWithoutLength content_provider,
  14558. const std::string &content_type,
  14559. ContentReceiver content_receiver,
  14560. UploadProgress progress) {
  14561. return send_with_content_provider_and_receiver(
  14562. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14563. content_type, std::move(content_receiver), progress);
  14564. }
  14565. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14566. const UploadFormDataItems &items,
  14567. const FormDataProviderItems &provider_items,
  14568. UploadProgress progress) {
  14569. const auto &boundary = detail::make_multipart_data_boundary();
  14570. const auto &content_type =
  14571. detail::serialize_multipart_formdata_get_content_type(boundary);
  14572. return send_with_content_provider_and_receiver(
  14573. "PATCH", path, headers, nullptr, 0, nullptr,
  14574. get_multipart_content_provider(boundary, items, provider_items),
  14575. content_type, nullptr, progress);
  14576. }
  14577. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14578. const std::string &body,
  14579. const std::string &content_type,
  14580. ContentReceiver content_receiver,
  14581. DownloadProgress progress) {
  14582. Request req;
  14583. req.method = "PATCH";
  14584. req.path = path;
  14585. req.headers = headers;
  14586. req.body = body;
  14587. req.content_receiver =
  14588. [content_receiver](const char *data, size_t data_length,
  14589. size_t /*offset*/, size_t /*total_length*/) {
  14590. return content_receiver(data, data_length);
  14591. };
  14592. req.download_progress = std::move(progress);
  14593. if (max_timeout_msec_ > 0) {
  14594. req.start_time_ = std::chrono::steady_clock::now();
  14595. }
  14596. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14597. return send_(std::move(req));
  14598. }
  14599. inline Result ClientImpl::Delete(const std::string &path,
  14600. DownloadProgress progress) {
  14601. return Delete(path, Headers(), std::string(), std::string(), progress);
  14602. }
  14603. inline Result ClientImpl::Delete(const std::string &path,
  14604. const Headers &headers,
  14605. DownloadProgress progress) {
  14606. return Delete(path, headers, std::string(), std::string(), progress);
  14607. }
  14608. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14609. size_t content_length,
  14610. const std::string &content_type,
  14611. DownloadProgress progress) {
  14612. return Delete(path, Headers(), body, content_length, content_type, progress);
  14613. }
  14614. inline Result ClientImpl::Delete(const std::string &path,
  14615. const std::string &body,
  14616. const std::string &content_type,
  14617. DownloadProgress progress) {
  14618. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14619. progress);
  14620. }
  14621. inline Result ClientImpl::Delete(const std::string &path,
  14622. const Headers &headers,
  14623. const std::string &body,
  14624. const std::string &content_type,
  14625. DownloadProgress progress) {
  14626. return Delete(path, headers, body.data(), body.size(), content_type,
  14627. progress);
  14628. }
  14629. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14630. DownloadProgress progress) {
  14631. return Delete(path, Headers(), params, progress);
  14632. }
  14633. inline Result ClientImpl::Delete(const std::string &path,
  14634. const Headers &headers, const Params &params,
  14635. DownloadProgress progress) {
  14636. auto query = detail::params_to_query_str(params);
  14637. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14638. progress);
  14639. }
  14640. inline Result ClientImpl::Delete(const std::string &path,
  14641. const Headers &headers, const char *body,
  14642. size_t content_length,
  14643. const std::string &content_type,
  14644. DownloadProgress progress) {
  14645. Request req;
  14646. req.method = "DELETE";
  14647. req.headers = headers;
  14648. req.path = path;
  14649. req.download_progress = std::move(progress);
  14650. if (max_timeout_msec_ > 0) {
  14651. req.start_time_ = std::chrono::steady_clock::now();
  14652. }
  14653. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14654. req.body.assign(body, content_length);
  14655. return send_(std::move(req));
  14656. }
  14657. inline Result ClientImpl::Options(const std::string &path) {
  14658. return Options(path, Headers());
  14659. }
  14660. inline Result ClientImpl::Options(const std::string &path,
  14661. const Headers &headers) {
  14662. Request req;
  14663. req.method = "OPTIONS";
  14664. req.headers = headers;
  14665. req.path = path;
  14666. if (max_timeout_msec_ > 0) {
  14667. req.start_time_ = std::chrono::steady_clock::now();
  14668. }
  14669. return send_(std::move(req));
  14670. }
  14671. inline void ClientImpl::stop() {
  14672. std::lock_guard<std::mutex> guard(socket_mutex_);
  14673. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14674. // do is to shutdown_socket, so that threads using this socket suddenly
  14675. // discover they can't read/write any more and error out. Everything else
  14676. // (closing the socket, shutting ssl down) is unsafe because these actions
  14677. // are not thread-safe.
  14678. if (socket_requests_in_flight_ > 0) {
  14679. shutdown_socket(socket_);
  14680. // Aside from that, we set a flag for the socket to be closed when we're
  14681. // done.
  14682. socket_should_be_closed_when_request_is_done_ = true;
  14683. return;
  14684. }
  14685. disconnect(/*gracefully=*/true);
  14686. }
  14687. inline std::string ClientImpl::host() const { return host_; }
  14688. inline int ClientImpl::port() const { return port_; }
  14689. inline size_t ClientImpl::is_socket_open() const {
  14690. std::lock_guard<std::mutex> guard(socket_mutex_);
  14691. return socket_.is_open();
  14692. }
  14693. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14694. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14695. connection_timeout_sec_ = sec;
  14696. connection_timeout_usec_ = usec;
  14697. }
  14698. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14699. read_timeout_sec_ = sec;
  14700. read_timeout_usec_ = usec;
  14701. }
  14702. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14703. write_timeout_sec_ = sec;
  14704. write_timeout_usec_ = usec;
  14705. }
  14706. inline void ClientImpl::set_max_timeout(time_t msec) {
  14707. max_timeout_msec_ = msec;
  14708. }
  14709. inline void ClientImpl::set_basic_auth(const std::string &username,
  14710. const std::string &password) {
  14711. basic_auth_username_ = username;
  14712. basic_auth_password_ = password;
  14713. }
  14714. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14715. bearer_token_auth_token_ = token;
  14716. }
  14717. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14718. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14719. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14720. inline void
  14721. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14722. addr_map_ = std::move(addr_map);
  14723. }
  14724. inline void ClientImpl::set_default_headers(Headers headers) {
  14725. default_headers_ = std::move(headers);
  14726. }
  14727. inline void ClientImpl::set_header_writer(
  14728. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14729. header_writer_ = writer;
  14730. }
  14731. inline void ClientImpl::set_address_family(int family) {
  14732. address_family_ = family;
  14733. }
  14734. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14735. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14736. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14737. socket_options_ = std::move(socket_options);
  14738. }
  14739. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14740. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14741. inline void ClientImpl::set_payload_max_length(size_t length) {
  14742. payload_max_length_ = length;
  14743. has_payload_max_length_ = true;
  14744. }
  14745. inline void ClientImpl::set_interface(const std::string &intf) {
  14746. interface_ = intf;
  14747. }
  14748. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14749. proxy_host_ = host;
  14750. proxy_port_ = port;
  14751. std::lock_guard<std::mutex> guard(socket_mutex_);
  14752. disconnect(/*gracefully=*/true);
  14753. }
  14754. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14755. const std::string &password) {
  14756. proxy_basic_auth_username_ = username;
  14757. proxy_basic_auth_password_ = password;
  14758. }
  14759. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14760. proxy_bearer_token_auth_token_ = token;
  14761. }
  14762. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14763. std::vector<detail::NoProxyEntry> parsed;
  14764. parsed.reserve(patterns.size());
  14765. for (const auto &p : patterns) {
  14766. auto trimmed = detail::trim_copy(p);
  14767. if (trimmed.empty()) { continue; }
  14768. detail::NoProxyEntry entry;
  14769. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14770. parsed.push_back(std::move(entry));
  14771. }
  14772. }
  14773. no_proxy_entries_ = std::move(parsed);
  14774. std::lock_guard<std::mutex> guard(socket_mutex_);
  14775. disconnect(/*gracefully=*/true);
  14776. }
  14777. #ifdef CPPHTTPLIB_SSL_ENABLED
  14778. inline void ClientImpl::set_digest_auth(const std::string &username,
  14779. const std::string &password) {
  14780. digest_auth_username_ = username;
  14781. digest_auth_password_ = password;
  14782. }
  14783. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14784. const std::string &ca_cert_dir_path) {
  14785. ca_cert_file_path_ = ca_cert_file_path;
  14786. ca_cert_dir_path_ = ca_cert_dir_path;
  14787. }
  14788. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14789. const std::string &password) {
  14790. proxy_digest_auth_username_ = username;
  14791. proxy_digest_auth_password_ = password;
  14792. }
  14793. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14794. server_certificate_verification_ = enabled;
  14795. }
  14796. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14797. server_hostname_verification_ = enabled;
  14798. }
  14799. inline void ClientImpl::enable_system_ca(bool enabled) {
  14800. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14801. }
  14802. #endif
  14803. inline void ClientImpl::set_logger(Logger logger) {
  14804. logger_ = std::move(logger);
  14805. }
  14806. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14807. error_logger_ = std::move(error_logger);
  14808. }
  14809. /*
  14810. * SSL/TLS Common Implementation
  14811. */
  14812. inline ClientConnection::~ClientConnection() {
  14813. #ifdef CPPHTTPLIB_SSL_ENABLED
  14814. if (session) {
  14815. tls::shutdown(session, true);
  14816. tls::free_session(session);
  14817. session = nullptr;
  14818. }
  14819. #endif
  14820. if (sock != INVALID_SOCKET) {
  14821. detail::close_socket(sock);
  14822. sock = INVALID_SOCKET;
  14823. }
  14824. }
  14825. // Universal client implementation
  14826. inline Client::Client(const std::string &scheme_host_port)
  14827. : Client(scheme_host_port, std::string(), std::string()) {}
  14828. inline Client::Client(const std::string &scheme_host_port,
  14829. const std::string &client_cert_path,
  14830. const std::string &client_key_path) {
  14831. detail::UrlComponents uc;
  14832. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14833. auto &scheme = uc.scheme;
  14834. #ifdef CPPHTTPLIB_SSL_ENABLED
  14835. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14836. #else
  14837. if (!scheme.empty() && scheme != "http") {
  14838. #endif
  14839. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14840. std::string msg = "'" + scheme + "' scheme is not supported.";
  14841. throw std::invalid_argument(msg);
  14842. #endif
  14843. return;
  14844. }
  14845. auto is_ssl = scheme == "https";
  14846. auto host = std::move(uc.host);
  14847. auto port = is_ssl ? 443 : 80;
  14848. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14849. if (is_ssl) {
  14850. #ifdef CPPHTTPLIB_SSL_ENABLED
  14851. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14852. client_key_path);
  14853. is_ssl_ = is_ssl;
  14854. #endif
  14855. } else {
  14856. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14857. client_key_path);
  14858. }
  14859. } else {
  14860. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14861. // if port param below changes.
  14862. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14863. client_cert_path, client_key_path);
  14864. }
  14865. }
  14866. inline Client::Client(const std::string &host, int port)
  14867. : Client(host, port, std::string(), std::string()) {}
  14868. inline Client::Client(const std::string &host, int port,
  14869. const std::string &client_cert_path,
  14870. const std::string &client_key_path)
  14871. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14872. client_key_path)) {}
  14873. inline Client::~Client() = default;
  14874. inline bool Client::is_valid() const {
  14875. return cli_ != nullptr && cli_->is_valid();
  14876. }
  14877. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14878. return cli_->Get(path, std::move(progress));
  14879. }
  14880. inline Result Client::Get(const std::string &path, const Headers &headers,
  14881. DownloadProgress progress) {
  14882. return cli_->Get(path, headers, std::move(progress));
  14883. }
  14884. inline Result Client::Get(const std::string &path,
  14885. ContentReceiver content_receiver,
  14886. DownloadProgress progress) {
  14887. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14888. }
  14889. inline Result Client::Get(const std::string &path, const Headers &headers,
  14890. ContentReceiver content_receiver,
  14891. DownloadProgress progress) {
  14892. return cli_->Get(path, headers, std::move(content_receiver),
  14893. std::move(progress));
  14894. }
  14895. inline Result Client::Get(const std::string &path,
  14896. ResponseHandler response_handler,
  14897. ContentReceiver content_receiver,
  14898. DownloadProgress progress) {
  14899. return cli_->Get(path, std::move(response_handler),
  14900. std::move(content_receiver), std::move(progress));
  14901. }
  14902. inline Result Client::Get(const std::string &path, const Headers &headers,
  14903. ResponseHandler response_handler,
  14904. ContentReceiver content_receiver,
  14905. DownloadProgress progress) {
  14906. return cli_->Get(path, headers, std::move(response_handler),
  14907. std::move(content_receiver), std::move(progress));
  14908. }
  14909. inline Result Client::Get(const std::string &path, const Params &params,
  14910. DownloadProgress progress) {
  14911. return cli_->Get(path, params, std::move(progress));
  14912. }
  14913. inline Result Client::Get(const std::string &path, const Params &params,
  14914. const Headers &headers, DownloadProgress progress) {
  14915. return cli_->Get(path, params, headers, std::move(progress));
  14916. }
  14917. inline Result Client::Get(const std::string &path, const Params &params,
  14918. const Headers &headers,
  14919. ContentReceiver content_receiver,
  14920. DownloadProgress progress) {
  14921. return cli_->Get(path, params, headers, std::move(content_receiver),
  14922. std::move(progress));
  14923. }
  14924. inline Result Client::Get(const std::string &path, const Params &params,
  14925. const Headers &headers,
  14926. ResponseHandler response_handler,
  14927. ContentReceiver content_receiver,
  14928. DownloadProgress progress) {
  14929. return cli_->Get(path, params, headers, std::move(response_handler),
  14930. std::move(content_receiver), std::move(progress));
  14931. }
  14932. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14933. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14934. return cli_->Head(path, headers);
  14935. }
  14936. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14937. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14938. return cli_->Post(path, headers);
  14939. }
  14940. inline Result Client::Post(const std::string &path, const char *body,
  14941. size_t content_length,
  14942. const std::string &content_type,
  14943. UploadProgress progress) {
  14944. return cli_->Post(path, body, content_length, content_type, progress);
  14945. }
  14946. inline Result Client::Post(const std::string &path, const Headers &headers,
  14947. const char *body, size_t content_length,
  14948. const std::string &content_type,
  14949. UploadProgress progress) {
  14950. return cli_->Post(path, headers, body, content_length, content_type,
  14951. progress);
  14952. }
  14953. inline Result Client::Post(const std::string &path, const std::string &body,
  14954. const std::string &content_type,
  14955. UploadProgress progress) {
  14956. return cli_->Post(path, body, content_type, progress);
  14957. }
  14958. inline Result Client::Post(const std::string &path, const Headers &headers,
  14959. const std::string &body,
  14960. const std::string &content_type,
  14961. UploadProgress progress) {
  14962. return cli_->Post(path, headers, body, content_type, progress);
  14963. }
  14964. inline Result Client::Post(const std::string &path, size_t content_length,
  14965. ContentProvider content_provider,
  14966. const std::string &content_type,
  14967. UploadProgress progress) {
  14968. return cli_->Post(path, content_length, std::move(content_provider),
  14969. content_type, progress);
  14970. }
  14971. inline Result Client::Post(const std::string &path, size_t content_length,
  14972. ContentProvider content_provider,
  14973. const std::string &content_type,
  14974. ContentReceiver content_receiver,
  14975. UploadProgress progress) {
  14976. return cli_->Post(path, content_length, std::move(content_provider),
  14977. content_type, std::move(content_receiver), progress);
  14978. }
  14979. inline Result Client::Post(const std::string &path,
  14980. ContentProviderWithoutLength content_provider,
  14981. const std::string &content_type,
  14982. UploadProgress progress) {
  14983. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14984. }
  14985. inline Result Client::Post(const std::string &path,
  14986. ContentProviderWithoutLength content_provider,
  14987. const std::string &content_type,
  14988. ContentReceiver content_receiver,
  14989. UploadProgress progress) {
  14990. return cli_->Post(path, std::move(content_provider), content_type,
  14991. std::move(content_receiver), progress);
  14992. }
  14993. inline Result Client::Post(const std::string &path, const Headers &headers,
  14994. size_t content_length,
  14995. ContentProvider content_provider,
  14996. const std::string &content_type,
  14997. UploadProgress progress) {
  14998. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14999. content_type, progress);
  15000. }
  15001. inline Result Client::Post(const std::string &path, const Headers &headers,
  15002. size_t content_length,
  15003. ContentProvider content_provider,
  15004. const std::string &content_type,
  15005. ContentReceiver content_receiver,
  15006. DownloadProgress progress) {
  15007. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15008. content_type, std::move(content_receiver), progress);
  15009. }
  15010. inline Result Client::Post(const std::string &path, const Headers &headers,
  15011. ContentProviderWithoutLength content_provider,
  15012. const std::string &content_type,
  15013. UploadProgress progress) {
  15014. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15015. progress);
  15016. }
  15017. inline Result Client::Post(const std::string &path, const Headers &headers,
  15018. ContentProviderWithoutLength content_provider,
  15019. const std::string &content_type,
  15020. ContentReceiver content_receiver,
  15021. DownloadProgress progress) {
  15022. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15023. std::move(content_receiver), progress);
  15024. }
  15025. inline Result Client::Post(const std::string &path, const Params &params) {
  15026. return cli_->Post(path, params);
  15027. }
  15028. inline Result Client::Post(const std::string &path, const Headers &headers,
  15029. const Params &params) {
  15030. return cli_->Post(path, headers, params);
  15031. }
  15032. inline Result Client::Post(const std::string &path,
  15033. const UploadFormDataItems &items,
  15034. UploadProgress progress) {
  15035. return cli_->Post(path, items, progress);
  15036. }
  15037. inline Result Client::Post(const std::string &path, const Headers &headers,
  15038. const UploadFormDataItems &items,
  15039. UploadProgress progress) {
  15040. return cli_->Post(path, headers, items, progress);
  15041. }
  15042. inline Result Client::Post(const std::string &path, const Headers &headers,
  15043. const UploadFormDataItems &items,
  15044. const std::string &boundary,
  15045. UploadProgress progress) {
  15046. return cli_->Post(path, headers, items, boundary, progress);
  15047. }
  15048. inline Result Client::Post(const std::string &path, const Headers &headers,
  15049. const UploadFormDataItems &items,
  15050. const FormDataProviderItems &provider_items,
  15051. UploadProgress progress) {
  15052. return cli_->Post(path, headers, items, provider_items, progress);
  15053. }
  15054. inline Result Client::Post(const std::string &path, const Headers &headers,
  15055. const std::string &body,
  15056. const std::string &content_type,
  15057. ContentReceiver content_receiver,
  15058. DownloadProgress progress) {
  15059. return cli_->Post(path, headers, body, content_type,
  15060. std::move(content_receiver), progress);
  15061. }
  15062. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15063. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15064. return cli_->Put(path, headers);
  15065. }
  15066. inline Result Client::Put(const std::string &path, const char *body,
  15067. size_t content_length,
  15068. const std::string &content_type,
  15069. UploadProgress progress) {
  15070. return cli_->Put(path, body, content_length, content_type, progress);
  15071. }
  15072. inline Result Client::Put(const std::string &path, const Headers &headers,
  15073. const char *body, size_t content_length,
  15074. const std::string &content_type,
  15075. UploadProgress progress) {
  15076. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15077. }
  15078. inline Result Client::Put(const std::string &path, const std::string &body,
  15079. const std::string &content_type,
  15080. UploadProgress progress) {
  15081. return cli_->Put(path, body, content_type, progress);
  15082. }
  15083. inline Result Client::Put(const std::string &path, const Headers &headers,
  15084. const std::string &body,
  15085. const std::string &content_type,
  15086. UploadProgress progress) {
  15087. return cli_->Put(path, headers, body, content_type, progress);
  15088. }
  15089. inline Result Client::Put(const std::string &path, size_t content_length,
  15090. ContentProvider content_provider,
  15091. const std::string &content_type,
  15092. UploadProgress progress) {
  15093. return cli_->Put(path, content_length, std::move(content_provider),
  15094. content_type, progress);
  15095. }
  15096. inline Result Client::Put(const std::string &path, size_t content_length,
  15097. ContentProvider content_provider,
  15098. const std::string &content_type,
  15099. ContentReceiver content_receiver,
  15100. UploadProgress progress) {
  15101. return cli_->Put(path, content_length, std::move(content_provider),
  15102. content_type, std::move(content_receiver), progress);
  15103. }
  15104. inline Result Client::Put(const std::string &path,
  15105. ContentProviderWithoutLength content_provider,
  15106. const std::string &content_type,
  15107. UploadProgress progress) {
  15108. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15109. }
  15110. inline Result Client::Put(const std::string &path,
  15111. ContentProviderWithoutLength content_provider,
  15112. const std::string &content_type,
  15113. ContentReceiver content_receiver,
  15114. UploadProgress progress) {
  15115. return cli_->Put(path, std::move(content_provider), content_type,
  15116. std::move(content_receiver), progress);
  15117. }
  15118. inline Result Client::Put(const std::string &path, const Headers &headers,
  15119. size_t content_length,
  15120. ContentProvider content_provider,
  15121. const std::string &content_type,
  15122. UploadProgress progress) {
  15123. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15124. content_type, progress);
  15125. }
  15126. inline Result Client::Put(const std::string &path, const Headers &headers,
  15127. size_t content_length,
  15128. ContentProvider content_provider,
  15129. const std::string &content_type,
  15130. ContentReceiver content_receiver,
  15131. UploadProgress progress) {
  15132. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15133. content_type, std::move(content_receiver), progress);
  15134. }
  15135. inline Result Client::Put(const std::string &path, const Headers &headers,
  15136. ContentProviderWithoutLength content_provider,
  15137. const std::string &content_type,
  15138. UploadProgress progress) {
  15139. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15140. progress);
  15141. }
  15142. inline Result Client::Put(const std::string &path, const Headers &headers,
  15143. ContentProviderWithoutLength content_provider,
  15144. const std::string &content_type,
  15145. ContentReceiver content_receiver,
  15146. UploadProgress progress) {
  15147. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15148. std::move(content_receiver), progress);
  15149. }
  15150. inline Result Client::Put(const std::string &path, const Params &params) {
  15151. return cli_->Put(path, params);
  15152. }
  15153. inline Result Client::Put(const std::string &path, const Headers &headers,
  15154. const Params &params) {
  15155. return cli_->Put(path, headers, params);
  15156. }
  15157. inline Result Client::Put(const std::string &path,
  15158. const UploadFormDataItems &items,
  15159. UploadProgress progress) {
  15160. return cli_->Put(path, items, progress);
  15161. }
  15162. inline Result Client::Put(const std::string &path, const Headers &headers,
  15163. const UploadFormDataItems &items,
  15164. UploadProgress progress) {
  15165. return cli_->Put(path, headers, items, progress);
  15166. }
  15167. inline Result Client::Put(const std::string &path, const Headers &headers,
  15168. const UploadFormDataItems &items,
  15169. const std::string &boundary,
  15170. UploadProgress progress) {
  15171. return cli_->Put(path, headers, items, boundary, progress);
  15172. }
  15173. inline Result Client::Put(const std::string &path, const Headers &headers,
  15174. const UploadFormDataItems &items,
  15175. const FormDataProviderItems &provider_items,
  15176. UploadProgress progress) {
  15177. return cli_->Put(path, headers, items, provider_items, progress);
  15178. }
  15179. inline Result Client::Put(const std::string &path, const Headers &headers,
  15180. const std::string &body,
  15181. const std::string &content_type,
  15182. ContentReceiver content_receiver,
  15183. DownloadProgress progress) {
  15184. return cli_->Put(path, headers, body, content_type, content_receiver,
  15185. progress);
  15186. }
  15187. inline Result Client::Patch(const std::string &path) {
  15188. return cli_->Patch(path);
  15189. }
  15190. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15191. return cli_->Patch(path, headers);
  15192. }
  15193. inline Result Client::Patch(const std::string &path, const char *body,
  15194. size_t content_length,
  15195. const std::string &content_type,
  15196. UploadProgress progress) {
  15197. return cli_->Patch(path, body, content_length, content_type, progress);
  15198. }
  15199. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15200. const char *body, size_t content_length,
  15201. const std::string &content_type,
  15202. UploadProgress progress) {
  15203. return cli_->Patch(path, headers, body, content_length, content_type,
  15204. progress);
  15205. }
  15206. inline Result Client::Patch(const std::string &path, const std::string &body,
  15207. const std::string &content_type,
  15208. UploadProgress progress) {
  15209. return cli_->Patch(path, body, content_type, progress);
  15210. }
  15211. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15212. const std::string &body,
  15213. const std::string &content_type,
  15214. UploadProgress progress) {
  15215. return cli_->Patch(path, headers, body, content_type, progress);
  15216. }
  15217. inline Result Client::Patch(const std::string &path, size_t content_length,
  15218. ContentProvider content_provider,
  15219. const std::string &content_type,
  15220. UploadProgress progress) {
  15221. return cli_->Patch(path, content_length, std::move(content_provider),
  15222. content_type, progress);
  15223. }
  15224. inline Result Client::Patch(const std::string &path, size_t content_length,
  15225. ContentProvider content_provider,
  15226. const std::string &content_type,
  15227. ContentReceiver content_receiver,
  15228. UploadProgress progress) {
  15229. return cli_->Patch(path, content_length, std::move(content_provider),
  15230. content_type, std::move(content_receiver), progress);
  15231. }
  15232. inline Result Client::Patch(const std::string &path,
  15233. ContentProviderWithoutLength content_provider,
  15234. const std::string &content_type,
  15235. UploadProgress progress) {
  15236. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15237. }
  15238. inline Result Client::Patch(const std::string &path,
  15239. ContentProviderWithoutLength content_provider,
  15240. const std::string &content_type,
  15241. ContentReceiver content_receiver,
  15242. UploadProgress progress) {
  15243. return cli_->Patch(path, std::move(content_provider), content_type,
  15244. std::move(content_receiver), progress);
  15245. }
  15246. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15247. size_t content_length,
  15248. ContentProvider content_provider,
  15249. const std::string &content_type,
  15250. UploadProgress progress) {
  15251. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15252. content_type, progress);
  15253. }
  15254. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15255. size_t content_length,
  15256. ContentProvider content_provider,
  15257. const std::string &content_type,
  15258. ContentReceiver content_receiver,
  15259. UploadProgress progress) {
  15260. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15261. content_type, std::move(content_receiver), progress);
  15262. }
  15263. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15264. ContentProviderWithoutLength content_provider,
  15265. const std::string &content_type,
  15266. UploadProgress progress) {
  15267. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15268. progress);
  15269. }
  15270. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15271. ContentProviderWithoutLength content_provider,
  15272. const std::string &content_type,
  15273. ContentReceiver content_receiver,
  15274. UploadProgress progress) {
  15275. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15276. std::move(content_receiver), progress);
  15277. }
  15278. inline Result Client::Patch(const std::string &path, const Params &params) {
  15279. return cli_->Patch(path, params);
  15280. }
  15281. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15282. const Params &params) {
  15283. return cli_->Patch(path, headers, params);
  15284. }
  15285. inline Result Client::Patch(const std::string &path,
  15286. const UploadFormDataItems &items,
  15287. UploadProgress progress) {
  15288. return cli_->Patch(path, items, progress);
  15289. }
  15290. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15291. const UploadFormDataItems &items,
  15292. UploadProgress progress) {
  15293. return cli_->Patch(path, headers, items, progress);
  15294. }
  15295. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15296. const UploadFormDataItems &items,
  15297. const std::string &boundary,
  15298. UploadProgress progress) {
  15299. return cli_->Patch(path, headers, items, boundary, progress);
  15300. }
  15301. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15302. const UploadFormDataItems &items,
  15303. const FormDataProviderItems &provider_items,
  15304. UploadProgress progress) {
  15305. return cli_->Patch(path, headers, items, provider_items, progress);
  15306. }
  15307. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15308. const std::string &body,
  15309. const std::string &content_type,
  15310. ContentReceiver content_receiver,
  15311. DownloadProgress progress) {
  15312. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15313. progress);
  15314. }
  15315. inline Result Client::Delete(const std::string &path,
  15316. DownloadProgress progress) {
  15317. return cli_->Delete(path, progress);
  15318. }
  15319. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15320. DownloadProgress progress) {
  15321. return cli_->Delete(path, headers, progress);
  15322. }
  15323. inline Result Client::Delete(const std::string &path, const char *body,
  15324. size_t content_length,
  15325. const std::string &content_type,
  15326. DownloadProgress progress) {
  15327. return cli_->Delete(path, body, content_length, content_type, progress);
  15328. }
  15329. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15330. const char *body, size_t content_length,
  15331. const std::string &content_type,
  15332. DownloadProgress progress) {
  15333. return cli_->Delete(path, headers, body, content_length, content_type,
  15334. progress);
  15335. }
  15336. inline Result Client::Delete(const std::string &path, const std::string &body,
  15337. const std::string &content_type,
  15338. DownloadProgress progress) {
  15339. return cli_->Delete(path, body, content_type, progress);
  15340. }
  15341. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15342. const std::string &body,
  15343. const std::string &content_type,
  15344. DownloadProgress progress) {
  15345. return cli_->Delete(path, headers, body, content_type, progress);
  15346. }
  15347. inline Result Client::Delete(const std::string &path, const Params &params,
  15348. DownloadProgress progress) {
  15349. return cli_->Delete(path, params, progress);
  15350. }
  15351. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15352. const Params &params, DownloadProgress progress) {
  15353. return cli_->Delete(path, headers, params, progress);
  15354. }
  15355. inline Result Client::Options(const std::string &path) {
  15356. return cli_->Options(path);
  15357. }
  15358. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15359. return cli_->Options(path, headers);
  15360. }
  15361. inline ClientImpl::StreamHandle
  15362. Client::open_stream(const std::string &method, const std::string &path,
  15363. const Params &params, const Headers &headers,
  15364. const std::string &body, const std::string &content_type) {
  15365. return cli_->open_stream(method, path, params, headers, body, content_type);
  15366. }
  15367. inline bool Client::send(Request &req, Response &res, Error &error) {
  15368. return cli_->send(req, res, error);
  15369. }
  15370. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15371. inline void Client::stop() { cli_->stop(); }
  15372. inline std::string Client::host() const { return cli_->host(); }
  15373. inline int Client::port() const { return cli_->port(); }
  15374. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15375. inline socket_t Client::socket() const { return cli_->socket(); }
  15376. inline void
  15377. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15378. cli_->set_hostname_addr_map(std::move(addr_map));
  15379. }
  15380. inline void Client::set_default_headers(Headers headers) {
  15381. cli_->set_default_headers(std::move(headers));
  15382. }
  15383. inline void Client::set_header_writer(
  15384. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15385. cli_->set_header_writer(writer);
  15386. }
  15387. inline void Client::set_address_family(int family) {
  15388. cli_->set_address_family(family);
  15389. }
  15390. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15391. inline void Client::set_socket_options(SocketOptions socket_options) {
  15392. cli_->set_socket_options(std::move(socket_options));
  15393. }
  15394. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15395. cli_->set_connection_timeout(sec, usec);
  15396. }
  15397. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15398. cli_->set_read_timeout(sec, usec);
  15399. }
  15400. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15401. cli_->set_write_timeout(sec, usec);
  15402. }
  15403. inline void Client::set_basic_auth(const std::string &username,
  15404. const std::string &password) {
  15405. cli_->set_basic_auth(username, password);
  15406. }
  15407. inline void Client::set_bearer_token_auth(const std::string &token) {
  15408. cli_->set_bearer_token_auth(token);
  15409. }
  15410. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15411. inline void Client::set_follow_location(bool on) {
  15412. cli_->set_follow_location(on);
  15413. }
  15414. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15415. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15416. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15417. inline void Client::set_payload_max_length(size_t length) {
  15418. cli_->set_payload_max_length(length);
  15419. }
  15420. inline void Client::set_interface(const std::string &intf) {
  15421. cli_->set_interface(intf);
  15422. }
  15423. inline void Client::set_proxy(const std::string &host, int port) {
  15424. cli_->set_proxy(host, port);
  15425. }
  15426. inline void Client::set_proxy_basic_auth(const std::string &username,
  15427. const std::string &password) {
  15428. cli_->set_proxy_basic_auth(username, password);
  15429. }
  15430. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15431. cli_->set_proxy_bearer_token_auth(token);
  15432. }
  15433. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15434. cli_->set_no_proxy(patterns);
  15435. }
  15436. inline void Client::set_logger(Logger logger) {
  15437. cli_->set_logger(std::move(logger));
  15438. }
  15439. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15440. cli_->set_error_logger(std::move(error_logger));
  15441. }
  15442. /*
  15443. * Group 6: SSL Server and Client implementation
  15444. */
  15445. #ifdef CPPHTTPLIB_SSL_ENABLED
  15446. // SSL HTTP server implementation
  15447. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15448. const char *client_ca_cert_file_path,
  15449. const char *client_ca_cert_dir_path,
  15450. const char *private_key_password) {
  15451. using namespace tls;
  15452. ctx_ = create_server_context();
  15453. if (!ctx_) { return; }
  15454. // Load server certificate and private key
  15455. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15456. private_key_password)) {
  15457. last_ssl_error_ = static_cast<int>(get_error());
  15458. free_context(ctx_);
  15459. ctx_ = nullptr;
  15460. return;
  15461. }
  15462. // Load client CA certificates for client authentication
  15463. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15464. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15465. client_ca_cert_dir_path)) {
  15466. last_ssl_error_ = static_cast<int>(get_error());
  15467. free_context(ctx_);
  15468. ctx_ = nullptr;
  15469. return;
  15470. }
  15471. // Enable client certificate verification
  15472. set_verify_client(ctx_, true);
  15473. }
  15474. }
  15475. inline SSLServer::SSLServer(const PemMemory &pem) {
  15476. using namespace tls;
  15477. ctx_ = create_server_context();
  15478. if (ctx_) {
  15479. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15480. pem.private_key_password)) {
  15481. last_ssl_error_ = static_cast<int>(get_error());
  15482. free_context(ctx_);
  15483. ctx_ = nullptr;
  15484. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15485. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15486. last_ssl_error_ = static_cast<int>(get_error());
  15487. free_context(ctx_);
  15488. ctx_ = nullptr;
  15489. } else {
  15490. set_verify_client(ctx_, true);
  15491. }
  15492. }
  15493. }
  15494. }
  15495. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15496. using namespace tls;
  15497. ctx_ = create_server_context();
  15498. if (ctx_) {
  15499. if (!setup_callback(ctx_)) {
  15500. free_context(ctx_);
  15501. ctx_ = nullptr;
  15502. }
  15503. }
  15504. }
  15505. inline SSLServer::~SSLServer() {
  15506. if (ctx_) { tls::free_context(ctx_); }
  15507. }
  15508. inline bool SSLServer::is_valid() const {
  15509. return ctx_ != nullptr && Server::is_valid();
  15510. }
  15511. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15512. using namespace tls;
  15513. // Create TLS session with mutex protection
  15514. session_t session = nullptr;
  15515. {
  15516. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15517. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15518. }
  15519. if (!session) {
  15520. last_ssl_error_ = static_cast<int>(get_error());
  15521. detail::shutdown_socket(sock);
  15522. detail::close_socket(sock);
  15523. return false;
  15524. }
  15525. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15526. bool handshake_done = false;
  15527. bool ret = false;
  15528. bool websocket_upgraded = false;
  15529. auto cleanup = detail::scope_exit([&] {
  15530. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15531. free_session(session);
  15532. detail::shutdown_socket(sock);
  15533. detail::close_socket(sock);
  15534. });
  15535. // Perform TLS accept handshake with timeout
  15536. TlsError tls_err;
  15537. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15538. &tls_err)) {
  15539. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15540. // Map TlsError to legacy ssl_error for backward compatibility
  15541. if (tls_err.code == ErrorCode::WantRead) {
  15542. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15543. } else if (tls_err.code == ErrorCode::WantWrite) {
  15544. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15545. } else {
  15546. last_ssl_error_ = SSL_ERROR_SSL;
  15547. }
  15548. #else
  15549. last_ssl_error_ = static_cast<int>(get_error());
  15550. #endif
  15551. return false;
  15552. }
  15553. handshake_done = true;
  15554. std::string remote_addr;
  15555. int remote_port = 0;
  15556. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15557. std::string local_addr;
  15558. int local_port = 0;
  15559. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15560. ret = serve_guarded([&]() {
  15561. return detail::process_server_socket_ssl(
  15562. svr_sock_, session, sock, keep_alive_max_count_,
  15563. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15564. write_timeout_sec_, write_timeout_usec_,
  15565. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15566. return process_request(
  15567. strm, remote_addr, remote_port, local_addr, local_port,
  15568. close_connection, connection_closed,
  15569. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15570. });
  15571. });
  15572. return ret;
  15573. }
  15574. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15575. const char *key_pem,
  15576. const char *client_ca_pem,
  15577. const char *password) {
  15578. if (!ctx_) { return false; }
  15579. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15580. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15581. return false;
  15582. }
  15583. if (client_ca_pem) {
  15584. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15585. }
  15586. return true;
  15587. }
  15588. // SSL HTTP client implementation
  15589. inline SSLClient::~SSLClient() {
  15590. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15591. // base function rather than the derived function once we get to the
  15592. // base class destructor, and won't free the SSL (causing a leak).
  15593. // This must happen before the context is freed below: some backends
  15594. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15595. // context, so freeing the context first leaves close_notify reading
  15596. // freed memory.
  15597. shutdown_ssl_impl(socket_, true);
  15598. if (ctx_) {
  15599. tls::free_context(ctx_);
  15600. ctx_ = nullptr;
  15601. }
  15602. }
  15603. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15604. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15605. shutdown_ssl_impl(socket, shutdown_gracefully);
  15606. }
  15607. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15608. bool shutdown_gracefully) {
  15609. if (socket.sock == INVALID_SOCKET) {
  15610. assert(socket.ssl == nullptr);
  15611. return;
  15612. }
  15613. if (socket.ssl) {
  15614. tls::shutdown(socket.ssl, shutdown_gracefully);
  15615. {
  15616. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15617. tls::free_session(socket.ssl);
  15618. }
  15619. socket.ssl = nullptr;
  15620. }
  15621. assert(socket.ssl == nullptr);
  15622. }
  15623. inline bool SSLClient::process_socket(
  15624. const Socket &socket,
  15625. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15626. std::function<bool(Stream &strm)> callback) {
  15627. assert(socket.ssl);
  15628. return detail::process_client_socket_ssl(
  15629. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15630. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15631. std::move(callback));
  15632. }
  15633. inline bool SSLClient::is_ssl() const { return true; }
  15634. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15635. if (!is_valid()) {
  15636. error = Error::SSLConnection;
  15637. return false;
  15638. }
  15639. return ClientImpl::create_and_connect_socket(socket, error);
  15640. }
  15641. inline bool SSLClient::setup_proxy_connection(
  15642. Socket &socket,
  15643. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15644. Response &res, bool &success, Error &error) {
  15645. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15646. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15647. return false;
  15648. }
  15649. if (!initialize_ssl(socket, error)) {
  15650. success = false;
  15651. return false;
  15652. }
  15653. return true;
  15654. }
  15655. // Assumes that socket_mutex_ is locked and that there are no requests in
  15656. // flight
  15657. inline bool SSLClient::connect_with_proxy(
  15658. Socket &socket,
  15659. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15660. Response &res, bool &success, Error &error) {
  15661. success = true;
  15662. Response proxy_res;
  15663. if (!detail::process_client_socket(
  15664. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15665. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15666. start_time, [&](Stream &strm) {
  15667. Request req2;
  15668. req2.method = "CONNECT";
  15669. req2.path =
  15670. detail::make_host_and_port_string_always_port(host_, port_);
  15671. if (max_timeout_msec_ > 0) {
  15672. req2.start_time_ = std::chrono::steady_clock::now();
  15673. }
  15674. return process_request(strm, req2, proxy_res, false, error);
  15675. })) {
  15676. // Thread-safe to close everything because we are assuming there are no
  15677. // requests in flight
  15678. shutdown_ssl(socket, true);
  15679. shutdown_socket(socket);
  15680. close_socket(socket);
  15681. success = false;
  15682. return false;
  15683. }
  15684. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15685. if (!proxy_digest_auth_username_.empty() &&
  15686. !proxy_digest_auth_password_.empty()) {
  15687. std::map<std::string, std::string> auth;
  15688. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15689. // Close the current socket and create a new one for the authenticated
  15690. // request
  15691. shutdown_ssl(socket, true);
  15692. shutdown_socket(socket);
  15693. close_socket(socket);
  15694. // Create a new socket for the authenticated CONNECT request
  15695. if (!ensure_socket_connection(socket, error)) {
  15696. success = false;
  15697. output_error_log(error, nullptr);
  15698. return false;
  15699. }
  15700. proxy_res = Response();
  15701. if (!detail::process_client_socket(
  15702. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15703. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15704. start_time, [&](Stream &strm) {
  15705. Request req3;
  15706. req3.method = "CONNECT";
  15707. req3.path = detail::make_host_and_port_string_always_port(
  15708. host_, port_);
  15709. req3.headers.insert(detail::make_digest_authentication_header(
  15710. req3, auth, 1, detail::random_string(10),
  15711. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15712. true));
  15713. if (max_timeout_msec_ > 0) {
  15714. req3.start_time_ = std::chrono::steady_clock::now();
  15715. }
  15716. return process_request(strm, req3, proxy_res, false, error);
  15717. })) {
  15718. // Thread-safe to close everything because we are assuming there are
  15719. // no requests in flight
  15720. shutdown_ssl(socket, true);
  15721. shutdown_socket(socket);
  15722. close_socket(socket);
  15723. success = false;
  15724. return false;
  15725. }
  15726. }
  15727. }
  15728. }
  15729. // If status code is not 200, proxy request is failed.
  15730. // Set error to ProxyConnection and return proxy response
  15731. // as the response of the request
  15732. if (proxy_res.status != StatusCode::OK_200) {
  15733. error = Error::ProxyConnection;
  15734. output_error_log(error, nullptr);
  15735. res = std::move(proxy_res);
  15736. // Thread-safe to close everything because we are assuming there are
  15737. // no requests in flight
  15738. shutdown_ssl(socket, true);
  15739. shutdown_socket(socket);
  15740. close_socket(socket);
  15741. return false;
  15742. }
  15743. return true;
  15744. }
  15745. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15746. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15747. if (is_proxy_enabled_for_host(host_)) { return true; }
  15748. if (!initialize_ssl(socket, error)) {
  15749. shutdown_socket(socket);
  15750. close_socket(socket);
  15751. return false;
  15752. }
  15753. return true;
  15754. }
  15755. // SSL HTTP client implementation
  15756. inline SSLClient::SSLClient(const std::string &host)
  15757. : SSLClient(host, 443, std::string(), std::string()) {}
  15758. inline SSLClient::SSLClient(const std::string &host, int port)
  15759. : SSLClient(host, port, std::string(), std::string()) {}
  15760. inline void SSLClient::init_ctx() {
  15761. ctx_ = tls::create_client_context();
  15762. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15763. }
  15764. inline void SSLClient::reset_ctx_on_error() {
  15765. last_backend_error_ = tls::get_error();
  15766. tls::free_context(ctx_);
  15767. ctx_ = nullptr;
  15768. }
  15769. inline SSLClient::SSLClient(const std::string &host, int port,
  15770. const std::string &client_cert_path,
  15771. const std::string &client_key_path,
  15772. const std::string &private_key_password)
  15773. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15774. init_ctx();
  15775. if (!ctx_) { return; }
  15776. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15777. const char *password =
  15778. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15779. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15780. client_key_path.c_str(), password)) {
  15781. reset_ctx_on_error();
  15782. }
  15783. }
  15784. }
  15785. inline SSLClient::SSLClient(const std::string &host, int port,
  15786. const PemMemory &pem)
  15787. : ClientImpl(host, port) {
  15788. init_ctx();
  15789. if (!ctx_) { return; }
  15790. if (pem.cert_pem && pem.key_pem) {
  15791. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15792. pem.private_key_password)) {
  15793. reset_ctx_on_error();
  15794. }
  15795. }
  15796. }
  15797. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15798. if (ca_cert_store && ctx_) {
  15799. // set_ca_store takes ownership of ca_cert_store
  15800. tls::set_ca_store(ctx_, ca_cert_store);
  15801. ca_cert_store_set_ = true;
  15802. } else if (ca_cert_store) {
  15803. tls::free_ca_store(ca_cert_store);
  15804. }
  15805. }
  15806. inline void
  15807. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15808. if (!ctx_) { return; }
  15809. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15810. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  15811. #endif
  15812. tls::set_verify_callback(ctx_, verifier);
  15813. }
  15814. inline void SSLClient::set_session_verifier(
  15815. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15816. session_verifier_ = std::move(verifier);
  15817. }
  15818. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15819. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15820. enable_windows_cert_verification_ = enabled;
  15821. }
  15822. #endif
  15823. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15824. std::size_t size) {
  15825. if (ctx_ && ca_cert && size > 0) {
  15826. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15827. tls::load_ca_pem(ctx_, ca_cert, size);
  15828. }
  15829. }
  15830. inline bool SSLClient::load_certs() {
  15831. auto ret = true;
  15832. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15833. // one client is shared across concurrent requests here.
  15834. std::call_once(initialize_cert_, [&]() {
  15835. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15836. ret = detail::load_client_ca_config(
  15837. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15838. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15839. last_backend_error_);
  15840. });
  15841. return ret;
  15842. }
  15843. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15844. // Load CA certificates if server verification is enabled
  15845. if (server_certificate_verification_) {
  15846. if (!load_certs()) {
  15847. error = Error::SSLLoadingCerts;
  15848. output_error_log(error, nullptr);
  15849. return false;
  15850. }
  15851. }
  15852. detail::ClientTlsSessionOptions options;
  15853. options.server_hostname_verification = server_hostname_verification_;
  15854. options.session_verifier = session_verifier_;
  15855. options.ctx_mutex = &ctx_mutex_;
  15856. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15857. // Skip Schannel when a custom CA cert is specified, as the Windows
  15858. // certificate store would not know about user-provided CA certificates.
  15859. // Also skip when system CA trust is explicitly disabled.
  15860. options.windows_cert_verification =
  15861. enable_windows_cert_verification_ &&
  15862. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15863. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15864. // Only a verifier set through set_server_certificate_verifier() is seen
  15865. // here, not one installed with tls::set_verify_callback() directly.
  15866. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  15867. #endif
  15868. tls::session_t session = nullptr;
  15869. // Use scope_exit to ensure session is freed on error paths
  15870. bool success = false;
  15871. auto session_guard = detail::scope_exit([&] {
  15872. if (!success) { tls::free_session(session); }
  15873. });
  15874. detail::ClientTlsSessionError tls_error;
  15875. if (!detail::setup_client_tls_session(
  15876. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15877. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15878. options)) {
  15879. error = tls_error.error;
  15880. last_ssl_error_ = tls_error.ssl_error;
  15881. last_backend_error_ = tls_error.backend_error;
  15882. output_error_log(error, nullptr);
  15883. return false;
  15884. }
  15885. success = true;
  15886. socket.ssl = session;
  15887. return true;
  15888. }
  15889. inline void Client::set_digest_auth(const std::string &username,
  15890. const std::string &password) {
  15891. cli_->set_digest_auth(username, password);
  15892. }
  15893. inline void Client::set_proxy_digest_auth(const std::string &username,
  15894. const std::string &password) {
  15895. cli_->set_proxy_digest_auth(username, password);
  15896. }
  15897. inline void Client::enable_server_certificate_verification(bool enabled) {
  15898. cli_->enable_server_certificate_verification(enabled);
  15899. }
  15900. inline void Client::enable_server_hostname_verification(bool enabled) {
  15901. cli_->enable_server_hostname_verification(enabled);
  15902. }
  15903. inline void Client::enable_system_ca(bool enabled) {
  15904. cli_->enable_system_ca(enabled);
  15905. }
  15906. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15907. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15908. if (is_ssl_) {
  15909. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15910. enabled);
  15911. }
  15912. }
  15913. #endif
  15914. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15915. const std::string &ca_cert_dir_path) {
  15916. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15917. }
  15918. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15919. if (is_ssl_) {
  15920. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15921. } else if (ca_cert_store) {
  15922. tls::free_ca_store(ca_cert_store);
  15923. }
  15924. }
  15925. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15926. if (is_ssl_) {
  15927. // Use the PEM-based path so the CA data is retained for redirect transfer
  15928. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15929. }
  15930. }
  15931. inline void
  15932. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15933. if (is_ssl_) {
  15934. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15935. std::move(verifier));
  15936. }
  15937. }
  15938. inline void Client::set_session_verifier(
  15939. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15940. if (is_ssl_) {
  15941. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15942. }
  15943. }
  15944. inline tls::ctx_t Client::tls_context() const {
  15945. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15946. return nullptr;
  15947. }
  15948. #endif // CPPHTTPLIB_SSL_ENABLED
  15949. /*
  15950. * Group 7: TLS abstraction layer - Common API
  15951. */
  15952. #ifdef CPPHTTPLIB_SSL_ENABLED
  15953. namespace tls {
  15954. // Helper for PeerCert construction
  15955. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15956. return PeerCert(get_peer_cert(session));
  15957. }
  15958. namespace impl {
  15959. inline VerifyCallback &get_verify_callback() {
  15960. static thread_local VerifyCallback callback;
  15961. return callback;
  15962. }
  15963. inline VerifyCallback &get_mbedtls_verify_callback() {
  15964. static thread_local VerifyCallback callback;
  15965. return callback;
  15966. }
  15967. // Check if a string is an IPv4 address
  15968. inline bool is_ipv4_address(const std::string &str) {
  15969. int dots = 0;
  15970. for (char c : str) {
  15971. if (c == '.') {
  15972. dots++;
  15973. } else if (!detail::is_ascii_digit(c)) {
  15974. return false;
  15975. }
  15976. }
  15977. return dots == 3;
  15978. }
  15979. // Parse IPv4 address string to bytes
  15980. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15981. const char *p = str.c_str();
  15982. for (int i = 0; i < 4; i++) {
  15983. if (i > 0) {
  15984. if (*p != '.') { return false; }
  15985. p++;
  15986. }
  15987. int val = 0;
  15988. int digits = 0;
  15989. while (detail::is_ascii_digit(*p)) {
  15990. val = val * 10 + (*p - '0');
  15991. if (val > 255) { return false; }
  15992. p++;
  15993. digits++;
  15994. }
  15995. if (digits == 0) { return false; }
  15996. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15997. if (digits > 1 && *(p - digits) == '0') { return false; }
  15998. out[i] = static_cast<unsigned char>(val);
  15999. }
  16000. return *p == '\0';
  16001. }
  16002. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16003. // `out` must have room for at least 16 bytes. Returns the address length
  16004. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16005. // literal. Used to match a host against iPAddress SANs the same way the
  16006. // OpenSSL backend does via X509_check_ip.
  16007. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16008. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16009. struct in6_addr addr6 = {};
  16010. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16011. memcpy(out, &addr6, 16);
  16012. return 16;
  16013. }
  16014. return 0;
  16015. }
  16016. #ifdef _WIN32
  16017. // Enumerate Windows system certificates and call callback with DER data
  16018. template <typename Callback>
  16019. inline bool enumerate_windows_system_certs(Callback cb) {
  16020. bool loaded = false;
  16021. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16022. for (auto store_name : store_names) {
  16023. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16024. if (hStore) {
  16025. PCCERT_CONTEXT pContext = nullptr;
  16026. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16027. nullptr) {
  16028. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16029. loaded = true;
  16030. }
  16031. }
  16032. CertCloseStore(hStore, 0);
  16033. }
  16034. }
  16035. return loaded;
  16036. }
  16037. #endif
  16038. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16039. // Enumerate macOS Keychain certificates and call callback with DER data
  16040. template <typename Callback>
  16041. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16042. bool loaded = false;
  16043. const SecTrustSettingsDomain domains[] = {
  16044. kSecTrustSettingsDomainSystem,
  16045. kSecTrustSettingsDomainAdmin,
  16046. kSecTrustSettingsDomainUser,
  16047. };
  16048. for (auto domain : domains) {
  16049. CFArrayRef certs = nullptr;
  16050. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16051. if (status != errSecSuccess || !certs) {
  16052. if (certs) CFRelease(certs);
  16053. continue;
  16054. }
  16055. CFIndex count = CFArrayGetCount(certs);
  16056. for (CFIndex i = 0; i < count; i++) {
  16057. SecCertificateRef cert =
  16058. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16059. CFDataRef data = SecCertificateCopyData(cert);
  16060. if (data) {
  16061. if (cb(CFDataGetBytePtr(data),
  16062. static_cast<size_t>(CFDataGetLength(data)))) {
  16063. loaded = true;
  16064. }
  16065. CFRelease(data);
  16066. }
  16067. }
  16068. CFRelease(certs);
  16069. }
  16070. return loaded;
  16071. }
  16072. #endif
  16073. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16074. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16075. // Common CA certificate file paths on Linux/Unix
  16076. inline const char **system_ca_paths() {
  16077. static const char *paths[] = {
  16078. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16079. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16080. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16081. "/etc/pki/tls/cacert.pem", // OpenELEC
  16082. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16083. nullptr};
  16084. return paths;
  16085. }
  16086. // Common CA certificate directory paths on Linux/Unix
  16087. inline const char **system_ca_dirs() {
  16088. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16089. "/etc/pki/tls/certs", // RHEL/CentOS
  16090. "/usr/share/ca-certificates", // Other
  16091. nullptr};
  16092. return dirs;
  16093. }
  16094. #endif
  16095. } // namespace impl
  16096. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16097. const char *ca_dir) {
  16098. if (!ctx) { return false; }
  16099. bool success = true;
  16100. if (ca_file && *ca_file) {
  16101. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16102. }
  16103. if (ca_dir && *ca_dir) {
  16104. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16105. }
  16106. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16107. // Set CA list for client certificate request (CertificateRequest message)
  16108. if (ca_file && *ca_file) {
  16109. auto list = SSL_load_client_CA_file(ca_file);
  16110. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16111. }
  16112. #endif
  16113. return success;
  16114. }
  16115. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16116. const char *password) {
  16117. return set_client_cert_pem(ctx, cert, key, password);
  16118. }
  16119. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16120. const char *key_path, const char *password) {
  16121. return set_client_cert_file(ctx, cert_path, key_path, password);
  16122. }
  16123. // PeerCert implementation
  16124. inline PeerCert::PeerCert() = default;
  16125. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16126. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16127. other.cert_ = nullptr;
  16128. }
  16129. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16130. if (this != &other) {
  16131. if (cert_) { free_cert(cert_); }
  16132. cert_ = other.cert_;
  16133. other.cert_ = nullptr;
  16134. }
  16135. return *this;
  16136. }
  16137. inline PeerCert::~PeerCert() {
  16138. if (cert_) { free_cert(cert_); }
  16139. }
  16140. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16141. inline std::string PeerCert::subject_cn() const {
  16142. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16143. }
  16144. inline std::string PeerCert::issuer_name() const {
  16145. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16146. }
  16147. inline bool PeerCert::check_hostname(const char *hostname) const {
  16148. return cert_ ? verify_hostname(cert_, hostname) : false;
  16149. }
  16150. inline std::vector<SanEntry> PeerCert::sans() const {
  16151. std::vector<SanEntry> result;
  16152. if (cert_) { get_cert_sans(cert_, result); }
  16153. return result;
  16154. }
  16155. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16156. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16157. }
  16158. inline std::string PeerCert::serial() const {
  16159. return cert_ ? get_cert_serial(cert_) : std::string();
  16160. }
  16161. // VerifyContext method implementations
  16162. inline std::string VerifyContext::subject_cn() const {
  16163. return cert ? get_cert_subject_cn(cert) : std::string();
  16164. }
  16165. inline std::string VerifyContext::issuer_name() const {
  16166. return cert ? get_cert_issuer_name(cert) : std::string();
  16167. }
  16168. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16169. return cert ? verify_hostname(cert, hostname) : false;
  16170. }
  16171. inline std::vector<SanEntry> VerifyContext::sans() const {
  16172. std::vector<SanEntry> result;
  16173. if (cert) { get_cert_sans(cert, result); }
  16174. return result;
  16175. }
  16176. inline bool VerifyContext::validity(time_t &not_before,
  16177. time_t &not_after) const {
  16178. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16179. }
  16180. inline std::string VerifyContext::serial() const {
  16181. return cert ? get_cert_serial(cert) : std::string();
  16182. }
  16183. // TlsError static method implementation
  16184. inline std::string TlsError::verify_error_to_string(long error_code) {
  16185. return verify_error_string(error_code);
  16186. }
  16187. } // namespace tls
  16188. // Request::peer_cert() implementation
  16189. inline tls::PeerCert Request::peer_cert() const {
  16190. return tls::get_peer_cert_from_session(ssl);
  16191. }
  16192. // Request::sni() implementation
  16193. inline std::string Request::sni() const {
  16194. if (!ssl) { return std::string(); }
  16195. const char *s = tls::get_sni(ssl);
  16196. return s ? std::string(s) : std::string();
  16197. }
  16198. #endif // CPPHTTPLIB_SSL_ENABLED
  16199. /*
  16200. * Group 8: TLS abstraction layer - OpenSSL backend
  16201. */
  16202. /*
  16203. * OpenSSL Backend Implementation
  16204. */
  16205. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16206. namespace tls {
  16207. namespace impl {
  16208. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16209. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16210. switch (ssl_error) {
  16211. case SSL_ERROR_NONE: return ErrorCode::Success;
  16212. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16213. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16214. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16215. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16216. case SSL_ERROR_SSL:
  16217. default: return ErrorCode::Fatal;
  16218. }
  16219. }
  16220. // Helper: Create client CA list from PEM string
  16221. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16222. // Caller takes ownership of returned list
  16223. inline STACK_OF(X509_NAME) *
  16224. create_client_ca_list_from_pem(const char *ca_pem) {
  16225. if (!ca_pem) { return nullptr; }
  16226. auto ca_list = sk_X509_NAME_new_null();
  16227. if (!ca_list) { return nullptr; }
  16228. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16229. if (!bio) {
  16230. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16231. return nullptr;
  16232. }
  16233. X509 *cert = nullptr;
  16234. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16235. nullptr) {
  16236. const X509_NAME *name = X509_get_subject_name(cert);
  16237. if (name) {
  16238. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16239. }
  16240. X509_free(cert);
  16241. }
  16242. BIO_free(bio);
  16243. return ca_list;
  16244. }
  16245. // OpenSSL verify callback wrapper
  16246. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16247. auto &callback = get_verify_callback();
  16248. if (!callback) { return preverify_ok; }
  16249. // Get SSL object from X509_STORE_CTX
  16250. auto ssl = static_cast<SSL *>(
  16251. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16252. if (!ssl) { return preverify_ok; }
  16253. // Get current certificate and depth
  16254. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16255. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16256. int error = X509_STORE_CTX_get_error(ctx);
  16257. // Build context
  16258. VerifyContext verify_ctx;
  16259. verify_ctx.session = static_cast<session_t>(ssl);
  16260. verify_ctx.cert = static_cast<cert_t>(cert);
  16261. verify_ctx.depth = depth;
  16262. verify_ctx.preverify_ok = (preverify_ok != 0);
  16263. verify_ctx.error_code = error;
  16264. verify_ctx.error_string =
  16265. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16266. return callback(verify_ctx) ? 1 : 0;
  16267. }
  16268. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16269. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16270. // that must be released with release_store_objects
  16271. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16272. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16273. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16274. #endif
  16275. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16276. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16277. return X509_STORE_get1_objects(store);
  16278. #else
  16279. return X509_STORE_get0_objects(store);
  16280. #endif
  16281. }
  16282. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16283. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16284. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16285. #else
  16286. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16287. #endif
  16288. }
  16289. } // namespace impl
  16290. inline ctx_t create_client_context() {
  16291. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16292. if (ctx) {
  16293. // Disable auto-retry to properly handle non-blocking I/O
  16294. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16295. // Set minimum TLS version
  16296. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16297. }
  16298. return static_cast<ctx_t>(ctx);
  16299. }
  16300. inline void free_context(ctx_t ctx) {
  16301. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16302. }
  16303. inline bool set_min_version(ctx_t ctx, Version version) {
  16304. if (!ctx) return false;
  16305. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16306. static_cast<int>(version)) == 1;
  16307. }
  16308. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16309. if (!ctx || !pem || len == 0) return false;
  16310. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16311. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16312. if (!store) return false;
  16313. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16314. if (!bio) return false;
  16315. bool ok = true;
  16316. X509 *cert = nullptr;
  16317. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16318. nullptr) {
  16319. if (X509_STORE_add_cert(store, cert) != 1) {
  16320. // Ignore duplicate errors
  16321. auto err = ERR_peek_last_error();
  16322. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16323. ok = false;
  16324. }
  16325. }
  16326. X509_free(cert);
  16327. if (!ok) break;
  16328. }
  16329. BIO_free(bio);
  16330. // Clear any "no more certificates" errors
  16331. ERR_clear_error();
  16332. return ok;
  16333. }
  16334. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16335. if (!ctx || !file_path) return false;
  16336. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16337. nullptr) == 1;
  16338. }
  16339. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16340. if (!ctx || !dir_path) return false;
  16341. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16342. dir_path) == 1;
  16343. }
  16344. inline bool load_system_certs(ctx_t ctx) {
  16345. if (!ctx) return false;
  16346. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16347. #ifdef _WIN32
  16348. // Windows: Load from system certificate store (ROOT and CA)
  16349. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16350. if (!store) return false;
  16351. bool loaded_any = false;
  16352. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16353. for (auto store_name : store_names) {
  16354. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16355. if (!hStore) continue;
  16356. PCCERT_CONTEXT pContext = nullptr;
  16357. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16358. nullptr) {
  16359. const unsigned char *data = pContext->pbCertEncoded;
  16360. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16361. if (x509) {
  16362. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16363. X509_free(x509);
  16364. }
  16365. }
  16366. CertCloseStore(hStore, 0);
  16367. }
  16368. return loaded_any;
  16369. #elif defined(__APPLE__)
  16370. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16371. // macOS: Load from Keychain
  16372. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16373. if (!store) return false;
  16374. bool loaded_any = false;
  16375. const SecTrustSettingsDomain domains[] = {
  16376. kSecTrustSettingsDomainSystem,
  16377. kSecTrustSettingsDomainAdmin,
  16378. kSecTrustSettingsDomainUser,
  16379. };
  16380. for (auto domain : domains) {
  16381. CFArrayRef certs = nullptr;
  16382. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16383. !certs) {
  16384. if (certs) CFRelease(certs);
  16385. continue;
  16386. }
  16387. auto count = CFArrayGetCount(certs);
  16388. for (CFIndex i = 0; i < count; i++) {
  16389. auto cert = reinterpret_cast<SecCertificateRef>(
  16390. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16391. CFDataRef der = SecCertificateCopyData(cert);
  16392. if (der) {
  16393. const unsigned char *data = CFDataGetBytePtr(der);
  16394. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16395. if (x509) {
  16396. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16397. X509_free(x509);
  16398. }
  16399. CFRelease(der);
  16400. }
  16401. }
  16402. CFRelease(certs);
  16403. }
  16404. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16405. #else
  16406. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16407. #endif
  16408. #else
  16409. // Other Unix: use default verify paths
  16410. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16411. #endif
  16412. }
  16413. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16414. const char *password) {
  16415. if (!ctx || !cert || !key) return false;
  16416. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16417. // Load certificate
  16418. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16419. if (!cert_bio) return false;
  16420. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16421. BIO_free(cert_bio);
  16422. if (!x509) return false;
  16423. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16424. X509_free(x509);
  16425. if (!cert_ok) return false;
  16426. // Load private key
  16427. auto key_bio = BIO_new_mem_buf(key, -1);
  16428. if (!key_bio) return false;
  16429. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16430. password ? const_cast<char *>(password)
  16431. : nullptr);
  16432. BIO_free(key_bio);
  16433. if (!pkey) return false;
  16434. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16435. EVP_PKEY_free(pkey);
  16436. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16437. }
  16438. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16439. const char *key_path, const char *password) {
  16440. if (!ctx || !cert_path || !key_path) return false;
  16441. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16442. if (password && password[0] != '\0') {
  16443. SSL_CTX_set_default_passwd_cb_userdata(
  16444. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16445. }
  16446. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16447. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16448. }
  16449. inline ctx_t create_server_context() {
  16450. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16451. if (ctx) {
  16452. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16453. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16454. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16455. }
  16456. return static_cast<ctx_t>(ctx);
  16457. }
  16458. inline void set_verify_client(ctx_t ctx, bool require) {
  16459. if (!ctx) return;
  16460. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16461. require
  16462. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16463. : SSL_VERIFY_NONE,
  16464. nullptr);
  16465. }
  16466. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16467. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16468. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16469. SSL *ssl = SSL_new(ssl_ctx);
  16470. if (!ssl) return nullptr;
  16471. // Disable auto-retry for proper non-blocking I/O handling
  16472. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16473. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16474. if (!bio) {
  16475. SSL_free(ssl);
  16476. return nullptr;
  16477. }
  16478. SSL_set_bio(ssl, bio, bio);
  16479. return static_cast<session_t>(ssl);
  16480. }
  16481. inline void free_session(session_t session) {
  16482. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16483. }
  16484. inline bool set_sni(session_t session, const char *hostname,
  16485. bool /*verify_hostname*/) {
  16486. if (!session || !hostname) return false;
  16487. auto ssl = static_cast<SSL *>(session);
  16488. // Set SNI (Server Name Indication) only - does not enable verification.
  16489. // OpenSSL never binds identity checking to SNI (that happens post-
  16490. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16491. #if defined(OPENSSL_IS_BORINGSSL)
  16492. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16493. #else
  16494. // Direct call instead of macro to suppress -Wold-style-cast warning
  16495. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16496. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16497. #endif
  16498. }
  16499. inline TlsError connect(session_t session) {
  16500. if (!session) { return TlsError(); }
  16501. auto ssl = static_cast<SSL *>(session);
  16502. auto ret = SSL_connect(ssl);
  16503. TlsError err;
  16504. if (ret == 1) {
  16505. err.code = ErrorCode::Success;
  16506. } else {
  16507. auto ssl_err = SSL_get_error(ssl, ret);
  16508. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16509. err.backend_code = ERR_get_error();
  16510. }
  16511. return err;
  16512. }
  16513. inline TlsError accept(session_t session) {
  16514. if (!session) { return TlsError(); }
  16515. auto ssl = static_cast<SSL *>(session);
  16516. auto ret = SSL_accept(ssl);
  16517. TlsError err;
  16518. if (ret == 1) {
  16519. err.code = ErrorCode::Success;
  16520. } else {
  16521. auto ssl_err = SSL_get_error(ssl, ret);
  16522. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16523. err.backend_code = ERR_get_error();
  16524. }
  16525. return err;
  16526. }
  16527. inline bool connect_nonblocking(session_t session, socket_t sock,
  16528. time_t timeout_sec, time_t timeout_usec,
  16529. TlsError *err) {
  16530. if (!session) {
  16531. if (err) { err->code = ErrorCode::Fatal; }
  16532. return false;
  16533. }
  16534. auto ssl = static_cast<SSL *>(session);
  16535. auto bio = SSL_get_rbio(ssl);
  16536. // Set non-blocking mode for handshake
  16537. detail::set_nonblocking(sock, true);
  16538. if (bio) { BIO_set_nbio(bio, 1); }
  16539. auto cleanup = detail::scope_exit([&]() {
  16540. // Restore blocking mode after handshake
  16541. if (bio) { BIO_set_nbio(bio, 0); }
  16542. detail::set_nonblocking(sock, false);
  16543. });
  16544. auto res = 0;
  16545. while ((res = SSL_connect(ssl)) != 1) {
  16546. auto ssl_err = SSL_get_error(ssl, res);
  16547. switch (ssl_err) {
  16548. case SSL_ERROR_WANT_READ:
  16549. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16550. continue;
  16551. }
  16552. break;
  16553. case SSL_ERROR_WANT_WRITE:
  16554. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16555. continue;
  16556. }
  16557. break;
  16558. default: break;
  16559. }
  16560. if (err) {
  16561. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16562. err->backend_code = ERR_get_error();
  16563. }
  16564. return false;
  16565. }
  16566. if (err) { err->code = ErrorCode::Success; }
  16567. return true;
  16568. }
  16569. inline bool accept_nonblocking(session_t session, socket_t sock,
  16570. time_t timeout_sec, time_t timeout_usec,
  16571. TlsError *err) {
  16572. if (!session) {
  16573. if (err) { err->code = ErrorCode::Fatal; }
  16574. return false;
  16575. }
  16576. auto ssl = static_cast<SSL *>(session);
  16577. auto bio = SSL_get_rbio(ssl);
  16578. // Set non-blocking mode for handshake
  16579. detail::set_nonblocking(sock, true);
  16580. if (bio) { BIO_set_nbio(bio, 1); }
  16581. auto cleanup = detail::scope_exit([&]() {
  16582. // Restore blocking mode after handshake
  16583. if (bio) { BIO_set_nbio(bio, 0); }
  16584. detail::set_nonblocking(sock, false);
  16585. });
  16586. auto res = 0;
  16587. while ((res = SSL_accept(ssl)) != 1) {
  16588. auto ssl_err = SSL_get_error(ssl, res);
  16589. switch (ssl_err) {
  16590. case SSL_ERROR_WANT_READ:
  16591. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16592. continue;
  16593. }
  16594. break;
  16595. case SSL_ERROR_WANT_WRITE:
  16596. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16597. continue;
  16598. }
  16599. break;
  16600. default: break;
  16601. }
  16602. if (err) {
  16603. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16604. err->backend_code = ERR_get_error();
  16605. }
  16606. return false;
  16607. }
  16608. if (err) { err->code = ErrorCode::Success; }
  16609. return true;
  16610. }
  16611. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16612. if (!session || !buf) {
  16613. err.code = ErrorCode::Fatal;
  16614. return -1;
  16615. }
  16616. auto ssl = static_cast<SSL *>(session);
  16617. constexpr auto max_len =
  16618. static_cast<size_t>((std::numeric_limits<int>::max)());
  16619. if (len > max_len) { len = max_len; }
  16620. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16621. if (ret > 0) {
  16622. err.code = ErrorCode::Success;
  16623. return ret;
  16624. }
  16625. auto ssl_err = SSL_get_error(ssl, ret);
  16626. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16627. if (err.code == ErrorCode::PeerClosed) {
  16628. return 0;
  16629. } // Gracefully handle the peer closed state.
  16630. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16631. return -1;
  16632. }
  16633. inline ssize_t write(session_t session, const void *buf, size_t len,
  16634. TlsError &err) {
  16635. if (!session || !buf) {
  16636. err.code = ErrorCode::Fatal;
  16637. return -1;
  16638. }
  16639. auto ssl = static_cast<SSL *>(session);
  16640. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16641. if (ret > 0) {
  16642. err.code = ErrorCode::Success;
  16643. return ret;
  16644. }
  16645. auto ssl_err = SSL_get_error(ssl, ret);
  16646. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16647. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16648. return -1;
  16649. }
  16650. inline int pending(const_session_t session) {
  16651. if (!session) return 0;
  16652. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16653. }
  16654. inline void shutdown(session_t session, bool graceful) {
  16655. if (!session) return;
  16656. auto ssl = static_cast<SSL *>(session);
  16657. if (graceful) {
  16658. // Send close_notify without waiting for the peer's. The connection is
  16659. // closed right after this, so a unidirectional shutdown is enough, and an
  16660. // idle peer that never answers would otherwise hold this thread until the
  16661. // read timeout. The other backends do not wait either.
  16662. SSL_shutdown(ssl);
  16663. }
  16664. }
  16665. inline bool is_peer_closed(session_t session, socket_t sock) {
  16666. if (!session) return true;
  16667. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16668. detail::set_nonblocking(sock, true);
  16669. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16670. auto ssl = static_cast<SSL *>(session);
  16671. char buf;
  16672. auto ret = SSL_peek(ssl, &buf, 1);
  16673. if (ret > 0) return false;
  16674. auto err = SSL_get_error(ssl, ret);
  16675. return err == SSL_ERROR_ZERO_RETURN;
  16676. }
  16677. inline cert_t get_peer_cert(const_session_t session) {
  16678. if (!session) return nullptr;
  16679. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16680. static_cast<SSL *>(const_cast<void *>(session))));
  16681. }
  16682. inline size_t get_peer_certs(const_session_t session,
  16683. std::vector<cert_t> &certs) {
  16684. certs.clear();
  16685. if (!session) { return 0; }
  16686. auto ssl = static_cast<const SSL *>(session);
  16687. // On the server side, the chain leaves out the peer's own certificate
  16688. if (SSL_is_server(ssl)) {
  16689. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16690. }
  16691. auto sk = SSL_get_peer_cert_chain(ssl);
  16692. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16693. auto x509 = sk_X509_value(sk, i);
  16694. X509_up_ref(x509);
  16695. certs.push_back(static_cast<cert_t>(x509));
  16696. }
  16697. return certs.size();
  16698. }
  16699. inline void free_cert(cert_t cert) {
  16700. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16701. }
  16702. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16703. if (!cert || !hostname) return false;
  16704. auto x509 = static_cast<X509 *>(cert);
  16705. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16706. if (detail::is_ip_address(hostname)) {
  16707. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16708. }
  16709. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16710. }
  16711. inline uint64_t hostname_mismatch_code() {
  16712. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16713. }
  16714. inline long get_verify_result(const_session_t session) {
  16715. if (!session) return X509_V_ERR_UNSPECIFIED;
  16716. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16717. }
  16718. inline std::string get_cert_subject_cn(cert_t cert) {
  16719. if (!cert) return "";
  16720. auto x509 = static_cast<X509 *>(cert);
  16721. auto subject_name = X509_get_subject_name(x509);
  16722. if (!subject_name) return "";
  16723. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16724. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16725. if (idx < 0) return "";
  16726. auto entry = X509_NAME_get_entry(subject_name, idx);
  16727. if (!entry) return "";
  16728. auto data = X509_NAME_ENTRY_get_data(entry);
  16729. if (!data) return "";
  16730. return std::string(
  16731. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16732. static_cast<size_t>(ASN1_STRING_length(data)));
  16733. }
  16734. inline std::string get_cert_issuer_name(cert_t cert) {
  16735. if (!cert) return "";
  16736. auto x509 = static_cast<X509 *>(cert);
  16737. auto issuer_name = X509_get_issuer_name(x509);
  16738. if (!issuer_name) return "";
  16739. char buf[256];
  16740. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16741. return std::string(buf);
  16742. }
  16743. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16744. sans.clear();
  16745. if (!cert) return false;
  16746. auto x509 = static_cast<X509 *>(cert);
  16747. auto names = static_cast<GENERAL_NAMES *>(
  16748. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16749. if (!names) return true; // No SANs is valid
  16750. auto count = sk_GENERAL_NAME_num(names);
  16751. for (decltype(count) i = 0; i < count; i++) {
  16752. auto gen = sk_GENERAL_NAME_value(names, i);
  16753. if (!gen) continue;
  16754. SanEntry entry;
  16755. switch (gen->type) {
  16756. case GEN_DNS:
  16757. entry.type = SanType::DNS;
  16758. if (gen->d.dNSName) {
  16759. entry.value = std::string(
  16760. reinterpret_cast<const char *>(
  16761. ASN1_STRING_get0_data(gen->d.dNSName)),
  16762. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16763. }
  16764. break;
  16765. case GEN_IPADD:
  16766. entry.type = SanType::IP;
  16767. if (gen->d.iPAddress) {
  16768. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16769. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16770. if (len == 4) {
  16771. // IPv4
  16772. char buf[INET_ADDRSTRLEN];
  16773. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16774. entry.value = buf;
  16775. } else if (len == 16) {
  16776. // IPv6
  16777. char buf[INET6_ADDRSTRLEN];
  16778. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16779. entry.value = buf;
  16780. }
  16781. }
  16782. break;
  16783. case GEN_EMAIL:
  16784. entry.type = SanType::EMAIL;
  16785. if (gen->d.rfc822Name) {
  16786. entry.value = std::string(
  16787. reinterpret_cast<const char *>(
  16788. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16789. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16790. }
  16791. break;
  16792. case GEN_URI:
  16793. entry.type = SanType::URI;
  16794. if (gen->d.uniformResourceIdentifier) {
  16795. entry.value = std::string(
  16796. reinterpret_cast<const char *>(
  16797. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16798. static_cast<size_t>(
  16799. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16800. }
  16801. break;
  16802. default: entry.type = SanType::OTHER; break;
  16803. }
  16804. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16805. }
  16806. GENERAL_NAMES_free(names);
  16807. return true;
  16808. }
  16809. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16810. time_t &not_after) {
  16811. if (!cert) return false;
  16812. auto x509 = static_cast<X509 *>(cert);
  16813. auto nb = X509_get0_notBefore(x509);
  16814. auto na = X509_get0_notAfter(x509);
  16815. if (!nb || !na) return false;
  16816. ASN1_TIME *epoch = ASN1_TIME_new();
  16817. if (!epoch) return false;
  16818. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16819. if (!ASN1_TIME_set(epoch, 0)) return false;
  16820. int pday, psec;
  16821. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16822. not_before = 86400 * (time_t)pday + psec;
  16823. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16824. not_after = 86400 * (time_t)pday + psec;
  16825. return true;
  16826. }
  16827. inline std::string get_cert_serial(cert_t cert) {
  16828. if (!cert) return "";
  16829. auto x509 = static_cast<X509 *>(cert);
  16830. auto serial = X509_get_serialNumber(x509);
  16831. if (!serial) return "";
  16832. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16833. if (!bn) return "";
  16834. auto hex = BN_bn2hex(bn);
  16835. BN_free(bn);
  16836. if (!hex) return "";
  16837. std::string result(hex);
  16838. OPENSSL_free(hex);
  16839. return result;
  16840. }
  16841. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16842. if (!cert) return false;
  16843. auto x509 = static_cast<X509 *>(cert);
  16844. auto len = i2d_X509(x509, nullptr);
  16845. if (len < 0) return false;
  16846. der.resize(static_cast<size_t>(len));
  16847. auto p = der.data();
  16848. i2d_X509(x509, &p);
  16849. return true;
  16850. }
  16851. inline const char *get_sni(const_session_t session) {
  16852. if (!session) return nullptr;
  16853. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16854. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16855. }
  16856. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16857. inline uint64_t get_error() { return ERR_get_error(); }
  16858. inline std::string error_string(uint64_t code) {
  16859. char buf[256];
  16860. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16861. return std::string(buf);
  16862. }
  16863. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16864. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16865. if (!mem) { return nullptr; }
  16866. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16867. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16868. if (!inf) { return nullptr; }
  16869. auto store = X509_STORE_new();
  16870. if (store) {
  16871. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16872. auto itmp = sk_X509_INFO_value(inf, i);
  16873. if (!itmp) { continue; }
  16874. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16875. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16876. }
  16877. }
  16878. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16879. return static_cast<ca_store_t>(store);
  16880. }
  16881. inline void free_ca_store(ca_store_t store) {
  16882. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16883. }
  16884. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16885. if (!ctx || !store) { return false; }
  16886. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16887. auto x509_store = static_cast<X509_STORE *>(store);
  16888. // Check if same store is already set
  16889. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16890. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16891. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16892. return true;
  16893. }
  16894. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16895. certs.clear();
  16896. if (!ctx) { return 0; }
  16897. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16898. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16899. if (!store) { return 0; }
  16900. auto objs = impl::get_store_objects(store);
  16901. if (!objs) { return 0; }
  16902. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16903. auto count = sk_X509_OBJECT_num(objs);
  16904. for (decltype(count) i = 0; i < count; i++) {
  16905. auto obj = sk_X509_OBJECT_value(objs, i);
  16906. if (!obj) { continue; }
  16907. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16908. auto x509 = X509_OBJECT_get0_X509(obj);
  16909. if (x509) {
  16910. // Increment reference count so caller can free it
  16911. X509_up_ref(x509);
  16912. certs.push_back(static_cast<cert_t>(x509));
  16913. }
  16914. }
  16915. }
  16916. return certs.size();
  16917. }
  16918. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16919. std::vector<std::string> names;
  16920. if (!ctx) { return names; }
  16921. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16922. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16923. if (!store) { return names; }
  16924. auto objs = impl::get_store_objects(store);
  16925. if (!objs) { return names; }
  16926. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16927. auto count = sk_X509_OBJECT_num(objs);
  16928. for (decltype(count) i = 0; i < count; i++) {
  16929. auto obj = sk_X509_OBJECT_value(objs, i);
  16930. if (!obj) { continue; }
  16931. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16932. auto x509 = X509_OBJECT_get0_X509(obj);
  16933. if (x509) {
  16934. auto subject = X509_get_subject_name(x509);
  16935. if (subject) {
  16936. char buf[512];
  16937. X509_NAME_oneline(subject, buf, sizeof(buf));
  16938. names.push_back(buf);
  16939. }
  16940. }
  16941. }
  16942. }
  16943. return names;
  16944. }
  16945. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16946. const char *key_pem, const char *password) {
  16947. if (!ctx || !cert_pem || !key_pem) { return false; }
  16948. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16949. // Load certificate from PEM
  16950. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16951. if (!cert_bio) { return false; }
  16952. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16953. BIO_free(cert_bio);
  16954. if (!cert) { return false; }
  16955. // Load private key from PEM
  16956. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16957. if (!key_bio) {
  16958. X509_free(cert);
  16959. return false;
  16960. }
  16961. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16962. password ? const_cast<char *>(password)
  16963. : nullptr);
  16964. BIO_free(key_bio);
  16965. if (!key) {
  16966. X509_free(cert);
  16967. return false;
  16968. }
  16969. // Update certificate and key
  16970. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16971. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16972. X509_free(cert);
  16973. EVP_PKEY_free(key);
  16974. return ret;
  16975. }
  16976. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16977. if (!ctx || !ca_pem) { return false; }
  16978. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16979. // Create new X509_STORE from PEM
  16980. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16981. if (!store) { return false; }
  16982. // SSL_CTX_set_cert_store takes ownership
  16983. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16984. // Set client CA list for client certificate request
  16985. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16986. if (ca_list) {
  16987. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16988. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16989. }
  16990. return true;
  16991. }
  16992. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16993. if (!ctx) { return false; }
  16994. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16995. impl::get_verify_callback() = std::move(callback);
  16996. if (impl::get_verify_callback()) {
  16997. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16998. } else {
  16999. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17000. }
  17001. return true;
  17002. }
  17003. inline long get_verify_error(const_session_t session) {
  17004. if (!session) { return -1; }
  17005. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17006. return SSL_get_verify_result(ssl);
  17007. }
  17008. inline std::string verify_error_string(long error_code) {
  17009. if (error_code == X509_V_OK) { return ""; }
  17010. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17011. return str ? str : "unknown error";
  17012. }
  17013. } // namespace tls
  17014. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17015. /*
  17016. * Group 9: TLS abstraction layer - Mbed TLS backend
  17017. */
  17018. /*
  17019. * Mbed TLS Backend Implementation
  17020. */
  17021. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17022. namespace tls {
  17023. namespace impl {
  17024. // Mbed TLS session wrapper
  17025. struct MbedTlsSession {
  17026. mbedtls_ssl_context ssl;
  17027. socket_t sock = INVALID_SOCKET;
  17028. std::string hostname; // For client: set via set_sni
  17029. std::string sni_hostname; // For server: received from client via SNI callback
  17030. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17031. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17032. // (e.g. a response that arrived while this side was still in its post-write
  17033. // check), the byte is pushed back here and served by the next read().
  17034. unsigned char peeked_byte = 0;
  17035. bool has_peeked_byte = false;
  17036. // Set by set_sni() when the caller disabled hostname verification, so the
  17037. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17038. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17039. // OpenSSL and wolfSSL keep them independent).
  17040. bool suppress_hostname_mismatch = false;
  17041. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  17042. // decide which verify callback to install when hostname verification is
  17043. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  17044. // wired for this context, or a self-contained one otherwise, so a session
  17045. // that never opted into a callback never consults the process-wide
  17046. // set_verify_callback() slot (which some other, unrelated client may have
  17047. // populated).
  17048. bool has_verify_callback = false;
  17049. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17050. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17051. MbedTlsSession(const MbedTlsSession &) = delete;
  17052. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17053. };
  17054. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17055. // queue)
  17056. inline int &mbedtls_last_error() {
  17057. static thread_local int err = 0;
  17058. return err;
  17059. }
  17060. // Helper to map Mbed TLS error to ErrorCode
  17061. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17062. uint32_t verify_flags) {
  17063. if (ret == 0) { return ErrorCode::Success; }
  17064. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17065. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17066. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17067. return ErrorCode::PeerClosed;
  17068. }
  17069. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17070. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17071. out_errno = errno;
  17072. return ErrorCode::SyscallError;
  17073. }
  17074. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17075. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17076. // the handshake's chain verification (see set_sni()); a mismatch there
  17077. // is reported the same way as any other verify_flags bit. Report it as
  17078. // HostnameMismatch, matching the other backends and the post-handshake
  17079. // identity check below, but only when naming is the sole problem -
  17080. // if the chain itself is also untrusted/expired/etc., that takes
  17081. // priority over the naming detail.
  17082. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17083. return ErrorCode::HostnameMismatch;
  17084. }
  17085. return ErrorCode::CertVerifyFailed;
  17086. }
  17087. return ErrorCode::Fatal;
  17088. }
  17089. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17090. // return value, including the verify-flags-dependent HostnameMismatch
  17091. // mapping; shared by connect() and connect_nonblocking() so the
  17092. // backend_code policy for that mapping only lives in one place.
  17093. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17094. int ret) {
  17095. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17096. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17097. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17098. ? static_cast<uint64_t>(verify_flags)
  17099. : static_cast<uint64_t>(-ret);
  17100. }
  17101. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17102. // non-fatal notification delivered between records, not an error and not
  17103. // application data, so I/O calls that see it should just be retried. Kept in
  17104. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17105. // splitting the closing brace across an #if.
  17106. inline bool mbedtls_is_session_ticket(int ret) {
  17107. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17108. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17109. #else
  17110. (void)ret;
  17111. return false;
  17112. #endif
  17113. }
  17114. // BIO-like send callback for Mbed TLS
  17115. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17116. size_t len) {
  17117. auto sock = *static_cast<socket_t *>(ctx);
  17118. #ifdef _WIN32
  17119. auto ret =
  17120. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17121. if (ret == SOCKET_ERROR) {
  17122. int err = WSAGetLastError();
  17123. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17124. return MBEDTLS_ERR_NET_SEND_FAILED;
  17125. }
  17126. #else
  17127. auto ret = send(sock, buf, len, 0);
  17128. if (ret < 0) {
  17129. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17130. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17131. }
  17132. return MBEDTLS_ERR_NET_SEND_FAILED;
  17133. }
  17134. #endif
  17135. return static_cast<int>(ret);
  17136. }
  17137. // BIO-like recv callback for Mbed TLS
  17138. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17139. auto sock = *static_cast<socket_t *>(ctx);
  17140. #ifdef _WIN32
  17141. auto ret =
  17142. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17143. if (ret == SOCKET_ERROR) {
  17144. int err = WSAGetLastError();
  17145. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17146. return MBEDTLS_ERR_NET_RECV_FAILED;
  17147. }
  17148. #else
  17149. auto ret = recv(sock, buf, len, 0);
  17150. if (ret < 0) {
  17151. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17152. return MBEDTLS_ERR_SSL_WANT_READ;
  17153. }
  17154. return MBEDTLS_ERR_NET_RECV_FAILED;
  17155. }
  17156. #endif
  17157. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17158. return static_cast<int>(ret);
  17159. }
  17160. // MbedTlsContext constructor/destructor implementations
  17161. inline MbedTlsContext::MbedTlsContext() {
  17162. mbedtls_ssl_config_init(&conf);
  17163. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17164. mbedtls_entropy_init(&entropy);
  17165. mbedtls_ctr_drbg_init(&ctr_drbg);
  17166. #endif
  17167. mbedtls_x509_crt_init(&ca_chain);
  17168. mbedtls_x509_crt_init(&own_cert);
  17169. mbedtls_pk_init(&own_key);
  17170. }
  17171. inline MbedTlsContext::~MbedTlsContext() {
  17172. mbedtls_pk_free(&own_key);
  17173. mbedtls_x509_crt_free(&own_cert);
  17174. mbedtls_x509_crt_free(&ca_chain);
  17175. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17176. mbedtls_ctr_drbg_free(&ctr_drbg);
  17177. mbedtls_entropy_free(&entropy);
  17178. #endif
  17179. mbedtls_ssl_config_free(&conf);
  17180. }
  17181. // Thread-local storage for SNI captured during handshake
  17182. // This is needed because the SNI callback doesn't have a way to pass
  17183. // session-specific data before the session is fully set up
  17184. inline std::string &mbedpending_sni() {
  17185. static thread_local std::string sni;
  17186. return sni;
  17187. }
  17188. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17189. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17190. const unsigned char *name, size_t name_len) {
  17191. (void)p_ctx;
  17192. (void)ssl;
  17193. // Store SNI name in thread-local storage
  17194. // It will be retrieved and stored in the session after handshake
  17195. if (name && name_len > 0) {
  17196. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17197. } else {
  17198. mbedpending_sni().clear();
  17199. }
  17200. return 0; // Accept any SNI
  17201. }
  17202. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17203. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17204. }
  17205. // Verify callback used when hostname verification is disabled for a session
  17206. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17207. // has_verify_callback is false). Deliberately does not consult
  17208. // get_verify_callback(): that slot is process-wide, so reading it here would
  17209. // pick up whatever another, unrelated client last installed there.
  17210. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17211. mbedtls_x509_crt *, int,
  17212. uint32_t *flags) {
  17213. (void)data;
  17214. mbedtls_clear_cn_mismatch(flags);
  17215. return 0;
  17216. }
  17217. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17218. int cert_depth, uint32_t *flags);
  17219. // MbedTLS verify callback wrapper
  17220. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17221. int cert_depth, uint32_t *flags) {
  17222. // data points to the MbedTlsSession
  17223. auto *session = static_cast<MbedTlsSession *>(data);
  17224. // set_sni() disabled hostname verification for this session: drop the
  17225. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17226. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17227. // SNI. The final pass/fail decision still comes from the remaining flags
  17228. // (or, below, from the user's own verify callback).
  17229. if (session && session->suppress_hostname_mismatch) {
  17230. mbedtls_clear_cn_mismatch(flags);
  17231. }
  17232. auto &callback = get_verify_callback();
  17233. if (!callback) { return 0; } // Continue with default verification
  17234. // Build context
  17235. VerifyContext verify_ctx;
  17236. verify_ctx.session = static_cast<session_t>(session);
  17237. verify_ctx.cert = static_cast<cert_t>(crt);
  17238. verify_ctx.depth = cert_depth;
  17239. verify_ctx.preverify_ok = (*flags == 0);
  17240. verify_ctx.error_code = static_cast<long>(*flags);
  17241. // Convert Mbed TLS flags to error string
  17242. static thread_local char error_buf[256];
  17243. if (*flags != 0) {
  17244. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17245. verify_ctx.error_string = error_buf;
  17246. } else {
  17247. verify_ctx.error_string = nullptr;
  17248. }
  17249. bool accepted = callback(verify_ctx);
  17250. if (accepted) {
  17251. *flags = 0; // Clear all error flags
  17252. return 0;
  17253. }
  17254. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17255. }
  17256. } // namespace impl
  17257. inline ctx_t create_client_context() {
  17258. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17259. if (!ctx) { return nullptr; }
  17260. ctx->is_server = false;
  17261. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17262. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17263. if (!detail::ensure_mbedtls_psa_crypto()) {
  17264. delete ctx;
  17265. return nullptr;
  17266. }
  17267. int ret;
  17268. #else
  17269. // Seed the random number generator
  17270. const char *pers = "httplib_client";
  17271. int ret = mbedtls_ctr_drbg_seed(
  17272. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17273. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17274. if (ret != 0) {
  17275. impl::mbedtls_last_error() = ret;
  17276. delete ctx;
  17277. return nullptr;
  17278. }
  17279. #endif
  17280. // Set up SSL config for client
  17281. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17282. MBEDTLS_SSL_TRANSPORT_STREAM,
  17283. MBEDTLS_SSL_PRESET_DEFAULT);
  17284. if (ret != 0) {
  17285. impl::mbedtls_last_error() = ret;
  17286. delete ctx;
  17287. return nullptr;
  17288. }
  17289. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17290. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17291. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17292. #endif
  17293. // Default: verify peer certificate
  17294. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17295. // Set minimum TLS version to 1.2
  17296. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17297. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17298. #else
  17299. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17300. MBEDTLS_SSL_MINOR_VERSION_3);
  17301. #endif
  17302. return static_cast<ctx_t>(ctx);
  17303. }
  17304. inline ctx_t create_server_context() {
  17305. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17306. if (!ctx) { return nullptr; }
  17307. ctx->is_server = true;
  17308. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17309. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17310. if (!detail::ensure_mbedtls_psa_crypto()) {
  17311. delete ctx;
  17312. return nullptr;
  17313. }
  17314. int ret;
  17315. #else
  17316. // Seed the random number generator
  17317. const char *pers = "httplib_server";
  17318. int ret = mbedtls_ctr_drbg_seed(
  17319. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17320. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17321. if (ret != 0) {
  17322. impl::mbedtls_last_error() = ret;
  17323. delete ctx;
  17324. return nullptr;
  17325. }
  17326. #endif
  17327. // Set up SSL config for server
  17328. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17329. MBEDTLS_SSL_TRANSPORT_STREAM,
  17330. MBEDTLS_SSL_PRESET_DEFAULT);
  17331. if (ret != 0) {
  17332. impl::mbedtls_last_error() = ret;
  17333. delete ctx;
  17334. return nullptr;
  17335. }
  17336. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17337. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17338. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17339. #endif
  17340. // Default: don't verify client
  17341. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17342. // Set minimum TLS version to 1.2
  17343. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17344. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17345. #else
  17346. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17347. MBEDTLS_SSL_MINOR_VERSION_3);
  17348. #endif
  17349. // Set SNI callback to capture client's SNI hostname
  17350. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17351. return static_cast<ctx_t>(ctx);
  17352. }
  17353. inline void free_context(ctx_t ctx) {
  17354. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17355. }
  17356. inline bool set_min_version(ctx_t ctx, Version version) {
  17357. if (!ctx) { return false; }
  17358. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17359. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17360. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17361. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17362. if (version >= Version::TLS1_3) {
  17363. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17364. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17365. #endif
  17366. }
  17367. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17368. #else
  17369. // Mbed TLS 2.x uses major/minor version numbers
  17370. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17371. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17372. if (version >= Version::TLS1_3) {
  17373. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17374. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17375. #else
  17376. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17377. #endif
  17378. }
  17379. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17380. #endif
  17381. return true;
  17382. }
  17383. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17384. if (!ctx || !pem) { return false; }
  17385. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17386. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17387. // Add null terminator if not present
  17388. std::string pem_str(pem, len);
  17389. int ret = mbedtls_x509_crt_parse(
  17390. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17391. pem_str.size() + 1);
  17392. if (ret != 0) {
  17393. impl::mbedtls_last_error() = ret;
  17394. return false;
  17395. }
  17396. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17397. return true;
  17398. }
  17399. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17400. if (!ctx || !file_path) { return false; }
  17401. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17402. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17403. if (ret != 0) {
  17404. impl::mbedtls_last_error() = ret;
  17405. return false;
  17406. }
  17407. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17408. return true;
  17409. }
  17410. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17411. if (!ctx || !dir_path) { return false; }
  17412. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17413. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17414. if (ret < 0) { // Returns number of certs on success, negative on error
  17415. impl::mbedtls_last_error() = ret;
  17416. return false;
  17417. }
  17418. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17419. return true;
  17420. }
  17421. inline bool load_system_certs(ctx_t ctx) {
  17422. if (!ctx) { return false; }
  17423. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17424. bool loaded = false;
  17425. #ifdef _WIN32
  17426. loaded = impl::enumerate_windows_system_certs(
  17427. [&](const unsigned char *data, size_t len) {
  17428. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17429. });
  17430. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17431. loaded = impl::enumerate_macos_keychain_certs(
  17432. [&](const unsigned char *data, size_t len) {
  17433. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17434. });
  17435. #else
  17436. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17437. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17438. loaded = true;
  17439. break;
  17440. }
  17441. }
  17442. if (!loaded) {
  17443. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17444. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17445. loaded = true;
  17446. break;
  17447. }
  17448. }
  17449. }
  17450. #endif
  17451. if (loaded) {
  17452. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17453. }
  17454. return loaded;
  17455. }
  17456. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17457. const char *password) {
  17458. if (!ctx || !cert || !key) { return false; }
  17459. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17460. // Parse certificate
  17461. std::string cert_str(cert);
  17462. int ret = mbedtls_x509_crt_parse(
  17463. &mctx->own_cert,
  17464. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17465. cert_str.size() + 1);
  17466. if (ret != 0) {
  17467. impl::mbedtls_last_error() = ret;
  17468. return false;
  17469. }
  17470. // Parse private key
  17471. std::string key_str(key);
  17472. const unsigned char *pwd =
  17473. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17474. size_t pwd_len = password ? strlen(password) : 0;
  17475. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17476. ret = mbedtls_pk_parse_key(
  17477. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17478. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17479. &mctx->ctr_drbg);
  17480. #else
  17481. ret = mbedtls_pk_parse_key(
  17482. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17483. key_str.size() + 1, pwd, pwd_len);
  17484. #endif
  17485. if (ret != 0) {
  17486. impl::mbedtls_last_error() = ret;
  17487. return false;
  17488. }
  17489. // Verify that the certificate and private key match.
  17490. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17491. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17492. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17493. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17494. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17495. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17496. #else
  17497. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17498. #endif
  17499. if (ret != 0) {
  17500. impl::mbedtls_last_error() = ret;
  17501. return false;
  17502. }
  17503. #endif
  17504. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17505. if (ret != 0) {
  17506. impl::mbedtls_last_error() = ret;
  17507. return false;
  17508. }
  17509. return true;
  17510. }
  17511. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17512. const char *key_path, const char *password) {
  17513. if (!ctx || !cert_path || !key_path) { return false; }
  17514. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17515. // Parse certificate file
  17516. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17517. if (ret != 0) {
  17518. impl::mbedtls_last_error() = ret;
  17519. return false;
  17520. }
  17521. // Parse private key file
  17522. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17523. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17524. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17525. #else
  17526. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17527. #endif
  17528. if (ret != 0) {
  17529. impl::mbedtls_last_error() = ret;
  17530. return false;
  17531. }
  17532. // Verify that the certificate and private key match.
  17533. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17534. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17535. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17536. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17537. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17538. #else
  17539. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17540. #endif
  17541. if (ret != 0) {
  17542. impl::mbedtls_last_error() = ret;
  17543. return false;
  17544. }
  17545. #endif
  17546. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17547. if (ret != 0) {
  17548. impl::mbedtls_last_error() = ret;
  17549. return false;
  17550. }
  17551. return true;
  17552. }
  17553. inline void set_verify_client(ctx_t ctx, bool require) {
  17554. if (!ctx) { return; }
  17555. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17556. mctx->verify_client = require;
  17557. if (require) {
  17558. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17559. } else {
  17560. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17561. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17562. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17563. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17564. : MBEDTLS_SSL_VERIFY_NONE);
  17565. }
  17566. }
  17567. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17568. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17569. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17570. auto session = new (std::nothrow) impl::MbedTlsSession();
  17571. if (!session) { return nullptr; }
  17572. session->sock = sock;
  17573. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17574. if (ret != 0) {
  17575. impl::mbedtls_last_error() = ret;
  17576. delete session;
  17577. return nullptr;
  17578. }
  17579. // Explicitly opt out of in-handshake hostname verification by default;
  17580. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17581. // fails outright when no hostname was set. set_sni() installs the real
  17582. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17583. // caller verifies the certificate identity post-handshake via
  17584. // verify_hostname().
  17585. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17586. // Set BIO callbacks
  17587. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17588. impl::mbedtls_net_recv_cb, nullptr);
  17589. // Set per-session verify callback with session pointer if callback is
  17590. // registered
  17591. session->has_verify_callback = mctx->has_verify_callback;
  17592. if (mctx->has_verify_callback) {
  17593. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17594. session);
  17595. }
  17596. return static_cast<session_t>(session);
  17597. }
  17598. inline void free_session(session_t session) {
  17599. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17600. }
  17601. inline bool set_sni(session_t session, const char *hostname,
  17602. bool verify_hostname) {
  17603. if (!session || !hostname) { return false; }
  17604. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17605. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17606. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17607. // independently, so a disabled hostname check is handled below by masking
  17608. // the resulting mismatch flag instead of skipping this call.
  17609. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17610. if (ret != 0) {
  17611. impl::mbedtls_last_error() = ret;
  17612. return false;
  17613. }
  17614. msession->hostname = hostname;
  17615. if (!verify_hostname) {
  17616. msession->suppress_hostname_mismatch = true;
  17617. // If a user verify callback is already wired for this session,
  17618. // mbedtls_verify_callback() masks the mismatch flag itself before
  17619. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17620. // here would be redundant. Otherwise install the self-contained masking
  17621. // callback, which never touches the process-wide callback slot.
  17622. if (!msession->has_verify_callback) {
  17623. mbedtls_ssl_set_verify(&msession->ssl,
  17624. impl::mbedtls_mask_hostname_mismatch_callback,
  17625. msession);
  17626. }
  17627. }
  17628. return true;
  17629. }
  17630. inline TlsError connect(session_t session) {
  17631. TlsError err;
  17632. if (!session) {
  17633. err.code = ErrorCode::Fatal;
  17634. return err;
  17635. }
  17636. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17637. int ret;
  17638. do {
  17639. ret = mbedtls_ssl_handshake(&msession->ssl);
  17640. } while (impl::mbedtls_is_session_ticket(ret));
  17641. if (ret == 0) {
  17642. err.code = ErrorCode::Success;
  17643. } else {
  17644. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17645. impl::mbedtls_last_error() = ret;
  17646. }
  17647. return err;
  17648. }
  17649. inline TlsError accept(session_t session) {
  17650. // Same as connect for Mbed TLS - handshake works for both client and server
  17651. auto result = connect(session);
  17652. // After successful handshake, capture SNI from thread-local storage
  17653. if (result.code == ErrorCode::Success && session) {
  17654. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17655. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17656. impl::mbedpending_sni().clear();
  17657. }
  17658. return result;
  17659. }
  17660. inline bool connect_nonblocking(session_t session, socket_t sock,
  17661. time_t timeout_sec, time_t timeout_usec,
  17662. TlsError *err) {
  17663. if (!session) {
  17664. if (err) { err->code = ErrorCode::Fatal; }
  17665. return false;
  17666. }
  17667. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17668. // Set socket to non-blocking mode
  17669. detail::set_nonblocking(sock, true);
  17670. auto cleanup =
  17671. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17672. int ret;
  17673. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17674. // Non-fatal TLS 1.3 ticket; retry immediately.
  17675. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17676. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17677. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17678. continue;
  17679. }
  17680. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17681. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17682. continue;
  17683. }
  17684. }
  17685. // TlsError or timeout
  17686. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17687. impl::mbedtls_last_error() = ret;
  17688. return false;
  17689. }
  17690. if (err) { err->code = ErrorCode::Success; }
  17691. return true;
  17692. }
  17693. inline bool accept_nonblocking(session_t session, socket_t sock,
  17694. time_t timeout_sec, time_t timeout_usec,
  17695. TlsError *err) {
  17696. // Same implementation as connect for Mbed TLS
  17697. bool result =
  17698. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17699. // After successful handshake, capture SNI from thread-local storage
  17700. if (result && session) {
  17701. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17702. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17703. impl::mbedpending_sni().clear();
  17704. }
  17705. return result;
  17706. }
  17707. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17708. if (!session || !buf) {
  17709. err.code = ErrorCode::Fatal;
  17710. return -1;
  17711. }
  17712. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17713. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17714. if (msession->has_peeked_byte) {
  17715. if (len == 0) { return 0; }
  17716. auto p = static_cast<unsigned char *>(buf);
  17717. p[0] = msession->peeked_byte;
  17718. msession->has_peeked_byte = false;
  17719. size_t n = 1;
  17720. // Top up with any already-decrypted bytes without risking a block.
  17721. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17722. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17723. if (extra > 0) { n += static_cast<size_t>(extra); }
  17724. }
  17725. err.code = ErrorCode::Success;
  17726. return static_cast<ssize_t>(n);
  17727. }
  17728. int ret;
  17729. do {
  17730. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17731. len);
  17732. } while (impl::mbedtls_is_session_ticket(ret));
  17733. if (ret > 0) {
  17734. err.code = ErrorCode::Success;
  17735. return static_cast<ssize_t>(ret);
  17736. }
  17737. if (ret == 0) {
  17738. err.code = ErrorCode::PeerClosed;
  17739. return 0;
  17740. }
  17741. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17742. err.backend_code = static_cast<uint64_t>(-ret);
  17743. impl::mbedtls_last_error() = ret;
  17744. // mbedTLS signals a clean close_notify via a negative error code rather
  17745. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17746. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17747. return -1;
  17748. }
  17749. inline ssize_t write(session_t session, const void *buf, size_t len,
  17750. TlsError &err) {
  17751. if (!session || !buf) {
  17752. err.code = ErrorCode::Fatal;
  17753. return -1;
  17754. }
  17755. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17756. int ret;
  17757. do {
  17758. ret = mbedtls_ssl_write(&msession->ssl,
  17759. static_cast<const unsigned char *>(buf), len);
  17760. } while (impl::mbedtls_is_session_ticket(ret));
  17761. if (ret > 0) {
  17762. err.code = ErrorCode::Success;
  17763. return static_cast<ssize_t>(ret);
  17764. }
  17765. if (ret == 0) {
  17766. err.code = ErrorCode::PeerClosed;
  17767. return 0;
  17768. }
  17769. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17770. err.backend_code = static_cast<uint64_t>(-ret);
  17771. impl::mbedtls_last_error() = ret;
  17772. return -1;
  17773. }
  17774. inline int pending(const_session_t session) {
  17775. if (!session) { return 0; }
  17776. auto msession =
  17777. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17778. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17779. (msession->has_peeked_byte ? 1 : 0);
  17780. }
  17781. inline void shutdown(session_t session, bool graceful) {
  17782. if (!session) { return; }
  17783. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17784. if (graceful) {
  17785. // Try to send close_notify, but don't block forever
  17786. int ret;
  17787. int attempts = 0;
  17788. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17789. attempts < 3) {
  17790. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17791. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17792. break;
  17793. }
  17794. attempts++;
  17795. }
  17796. }
  17797. }
  17798. inline bool is_peer_closed(session_t session, socket_t sock) {
  17799. if (!session || sock == INVALID_SOCKET) { return true; }
  17800. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17801. // Check if there's already decrypted or pushed-back data available.
  17802. // If so, the connection is definitely alive.
  17803. if (msession->has_peeked_byte ||
  17804. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17805. return false;
  17806. }
  17807. // Set socket to non-blocking to avoid blocking on read
  17808. detail::set_nonblocking(sock, true);
  17809. auto cleanup =
  17810. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17811. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17812. // on application data — e.g. a response that already arrived — push the
  17813. // byte back so the next read() delivers it instead of losing it.
  17814. unsigned char buf;
  17815. int ret;
  17816. do {
  17817. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17818. } while (impl::mbedtls_is_session_ticket(ret));
  17819. // If we got data or WANT_READ (would block), connection is alive
  17820. if (ret > 0) {
  17821. msession->peeked_byte = buf;
  17822. msession->has_peeked_byte = true;
  17823. return false;
  17824. }
  17825. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17826. // If we get a peer close notify or a connection reset, the peer is closed
  17827. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17828. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17829. }
  17830. inline cert_t get_peer_cert(const_session_t session) {
  17831. if (!session) { return nullptr; }
  17832. auto msession =
  17833. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17834. // Mbed TLS returns a pointer to the internal peer cert chain.
  17835. // WARNING: This pointer is only valid while the session is active.
  17836. // Do not use the certificate after calling free_session().
  17837. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17838. return const_cast<mbedtls_x509_crt *>(cert);
  17839. }
  17840. inline size_t get_peer_certs(const_session_t session,
  17841. std::vector<cert_t> &certs) {
  17842. certs.clear();
  17843. // Mbed TLS parses the whole received chain into a list headed by the peer
  17844. // certificate, owned by the session like get_peer_cert()'s result
  17845. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  17846. crt && crt->raw.len > 0; crt = crt->next) {
  17847. certs.push_back(static_cast<cert_t>(crt));
  17848. }
  17849. return certs.size();
  17850. }
  17851. inline void free_cert(cert_t cert) {
  17852. // Mbed TLS: peer certificate is owned by the SSL context.
  17853. // No-op here, but callers should still call this for cross-backend
  17854. // portability.
  17855. (void)cert;
  17856. }
  17857. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17858. if (!cert || !hostname) { return false; }
  17859. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17860. std::string host_str(hostname);
  17861. // Check if hostname is an IP address (IPv4 or IPv6)
  17862. unsigned char ip_bytes[16];
  17863. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17864. auto is_ip = ip_len > 0;
  17865. // Check Subject Alternative Names (SAN)
  17866. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17867. // - DNS names: raw string bytes
  17868. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17869. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17870. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17871. const unsigned char *p = san->buf.p;
  17872. size_t len = san->buf.len;
  17873. if (is_ip) {
  17874. // For an IP host, only a matching iPAddress SAN of the same family
  17875. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17876. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17877. } else {
  17878. // Check if this SAN is a DNS name (printable ASCII string)
  17879. bool is_dns = len > 0;
  17880. for (size_t i = 0; i < len && is_dns; i++) {
  17881. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17882. }
  17883. if (is_dns) {
  17884. std::string san_name(reinterpret_cast<const char *>(p), len);
  17885. if (detail::match_hostname(san_name, host_str)) { return true; }
  17886. }
  17887. }
  17888. san = san->next;
  17889. }
  17890. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17891. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17892. // the OpenSSL backend's X509_check_ip behaves the same way).
  17893. if (!is_ip) {
  17894. char cn[256];
  17895. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17896. if (ret > 0) {
  17897. std::string cn_str(cn);
  17898. // Look for "CN=" in the DN string
  17899. size_t cn_pos = cn_str.find("CN=");
  17900. if (cn_pos != std::string::npos) {
  17901. size_t start = cn_pos + 3;
  17902. size_t end = cn_str.find(',', start);
  17903. std::string cn_value =
  17904. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17905. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17906. }
  17907. }
  17908. }
  17909. return false;
  17910. }
  17911. inline uint64_t hostname_mismatch_code() {
  17912. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17913. }
  17914. inline long get_verify_result(const_session_t session) {
  17915. if (!session) { return -1; }
  17916. auto msession =
  17917. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17918. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17919. // Return 0 (X509_V_OK equivalent) if verification passed
  17920. return flags == 0 ? 0 : static_cast<long>(flags);
  17921. }
  17922. inline std::string get_cert_subject_cn(cert_t cert) {
  17923. if (!cert) return "";
  17924. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17925. // Find the CN in the subject
  17926. const mbedtls_x509_name *name = &x509->subject;
  17927. while (name != nullptr) {
  17928. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17929. return std::string(reinterpret_cast<const char *>(name->val.p),
  17930. name->val.len);
  17931. }
  17932. name = name->next;
  17933. }
  17934. return "";
  17935. }
  17936. inline std::string get_cert_issuer_name(cert_t cert) {
  17937. if (!cert) return "";
  17938. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17939. // Build a human-readable issuer name string
  17940. char buf[512];
  17941. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17942. if (ret < 0) return "";
  17943. return std::string(buf);
  17944. }
  17945. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17946. sans.clear();
  17947. if (!cert) return false;
  17948. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17949. // Parse the Subject Alternative Name extension
  17950. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17951. while (cur != nullptr) {
  17952. if (cur->buf.len > 0) {
  17953. // Mbed TLS stores SAN as ASN.1 sequences
  17954. // The tag byte indicates the type
  17955. const unsigned char *p = cur->buf.p;
  17956. size_t len = cur->buf.len;
  17957. // First byte is the tag
  17958. unsigned char tag = *p;
  17959. p++;
  17960. len--;
  17961. // Parse length (simple single-byte length assumed)
  17962. if (len > 0 && *p < 0x80) {
  17963. size_t value_len = *p;
  17964. p++;
  17965. len--;
  17966. if (value_len <= len) {
  17967. SanEntry entry;
  17968. // ASN.1 context tags for GeneralName
  17969. switch (tag & 0x1F) {
  17970. case 2: // dNSName
  17971. entry.type = SanType::DNS;
  17972. entry.value =
  17973. std::string(reinterpret_cast<const char *>(p), value_len);
  17974. break;
  17975. case 7: // iPAddress
  17976. entry.type = SanType::IP;
  17977. if (value_len == 4) {
  17978. // IPv4
  17979. char buf[16];
  17980. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17981. entry.value = buf;
  17982. } else if (value_len == 16) {
  17983. // IPv6
  17984. char buf[64];
  17985. snprintf(buf, sizeof(buf),
  17986. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17987. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17988. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17989. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17990. entry.value = buf;
  17991. }
  17992. break;
  17993. case 1: // rfc822Name (email)
  17994. entry.type = SanType::EMAIL;
  17995. entry.value =
  17996. std::string(reinterpret_cast<const char *>(p), value_len);
  17997. break;
  17998. case 6: // uniformResourceIdentifier
  17999. entry.type = SanType::URI;
  18000. entry.value =
  18001. std::string(reinterpret_cast<const char *>(p), value_len);
  18002. break;
  18003. default: entry.type = SanType::OTHER; break;
  18004. }
  18005. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18006. }
  18007. }
  18008. }
  18009. cur = cur->next;
  18010. }
  18011. return true;
  18012. }
  18013. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18014. time_t &not_after) {
  18015. if (!cert) return false;
  18016. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18017. // Convert mbedtls_x509_time to time_t
  18018. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18019. struct tm tm_time = {};
  18020. tm_time.tm_year = t.year - 1900;
  18021. tm_time.tm_mon = t.mon - 1;
  18022. tm_time.tm_mday = t.day;
  18023. tm_time.tm_hour = t.hour;
  18024. tm_time.tm_min = t.min;
  18025. tm_time.tm_sec = t.sec;
  18026. #ifdef _WIN32
  18027. return _mkgmtime(&tm_time);
  18028. #else
  18029. return timegm(&tm_time);
  18030. #endif
  18031. };
  18032. not_before = to_time_t(x509->valid_from);
  18033. not_after = to_time_t(x509->valid_to);
  18034. return true;
  18035. }
  18036. inline std::string get_cert_serial(cert_t cert) {
  18037. if (!cert) return "";
  18038. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18039. // Convert serial number to hex string
  18040. std::string result;
  18041. result.reserve(x509->serial.len * 2);
  18042. for (size_t i = 0; i < x509->serial.len; i++) {
  18043. char hex[3];
  18044. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18045. result += hex;
  18046. }
  18047. return result;
  18048. }
  18049. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18050. if (!cert) return false;
  18051. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18052. if (!crt->raw.p || crt->raw.len == 0) return false;
  18053. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18054. return true;
  18055. }
  18056. inline const char *get_sni(const_session_t session) {
  18057. if (!session) return nullptr;
  18058. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18059. // For server: return SNI received from client during handshake
  18060. if (!msession->sni_hostname.empty()) {
  18061. return msession->sni_hostname.c_str();
  18062. }
  18063. // For client: return the hostname set via set_sni
  18064. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18065. return nullptr;
  18066. }
  18067. inline uint64_t peek_error() {
  18068. // Mbed TLS doesn't have an error queue, return the last error
  18069. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18070. }
  18071. inline uint64_t get_error() {
  18072. // Mbed TLS doesn't have an error queue, return and clear the last error
  18073. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18074. impl::mbedtls_last_error() = 0;
  18075. return err;
  18076. }
  18077. inline std::string error_string(uint64_t code) {
  18078. char buf[256];
  18079. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18080. return std::string(buf);
  18081. }
  18082. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18083. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18084. if (!ca_chain) { return nullptr; }
  18085. mbedtls_x509_crt_init(ca_chain);
  18086. // mbedtls_x509_crt_parse expects null-terminated PEM
  18087. int ret = mbedtls_x509_crt_parse(ca_chain,
  18088. reinterpret_cast<const unsigned char *>(pem),
  18089. len + 1); // +1 for null terminator
  18090. if (ret != 0) {
  18091. // Try without +1 in case PEM is already null-terminated
  18092. ret = mbedtls_x509_crt_parse(
  18093. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18094. if (ret != 0) {
  18095. mbedtls_x509_crt_free(ca_chain);
  18096. delete ca_chain;
  18097. return nullptr;
  18098. }
  18099. }
  18100. return static_cast<ca_store_t>(ca_chain);
  18101. }
  18102. inline void free_ca_store(ca_store_t store) {
  18103. if (store) {
  18104. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18105. mbedtls_x509_crt_free(ca_chain);
  18106. delete ca_chain;
  18107. }
  18108. }
  18109. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18110. if (!ctx || !store) { return false; }
  18111. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18112. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18113. // Free existing CA chain
  18114. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18115. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18116. // Copy the CA chain (deep copy)
  18117. // Parse from the raw data of the source cert
  18118. mbedtls_x509_crt *src = ca_chain;
  18119. while (src != nullptr) {
  18120. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18121. src->raw.len);
  18122. if (ret != 0) {
  18123. free_ca_store(store);
  18124. return false;
  18125. }
  18126. src = src->next;
  18127. }
  18128. // This function takes ownership of the store; the chain was deep-copied
  18129. // above, so release the source
  18130. free_ca_store(store);
  18131. // Update the SSL config to use the new CA chain
  18132. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18133. return true;
  18134. }
  18135. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18136. certs.clear();
  18137. if (!ctx) { return 0; }
  18138. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18139. // Iterate through the CA chain
  18140. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18141. while (cert != nullptr && cert->raw.len > 0) {
  18142. // Create a copy of the certificate for the caller
  18143. auto *copy = new mbedtls_x509_crt;
  18144. mbedtls_x509_crt_init(copy);
  18145. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18146. if (ret == 0) {
  18147. certs.push_back(static_cast<cert_t>(copy));
  18148. } else {
  18149. mbedtls_x509_crt_free(copy);
  18150. delete copy;
  18151. }
  18152. cert = cert->next;
  18153. }
  18154. return certs.size();
  18155. }
  18156. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18157. std::vector<std::string> names;
  18158. if (!ctx) { return names; }
  18159. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18160. // Iterate through the CA chain
  18161. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18162. while (cert != nullptr && cert->raw.len > 0) {
  18163. char buf[512];
  18164. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18165. if (ret > 0) { names.push_back(buf); }
  18166. cert = cert->next;
  18167. }
  18168. return names;
  18169. }
  18170. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18171. const char *key_pem, const char *password) {
  18172. if (!ctx || !cert_pem || !key_pem) { return false; }
  18173. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18174. // Free existing certificate and key
  18175. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18176. mbedtls_pk_free(&mbed_ctx->own_key);
  18177. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18178. mbedtls_pk_init(&mbed_ctx->own_key);
  18179. // Parse certificate PEM
  18180. int ret = mbedtls_x509_crt_parse(
  18181. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18182. strlen(cert_pem) + 1);
  18183. if (ret != 0) {
  18184. impl::mbedtls_last_error() = ret;
  18185. return false;
  18186. }
  18187. // Parse private key PEM
  18188. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18189. ret = mbedtls_pk_parse_key(
  18190. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18191. strlen(key_pem) + 1,
  18192. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18193. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18194. &mbed_ctx->ctr_drbg);
  18195. #else
  18196. ret = mbedtls_pk_parse_key(
  18197. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18198. strlen(key_pem) + 1,
  18199. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18200. password ? strlen(password) : 0);
  18201. #endif
  18202. if (ret != 0) {
  18203. impl::mbedtls_last_error() = ret;
  18204. return false;
  18205. }
  18206. // Configure SSL to use the new certificate and key
  18207. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18208. &mbed_ctx->own_key);
  18209. if (ret != 0) {
  18210. impl::mbedtls_last_error() = ret;
  18211. return false;
  18212. }
  18213. return true;
  18214. }
  18215. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18216. if (!ctx || !ca_pem) { return false; }
  18217. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18218. // Free existing CA chain
  18219. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18220. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18221. // Parse CA PEM
  18222. int ret = mbedtls_x509_crt_parse(
  18223. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18224. strlen(ca_pem) + 1);
  18225. if (ret != 0) {
  18226. impl::mbedtls_last_error() = ret;
  18227. return false;
  18228. }
  18229. // Update SSL config to use new CA chain
  18230. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18231. return true;
  18232. }
  18233. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18234. if (!ctx) { return false; }
  18235. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18236. impl::get_verify_callback() = std::move(callback);
  18237. mbed_ctx->has_verify_callback =
  18238. static_cast<bool>(impl::get_verify_callback());
  18239. if (mbed_ctx->has_verify_callback) {
  18240. // Set OPTIONAL mode to ensure callback is called even when verification
  18241. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18242. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18243. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18244. nullptr);
  18245. } else {
  18246. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18247. }
  18248. return true;
  18249. }
  18250. inline long get_verify_error(const_session_t session) {
  18251. if (!session) { return -1; }
  18252. auto *msession =
  18253. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18254. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18255. }
  18256. inline std::string verify_error_string(long error_code) {
  18257. if (error_code == 0) { return ""; }
  18258. char buf[256];
  18259. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18260. static_cast<uint32_t>(error_code));
  18261. // Remove trailing newline if present
  18262. std::string result(buf);
  18263. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18264. result.pop_back();
  18265. }
  18266. return result;
  18267. }
  18268. } // namespace tls
  18269. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18270. /*
  18271. * Group 10: TLS abstraction layer - wolfSSL backend
  18272. */
  18273. /*
  18274. * wolfSSL Backend Implementation
  18275. */
  18276. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18277. namespace tls {
  18278. namespace impl {
  18279. // wolfSSL session wrapper
  18280. struct WolfSSLSession {
  18281. WOLFSSL *ssl = nullptr;
  18282. socket_t sock = INVALID_SOCKET;
  18283. std::string hostname; // For client: set via set_sni
  18284. std::string sni_hostname; // For server: received from client via SNI callback
  18285. WolfSSLSession() = default;
  18286. ~WolfSSLSession() {
  18287. if (ssl) { wolfSSL_free(ssl); }
  18288. }
  18289. WolfSSLSession(const WolfSSLSession &) = delete;
  18290. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18291. };
  18292. // Thread-local error code accessor for wolfSSL
  18293. inline uint64_t &wolfssl_last_error() {
  18294. static thread_local uint64_t err = 0;
  18295. return err;
  18296. }
  18297. // Helper to map wolfSSL error to ErrorCode.
  18298. // ssl_error is the value from wolfSSL_get_error().
  18299. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18300. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18301. int &out_errno) {
  18302. switch (ssl_error) {
  18303. case SSL_ERROR_NONE: return ErrorCode::Success;
  18304. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18305. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18306. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18307. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18308. default:
  18309. if (ssl) {
  18310. // wolfSSL stores the low-level error code as a negative value.
  18311. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18312. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18313. if (low_err == DOMAIN_NAME_MISMATCH) {
  18314. return ErrorCode::HostnameMismatch;
  18315. }
  18316. // Check verify result to distinguish cert verification from generic SSL
  18317. // errors.
  18318. long vr = wolfSSL_get_verify_result(ssl);
  18319. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18320. }
  18321. return ErrorCode::Fatal;
  18322. }
  18323. }
  18324. // WolfSSLContext constructor/destructor implementations
  18325. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18326. inline WolfSSLContext::~WolfSSLContext() {
  18327. if (ctx) { wolfSSL_CTX_free(ctx); }
  18328. }
  18329. // Thread-local storage for SNI captured during handshake
  18330. inline std::string &wolfssl_pending_sni() {
  18331. static thread_local std::string sni;
  18332. return sni;
  18333. }
  18334. // SNI callback for wolfSSL server to capture client's SNI hostname
  18335. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18336. (void)ret;
  18337. (void)exArg;
  18338. void *name_data = nullptr;
  18339. unsigned short name_len =
  18340. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18341. if (name_data && name_len > 0) {
  18342. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18343. name_len);
  18344. } else {
  18345. wolfssl_pending_sni().clear();
  18346. }
  18347. return 0; // Continue regardless
  18348. }
  18349. // wolfSSL verify callback wrapper
  18350. inline int wolfssl_verify_callback(int preverify_ok,
  18351. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18352. auto &callback = get_verify_callback();
  18353. if (!callback) { return preverify_ok; }
  18354. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18355. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18356. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18357. // Get the WOLFSSL object from the X509_STORE_CTX
  18358. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18359. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18360. VerifyContext verify_ctx;
  18361. verify_ctx.session = static_cast<session_t>(ssl);
  18362. verify_ctx.cert = static_cast<cert_t>(cert);
  18363. verify_ctx.depth = depth;
  18364. verify_ctx.preverify_ok = (preverify_ok != 0);
  18365. verify_ctx.error_code = static_cast<long>(err);
  18366. if (err != 0) {
  18367. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18368. } else {
  18369. verify_ctx.error_string = nullptr;
  18370. }
  18371. bool accepted = callback(verify_ctx);
  18372. return accepted ? 1 : 0;
  18373. }
  18374. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18375. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18376. wolfSSL_CTX_set_default_passwd_cb(
  18377. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18378. auto *pwd = static_cast<const char *>(userdata);
  18379. if (!pwd) return 0;
  18380. auto len = static_cast<int>(strlen(pwd));
  18381. if (len > size) len = size;
  18382. memcpy(buf, pwd, static_cast<size_t>(len));
  18383. return len;
  18384. });
  18385. }
  18386. } // namespace impl
  18387. inline ctx_t create_client_context() {
  18388. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18389. if (!ctx) { return nullptr; }
  18390. ctx->is_server = false;
  18391. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18392. if (!method) {
  18393. delete ctx;
  18394. return nullptr;
  18395. }
  18396. ctx->ctx = wolfSSL_CTX_new(method);
  18397. if (!ctx->ctx) {
  18398. delete ctx;
  18399. return nullptr;
  18400. }
  18401. // Default: verify peer certificate
  18402. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18403. return static_cast<ctx_t>(ctx);
  18404. }
  18405. inline ctx_t create_server_context() {
  18406. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18407. if (!ctx) { return nullptr; }
  18408. ctx->is_server = true;
  18409. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18410. if (!method) {
  18411. delete ctx;
  18412. return nullptr;
  18413. }
  18414. ctx->ctx = wolfSSL_CTX_new(method);
  18415. if (!ctx->ctx) {
  18416. delete ctx;
  18417. return nullptr;
  18418. }
  18419. // Default: don't verify client
  18420. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18421. // Enable SNI on server
  18422. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18423. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18424. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18425. return static_cast<ctx_t>(ctx);
  18426. }
  18427. inline void free_context(ctx_t ctx) {
  18428. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18429. }
  18430. inline bool set_min_version(ctx_t ctx, Version version) {
  18431. if (!ctx) { return false; }
  18432. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18433. int min_ver = WOLFSSL_TLSV1_2;
  18434. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18435. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18436. }
  18437. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18438. if (!ctx || !pem) { return false; }
  18439. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18440. int ret = wolfSSL_CTX_load_verify_buffer(
  18441. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18442. static_cast<long>(len), SSL_FILETYPE_PEM);
  18443. if (ret != SSL_SUCCESS) {
  18444. impl::wolfssl_last_error() =
  18445. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18446. return false;
  18447. }
  18448. wctx->ca_pem_data_.append(pem, len);
  18449. return true;
  18450. }
  18451. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18452. if (!ctx || !file_path) { return false; }
  18453. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18454. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18455. if (ret != SSL_SUCCESS) {
  18456. impl::wolfssl_last_error() =
  18457. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18458. return false;
  18459. }
  18460. return true;
  18461. }
  18462. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18463. if (!ctx || !dir_path) { return false; }
  18464. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18465. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18466. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18467. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18468. // immediately. Return true even on failure since the CA file may have
  18469. // already been loaded, matching OpenSSL's lenient behavior.
  18470. (void)ret;
  18471. return true;
  18472. }
  18473. inline bool load_system_certs(ctx_t ctx) {
  18474. if (!ctx) { return false; }
  18475. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18476. bool loaded = false;
  18477. #ifdef _WIN32
  18478. loaded = impl::enumerate_windows_system_certs(
  18479. [&](const unsigned char *data, size_t len) {
  18480. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18481. static_cast<long>(len),
  18482. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18483. });
  18484. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18485. loaded = impl::enumerate_macos_keychain_certs(
  18486. [&](const unsigned char *data, size_t len) {
  18487. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18488. static_cast<long>(len),
  18489. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18490. });
  18491. #else
  18492. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18493. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18494. SSL_SUCCESS) {
  18495. loaded = true;
  18496. break;
  18497. }
  18498. }
  18499. if (!loaded) {
  18500. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18501. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18502. SSL_SUCCESS) {
  18503. loaded = true;
  18504. break;
  18505. }
  18506. }
  18507. }
  18508. #endif
  18509. return loaded;
  18510. }
  18511. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18512. const char *password) {
  18513. if (!ctx || !cert || !key) { return false; }
  18514. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18515. // Load certificate
  18516. int ret = wolfSSL_CTX_use_certificate_buffer(
  18517. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18518. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18519. if (ret != SSL_SUCCESS) {
  18520. impl::wolfssl_last_error() =
  18521. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18522. return false;
  18523. }
  18524. // Set password callback if password is provided
  18525. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18526. // Load private key
  18527. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18528. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18529. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18530. if (ret != SSL_SUCCESS) {
  18531. impl::wolfssl_last_error() =
  18532. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18533. return false;
  18534. }
  18535. // Verify that the certificate and private key match
  18536. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18537. }
  18538. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18539. const char *key_path, const char *password) {
  18540. if (!ctx || !cert_path || !key_path) { return false; }
  18541. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18542. // Load certificate file
  18543. int ret =
  18544. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18545. if (ret != SSL_SUCCESS) {
  18546. impl::wolfssl_last_error() =
  18547. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18548. return false;
  18549. }
  18550. // Set password callback if password is provided
  18551. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18552. // Load private key file
  18553. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18554. if (ret != SSL_SUCCESS) {
  18555. impl::wolfssl_last_error() =
  18556. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18557. return false;
  18558. }
  18559. // Verify that the certificate and private key match
  18560. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18561. }
  18562. inline void set_verify_client(ctx_t ctx, bool require) {
  18563. if (!ctx) { return; }
  18564. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18565. wctx->verify_client = require;
  18566. if (require) {
  18567. wolfSSL_CTX_set_verify(
  18568. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18569. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18570. } else {
  18571. if (wctx->has_verify_callback) {
  18572. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18573. impl::wolfssl_verify_callback);
  18574. } else {
  18575. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18576. }
  18577. }
  18578. }
  18579. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18580. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18581. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18582. auto session = new (std::nothrow) impl::WolfSSLSession();
  18583. if (!session) { return nullptr; }
  18584. session->sock = sock;
  18585. session->ssl = wolfSSL_new(wctx->ctx);
  18586. if (!session->ssl) {
  18587. impl::wolfssl_last_error() =
  18588. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18589. delete session;
  18590. return nullptr;
  18591. }
  18592. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18593. return static_cast<session_t>(session);
  18594. }
  18595. inline void free_session(session_t session) {
  18596. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18597. }
  18598. inline bool set_sni(session_t session, const char *hostname,
  18599. bool verify_hostname) {
  18600. if (!session || !hostname) { return false; }
  18601. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18602. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18603. static_cast<word16>(strlen(hostname)));
  18604. if (ret != WOLFSSL_SUCCESS) {
  18605. impl::wolfssl_last_error() =
  18606. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18607. return false;
  18608. }
  18609. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18610. // separately from the SNI extension sent above; skip it when hostname
  18611. // verification is disabled so only the chain is checked, matching OpenSSL.
  18612. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18613. wsession->hostname = hostname;
  18614. return true;
  18615. }
  18616. inline TlsError connect(session_t session) {
  18617. TlsError err;
  18618. if (!session) {
  18619. err.code = ErrorCode::Fatal;
  18620. return err;
  18621. }
  18622. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18623. int ret = wolfSSL_connect(wsession->ssl);
  18624. if (ret == SSL_SUCCESS) {
  18625. err.code = ErrorCode::Success;
  18626. } else {
  18627. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18628. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18629. err.backend_code = static_cast<uint64_t>(ssl_error);
  18630. impl::wolfssl_last_error() = err.backend_code;
  18631. }
  18632. return err;
  18633. }
  18634. inline TlsError accept(session_t session) {
  18635. TlsError err;
  18636. if (!session) {
  18637. err.code = ErrorCode::Fatal;
  18638. return err;
  18639. }
  18640. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18641. int ret = wolfSSL_accept(wsession->ssl);
  18642. if (ret == SSL_SUCCESS) {
  18643. err.code = ErrorCode::Success;
  18644. // Capture SNI from thread-local storage after successful handshake
  18645. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18646. impl::wolfssl_pending_sni().clear();
  18647. } else {
  18648. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18649. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18650. err.backend_code = static_cast<uint64_t>(ssl_error);
  18651. impl::wolfssl_last_error() = err.backend_code;
  18652. }
  18653. return err;
  18654. }
  18655. inline bool connect_nonblocking(session_t session, socket_t sock,
  18656. time_t timeout_sec, time_t timeout_usec,
  18657. TlsError *err) {
  18658. if (!session) {
  18659. if (err) { err->code = ErrorCode::Fatal; }
  18660. return false;
  18661. }
  18662. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18663. // Set socket to non-blocking mode
  18664. detail::set_nonblocking(sock, true);
  18665. auto cleanup =
  18666. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18667. int ret;
  18668. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18669. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18670. if (ssl_error == SSL_ERROR_WANT_READ) {
  18671. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18672. continue;
  18673. }
  18674. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18675. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18676. continue;
  18677. }
  18678. }
  18679. // Error or timeout
  18680. if (err) {
  18681. err->code =
  18682. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18683. err->backend_code = static_cast<uint64_t>(ssl_error);
  18684. }
  18685. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18686. return false;
  18687. }
  18688. if (err) { err->code = ErrorCode::Success; }
  18689. return true;
  18690. }
  18691. inline bool accept_nonblocking(session_t session, socket_t sock,
  18692. time_t timeout_sec, time_t timeout_usec,
  18693. TlsError *err) {
  18694. if (!session) {
  18695. if (err) { err->code = ErrorCode::Fatal; }
  18696. return false;
  18697. }
  18698. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18699. // Set socket to non-blocking mode
  18700. detail::set_nonblocking(sock, true);
  18701. auto cleanup =
  18702. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18703. int ret;
  18704. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18705. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18706. if (ssl_error == SSL_ERROR_WANT_READ) {
  18707. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18708. continue;
  18709. }
  18710. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18711. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18712. continue;
  18713. }
  18714. }
  18715. // Error or timeout
  18716. if (err) {
  18717. err->code =
  18718. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18719. err->backend_code = static_cast<uint64_t>(ssl_error);
  18720. }
  18721. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18722. return false;
  18723. }
  18724. if (err) { err->code = ErrorCode::Success; }
  18725. // Capture SNI from thread-local storage after successful handshake
  18726. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18727. impl::wolfssl_pending_sni().clear();
  18728. return true;
  18729. }
  18730. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18731. if (!session || !buf) {
  18732. err.code = ErrorCode::Fatal;
  18733. return -1;
  18734. }
  18735. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18736. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18737. if (ret > 0) {
  18738. err.code = ErrorCode::Success;
  18739. return static_cast<ssize_t>(ret);
  18740. }
  18741. if (ret == 0) {
  18742. err.code = ErrorCode::PeerClosed;
  18743. return 0;
  18744. }
  18745. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18746. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18747. err.backend_code = static_cast<uint64_t>(ssl_error);
  18748. impl::wolfssl_last_error() = err.backend_code;
  18749. return -1;
  18750. }
  18751. inline ssize_t write(session_t session, const void *buf, size_t len,
  18752. TlsError &err) {
  18753. if (!session || !buf) {
  18754. err.code = ErrorCode::Fatal;
  18755. return -1;
  18756. }
  18757. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18758. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18759. if (ret > 0) {
  18760. err.code = ErrorCode::Success;
  18761. return static_cast<ssize_t>(ret);
  18762. }
  18763. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18764. // Treat this as an error (return -1) so callers don't spin in a
  18765. // write loop adding zero to the offset.
  18766. if (ret == 0) {
  18767. err.code = ErrorCode::PeerClosed;
  18768. return -1;
  18769. }
  18770. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18771. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18772. err.backend_code = static_cast<uint64_t>(ssl_error);
  18773. impl::wolfssl_last_error() = err.backend_code;
  18774. return -1;
  18775. }
  18776. inline int pending(const_session_t session) {
  18777. if (!session) { return 0; }
  18778. auto wsession =
  18779. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18780. return wolfSSL_pending(wsession->ssl);
  18781. }
  18782. inline void shutdown(session_t session, bool graceful) {
  18783. if (!session) { return; }
  18784. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18785. if (graceful) {
  18786. int ret;
  18787. int attempts = 0;
  18788. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18789. attempts < 3) {
  18790. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18791. if (ssl_error != SSL_ERROR_WANT_READ &&
  18792. ssl_error != SSL_ERROR_WANT_WRITE) {
  18793. break;
  18794. }
  18795. attempts++;
  18796. }
  18797. } else {
  18798. wolfSSL_shutdown(wsession->ssl);
  18799. }
  18800. }
  18801. inline bool is_peer_closed(session_t session, socket_t sock) {
  18802. if (!session || sock == INVALID_SOCKET) { return true; }
  18803. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18804. // Check if there's already decrypted data available
  18805. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18806. // Set socket to non-blocking to avoid blocking on read
  18807. detail::set_nonblocking(sock, true);
  18808. auto cleanup =
  18809. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18810. // Peek 1 byte to check connection status without consuming data
  18811. unsigned char buf;
  18812. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18813. // If we got data or WANT_READ (would block), connection is alive
  18814. if (ret > 0) { return false; }
  18815. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18816. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18817. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18818. ret == 0;
  18819. }
  18820. inline cert_t get_peer_cert(const_session_t session) {
  18821. if (!session) { return nullptr; }
  18822. auto wsession =
  18823. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18824. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18825. return static_cast<cert_t>(cert);
  18826. }
  18827. inline size_t get_peer_certs(const_session_t session,
  18828. std::vector<cert_t> &certs) {
  18829. certs.clear();
  18830. if (!session) { return 0; }
  18831. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  18832. #ifdef SESSION_CERTS
  18833. auto wsession =
  18834. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18835. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  18836. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  18837. for (int i = 0; i < count; i++) {
  18838. auto x509 = wolfSSL_get_chain_X509(chain, i);
  18839. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18840. }
  18841. #endif
  18842. return certs.size();
  18843. }
  18844. inline void free_cert(cert_t cert) {
  18845. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18846. }
  18847. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18848. if (!cert || !hostname) { return false; }
  18849. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18850. std::string host_str(hostname);
  18851. // Check if hostname is an IP address (IPv4 or IPv6)
  18852. unsigned char ip_bytes[16];
  18853. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18854. auto is_ip = ip_len > 0;
  18855. // Check Subject Alternative Names
  18856. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18857. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18858. if (san_names) {
  18859. int san_count = wolfSSL_sk_num(san_names);
  18860. for (int i = 0; i < san_count; i++) {
  18861. auto *names =
  18862. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18863. if (!names) continue;
  18864. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18865. // DNS name
  18866. unsigned char *dns_name = nullptr;
  18867. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18868. if (dns_name && dns_len > 0) {
  18869. std::string san_name(reinterpret_cast<char *>(dns_name),
  18870. static_cast<size_t>(dns_len));
  18871. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18872. if (detail::match_hostname(san_name, host_str)) {
  18873. wolfSSL_sk_free(san_names);
  18874. return true;
  18875. }
  18876. }
  18877. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18878. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18879. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18880. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18881. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18882. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18883. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18884. wolfSSL_sk_free(san_names);
  18885. return true;
  18886. }
  18887. }
  18888. }
  18889. wolfSSL_sk_free(san_names);
  18890. }
  18891. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18892. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18893. // the OpenSSL backend's X509_check_ip behaves the same way).
  18894. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18895. if (subject) {
  18896. char cn[256] = {};
  18897. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18898. sizeof(cn));
  18899. if (cn_len > 0) {
  18900. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18901. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18902. }
  18903. }
  18904. return false;
  18905. }
  18906. inline uint64_t hostname_mismatch_code() {
  18907. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18908. }
  18909. inline long get_verify_result(const_session_t session) {
  18910. if (!session) { return -1; }
  18911. auto wsession =
  18912. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18913. long result = wolfSSL_get_verify_result(wsession->ssl);
  18914. return result;
  18915. }
  18916. inline std::string get_cert_subject_cn(cert_t cert) {
  18917. if (!cert) return "";
  18918. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18919. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18920. if (!subject) return "";
  18921. char cn[256] = {};
  18922. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18923. sizeof(cn));
  18924. if (cn_len <= 0) return "";
  18925. return std::string(cn, static_cast<size_t>(cn_len));
  18926. }
  18927. inline std::string get_cert_issuer_name(cert_t cert) {
  18928. if (!cert) return "";
  18929. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18930. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18931. if (!issuer) return "";
  18932. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18933. if (!name_str) return "";
  18934. std::string result(name_str);
  18935. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18936. return result;
  18937. }
  18938. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18939. sans.clear();
  18940. if (!cert) return false;
  18941. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18942. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18943. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18944. if (!san_names) return true; // No SANs is not an error
  18945. int count = wolfSSL_sk_num(san_names);
  18946. for (int i = 0; i < count; i++) {
  18947. auto *name =
  18948. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18949. if (!name) continue;
  18950. SanEntry entry;
  18951. switch (name->type) {
  18952. case WOLFSSL_GEN_DNS: {
  18953. entry.type = SanType::DNS;
  18954. unsigned char *dns_name = nullptr;
  18955. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18956. if (dns_name && dns_len > 0) {
  18957. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18958. static_cast<size_t>(dns_len));
  18959. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18960. }
  18961. break;
  18962. }
  18963. case WOLFSSL_GEN_IPADD: {
  18964. entry.type = SanType::IP;
  18965. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18966. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18967. if (ip_data && ip_len == 4) {
  18968. char buf[16];
  18969. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18970. ip_data[2], ip_data[3]);
  18971. entry.value = buf;
  18972. } else if (ip_data && ip_len == 16) {
  18973. char buf[64];
  18974. snprintf(buf, sizeof(buf),
  18975. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18976. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18977. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18978. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18979. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18980. ip_data[14], ip_data[15]);
  18981. entry.value = buf;
  18982. }
  18983. break;
  18984. }
  18985. case WOLFSSL_GEN_EMAIL:
  18986. entry.type = SanType::EMAIL;
  18987. {
  18988. unsigned char *email = nullptr;
  18989. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18990. if (email && email_len > 0) {
  18991. entry.value = std::string(reinterpret_cast<char *>(email),
  18992. static_cast<size_t>(email_len));
  18993. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18994. }
  18995. }
  18996. break;
  18997. case WOLFSSL_GEN_URI:
  18998. entry.type = SanType::URI;
  18999. {
  19000. unsigned char *uri = nullptr;
  19001. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19002. &uri, name->d.uniformResourceIdentifier);
  19003. if (uri && uri_len > 0) {
  19004. entry.value = std::string(reinterpret_cast<char *>(uri),
  19005. static_cast<size_t>(uri_len));
  19006. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19007. }
  19008. }
  19009. break;
  19010. default: entry.type = SanType::OTHER; break;
  19011. }
  19012. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19013. }
  19014. wolfSSL_sk_free(san_names);
  19015. return true;
  19016. }
  19017. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19018. time_t &not_after) {
  19019. if (!cert) return false;
  19020. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19021. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19022. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19023. if (!nb || !na) return false;
  19024. // wolfSSL_ASN1_TIME_to_tm is available
  19025. struct tm tm_nb = {}, tm_na = {};
  19026. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19027. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19028. #ifdef _WIN32
  19029. not_before = _mkgmtime(&tm_nb);
  19030. not_after = _mkgmtime(&tm_na);
  19031. #else
  19032. not_before = timegm(&tm_nb);
  19033. not_after = timegm(&tm_na);
  19034. #endif
  19035. return true;
  19036. }
  19037. inline std::string get_cert_serial(cert_t cert) {
  19038. if (!cert) return "";
  19039. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19040. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19041. if (!serial_asn1) return "";
  19042. // Get the serial number data
  19043. int len = serial_asn1->length;
  19044. unsigned char *data = serial_asn1->data;
  19045. if (!data || len <= 0) return "";
  19046. std::string result;
  19047. result.reserve(static_cast<size_t>(len) * 2);
  19048. for (int i = 0; i < len; i++) {
  19049. char hex[3];
  19050. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19051. result += hex;
  19052. }
  19053. return result;
  19054. }
  19055. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19056. if (!cert) return false;
  19057. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19058. int der_len = 0;
  19059. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19060. if (!der_data || der_len <= 0) return false;
  19061. der.assign(der_data, der_data + der_len);
  19062. return true;
  19063. }
  19064. inline const char *get_sni(const_session_t session) {
  19065. if (!session) return nullptr;
  19066. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19067. // For server: return SNI received from client during handshake
  19068. if (!wsession->sni_hostname.empty()) {
  19069. return wsession->sni_hostname.c_str();
  19070. }
  19071. // For client: return the hostname set via set_sni
  19072. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19073. return nullptr;
  19074. }
  19075. inline uint64_t peek_error() {
  19076. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19077. }
  19078. inline uint64_t get_error() {
  19079. uint64_t err = impl::wolfssl_last_error();
  19080. impl::wolfssl_last_error() = 0;
  19081. return err;
  19082. }
  19083. inline std::string error_string(uint64_t code) {
  19084. char buf[256];
  19085. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19086. return std::string(buf);
  19087. }
  19088. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19089. if (!pem || len == 0) { return nullptr; }
  19090. // Validate by attempting to load into a temporary ctx
  19091. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19092. if (!tmp_ctx) { return nullptr; }
  19093. int ret = wolfSSL_CTX_load_verify_buffer(
  19094. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19095. static_cast<long>(len), SSL_FILETYPE_PEM);
  19096. wolfSSL_CTX_free(tmp_ctx);
  19097. if (ret != SSL_SUCCESS) { return nullptr; }
  19098. return static_cast<ca_store_t>(
  19099. new impl::WolfSSLCAStore{std::string(pem, len)});
  19100. }
  19101. inline void free_ca_store(ca_store_t store) {
  19102. delete static_cast<impl::WolfSSLCAStore *>(store);
  19103. }
  19104. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19105. if (!ctx || !store) { return false; }
  19106. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19107. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19108. int ret = wolfSSL_CTX_load_verify_buffer(
  19109. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19110. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19111. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19112. // This function takes ownership of the store; the PEM data was copied into
  19113. // the context, so release the source
  19114. free_ca_store(store);
  19115. return ret == SSL_SUCCESS;
  19116. }
  19117. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19118. certs.clear();
  19119. if (!ctx) { return 0; }
  19120. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19121. if (wctx->ca_pem_data_.empty()) { return 0; }
  19122. const std::string &pem = wctx->ca_pem_data_;
  19123. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19124. const std::string end_marker = "-----END CERTIFICATE-----";
  19125. size_t pos = 0;
  19126. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19127. size_t end_pos = pem.find(end_marker, pos);
  19128. if (end_pos == std::string::npos) { break; }
  19129. end_pos += end_marker.size();
  19130. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19131. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19132. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19133. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19134. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19135. pos = end_pos;
  19136. }
  19137. return certs.size();
  19138. }
  19139. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19140. std::vector<std::string> names;
  19141. if (!ctx) { return names; }
  19142. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19143. if (wctx->ca_pem_data_.empty()) { return names; }
  19144. const std::string &pem = wctx->ca_pem_data_;
  19145. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19146. const std::string end_marker = "-----END CERTIFICATE-----";
  19147. size_t pos = 0;
  19148. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19149. size_t end_pos = pem.find(end_marker, pos);
  19150. if (end_pos == std::string::npos) { break; }
  19151. end_pos += end_marker.size();
  19152. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19153. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19154. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19155. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19156. if (x509) {
  19157. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19158. if (subject) {
  19159. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19160. if (name_str) {
  19161. names.push_back(name_str);
  19162. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19163. }
  19164. }
  19165. wolfSSL_X509_free(x509);
  19166. }
  19167. pos = end_pos;
  19168. }
  19169. return names;
  19170. }
  19171. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19172. const char *key_pem, const char *password) {
  19173. if (!ctx || !cert_pem || !key_pem) { return false; }
  19174. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19175. // Load new certificate
  19176. int ret = wolfSSL_CTX_use_certificate_buffer(
  19177. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19178. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19179. if (ret != SSL_SUCCESS) {
  19180. impl::wolfssl_last_error() =
  19181. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19182. return false;
  19183. }
  19184. // Set password if provided
  19185. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19186. // Load new private key
  19187. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19188. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19189. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19190. if (ret != SSL_SUCCESS) {
  19191. impl::wolfssl_last_error() =
  19192. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19193. return false;
  19194. }
  19195. return true;
  19196. }
  19197. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19198. if (!ctx || !ca_pem) { return false; }
  19199. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19200. int ret = wolfSSL_CTX_load_verify_buffer(
  19201. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19202. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19203. if (ret != SSL_SUCCESS) {
  19204. impl::wolfssl_last_error() =
  19205. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19206. return false;
  19207. }
  19208. return true;
  19209. }
  19210. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19211. if (!ctx) { return false; }
  19212. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19213. impl::get_verify_callback() = std::move(callback);
  19214. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19215. if (wctx->has_verify_callback) {
  19216. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19217. impl::wolfssl_verify_callback);
  19218. } else {
  19219. wolfSSL_CTX_set_verify(
  19220. wctx->ctx,
  19221. wctx->verify_client
  19222. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19223. : SSL_VERIFY_NONE,
  19224. nullptr);
  19225. }
  19226. return true;
  19227. }
  19228. inline long get_verify_error(const_session_t session) {
  19229. if (!session) { return -1; }
  19230. auto *wsession =
  19231. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19232. return wolfSSL_get_verify_result(wsession->ssl);
  19233. }
  19234. inline std::string verify_error_string(long error_code) {
  19235. if (error_code == 0) { return ""; }
  19236. const char *str =
  19237. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19238. return str ? std::string(str) : std::string();
  19239. }
  19240. } // namespace tls
  19241. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19242. // WebSocket implementation
  19243. namespace ws {
  19244. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19245. bool fin) {
  19246. std::lock_guard<std::mutex> lock(write_mutex_);
  19247. if (closed_) { return false; }
  19248. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19249. }
  19250. inline ReadResult WebSocket::read(std::string &msg) {
  19251. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19252. while (!closed_) {
  19253. Opcode opcode;
  19254. std::string payload;
  19255. bool fin;
  19256. impl::FrameRead r =
  19257. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19258. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19259. // A timeout landed on a frame boundary: the connection is untouched and
  19260. // still usable, so hand control back without closing it. That is only
  19261. // useful to a caller who asked for the timeout; the compile-time default
  19262. // is a backstop against a peer gone quiet, and elapsing it closes the
  19263. // connection so a plain `while (ws.read(msg))` loop ends.
  19264. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19265. if (r != impl::FrameRead::Ok) {
  19266. closed_ = true;
  19267. return Fail;
  19268. }
  19269. switch (opcode) {
  19270. case Opcode::Ping: {
  19271. std::lock_guard<std::mutex> lock(write_mutex_);
  19272. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19273. payload.size(), true, !is_server_);
  19274. continue;
  19275. }
  19276. case Opcode::Pong: {
  19277. std::lock_guard<std::mutex> lock(ping_mutex_);
  19278. unacked_pings_ = 0;
  19279. continue;
  19280. }
  19281. case Opcode::Close: {
  19282. if (!closed_.exchange(true)) {
  19283. // Echo close frame back
  19284. std::lock_guard<std::mutex> lock(write_mutex_);
  19285. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19286. payload.size(), true, !is_server_);
  19287. }
  19288. return Fail;
  19289. }
  19290. case Opcode::Text:
  19291. case Opcode::Binary: {
  19292. auto result = opcode == Opcode::Text ? Text : Binary;
  19293. msg = std::move(payload);
  19294. // Handle fragmentation
  19295. if (!fin) {
  19296. while (true) {
  19297. Opcode cont_opcode;
  19298. std::string cont_payload;
  19299. bool cont_fin;
  19300. // A timeout is not reportable here: half of a fragmented message is
  19301. // already in `msg` and read() has no way to resume it, so it is a
  19302. // failure like any other. Timeouts are only ever seen on a message
  19303. // boundary.
  19304. if (impl::read_websocket_frame(
  19305. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19306. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19307. impl::FrameRead::Ok) {
  19308. closed_ = true;
  19309. return Fail;
  19310. }
  19311. if (cont_opcode == Opcode::Ping) {
  19312. std::lock_guard<std::mutex> lock(write_mutex_);
  19313. detail::write_websocket_frame(
  19314. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19315. true, !is_server_);
  19316. continue;
  19317. }
  19318. if (cont_opcode == Opcode::Pong) {
  19319. std::lock_guard<std::mutex> lock(ping_mutex_);
  19320. unacked_pings_ = 0;
  19321. continue;
  19322. }
  19323. if (cont_opcode == Opcode::Close) {
  19324. if (!closed_.exchange(true)) {
  19325. std::lock_guard<std::mutex> lock(write_mutex_);
  19326. detail::write_websocket_frame(
  19327. strm_, Opcode::Close, cont_payload.data(),
  19328. cont_payload.size(), true, !is_server_);
  19329. }
  19330. return Fail;
  19331. }
  19332. // RFC 6455: continuation frames must use opcode 0x0
  19333. if (cont_opcode != Opcode::Continuation) {
  19334. closed_ = true;
  19335. return Fail;
  19336. }
  19337. msg += cont_payload;
  19338. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19339. closed_ = true;
  19340. return Fail;
  19341. }
  19342. if (cont_fin) { break; }
  19343. }
  19344. }
  19345. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19346. if (result == Text && !impl::is_valid_utf8(msg)) {
  19347. // close() takes the read lock to wait for the peer's Close reply, so
  19348. // it must not run while this thread still holds it.
  19349. read_lock.unlock();
  19350. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19351. return Fail;
  19352. }
  19353. return result;
  19354. }
  19355. default: closed_ = true; return Fail;
  19356. }
  19357. }
  19358. return Fail;
  19359. }
  19360. inline bool WebSocket::send(const std::string &data) {
  19361. return send_frame(Opcode::Text, data.data(), data.size());
  19362. }
  19363. inline bool WebSocket::send(const char *data, size_t len) {
  19364. return send_frame(Opcode::Binary, data, len);
  19365. }
  19366. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19367. if (closed_.exchange(true)) { return; }
  19368. ping_cv_.notify_all();
  19369. std::string payload;
  19370. auto code = static_cast<uint16_t>(status);
  19371. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19372. payload.push_back(static_cast<char>(code & 0xFF));
  19373. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19374. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19375. payload += reason.substr(0, 123);
  19376. {
  19377. std::lock_guard<std::mutex> lock(write_mutex_);
  19378. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19379. payload.size(), true, !is_server_);
  19380. }
  19381. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19382. // Close response before closing the TCP connection.
  19383. //
  19384. // Wait only when no other thread is parsing frames. When one is, it is the
  19385. // thread positioned to see the peer's reply, and reading here would take
  19386. // bytes out of the message it is assembling. Bailing out also leaves the
  19387. // stream, including its read timeout, entirely to that thread.
  19388. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19389. if (!read_lock.owns_lock()) { return; }
  19390. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19391. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19392. Opcode op;
  19393. std::string resp;
  19394. bool fin;
  19395. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19396. impl::FrameRead::Ok) {
  19397. if (op == Opcode::Close) { break; }
  19398. }
  19399. }
  19400. inline WebSocket::~WebSocket() {
  19401. {
  19402. std::lock_guard<std::mutex> lock(ping_mutex_);
  19403. closed_ = true;
  19404. }
  19405. ping_cv_.notify_all();
  19406. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19407. }
  19408. inline void WebSocket::start_heartbeat() {
  19409. if (ping_interval_sec_ == 0) { return; }
  19410. ping_thread_ = std::thread([this]() {
  19411. std::unique_lock<std::mutex> lock(ping_mutex_);
  19412. while (!closed_) {
  19413. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19414. if (closed_) { break; }
  19415. // If the peer has failed to respond to the previous pings, give up.
  19416. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19417. // opt-in liveness check controlled by max_missed_pongs_.
  19418. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19419. lock.unlock();
  19420. close(CloseStatus::GoingAway, "pong timeout");
  19421. return;
  19422. }
  19423. lock.unlock();
  19424. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19425. lock.lock();
  19426. closed_ = true;
  19427. break;
  19428. }
  19429. lock.lock();
  19430. unacked_pings_++;
  19431. }
  19432. });
  19433. }
  19434. inline const Request &WebSocket::request() const { return req_; }
  19435. inline bool WebSocket::is_open() const { return !closed_; }
  19436. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19437. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19438. // poll(), where 0 would instead mean "return immediately", so hand it the
  19439. // negative poll uses for an unbounded wait.
  19440. if (sec == 0 && usec == 0) { sec = -1; }
  19441. strm_.set_read_timeout(sec, usec);
  19442. read_timeout_set_ = true;
  19443. }
  19444. // WebSocketClient implementation
  19445. inline WebSocketClient::WebSocketClient(
  19446. const std::string &scheme_host_port_path, const Headers &headers)
  19447. : headers_(headers) {
  19448. detail::UrlComponents uc;
  19449. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19450. !uc.host.empty() && !uc.path.empty()) {
  19451. auto &scheme = uc.scheme;
  19452. #ifdef CPPHTTPLIB_SSL_ENABLED
  19453. if (scheme != "ws" && scheme != "wss") {
  19454. #else
  19455. if (scheme != "ws") {
  19456. #endif
  19457. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19458. std::string msg = "'" + scheme + "' scheme is not supported.";
  19459. throw std::invalid_argument(msg);
  19460. #endif
  19461. return;
  19462. }
  19463. auto is_ssl = scheme == "wss";
  19464. host_ = std::move(uc.host);
  19465. port_ = is_ssl ? 443 : 80;
  19466. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19467. path_ = std::move(uc.path);
  19468. if (!uc.query.empty()) { path_ += uc.query; }
  19469. #ifdef CPPHTTPLIB_SSL_ENABLED
  19470. is_ssl_ = is_ssl;
  19471. if (is_ssl_) {
  19472. // The context lives as long as the client so that CA configuration
  19473. // survives reconnects; sessions are created per connection.
  19474. tls_ctx_ = tls::create_client_context();
  19475. if (!tls_ctx_) { return; }
  19476. }
  19477. #else
  19478. if (is_ssl) { return; }
  19479. #endif
  19480. is_valid_ = true;
  19481. }
  19482. }
  19483. #ifdef CPPHTTPLIB_SSL_ENABLED
  19484. inline WebSocketClient::WebSocketClient(
  19485. const std::string &scheme_host_port_path, const PemMemory &pem,
  19486. const Headers &headers)
  19487. : WebSocketClient(scheme_host_port_path, headers) {
  19488. // For ws:// URLs the client certificate is silently ignored, consistent
  19489. // with the TLS-only setters such as set_ca_cert_path().
  19490. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19491. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19492. pem.private_key_password)) {
  19493. tls::free_context(tls_ctx_);
  19494. tls_ctx_ = nullptr;
  19495. is_valid_ = false;
  19496. }
  19497. }
  19498. }
  19499. #endif
  19500. inline WebSocketClient::~WebSocketClient() {
  19501. shutdown_and_close();
  19502. #ifdef CPPHTTPLIB_SSL_ENABLED
  19503. if (tls_ctx_) {
  19504. tls::free_context(tls_ctx_);
  19505. tls_ctx_ = nullptr;
  19506. }
  19507. #endif
  19508. }
  19509. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19510. inline void WebSocketClient::shutdown_and_close() {
  19511. // Send the close frame while the TLS session is still alive: ws_ holds an
  19512. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19513. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19514. if (ws_ && ws_->is_open()) { ws_->close(); }
  19515. ws_.reset();
  19516. #ifdef CPPHTTPLIB_SSL_ENABLED
  19517. if (is_ssl_) {
  19518. if (tls_session_) {
  19519. tls::shutdown(tls_session_, true);
  19520. tls::free_session(tls_session_);
  19521. tls_session_ = nullptr;
  19522. }
  19523. }
  19524. #endif
  19525. if (sock_ != INVALID_SOCKET) {
  19526. detail::shutdown_socket(sock_);
  19527. detail::close_socket(sock_);
  19528. sock_ = INVALID_SOCKET;
  19529. }
  19530. }
  19531. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19532. Error &error, int &ssl_error,
  19533. uint64_t &ssl_backend_error) {
  19534. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19535. // The streams wait with poll(), where 0 instead means "return immediately",
  19536. // so they are given the negative poll uses for an unbounded wait.
  19537. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19538. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19539. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19540. // The handshake belongs to establishing the connection, so an unset read
  19541. // timeout leaves it bounded by the connection timeout instead of forever.
  19542. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19543. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19544. #ifdef CPPHTTPLIB_SSL_ENABLED
  19545. if (is_ssl_) {
  19546. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19547. // is not safe to call concurrently on one client to begin with, since
  19548. // nothing else here is guarded either.
  19549. if (server_certificate_verification_ && !certs_loaded_) {
  19550. uint64_t backend_error = 0;
  19551. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19552. ca_cert_dir_path_, custom_ca_loaded_,
  19553. system_ca_mode_, backend_error);
  19554. certs_loaded_ = true;
  19555. }
  19556. detail::ClientTlsSessionOptions options;
  19557. options.server_hostname_verification = server_hostname_verification_;
  19558. detail::ClientTlsSessionError tls_error;
  19559. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19560. server_certificate_verification_,
  19561. hs_sec, hs_usec, &tls_error,
  19562. options)) {
  19563. error = tls_error.error;
  19564. ssl_error = tls_error.ssl_error;
  19565. ssl_backend_error = tls_error.backend_error;
  19566. return false;
  19567. }
  19568. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19569. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19570. write_timeout_usec_));
  19571. return true;
  19572. }
  19573. #else
  19574. (void)error;
  19575. (void)ssl_error;
  19576. (void)ssl_backend_error;
  19577. (void)hs_sec;
  19578. (void)hs_usec;
  19579. #endif
  19580. strm = std::unique_ptr<Stream>(
  19581. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19582. write_timeout_sec_, write_timeout_usec_));
  19583. return true;
  19584. }
  19585. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19586. #ifdef CPPHTTPLIB_SSL_ENABLED
  19587. auto is_ssl = is_ssl_;
  19588. #else
  19589. auto is_ssl = false;
  19590. #endif
  19591. if (!req.has_header("Host")) {
  19592. req.headers.emplace("Host", detail::make_default_host_header_value(
  19593. host_, port_, is_ssl, address_family_));
  19594. }
  19595. detail::add_default_user_agent_header(req);
  19596. }
  19597. inline Result WebSocketClient::connect() {
  19598. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19599. shutdown_and_close();
  19600. // Check is custom IP or hostname specified for host_
  19601. std::string connect_host;
  19602. std::string ip;
  19603. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19604. auto error = Error::Success;
  19605. sock_ = detail::create_client_socket(
  19606. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19607. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19608. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19609. write_timeout_usec_, interface_, error);
  19610. if (sock_ == INVALID_SOCKET) {
  19611. if (error == Error::Success) { error = Error::Connection; }
  19612. return Result{error, -1, Headers{}};
  19613. }
  19614. std::unique_ptr<Stream> strm;
  19615. auto stream_error = Error::SSLConnection;
  19616. int ssl_error = 0;
  19617. uint64_t ssl_backend_error = 0;
  19618. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19619. shutdown_and_close();
  19620. #ifdef CPPHTTPLIB_SSL_ENABLED
  19621. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19622. #else
  19623. return Result{stream_error, -1, Headers{}};
  19624. #endif
  19625. }
  19626. Request req;
  19627. req.method = "GET";
  19628. req.path = path_;
  19629. req.headers = headers_;
  19630. prepare_default_headers(req);
  19631. detail::WebSocketUpgradeResponse upgrade;
  19632. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19633. shutdown_and_close();
  19634. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19635. }
  19636. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19637. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19638. websocket_ping_interval_sec_,
  19639. websocket_max_missed_pongs_));
  19640. // The stream was created with the timeout already; tell the WebSocket
  19641. // whether it came from the caller, so read() knows to report it as Timeout.
  19642. ws_->read_timeout_set_ = read_timeout_set_;
  19643. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19644. }
  19645. inline ReadResult WebSocketClient::read(std::string &msg) {
  19646. if (!ws_) { return Fail; }
  19647. return ws_->read(msg);
  19648. }
  19649. inline bool WebSocketClient::send(const std::string &data) {
  19650. if (!ws_) { return false; }
  19651. return ws_->send(data);
  19652. }
  19653. inline bool WebSocketClient::send(const char *data, size_t len) {
  19654. if (!ws_) { return false; }
  19655. return ws_->send(data, len);
  19656. }
  19657. inline void WebSocketClient::close(CloseStatus status,
  19658. const std::string &reason) {
  19659. if (ws_) { ws_->close(status, reason); }
  19660. }
  19661. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19662. inline const std::string &WebSocketClient::subprotocol() const {
  19663. return subprotocol_;
  19664. }
  19665. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19666. read_timeout_sec_ = sec;
  19667. read_timeout_usec_ = usec;
  19668. read_timeout_set_ = true;
  19669. // The members above only seed the next connect(); read() consults the
  19670. // stream, so an already-open connection has to be told directly.
  19671. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19672. }
  19673. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19674. write_timeout_sec_ = sec;
  19675. write_timeout_usec_ = usec;
  19676. }
  19677. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19678. websocket_ping_interval_sec_ = sec;
  19679. }
  19680. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19681. websocket_max_missed_pongs_ = count;
  19682. }
  19683. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19684. inline void WebSocketClient::set_address_family(int family) {
  19685. address_family_ = family;
  19686. }
  19687. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19688. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19689. socket_options_ = std::move(socket_options);
  19690. }
  19691. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19692. connection_timeout_sec_ = sec;
  19693. connection_timeout_usec_ = usec;
  19694. }
  19695. inline void WebSocketClient::set_interface(const std::string &intf) {
  19696. interface_ = intf;
  19697. }
  19698. inline void WebSocketClient::set_hostname_addr_map(
  19699. std::map<std::string, std::string> addr_map) {
  19700. addr_map_ = std::move(addr_map);
  19701. }
  19702. #ifdef CPPHTTPLIB_SSL_ENABLED
  19703. inline void
  19704. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19705. const std::string &ca_cert_dir_path) {
  19706. ca_cert_file_path_ = ca_cert_file_path;
  19707. ca_cert_dir_path_ = ca_cert_dir_path;
  19708. }
  19709. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19710. if (store && tls_ctx_) {
  19711. // set_ca_store takes ownership of store
  19712. tls::set_ca_store(tls_ctx_, store);
  19713. custom_ca_loaded_ = true;
  19714. } else if (store) {
  19715. tls::free_ca_store(store);
  19716. }
  19717. }
  19718. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19719. std::size_t size) {
  19720. if (tls_ctx_ && ca_cert && size > 0) {
  19721. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19722. custom_ca_loaded_ = true;
  19723. }
  19724. }
  19725. inline void
  19726. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19727. server_certificate_verification_ = enabled;
  19728. }
  19729. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19730. server_hostname_verification_ = enabled;
  19731. }
  19732. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19733. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19734. }
  19735. #endif // CPPHTTPLIB_SSL_ENABLED
  19736. } // namespace ws
  19737. // ----------------------------------------------------------------------------
  19738. } // namespace httplib
  19739. #endif // CPPHTTPLIB_HTTPLIB_H