httplib.h 796 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292
  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.60.1"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003c01"
  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. bool is_host(const std::string &s);
  3258. } // namespace fields
  3259. } // namespace detail
  3260. /*
  3261. * TLS Abstraction Layer Declarations
  3262. */
  3263. #ifdef CPPHTTPLIB_SSL_ENABLED
  3264. // TLS abstraction layer - backend-specific type declarations
  3265. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3266. namespace tls {
  3267. namespace impl {
  3268. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3269. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3270. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3271. struct MbedTlsContext {
  3272. mbedtls_ssl_config conf;
  3273. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3274. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3275. mbedtls_entropy_context entropy;
  3276. mbedtls_ctr_drbg_context ctr_drbg;
  3277. #endif
  3278. mbedtls_x509_crt ca_chain;
  3279. mbedtls_x509_crt own_cert;
  3280. mbedtls_pk_context own_key;
  3281. bool is_server = false;
  3282. bool verify_client = false;
  3283. bool has_verify_callback = false;
  3284. MbedTlsContext();
  3285. ~MbedTlsContext();
  3286. MbedTlsContext(const MbedTlsContext &) = delete;
  3287. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3288. };
  3289. } // namespace impl
  3290. } // namespace tls
  3291. #endif
  3292. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3293. namespace tls {
  3294. namespace impl {
  3295. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3296. // This struct is accessible via tls::impl for use in SSL context
  3297. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3298. struct WolfSSLContext {
  3299. WOLFSSL_CTX *ctx = nullptr;
  3300. bool is_server = false;
  3301. bool verify_client = false;
  3302. bool has_verify_callback = false;
  3303. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3304. WolfSSLContext();
  3305. ~WolfSSLContext();
  3306. WolfSSLContext(const WolfSSLContext &) = delete;
  3307. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3308. };
  3309. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3310. struct WolfSSLCAStore {
  3311. std::string pem_data;
  3312. };
  3313. } // namespace impl
  3314. } // namespace tls
  3315. #endif
  3316. #endif // CPPHTTPLIB_SSL_ENABLED
  3317. namespace stream {
  3318. class Result {
  3319. public:
  3320. Result();
  3321. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3322. Result(Result &&other) noexcept;
  3323. Result &operator=(Result &&other) noexcept;
  3324. Result(const Result &) = delete;
  3325. Result &operator=(const Result &) = delete;
  3326. // Response info
  3327. bool is_valid() const;
  3328. explicit operator bool() const;
  3329. int status() const;
  3330. const Headers &headers() const;
  3331. std::string get_header_value(const std::string &key,
  3332. const char *def = "") const;
  3333. bool has_header(const std::string &key) const;
  3334. Error error() const;
  3335. Error read_error() const;
  3336. bool has_read_error() const;
  3337. // Stream reading
  3338. bool next();
  3339. const char *data() const;
  3340. size_t size() const;
  3341. std::string read_all();
  3342. private:
  3343. ClientImpl::StreamHandle handle_;
  3344. std::string buffer_;
  3345. size_t current_size_ = 0;
  3346. size_t chunk_size_;
  3347. bool finished_ = false;
  3348. };
  3349. // GET
  3350. template <typename ClientType>
  3351. inline Result Get(ClientType &cli, const std::string &path,
  3352. size_t chunk_size = 8192) {
  3353. return Result{cli.open_stream("GET", path), chunk_size};
  3354. }
  3355. template <typename ClientType>
  3356. inline Result Get(ClientType &cli, const std::string &path,
  3357. const Headers &headers, size_t chunk_size = 8192) {
  3358. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3359. }
  3360. template <typename ClientType>
  3361. inline Result Get(ClientType &cli, const std::string &path,
  3362. const Params &params, size_t chunk_size = 8192) {
  3363. return Result{cli.open_stream("GET", path, params), chunk_size};
  3364. }
  3365. template <typename ClientType>
  3366. inline Result Get(ClientType &cli, const std::string &path,
  3367. const Params &params, const Headers &headers,
  3368. size_t chunk_size = 8192) {
  3369. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3370. }
  3371. // POST
  3372. template <typename ClientType>
  3373. inline Result Post(ClientType &cli, const std::string &path,
  3374. const std::string &body, const std::string &content_type,
  3375. size_t chunk_size = 8192) {
  3376. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3377. chunk_size};
  3378. }
  3379. template <typename ClientType>
  3380. inline Result Post(ClientType &cli, const std::string &path,
  3381. const Headers &headers, const std::string &body,
  3382. const std::string &content_type, size_t chunk_size = 8192) {
  3383. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3384. chunk_size};
  3385. }
  3386. template <typename ClientType>
  3387. inline Result Post(ClientType &cli, const std::string &path,
  3388. const Params &params, const std::string &body,
  3389. const std::string &content_type, size_t chunk_size = 8192) {
  3390. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3391. chunk_size};
  3392. }
  3393. template <typename ClientType>
  3394. inline Result Post(ClientType &cli, const std::string &path,
  3395. const Params &params, const Headers &headers,
  3396. const std::string &body, const std::string &content_type,
  3397. size_t chunk_size = 8192) {
  3398. return Result{
  3399. cli.open_stream("POST", path, params, headers, body, content_type),
  3400. chunk_size};
  3401. }
  3402. // PUT
  3403. template <typename ClientType>
  3404. inline Result Put(ClientType &cli, const std::string &path,
  3405. const std::string &body, const std::string &content_type,
  3406. size_t chunk_size = 8192) {
  3407. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3408. chunk_size};
  3409. }
  3410. template <typename ClientType>
  3411. inline Result Put(ClientType &cli, const std::string &path,
  3412. const Headers &headers, const std::string &body,
  3413. const std::string &content_type, size_t chunk_size = 8192) {
  3414. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3415. chunk_size};
  3416. }
  3417. template <typename ClientType>
  3418. inline Result Put(ClientType &cli, const std::string &path,
  3419. const Params &params, const std::string &body,
  3420. const std::string &content_type, size_t chunk_size = 8192) {
  3421. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3422. chunk_size};
  3423. }
  3424. template <typename ClientType>
  3425. inline Result Put(ClientType &cli, const std::string &path,
  3426. const Params &params, const Headers &headers,
  3427. const std::string &body, const std::string &content_type,
  3428. size_t chunk_size = 8192) {
  3429. return Result{
  3430. cli.open_stream("PUT", path, params, headers, body, content_type),
  3431. chunk_size};
  3432. }
  3433. // PATCH
  3434. template <typename ClientType>
  3435. inline Result Patch(ClientType &cli, const std::string &path,
  3436. const std::string &body, const std::string &content_type,
  3437. size_t chunk_size = 8192) {
  3438. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3439. chunk_size};
  3440. }
  3441. template <typename ClientType>
  3442. inline Result Patch(ClientType &cli, const std::string &path,
  3443. const Headers &headers, const std::string &body,
  3444. const std::string &content_type, size_t chunk_size = 8192) {
  3445. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3446. chunk_size};
  3447. }
  3448. template <typename ClientType>
  3449. inline Result Patch(ClientType &cli, const std::string &path,
  3450. const Params &params, const std::string &body,
  3451. const std::string &content_type, size_t chunk_size = 8192) {
  3452. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3453. chunk_size};
  3454. }
  3455. template <typename ClientType>
  3456. inline Result Patch(ClientType &cli, const std::string &path,
  3457. const Params &params, const Headers &headers,
  3458. const std::string &body, const std::string &content_type,
  3459. size_t chunk_size = 8192) {
  3460. return Result{
  3461. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3462. chunk_size};
  3463. }
  3464. // DELETE
  3465. template <typename ClientType>
  3466. inline Result Delete(ClientType &cli, const std::string &path,
  3467. size_t chunk_size = 8192) {
  3468. return Result{cli.open_stream("DELETE", path), chunk_size};
  3469. }
  3470. template <typename ClientType>
  3471. inline Result Delete(ClientType &cli, const std::string &path,
  3472. const Headers &headers, size_t chunk_size = 8192) {
  3473. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3474. }
  3475. template <typename ClientType>
  3476. inline Result Delete(ClientType &cli, const std::string &path,
  3477. const std::string &body, const std::string &content_type,
  3478. size_t chunk_size = 8192) {
  3479. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3480. chunk_size};
  3481. }
  3482. template <typename ClientType>
  3483. inline Result Delete(ClientType &cli, const std::string &path,
  3484. const Headers &headers, const std::string &body,
  3485. const std::string &content_type,
  3486. size_t chunk_size = 8192) {
  3487. return Result{
  3488. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3489. chunk_size};
  3490. }
  3491. template <typename ClientType>
  3492. inline Result Delete(ClientType &cli, const std::string &path,
  3493. const Params &params, size_t chunk_size = 8192) {
  3494. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3495. }
  3496. template <typename ClientType>
  3497. inline Result Delete(ClientType &cli, const std::string &path,
  3498. const Params &params, const Headers &headers,
  3499. size_t chunk_size = 8192) {
  3500. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3501. }
  3502. template <typename ClientType>
  3503. inline Result Delete(ClientType &cli, const std::string &path,
  3504. const Params &params, const std::string &body,
  3505. const std::string &content_type,
  3506. size_t chunk_size = 8192) {
  3507. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3508. chunk_size};
  3509. }
  3510. template <typename ClientType>
  3511. inline Result Delete(ClientType &cli, const std::string &path,
  3512. const Params &params, const Headers &headers,
  3513. const std::string &body, const std::string &content_type,
  3514. size_t chunk_size = 8192) {
  3515. return Result{
  3516. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3517. chunk_size};
  3518. }
  3519. // HEAD
  3520. template <typename ClientType>
  3521. inline Result Head(ClientType &cli, const std::string &path,
  3522. size_t chunk_size = 8192) {
  3523. return Result{cli.open_stream("HEAD", path), chunk_size};
  3524. }
  3525. template <typename ClientType>
  3526. inline Result Head(ClientType &cli, const std::string &path,
  3527. const Headers &headers, size_t chunk_size = 8192) {
  3528. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3529. }
  3530. template <typename ClientType>
  3531. inline Result Head(ClientType &cli, const std::string &path,
  3532. const Params &params, size_t chunk_size = 8192) {
  3533. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Head(ClientType &cli, const std::string &path,
  3537. const Params &params, const Headers &headers,
  3538. size_t chunk_size = 8192) {
  3539. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3540. }
  3541. // OPTIONS
  3542. template <typename ClientType>
  3543. inline Result Options(ClientType &cli, const std::string &path,
  3544. size_t chunk_size = 8192) {
  3545. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3546. }
  3547. template <typename ClientType>
  3548. inline Result Options(ClientType &cli, const std::string &path,
  3549. const Headers &headers, size_t chunk_size = 8192) {
  3550. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3551. }
  3552. template <typename ClientType>
  3553. inline Result Options(ClientType &cli, const std::string &path,
  3554. const Params &params, size_t chunk_size = 8192) {
  3555. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3556. }
  3557. template <typename ClientType>
  3558. inline Result Options(ClientType &cli, const std::string &path,
  3559. const Params &params, const Headers &headers,
  3560. size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3562. }
  3563. } // namespace stream
  3564. namespace sse {
  3565. struct SSEMessage {
  3566. std::string event; // Event type (default: "message")
  3567. std::string data; // Event payload
  3568. std::string id; // Event ID for Last-Event-ID header
  3569. SSEMessage();
  3570. void clear();
  3571. };
  3572. class SSEClient {
  3573. public:
  3574. using MessageHandler = std::function<void(const SSEMessage &)>;
  3575. using ErrorHandler = std::function<void(Error)>;
  3576. using OpenHandler = std::function<void()>;
  3577. SSEClient(Client &client, const std::string &path);
  3578. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3579. ~SSEClient();
  3580. SSEClient(const SSEClient &) = delete;
  3581. SSEClient &operator=(const SSEClient &) = delete;
  3582. // Event handlers
  3583. SSEClient &on_message(MessageHandler handler);
  3584. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3585. SSEClient &on_open(OpenHandler handler);
  3586. SSEClient &on_error(ErrorHandler handler);
  3587. SSEClient &set_reconnect_interval(int ms);
  3588. SSEClient &set_max_reconnect_attempts(int n);
  3589. // Update headers (thread-safe)
  3590. SSEClient &set_headers(const Headers &headers);
  3591. // State accessors
  3592. bool is_connected() const;
  3593. const std::string &last_event_id() const;
  3594. // Blocking start - runs event loop with auto-reconnect
  3595. void start();
  3596. // Non-blocking start - runs in background thread
  3597. void start_async();
  3598. // Stop the client (thread-safe)
  3599. void stop();
  3600. private:
  3601. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3602. bool &has_data, bool &has_id);
  3603. void run_event_loop();
  3604. void dispatch_event(const SSEMessage &msg);
  3605. bool should_reconnect(int count) const;
  3606. void wait_for_reconnect();
  3607. // Client and path
  3608. Client &client_;
  3609. std::string path_;
  3610. Headers headers_;
  3611. mutable std::mutex headers_mutex_;
  3612. // Callbacks
  3613. MessageHandler on_message_;
  3614. std::map<std::string, MessageHandler> event_handlers_;
  3615. OpenHandler on_open_;
  3616. ErrorHandler on_error_;
  3617. // Configuration
  3618. int reconnect_interval_ms_ = 3000;
  3619. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3620. // State
  3621. std::atomic<bool> running_{false};
  3622. std::atomic<bool> connected_{false};
  3623. std::string last_event_id_;
  3624. // Async support
  3625. std::thread async_thread_;
  3626. };
  3627. } // namespace sse
  3628. namespace ws {
  3629. class WebSocketClient;
  3630. enum class Opcode : uint8_t {
  3631. Continuation = 0x0,
  3632. Text = 0x1,
  3633. Binary = 0x2,
  3634. Close = 0x8,
  3635. Ping = 0x9,
  3636. Pong = 0xA,
  3637. };
  3638. enum class CloseStatus : uint16_t {
  3639. Normal = 1000,
  3640. GoingAway = 1001,
  3641. ProtocolError = 1002,
  3642. UnsupportedData = 1003,
  3643. NoStatus = 1005,
  3644. Abnormal = 1006,
  3645. InvalidPayload = 1007,
  3646. PolicyViolation = 1008,
  3647. MessageTooBig = 1009,
  3648. MandatoryExtension = 1010,
  3649. InternalError = 1011,
  3650. };
  3651. // Timeout is returned only when a read timeout was set and it elapsed before
  3652. // any byte of a frame arrived: nothing was consumed and the connection is
  3653. // still open, so the caller can send on it and read again. `msg` is left
  3654. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3655. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3656. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3657. // upgrade handshake fully succeeded. On failure error() identifies the
  3658. // failing layer; status()/headers() expose the server's upgrade response
  3659. // when one was received (status() is -1 otherwise).
  3660. class Result {
  3661. public:
  3662. Result() = default;
  3663. Result(Error err, int status, Headers &&headers)
  3664. : err_(err), status_(status), headers_(std::move(headers)) {}
  3665. explicit operator bool() const { return err_ == Error::Success; }
  3666. Error error() const { return err_; }
  3667. // Upgrade response info
  3668. int status() const { return status_; }
  3669. const Headers &headers() const { return headers_; }
  3670. std::string get_header_value(const std::string &key,
  3671. const char *def = "") const {
  3672. return detail::get_header_value(headers_, key, def, 0);
  3673. }
  3674. bool has_header(const std::string &key) const {
  3675. return headers_.find(key) != headers_.end();
  3676. }
  3677. #ifdef CPPHTTPLIB_SSL_ENABLED
  3678. Result(Error err, int status, Headers &&headers, int ssl_error,
  3679. uint64_t ssl_backend_error)
  3680. : err_(err), status_(status), headers_(std::move(headers)),
  3681. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3682. int ssl_error() const { return ssl_error_; }
  3683. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3684. #endif
  3685. private:
  3686. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3687. int status_ = -1;
  3688. Headers headers_;
  3689. #ifdef CPPHTTPLIB_SSL_ENABLED
  3690. int ssl_error_ = 0;
  3691. uint64_t ssl_backend_error_ = 0;
  3692. #endif
  3693. };
  3694. class WebSocket {
  3695. public:
  3696. WebSocket(const WebSocket &) = delete;
  3697. WebSocket &operator=(const WebSocket &) = delete;
  3698. ~WebSocket();
  3699. ReadResult read(std::string &msg);
  3700. bool send(const std::string &data);
  3701. bool send(const char *data, size_t len);
  3702. void close(CloseStatus status = CloseStatus::Normal,
  3703. const std::string &reason = "");
  3704. const Request &request() const;
  3705. bool is_open() const;
  3706. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3707. // A server handler owns its connection's timeout this way; a client sets it
  3708. // through WebSocketClient. Safe to call while another thread is in read().
  3709. //
  3710. // Only a timeout set here is reported as Timeout. The compile-time default
  3711. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3712. // than a request for control, so when it elapses read() returns Fail and
  3713. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3714. void set_read_timeout(time_t sec, time_t usec = 0);
  3715. template <class Rep, class Period>
  3716. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3717. private:
  3718. friend class httplib::Server;
  3719. friend class httplib::ws::WebSocketClient;
  3720. WebSocket(
  3721. Stream &strm, const Request &req, bool is_server,
  3722. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3723. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3724. : strm_(strm), req_(req), is_server_(is_server),
  3725. ping_interval_sec_(ping_interval_sec),
  3726. max_missed_pongs_(max_missed_pongs) {
  3727. start_heartbeat();
  3728. }
  3729. WebSocket(
  3730. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3731. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3732. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3733. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3734. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3735. max_missed_pongs_(max_missed_pongs) {
  3736. start_heartbeat();
  3737. }
  3738. void start_heartbeat();
  3739. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3740. Stream &strm_;
  3741. std::unique_ptr<Stream> owned_strm_;
  3742. Request req_;
  3743. bool is_server_;
  3744. time_t ping_interval_sec_;
  3745. int max_missed_pongs_;
  3746. int unacked_pings_ = 0;
  3747. std::atomic<bool> closed_{false};
  3748. // Set once the caller has bounded read() through set_read_timeout(). Until
  3749. // then the timeout in effect is the compile-time default, and elapsing it
  3750. // is a failure that closes the connection, not a Timeout.
  3751. std::atomic<bool> read_timeout_set_{false};
  3752. std::mutex write_mutex_;
  3753. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3754. // may do so: read_websocket_frame() reads a payload until it has the whole
  3755. // declared length, so a second parser stealing bytes silently corrupts the
  3756. // message the first one is assembling.
  3757. std::mutex read_mutex_;
  3758. std::thread ping_thread_;
  3759. std::mutex ping_mutex_;
  3760. std::condition_variable ping_cv_;
  3761. };
  3762. class WebSocketClient {
  3763. public:
  3764. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3765. const Headers &headers = {});
  3766. ~WebSocketClient();
  3767. WebSocketClient(const WebSocketClient &) = delete;
  3768. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3769. bool is_valid() const;
  3770. Result connect();
  3771. ReadResult read(std::string &msg);
  3772. bool send(const std::string &data);
  3773. bool send(const char *data, size_t len);
  3774. void close(CloseStatus status = CloseStatus::Normal,
  3775. const std::string &reason = "");
  3776. bool is_open() const;
  3777. const std::string &subprotocol() const;
  3778. void set_read_timeout(time_t sec, time_t usec = 0);
  3779. template <class Rep, class Period>
  3780. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3781. void set_write_timeout(time_t sec, time_t usec = 0);
  3782. template <class Rep, class Period>
  3783. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3784. void set_websocket_ping_interval(time_t sec);
  3785. void set_websocket_max_missed_pongs(int count);
  3786. void set_tcp_nodelay(bool on);
  3787. void set_address_family(int family);
  3788. void set_ipv6_v6only(bool on);
  3789. void set_socket_options(SocketOptions socket_options);
  3790. void set_connection_timeout(time_t sec, time_t usec = 0);
  3791. template <class Rep, class Period>
  3792. void
  3793. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3794. void set_interface(const std::string &intf);
  3795. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3796. #ifdef CPPHTTPLIB_SSL_ENABLED
  3797. struct PemMemory {
  3798. const char *cert_pem;
  3799. size_t cert_pem_len;
  3800. const char *key_pem;
  3801. size_t key_pem_len;
  3802. const char *private_key_password;
  3803. };
  3804. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3805. const PemMemory &pem, const Headers &headers = {});
  3806. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3807. const std::string &ca_cert_dir_path = std::string());
  3808. void set_ca_cert_store(tls::ca_store_t store);
  3809. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3810. void enable_server_certificate_verification(bool enabled);
  3811. void enable_server_hostname_verification(bool enabled);
  3812. void enable_system_ca(bool enabled);
  3813. #endif
  3814. private:
  3815. void shutdown_and_close();
  3816. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3817. int &ssl_error, uint64_t &ssl_backend_error);
  3818. void prepare_default_headers(Request &req);
  3819. std::string host_;
  3820. int port_;
  3821. std::string path_;
  3822. Headers headers_;
  3823. std::string subprotocol_;
  3824. bool is_valid_ = false;
  3825. socket_t sock_ = INVALID_SOCKET;
  3826. std::unique_ptr<WebSocket> ws_;
  3827. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3828. time_t read_timeout_usec_ = 0;
  3829. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3830. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3831. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3832. time_t websocket_ping_interval_sec_ =
  3833. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3834. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3835. int address_family_ = AF_UNSPEC;
  3836. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3837. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3838. SocketOptions socket_options_ = nullptr;
  3839. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3840. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3841. std::string interface_;
  3842. // Hostname to connection target map. The value is an IP literal or another
  3843. // hostname; only the connection target changes, never the identity.
  3844. std::map<std::string, std::string> addr_map_;
  3845. #ifdef CPPHTTPLIB_SSL_ENABLED
  3846. bool is_ssl_ = false;
  3847. tls::ctx_t tls_ctx_ = nullptr;
  3848. tls::session_t tls_session_ = nullptr;
  3849. std::string ca_cert_file_path_;
  3850. std::string ca_cert_dir_path_;
  3851. bool custom_ca_loaded_ = false;
  3852. bool certs_loaded_ = false;
  3853. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3854. bool server_certificate_verification_ = true;
  3855. bool server_hostname_verification_ = true;
  3856. #endif
  3857. };
  3858. template <class Rep, class Period>
  3859. inline void WebSocket::set_read_timeout(
  3860. const std::chrono::duration<Rep, Period> &duration) {
  3861. detail::duration_to_sec_and_usec(
  3862. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3863. }
  3864. template <class Rep, class Period>
  3865. inline void WebSocketClient::set_read_timeout(
  3866. const std::chrono::duration<Rep, Period> &duration) {
  3867. detail::duration_to_sec_and_usec(
  3868. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3869. }
  3870. template <class Rep, class Period>
  3871. inline void WebSocketClient::set_write_timeout(
  3872. const std::chrono::duration<Rep, Period> &duration) {
  3873. detail::duration_to_sec_and_usec(
  3874. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3875. }
  3876. template <class Rep, class Period>
  3877. inline void WebSocketClient::set_connection_timeout(
  3878. const std::chrono::duration<Rep, Period> &duration) {
  3879. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3880. set_connection_timeout(sec, usec);
  3881. });
  3882. }
  3883. namespace impl {
  3884. bool is_valid_utf8(const std::string &s);
  3885. // Three states, because a failure that consumed bytes and one that consumed
  3886. // none are not the same thing: the first has left the stream in the middle of
  3887. // a frame and the connection cannot be reused, the second can just be retried.
  3888. enum class FrameRead { Ok, Fail, Timeout };
  3889. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3890. std::string &payload, bool &fin,
  3891. bool expect_masked, size_t max_len);
  3892. } // namespace impl
  3893. } // namespace ws
  3894. // ----------------------------------------------------------------------------
  3895. /*
  3896. * Implementation that will be part of the .cc file if split into .h + .cc.
  3897. */
  3898. namespace stream {
  3899. // stream::Result implementations
  3900. inline Result::Result() : chunk_size_(8192) {}
  3901. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3902. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3903. inline Result::Result(Result &&other) noexcept
  3904. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3905. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3906. finished_(other.finished_) {
  3907. other.current_size_ = 0;
  3908. other.finished_ = true;
  3909. }
  3910. inline Result &Result::operator=(Result &&other) noexcept {
  3911. if (this != &other) {
  3912. handle_ = std::move(other.handle_);
  3913. buffer_ = std::move(other.buffer_);
  3914. current_size_ = other.current_size_;
  3915. chunk_size_ = other.chunk_size_;
  3916. finished_ = other.finished_;
  3917. other.current_size_ = 0;
  3918. other.finished_ = true;
  3919. }
  3920. return *this;
  3921. }
  3922. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3923. inline Result::operator bool() const { return is_valid(); }
  3924. inline int Result::status() const {
  3925. return handle_.response ? handle_.response->status : -1;
  3926. }
  3927. inline const Headers &Result::headers() const {
  3928. static const Headers empty_headers;
  3929. return handle_.response ? handle_.response->headers : empty_headers;
  3930. }
  3931. inline std::string Result::get_header_value(const std::string &key,
  3932. const char *def) const {
  3933. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3934. }
  3935. inline bool Result::has_header(const std::string &key) const {
  3936. return handle_.response ? handle_.response->has_header(key) : false;
  3937. }
  3938. inline Error Result::error() const { return handle_.error; }
  3939. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3940. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3941. inline bool Result::next() {
  3942. if (!handle_.is_valid() || finished_) { return false; }
  3943. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3944. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3945. if (n > 0) {
  3946. current_size_ = static_cast<size_t>(n);
  3947. return true;
  3948. }
  3949. current_size_ = 0;
  3950. finished_ = true;
  3951. return false;
  3952. }
  3953. inline const char *Result::data() const { return buffer_.data(); }
  3954. inline size_t Result::size() const { return current_size_; }
  3955. inline std::string Result::read_all() {
  3956. std::string result;
  3957. while (next()) {
  3958. result.append(data(), size());
  3959. }
  3960. return result;
  3961. }
  3962. } // namespace stream
  3963. namespace sse {
  3964. // SSEMessage implementations
  3965. inline SSEMessage::SSEMessage() : event("message") {}
  3966. inline void SSEMessage::clear() {
  3967. event = "message";
  3968. data.clear();
  3969. id.clear();
  3970. }
  3971. // SSEClient implementations
  3972. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3973. : client_(client), path_(path) {}
  3974. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3975. const Headers &headers)
  3976. : client_(client), path_(path), headers_(headers) {}
  3977. inline SSEClient::~SSEClient() { stop(); }
  3978. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3979. on_message_ = std::move(handler);
  3980. return *this;
  3981. }
  3982. inline SSEClient &SSEClient::on_event(const std::string &type,
  3983. MessageHandler handler) {
  3984. event_handlers_[type] = std::move(handler);
  3985. return *this;
  3986. }
  3987. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3988. on_open_ = std::move(handler);
  3989. return *this;
  3990. }
  3991. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3992. on_error_ = std::move(handler);
  3993. return *this;
  3994. }
  3995. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3996. reconnect_interval_ms_ = ms;
  3997. return *this;
  3998. }
  3999. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4000. max_reconnect_attempts_ = n;
  4001. return *this;
  4002. }
  4003. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4004. std::lock_guard<std::mutex> lock(headers_mutex_);
  4005. headers_ = headers;
  4006. return *this;
  4007. }
  4008. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4009. inline const std::string &SSEClient::last_event_id() const {
  4010. return last_event_id_;
  4011. }
  4012. inline void SSEClient::start() {
  4013. running_.store(true);
  4014. run_event_loop();
  4015. }
  4016. inline void SSEClient::start_async() {
  4017. running_.store(true);
  4018. async_thread_ = std::thread([this]() { run_event_loop(); });
  4019. }
  4020. inline void SSEClient::stop() {
  4021. running_.store(false);
  4022. client_.stop(); // Cancel any pending operations
  4023. if (async_thread_.joinable()) { async_thread_.join(); }
  4024. }
  4025. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4026. int &retry_ms, bool &has_data,
  4027. bool &has_id) {
  4028. // Blank line signals end of event
  4029. if (line.empty()) { return true; }
  4030. // Lines starting with ':' are comments (ignored)
  4031. if (line[0] == ':') { return false; }
  4032. // Find the colon separator
  4033. auto colon_pos = line.find(':');
  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 != std::string::npos && 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. }
  4042. // Handle known fields
  4043. if (field == "event") {
  4044. msg.event = value;
  4045. } else if (field == "data") {
  4046. // Multiple data lines are concatenated with newlines
  4047. if (has_data) { msg.data += "\n"; }
  4048. msg.data += value;
  4049. has_data = true;
  4050. } else if (field == "id") {
  4051. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4052. // valid (clears the last event ID)
  4053. if (detail::fields::is_field_value(value)) {
  4054. msg.id = value;
  4055. has_id = true;
  4056. }
  4057. } else if (field == "retry") {
  4058. // Parse retry interval in milliseconds
  4059. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4060. if (detail::is_numeric(value)) {
  4061. int v = 0;
  4062. auto res =
  4063. detail::from_chars(value.data(), value.data() + value.size(), v);
  4064. if (res.ec == std::errc{}) { retry_ms = v; }
  4065. }
  4066. }
  4067. // Unknown fields are ignored per SSE spec
  4068. return false;
  4069. }
  4070. inline void SSEClient::run_event_loop() {
  4071. auto reconnect_count = 0;
  4072. while (running_.load()) {
  4073. // Build headers, including Last-Event-ID if we have one
  4074. Headers request_headers;
  4075. {
  4076. std::lock_guard<std::mutex> lock(headers_mutex_);
  4077. request_headers = headers_;
  4078. }
  4079. if (!last_event_id_.empty()) {
  4080. request_headers.emplace("Last-Event-ID", last_event_id_);
  4081. }
  4082. // Open streaming connection
  4083. auto result = stream::Get(client_, path_, request_headers);
  4084. // Connection error handling
  4085. if (!result) {
  4086. connected_.store(false);
  4087. if (on_error_) { on_error_(result.error()); }
  4088. if (!should_reconnect(reconnect_count)) { break; }
  4089. wait_for_reconnect();
  4090. reconnect_count++;
  4091. continue;
  4092. }
  4093. if (result.status() != StatusCode::OK_200) {
  4094. connected_.store(false);
  4095. if (on_error_) { on_error_(Error::Connection); }
  4096. // For certain errors, don't reconnect.
  4097. // Note: 401 is intentionally absent so that handlers can refresh
  4098. // credentials via set_headers() and let the client reconnect.
  4099. if (result.status() == StatusCode::NoContent_204 ||
  4100. result.status() == StatusCode::NotFound_404 ||
  4101. result.status() == StatusCode::Forbidden_403) {
  4102. break;
  4103. }
  4104. if (!should_reconnect(reconnect_count)) { break; }
  4105. wait_for_reconnect();
  4106. reconnect_count++;
  4107. continue;
  4108. }
  4109. // Connection successful
  4110. connected_.store(true);
  4111. reconnect_count = 0;
  4112. if (on_open_) { on_open_(); }
  4113. // Event receiving loop
  4114. std::string buffer;
  4115. SSEMessage current_msg;
  4116. auto has_data = false;
  4117. auto has_id = false;
  4118. auto first_line = true;
  4119. auto after_cr = false;
  4120. while (running_.load() && result.next()) {
  4121. // What is left in the buffer has no line ending
  4122. auto search_pos = buffer.size();
  4123. buffer.append(result.data(), result.size());
  4124. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4125. // per the SSE spec
  4126. size_t line_start = 0;
  4127. size_t eol_pos;
  4128. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4129. std::string::npos) {
  4130. auto line = buffer.substr(line_start, eol_pos - line_start);
  4131. line_start = eol_pos + 1;
  4132. search_pos = line_start;
  4133. // The \n of a \r\n may arrive in a later chunk than its \r
  4134. auto is_lf_of_crlf =
  4135. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4136. after_cr = buffer[eol_pos] == '\r';
  4137. if (is_lf_of_crlf) { continue; }
  4138. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4139. if (first_line) {
  4140. first_line = false;
  4141. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4142. }
  4143. // Parse the line and check if event is complete
  4144. auto event_complete = parse_sse_line(
  4145. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4146. if (event_complete) {
  4147. // Update last_event_id for reconnection, even for an event that
  4148. // has no data. An empty id clears it.
  4149. if (has_id) { last_event_id_ = current_msg.id; }
  4150. // An event without a data field is not dispatched
  4151. if (has_data) { dispatch_event(current_msg); }
  4152. // Reset the message for the next event either way
  4153. current_msg.clear();
  4154. has_data = false;
  4155. has_id = false;
  4156. }
  4157. }
  4158. // Keep unprocessed data in buffer
  4159. buffer.erase(0, line_start);
  4160. }
  4161. // Connection ended
  4162. connected_.store(false);
  4163. if (!running_.load()) { break; }
  4164. // Check for read errors
  4165. if (result.has_read_error()) {
  4166. if (on_error_) { on_error_(result.read_error()); }
  4167. }
  4168. if (!should_reconnect(reconnect_count)) { break; }
  4169. wait_for_reconnect();
  4170. reconnect_count++;
  4171. }
  4172. connected_.store(false);
  4173. }
  4174. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4175. // Check for specific event type handler first
  4176. auto it = event_handlers_.find(msg.event);
  4177. if (it != event_handlers_.end()) {
  4178. it->second(msg);
  4179. return;
  4180. }
  4181. // Fall back to generic message handler
  4182. if (on_message_) { on_message_(msg); }
  4183. }
  4184. inline bool SSEClient::should_reconnect(int count) const {
  4185. if (!running_.load()) { return false; }
  4186. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4187. return count < max_reconnect_attempts_;
  4188. }
  4189. inline void SSEClient::wait_for_reconnect() {
  4190. // Use small increments to check running_ flag frequently.
  4191. // Always wait at least one increment, so that a zero interval (e.g.
  4192. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4193. const auto step_ms = 100;
  4194. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4195. auto waited = 0;
  4196. while (running_.load() && waited < interval_ms) {
  4197. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4198. waited += step_ms;
  4199. }
  4200. }
  4201. } // namespace sse
  4202. #ifdef CPPHTTPLIB_SSL_ENABLED
  4203. /*
  4204. * TLS abstraction layer - internal function declarations
  4205. * These are implementation details and not part of the public API.
  4206. */
  4207. namespace tls {
  4208. // Client context
  4209. ctx_t create_client_context();
  4210. void free_context(ctx_t ctx);
  4211. bool set_min_version(ctx_t ctx, Version version);
  4212. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4213. bool load_ca_file(ctx_t ctx, const char *file_path);
  4214. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4215. bool load_system_certs(ctx_t ctx);
  4216. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4217. const char *password);
  4218. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4219. const char *key_path, const char *password);
  4220. // Server context
  4221. ctx_t create_server_context();
  4222. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4223. const char *password);
  4224. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4225. const char *key_path, const char *password);
  4226. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4227. void set_verify_client(ctx_t ctx, bool require);
  4228. // Session management
  4229. session_t create_session(ctx_t ctx, socket_t sock);
  4230. void free_session(session_t session);
  4231. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4232. // Handshake (non-blocking capable)
  4233. TlsError connect(session_t session);
  4234. TlsError accept(session_t session);
  4235. // Handshake with timeout (blocking until timeout)
  4236. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4237. time_t timeout_usec, TlsError *err);
  4238. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4239. time_t timeout_usec, TlsError *err);
  4240. // I/O (non-blocking capable)
  4241. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4242. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4243. int pending(const_session_t session);
  4244. void shutdown(session_t session, bool graceful);
  4245. // Connection state
  4246. bool is_peer_closed(session_t session, socket_t sock);
  4247. // Certificate verification
  4248. cert_t get_peer_cert(const_session_t session);
  4249. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4250. // do not use them after free_session(), as with get_peer_cert().
  4251. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4252. void free_cert(cert_t cert);
  4253. bool verify_hostname(cert_t cert, const char *hostname);
  4254. uint64_t hostname_mismatch_code();
  4255. long get_verify_result(const_session_t session);
  4256. // Certificate introspection
  4257. std::string get_cert_subject_cn(cert_t cert);
  4258. std::string get_cert_issuer_name(cert_t cert);
  4259. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4260. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4261. std::string get_cert_serial(cert_t cert);
  4262. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4263. const char *get_sni(const_session_t session);
  4264. // CA store management
  4265. ca_store_t create_ca_store(const char *pem, size_t len);
  4266. void free_ca_store(ca_store_t store);
  4267. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4268. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4269. std::vector<std::string> get_ca_names(ctx_t ctx);
  4270. // Dynamic certificate update (for servers)
  4271. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4272. const char *password);
  4273. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4274. // Certificate verification callback
  4275. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4276. long get_verify_error(const_session_t session);
  4277. std::string verify_error_string(long error_code);
  4278. // TlsError information
  4279. uint64_t peek_error();
  4280. uint64_t get_error();
  4281. std::string error_string(uint64_t code);
  4282. } // namespace tls
  4283. #endif // CPPHTTPLIB_SSL_ENABLED
  4284. /*
  4285. * Group 1: detail namespace - Non-SSL utilities
  4286. */
  4287. namespace detail {
  4288. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4289. const void *optval, socklen_t optlen) {
  4290. return setsockopt(sock, level, optname,
  4291. #ifdef _WIN32
  4292. reinterpret_cast<const char *>(optval),
  4293. #else
  4294. optval,
  4295. #endif
  4296. optlen) == 0;
  4297. }
  4298. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4299. time_t sec, time_t usec) {
  4300. #ifdef _WIN32
  4301. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4302. #else
  4303. timeval timeout;
  4304. timeout.tv_sec = static_cast<long>(sec);
  4305. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4306. #endif
  4307. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4308. }
  4309. inline bool is_hex(char c, int &v) {
  4310. if (is_ascii_digit(c)) {
  4311. v = c - '0';
  4312. return true;
  4313. } else if ('A' <= c && c <= 'F') {
  4314. v = c - 'A' + 10;
  4315. return true;
  4316. } else if ('a' <= c && c <= 'f') {
  4317. v = c - 'a' + 10;
  4318. return true;
  4319. }
  4320. return false;
  4321. }
  4322. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4323. int &val) {
  4324. if (i >= s.size()) { return false; }
  4325. val = 0;
  4326. for (; cnt; i++, cnt--) {
  4327. if (!s[i]) { return false; }
  4328. auto v = 0;
  4329. if (is_hex(s[i], v)) {
  4330. val = val * 16 + v;
  4331. } else {
  4332. return false;
  4333. }
  4334. }
  4335. return true;
  4336. }
  4337. inline std::string from_i_to_hex(size_t n) {
  4338. static const auto charset = "0123456789abcdef";
  4339. std::string ret;
  4340. do {
  4341. ret = charset[n & 15] + ret;
  4342. n >>= 4;
  4343. } while (n > 0);
  4344. return ret;
  4345. }
  4346. inline std::string compute_etag(const FileStat &fs,
  4347. const std::string &suffix = std::string()) {
  4348. if (!fs.is_file()) { return std::string(); }
  4349. // If mtime cannot be determined (negative value indicates an error
  4350. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4351. // value like 0 could collide with a real file that legitimately has
  4352. // mtime == 0 (epoch) and lead to misleading validators.
  4353. auto mtime_raw = fs.mtime();
  4354. if (mtime_raw < 0) { return std::string(); }
  4355. auto mtime = static_cast<size_t>(mtime_raw);
  4356. auto size = fs.size();
  4357. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4358. from_i_to_hex(size) + suffix + "\"";
  4359. }
  4360. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4361. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4362. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4363. inline std::string file_mtime_to_http_date(time_t mtime) {
  4364. if (mtime < 0) { return std::string(); }
  4365. struct tm tm_buf;
  4366. #ifdef _WIN32
  4367. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4368. #else
  4369. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4370. #endif
  4371. char buf[64];
  4372. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4373. return std::string();
  4374. }
  4375. return std::string(buf);
  4376. }
  4377. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4378. inline time_t parse_http_date(const std::string &date_str) {
  4379. struct tm tm_buf;
  4380. // Create a classic locale object once for all parsing attempts
  4381. const std::locale classic_locale = std::locale::classic();
  4382. // Try to parse using std::get_time (C++11, cross-platform)
  4383. auto try_parse = [&](const char *fmt) -> bool {
  4384. std::istringstream ss(date_str);
  4385. ss.imbue(classic_locale);
  4386. memset(&tm_buf, 0, sizeof(tm_buf));
  4387. ss >> std::get_time(&tm_buf, fmt);
  4388. return !ss.fail();
  4389. };
  4390. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4391. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4392. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4393. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4394. // asctime format: "Sun Nov 6 08:49:37 1994"
  4395. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4396. return static_cast<time_t>(-1);
  4397. }
  4398. }
  4399. }
  4400. #ifdef _WIN32
  4401. return _mkgmtime(&tm_buf);
  4402. #elif defined _AIX
  4403. return mktime(&tm_buf);
  4404. #else
  4405. return timegm(&tm_buf);
  4406. #endif
  4407. }
  4408. inline bool is_weak_etag(const std::string &s) {
  4409. // Check if the string is a weak ETag (starts with 'W/"')
  4410. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4411. }
  4412. inline bool is_strong_etag(const std::string &s) {
  4413. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4414. // chars)
  4415. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4416. }
  4417. inline size_t to_utf8(int code, char *buff) {
  4418. if (code < 0x0080) {
  4419. buff[0] = static_cast<char>(code & 0x7F);
  4420. return 1;
  4421. } else if (code < 0x0800) {
  4422. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4423. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4424. return 2;
  4425. } else if (code < 0xD800) {
  4426. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4427. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4428. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4429. return 3;
  4430. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4431. return 0;
  4432. } else if (code < 0x10000) {
  4433. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4434. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4435. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4436. return 3;
  4437. } else if (code < 0x110000) {
  4438. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4439. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4440. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4441. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4442. return 4;
  4443. }
  4444. // NOTREACHED
  4445. return 0;
  4446. }
  4447. } // namespace detail
  4448. namespace ws {
  4449. namespace impl {
  4450. inline bool is_valid_utf8(const std::string &s) {
  4451. size_t i = 0;
  4452. auto n = s.size();
  4453. while (i < n) {
  4454. auto c = static_cast<unsigned char>(s[i]);
  4455. size_t len;
  4456. uint32_t cp;
  4457. if (c < 0x80) {
  4458. i++;
  4459. continue;
  4460. } else if ((c & 0xE0) == 0xC0) {
  4461. len = 2;
  4462. cp = c & 0x1F;
  4463. } else if ((c & 0xF0) == 0xE0) {
  4464. len = 3;
  4465. cp = c & 0x0F;
  4466. } else if ((c & 0xF8) == 0xF0) {
  4467. len = 4;
  4468. cp = c & 0x07;
  4469. } else {
  4470. return false;
  4471. }
  4472. if (i + len > n) { return false; }
  4473. for (size_t j = 1; j < len; j++) {
  4474. auto b = static_cast<unsigned char>(s[i + j]);
  4475. if ((b & 0xC0) != 0x80) { return false; }
  4476. cp = (cp << 6) | (b & 0x3F);
  4477. }
  4478. // Overlong encoding check
  4479. if (len == 2 && cp < 0x80) { return false; }
  4480. if (len == 3 && cp < 0x800) { return false; }
  4481. if (len == 4 && cp < 0x10000) { return false; }
  4482. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4483. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4484. if (cp > 0x10FFFF) { return false; }
  4485. i += len;
  4486. }
  4487. return true;
  4488. }
  4489. } // namespace impl
  4490. } // namespace ws
  4491. namespace detail {
  4492. // NOTE: This code came up with the following stackoverflow post:
  4493. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4494. inline std::string base64_encode(const std::string &in) {
  4495. static const auto lookup =
  4496. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4497. std::string out;
  4498. out.reserve(in.size());
  4499. // Unsigned: the accumulator is never masked, so with a signed int the
  4500. // `val << 8` below overflows once enough bytes are folded in (undefined
  4501. // behaviour before C++20). Only the low bits are ever emitted, so the
  4502. // wrap-around of an unsigned accumulator does not affect the output.
  4503. uint32_t val = 0;
  4504. auto valb = -6;
  4505. for (auto c : in) {
  4506. val = (val << 8) + static_cast<uint8_t>(c);
  4507. valb += 8;
  4508. while (valb >= 0) {
  4509. out.push_back(lookup[(val >> valb) & 0x3F]);
  4510. valb -= 6;
  4511. }
  4512. }
  4513. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4514. while (out.size() % 4) {
  4515. out.push_back('=');
  4516. }
  4517. return out;
  4518. }
  4519. inline std::string sha1(const std::string &input) {
  4520. // RFC 3174 SHA-1 implementation
  4521. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4522. return (x << n) | (x >> (32 - n));
  4523. };
  4524. uint32_t h0 = 0x67452301;
  4525. uint32_t h1 = 0xEFCDAB89;
  4526. uint32_t h2 = 0x98BADCFE;
  4527. uint32_t h3 = 0x10325476;
  4528. uint32_t h4 = 0xC3D2E1F0;
  4529. // Pre-processing: adding padding bits
  4530. std::string msg = input;
  4531. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4532. msg.push_back(static_cast<char>(0x80u));
  4533. while (msg.size() % 64 != 56) {
  4534. msg.push_back(0);
  4535. }
  4536. // Append original length in bits as 64-bit big-endian
  4537. for (int i = 56; i >= 0; i -= 8) {
  4538. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4539. }
  4540. // Process each 512-bit chunk
  4541. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4542. uint32_t w[80];
  4543. for (size_t i = 0; i < 16; i++) {
  4544. w[i] =
  4545. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4546. << 24) |
  4547. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4548. << 16) |
  4549. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4550. << 8) |
  4551. (static_cast<uint32_t>(
  4552. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4553. }
  4554. for (int i = 16; i < 80; i++) {
  4555. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4556. }
  4557. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4558. for (int i = 0; i < 80; i++) {
  4559. uint32_t f, k;
  4560. if (i < 20) {
  4561. f = (b & c) | ((~b) & d);
  4562. k = 0x5A827999;
  4563. } else if (i < 40) {
  4564. f = b ^ c ^ d;
  4565. k = 0x6ED9EBA1;
  4566. } else if (i < 60) {
  4567. f = (b & c) | (b & d) | (c & d);
  4568. k = 0x8F1BBCDC;
  4569. } else {
  4570. f = b ^ c ^ d;
  4571. k = 0xCA62C1D6;
  4572. }
  4573. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4574. e = d;
  4575. d = c;
  4576. c = left_rotate(b, 30);
  4577. b = a;
  4578. a = temp;
  4579. }
  4580. h0 += a;
  4581. h1 += b;
  4582. h2 += c;
  4583. h3 += d;
  4584. h4 += e;
  4585. }
  4586. // Produce the final hash as a 20-byte binary string
  4587. std::string hash(20, '\0');
  4588. for (size_t i = 0; i < 4; i++) {
  4589. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4590. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4591. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4592. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4593. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4594. }
  4595. return hash;
  4596. }
  4597. inline std::string websocket_accept_key(const std::string &client_key) {
  4598. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4599. return base64_encode(sha1(client_key + magic));
  4600. }
  4601. inline bool is_websocket_upgrade(const Request &req) {
  4602. if (req.method != "GET") { return false; }
  4603. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4604. // list of protocols and asks recipients to match each name
  4605. // case-insensitively, so look for the token rather than compare the whole
  4606. // field value.
  4607. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4608. // Check Connection: Upgrade
  4609. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4610. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4611. // RFC 6455 Section 4.2.1
  4612. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4613. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4614. return false;
  4615. }
  4616. static const std::string b64chars =
  4617. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4618. for (size_t i = 0; i < 22; i++) {
  4619. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4620. }
  4621. // Check Sec-WebSocket-Version: 13
  4622. auto version = req.get_header_value("Sec-WebSocket-Version");
  4623. if (version != "13") { return false; }
  4624. return true;
  4625. }
  4626. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4627. const char *data, size_t len, bool fin,
  4628. bool mask) {
  4629. // First byte: FIN + opcode
  4630. uint8_t header[2];
  4631. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4632. (static_cast<uint8_t>(opcode) & 0x0F));
  4633. // Second byte: MASK + payload length
  4634. if (len < 126) {
  4635. header[1] = static_cast<uint8_t>(len);
  4636. if (mask) { header[1] |= 0x80; }
  4637. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4638. } else if (len <= 0xFFFF) {
  4639. header[1] = 126;
  4640. if (mask) { header[1] |= 0x80; }
  4641. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4642. uint8_t ext[2];
  4643. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4644. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4645. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4646. } else {
  4647. header[1] = 127;
  4648. if (mask) { header[1] |= 0x80; }
  4649. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4650. uint8_t ext[8];
  4651. for (int i = 7; i >= 0; i--) {
  4652. ext[7 - i] =
  4653. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4654. }
  4655. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4656. }
  4657. if (mask) {
  4658. // Generate random mask key
  4659. thread_local std::mt19937 rng(std::random_device{}());
  4660. uint8_t mask_key[4];
  4661. auto r = rng();
  4662. std::memcpy(mask_key, &r, 4);
  4663. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4664. // Write masked payload in chunks
  4665. const size_t chunk_size = 4096;
  4666. std::vector<char> buf((std::min)(len, chunk_size));
  4667. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4668. size_t n = (std::min)(chunk_size, len - offset);
  4669. for (size_t i = 0; i < n; i++) {
  4670. buf[i] =
  4671. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4672. }
  4673. if (strm.write(buf.data(), n) < 0) { return false; }
  4674. }
  4675. } else {
  4676. if (len > 0) {
  4677. if (strm.write(data, len) < 0) { return false; }
  4678. }
  4679. }
  4680. return true;
  4681. }
  4682. } // namespace detail
  4683. namespace ws {
  4684. namespace impl {
  4685. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4686. // hands back whatever its buffer already holds -- so every multi-byte field has
  4687. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4688. // header straddles the read buffer's boundary.
  4689. //
  4690. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4691. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4692. // there is a failure like any other. (When read() fails it always records why,
  4693. // so the error belongs to this call and not to an earlier one.)
  4694. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4695. auto p = static_cast<char *>(buf);
  4696. size_t total = 0;
  4697. while (total < size) {
  4698. auto n = strm.read(p + total, size - total);
  4699. if (n <= 0) {
  4700. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4701. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4702. }
  4703. total += static_cast<size_t>(n);
  4704. }
  4705. return FrameRead::Ok;
  4706. }
  4707. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4708. std::string &payload, bool &fin,
  4709. bool expect_masked, size_t max_len) {
  4710. // Read first 2 bytes. This is the only read that may report a timeout: it
  4711. // sits on a frame boundary, where nothing has been consumed yet.
  4712. uint8_t header[2];
  4713. FrameRead first = read_exact(strm, header, 2);
  4714. if (first != FrameRead::Ok) { return first; }
  4715. fin = (header[0] & 0x80) != 0;
  4716. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4717. if (header[0] & 0x70) { return FrameRead::Fail; }
  4718. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4719. bool masked = (header[1] & 0x80) != 0;
  4720. uint64_t payload_len = header[1] & 0x7F;
  4721. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4722. // MUST have a payload length of 125 bytes or less
  4723. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4724. if (is_control) {
  4725. if (!fin) { return FrameRead::Fail; }
  4726. if (payload_len > 125) { return FrameRead::Fail; }
  4727. }
  4728. if (masked != expect_masked) { return FrameRead::Fail; }
  4729. // Extended payload length
  4730. if (payload_len == 126) {
  4731. uint8_t ext[2];
  4732. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4733. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4734. } else if (payload_len == 127) {
  4735. uint8_t ext[8];
  4736. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4737. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4738. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4739. payload_len = 0;
  4740. for (int i = 0; i < 8; i++) {
  4741. payload_len = (payload_len << 8) | ext[i];
  4742. }
  4743. }
  4744. if (payload_len > max_len) { return FrameRead::Fail; }
  4745. // Read mask key if present
  4746. uint8_t mask_key[4] = {0};
  4747. if (masked) {
  4748. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4749. return FrameRead::Fail;
  4750. }
  4751. }
  4752. // Read payload
  4753. payload.resize(static_cast<size_t>(payload_len));
  4754. if (payload_len > 0 &&
  4755. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4756. FrameRead::Ok) {
  4757. return FrameRead::Fail;
  4758. }
  4759. // Unmask if needed
  4760. if (masked) {
  4761. for (size_t i = 0; i < payload.size(); i++) {
  4762. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4763. }
  4764. }
  4765. return FrameRead::Ok;
  4766. }
  4767. } // namespace impl
  4768. } // namespace ws
  4769. namespace detail {
  4770. inline bool is_valid_path(const std::string &path) {
  4771. size_t level = 0;
  4772. size_t i = 0;
  4773. // Skip slash
  4774. while (i < path.size() && path[i] == '/') {
  4775. i++;
  4776. }
  4777. while (i < path.size()) {
  4778. // Read component
  4779. auto beg = i;
  4780. while (i < path.size() && path[i] != '/') {
  4781. if (path[i] == '\0') {
  4782. return false;
  4783. } else if (path[i] == '\\') {
  4784. return false;
  4785. }
  4786. i++;
  4787. }
  4788. auto len = i - beg;
  4789. assert(len > 0);
  4790. if (!path.compare(beg, len, ".")) {
  4791. ;
  4792. } else if (!path.compare(beg, len, "..")) {
  4793. if (level == 0) { return false; }
  4794. level--;
  4795. } else {
  4796. level++;
  4797. }
  4798. // Skip slash
  4799. while (i < path.size() && path[i] == '/') {
  4800. i++;
  4801. }
  4802. }
  4803. return true;
  4804. }
  4805. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4806. #if defined(_WIN32)
  4807. char buf[_MAX_PATH];
  4808. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4809. resolved = buf;
  4810. #elif defined(PATH_MAX)
  4811. char buf[PATH_MAX];
  4812. if (realpath(path, buf) == nullptr) { return false; }
  4813. resolved = buf;
  4814. #else
  4815. auto buf = realpath(path, nullptr);
  4816. auto guard = scope_exit([&]() { std::free(buf); });
  4817. if (buf == nullptr) { return false; }
  4818. resolved = buf;
  4819. #endif
  4820. return true;
  4821. }
  4822. inline bool is_path_within_base(const std::string &resolved_path,
  4823. const std::string &resolved_base) {
  4824. #if defined(_WIN32)
  4825. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4826. resolved_base.size()) == 0;
  4827. #else
  4828. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4829. resolved_base.size()) == 0;
  4830. #endif
  4831. }
  4832. inline FileStat::FileStat(const std::string &path) {
  4833. #if defined(_WIN32)
  4834. auto wpath = u8string_to_wstring(path.c_str());
  4835. ret_ = _wstat(wpath.c_str(), &st_);
  4836. #else
  4837. ret_ = stat(path.c_str(), &st_);
  4838. #endif
  4839. }
  4840. inline bool FileStat::is_file() const {
  4841. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4842. }
  4843. inline bool FileStat::is_dir() const {
  4844. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4845. }
  4846. inline time_t FileStat::mtime() const {
  4847. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4848. : static_cast<time_t>(-1);
  4849. }
  4850. inline size_t FileStat::size() const {
  4851. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4852. }
  4853. inline std::string encode_path(const std::string &s) {
  4854. std::string result;
  4855. result.reserve(s.size());
  4856. for (size_t i = 0; s[i]; i++) {
  4857. switch (s[i]) {
  4858. case ' ': result += "%20"; break;
  4859. case '+': result += "%2B"; break;
  4860. case '\'': result += "%27"; break;
  4861. case ',': result += "%2C"; break;
  4862. // case ':': result += "%3A"; break; // ok? probably...
  4863. case ';': result += "%3B"; break;
  4864. default:
  4865. auto c = static_cast<uint8_t>(s[i]);
  4866. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4867. // in a request-target as-is.
  4868. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4869. result += '%';
  4870. char hex[4];
  4871. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4872. assert(len == 2);
  4873. result.append(hex, static_cast<size_t>(len));
  4874. } else {
  4875. result += s[i];
  4876. }
  4877. break;
  4878. }
  4879. }
  4880. return result;
  4881. }
  4882. inline std::string file_extension(const std::string &path) {
  4883. std::smatch m;
  4884. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4885. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4886. return std::string();
  4887. }
  4888. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4889. template <typename T>
  4890. inline bool parse_header(const char *beg, const char *end, T fn);
  4891. template <typename T>
  4892. inline bool parse_header(const char *beg, const char *end, T fn) {
  4893. // Skip trailing spaces and tabs.
  4894. while (beg < end && is_space_or_tab(end[-1])) {
  4895. end--;
  4896. }
  4897. auto p = beg;
  4898. while (p < end && *p != ':') {
  4899. p++;
  4900. }
  4901. auto name = std::string(beg, p);
  4902. if (!detail::fields::is_field_name(name)) { return false; }
  4903. if (p == end) { return false; }
  4904. auto key_end = p;
  4905. if (*p++ != ':') { return false; }
  4906. while (p < end && is_space_or_tab(*p)) {
  4907. p++;
  4908. }
  4909. if (p <= end) {
  4910. auto key_len = key_end - beg;
  4911. if (!key_len) { return false; }
  4912. auto key = std::string(beg, key_end);
  4913. auto val = std::string(p, end);
  4914. if (!detail::fields::is_field_value(val)) { return false; }
  4915. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4916. // percent-decoded by the recipient. Applications that need to interpret a
  4917. // value as a URI component should call httplib::decode_uri_component()
  4918. // (or decode_path_component()) explicitly.
  4919. fn(key, val);
  4920. return true;
  4921. }
  4922. return false;
  4923. }
  4924. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4925. const Headers &src_headers) {
  4926. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4927. // transfer coding is complete when a chunk with a chunk-size of zero is
  4928. // received, possibly followed by a trailer section, and finally terminated by
  4929. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4930. //
  4931. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4932. // doesn't care for the existence of the final CRLF. In other words, it seems
  4933. // to be ok whether the final CRLF exists or not in the chunked data.
  4934. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4935. //
  4936. // According to the reference code in RFC 9112, cpp-httplib now allows
  4937. // chunked transfer coding data without the final CRLF.
  4938. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4939. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4940. "transfer-encoding",
  4941. "content-length",
  4942. "host",
  4943. "authorization",
  4944. "www-authenticate",
  4945. "proxy-authenticate",
  4946. "proxy-authorization",
  4947. "cookie",
  4948. "set-cookie",
  4949. "cache-control",
  4950. "expect",
  4951. "max-forwards",
  4952. "pragma",
  4953. "range",
  4954. "te",
  4955. "age",
  4956. "expires",
  4957. "date",
  4958. "location",
  4959. "retry-after",
  4960. "vary",
  4961. "warning",
  4962. "content-encoding",
  4963. "content-type",
  4964. "content-range",
  4965. "trailer"};
  4966. case_ignore::unordered_set<std::string> declared_trailers;
  4967. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4968. if (!trailer_header.empty()) {
  4969. // split() trims each token and skips empty ones, so the name arrives ready
  4970. // to look up.
  4971. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4972. ',', [&](const char *b, const char *e) {
  4973. // A legitimate message declares only a handful of trailers. Cap the
  4974. // set so a peer cannot grow it without bound: an oversized set only
  4975. // arises from an attempt to force many colliding names into
  4976. // quadratic lookups (case_ignore::hash is unkeyed).
  4977. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4978. return;
  4979. }
  4980. std::string key(b, e);
  4981. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4982. declared_trailers.insert(key);
  4983. }
  4984. });
  4985. }
  4986. size_t trailer_header_count = 0;
  4987. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4988. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4989. // Count every received trailer field, not only the declared ones stored in
  4990. // dest, so undeclared fields cannot keep this loop running past the limit.
  4991. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4992. constexpr auto line_terminator_len = 2;
  4993. auto line_beg = line_reader.ptr();
  4994. auto line_end =
  4995. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4996. if (!parse_header(line_beg, line_end,
  4997. [&](const std::string &key, const std::string &val) {
  4998. if (declared_trailers.find(key) !=
  4999. declared_trailers.end()) {
  5000. dest.emplace(key, val);
  5001. }
  5002. })) {
  5003. return false;
  5004. }
  5005. trailer_header_count++;
  5006. if (!line_reader.getline()) { return false; }
  5007. }
  5008. return true;
  5009. }
  5010. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5011. size_t right) {
  5012. while (b + left < e && is_space_or_tab(b[left])) {
  5013. left++;
  5014. }
  5015. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5016. right--;
  5017. }
  5018. return std::make_pair(left, right);
  5019. }
  5020. inline std::string trim_copy(const std::string &s) {
  5021. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5022. return s.substr(r.first, r.second - r.first);
  5023. }
  5024. inline std::string trim_double_quotes_copy(const std::string &s) {
  5025. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5026. return s.substr(1, s.size() - 2);
  5027. }
  5028. return s;
  5029. }
  5030. inline void
  5031. divide(const char *data, std::size_t size, char d,
  5032. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5033. fn) {
  5034. const auto it = std::find(data, data + size, d);
  5035. const auto found = static_cast<std::size_t>(it != data + size);
  5036. const auto lhs_data = data;
  5037. const auto lhs_size = static_cast<std::size_t>(it - data);
  5038. const auto rhs_data = it + found;
  5039. const auto rhs_size = size - lhs_size - found;
  5040. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5041. }
  5042. inline void
  5043. divide(const std::string &str, char d,
  5044. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5045. fn) {
  5046. divide(str.data(), str.size(), d, std::move(fn));
  5047. }
  5048. inline void split(const char *b, const char *e, char d,
  5049. std::function<void(const char *, const char *)> fn) {
  5050. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5051. }
  5052. inline void split(const char *b, const char *e, char d, size_t m,
  5053. std::function<void(const char *, const char *)> fn) {
  5054. size_t i = 0;
  5055. size_t beg = 0;
  5056. size_t count = 1;
  5057. while (e ? (b + i < e) : (b[i] != '\0')) {
  5058. if (b[i] == d && 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. // Same contract as split(), except that a delimiter inside a quoted-string is
  5072. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5073. // quoted-string, and ';' and '=' are legal characters inside one.
  5074. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5075. std::function<void(const char *, const char *)> fn) {
  5076. size_t i = 0;
  5077. size_t beg = 0;
  5078. size_t count = 1;
  5079. auto in_quotes = false;
  5080. while (e ? (b + i < e) : (b[i] != '\0')) {
  5081. if (b[i] == '"') {
  5082. in_quotes = !in_quotes;
  5083. } else if (b[i] == d && !in_quotes && count < m) {
  5084. auto r = trim(b, e, beg, i);
  5085. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5086. beg = i + 1;
  5087. count++;
  5088. }
  5089. i++;
  5090. }
  5091. if (i) {
  5092. auto r = trim(b, e, beg, i);
  5093. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5094. }
  5095. }
  5096. inline void split_unquoted(const char *b, const char *e, char d,
  5097. std::function<void(const char *, const char *)> fn) {
  5098. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5099. std::move(fn));
  5100. }
  5101. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5102. // key a token, so the first '=' is the separator even when the value is a
  5103. // quoted-string carrying more of them.
  5104. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5105. std::string &val) {
  5106. divide(
  5107. b, static_cast<std::size_t>(e - b), '=',
  5108. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5109. const auto kr = trim(kb, kb + klen, 0, klen);
  5110. key.assign(kb + kr.first, kb + kr.second);
  5111. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5112. val.assign(vb + vr.first, vb + vr.second);
  5113. });
  5114. }
  5115. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5116. std::function<bool(const char *, const char *)> fn) {
  5117. size_t i = 0;
  5118. size_t beg = 0;
  5119. size_t count = 1;
  5120. while (e ? (b + i < e) : (b[i] != '\0')) {
  5121. if (b[i] == d && count < m) {
  5122. auto r = trim(b, e, beg, i);
  5123. if (r.first < r.second) {
  5124. auto found = fn(&b[r.first], &b[r.second]);
  5125. if (found) { return true; }
  5126. }
  5127. beg = i + 1;
  5128. count++;
  5129. }
  5130. i++;
  5131. }
  5132. if (i) {
  5133. auto r = trim(b, e, beg, i);
  5134. if (r.first < r.second) {
  5135. auto found = fn(&b[r.first], &b[r.second]);
  5136. if (found) { return true; }
  5137. }
  5138. }
  5139. return false;
  5140. }
  5141. inline bool split_find(const char *b, const char *e, char d,
  5142. std::function<bool(const char *, const char *)> fn) {
  5143. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5144. std::move(fn));
  5145. }
  5146. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5147. size_t fixed_buffer_size)
  5148. : strm_(strm), fixed_buffer_(fixed_buffer),
  5149. fixed_buffer_size_(fixed_buffer_size) {}
  5150. inline const char *stream_line_reader::ptr() const {
  5151. if (growable_buffer_.empty()) {
  5152. return fixed_buffer_;
  5153. } else {
  5154. return growable_buffer_.data();
  5155. }
  5156. }
  5157. inline size_t stream_line_reader::size() const {
  5158. if (growable_buffer_.empty()) {
  5159. return fixed_buffer_used_size_;
  5160. } else {
  5161. return growable_buffer_.size();
  5162. }
  5163. }
  5164. inline bool stream_line_reader::end_with_crlf() const {
  5165. auto end = ptr() + size();
  5166. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5167. }
  5168. inline bool stream_line_reader::getline() {
  5169. fixed_buffer_used_size_ = 0;
  5170. growable_buffer_.clear();
  5171. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5172. char prev_byte = 0;
  5173. #endif
  5174. for (size_t i = 0;; i++) {
  5175. // Fast path: whatever the stream has already buffered can be scanned for
  5176. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5177. // call, a bounds check and a one-byte copy per character of the request.
  5178. size_t buffered_size = 0;
  5179. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5180. auto take = buffered_size;
  5181. auto terminated = false;
  5182. for (size_t at = 0; at < buffered_size;) {
  5183. auto nl = static_cast<const char *>(
  5184. memchr(buffered + at, '\n', buffered_size - at));
  5185. if (!nl) { break; }
  5186. auto pos = static_cast<size_t>(nl - buffered);
  5187. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5188. take = pos + 1;
  5189. terminated = true;
  5190. break;
  5191. #else
  5192. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5193. // be the last byte of an earlier chunk, hence prev_byte.
  5194. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5195. take = pos + 1;
  5196. terminated = true;
  5197. break;
  5198. }
  5199. at = pos + 1;
  5200. #endif
  5201. }
  5202. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5203. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5204. prev_byte = buffered[take - 1];
  5205. #endif
  5206. append(buffered, take);
  5207. strm_.consume_buffered(take);
  5208. i += take;
  5209. if (terminated) { return true; }
  5210. continue;
  5211. }
  5212. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5213. // Treat exceptionally long lines as an error to
  5214. // prevent infinite loops/memory exhaustion
  5215. return false;
  5216. }
  5217. char byte;
  5218. auto n = strm_.read(&byte, 1);
  5219. if (n < 0) {
  5220. return false;
  5221. } else if (n == 0) {
  5222. if (i == 0) {
  5223. return false;
  5224. } else {
  5225. break;
  5226. }
  5227. }
  5228. append(byte);
  5229. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5230. if (byte == '\n') { break; }
  5231. #else
  5232. if (prev_byte == '\r' && byte == '\n') { break; }
  5233. prev_byte = byte;
  5234. #endif
  5235. }
  5236. return true;
  5237. }
  5238. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5239. inline void stream_line_reader::append(const char *data, size_t size) {
  5240. // Once the line has outgrown the fixed buffer everything must keep going to
  5241. // the growable one, even if a later chunk would have fit. Without the
  5242. // emptiness check a short append after a long one would land in the fixed
  5243. // buffer, which ptr() and size() no longer look at, and be lost.
  5244. if (growable_buffer_.empty() &&
  5245. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5246. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5247. fixed_buffer_used_size_ += size;
  5248. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5249. } else {
  5250. // Unlike the per-character overload, this can be the very first append of
  5251. // the line, so the fixed buffer may hold nothing and carry no terminator
  5252. // yet. assign() takes an explicit length and does not need one.
  5253. if (growable_buffer_.empty()) {
  5254. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5255. }
  5256. growable_buffer_.append(data, size);
  5257. }
  5258. }
  5259. inline mmap::mmap(const char *path) { open(path); }
  5260. inline mmap::~mmap() { close(); }
  5261. inline bool mmap::open(const char *path) {
  5262. close();
  5263. #if defined(_WIN32)
  5264. auto wpath = u8string_to_wstring(path);
  5265. if (wpath.empty()) { return false; }
  5266. hFile_ =
  5267. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5268. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5269. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5270. LARGE_INTEGER size{};
  5271. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5272. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5273. // See:
  5274. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5275. if (static_cast<ULONGLONG>(size.QuadPart) >
  5276. (std::numeric_limits<decltype(size_)>::max)()) {
  5277. // `size_t` might be 32-bits, on 32-bits Windows.
  5278. return false;
  5279. }
  5280. size_ = static_cast<size_t>(size.QuadPart);
  5281. hMapping_ =
  5282. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5283. // Special treatment for an empty file...
  5284. if (hMapping_ == NULL && size_ == 0) {
  5285. close();
  5286. is_open_empty_file = true;
  5287. return true;
  5288. }
  5289. if (hMapping_ == NULL) {
  5290. close();
  5291. return false;
  5292. }
  5293. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5294. if (addr_ == nullptr) {
  5295. close();
  5296. return false;
  5297. }
  5298. #else
  5299. fd_ = ::open(path, O_RDONLY);
  5300. if (fd_ == -1) { return false; }
  5301. struct stat sb;
  5302. if (fstat(fd_, &sb) == -1) {
  5303. close();
  5304. return false;
  5305. }
  5306. size_ = static_cast<size_t>(sb.st_size);
  5307. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5308. // Special treatment for an empty file...
  5309. if (addr_ == MAP_FAILED && size_ == 0) {
  5310. close();
  5311. is_open_empty_file = true;
  5312. return false;
  5313. }
  5314. if (addr_ == MAP_FAILED) {
  5315. // Clear the sentinel before `close()`, since `is_open()` only checks
  5316. // `addr_` against nullptr and `munmap()` must not be called with it.
  5317. addr_ = nullptr;
  5318. close();
  5319. return false;
  5320. }
  5321. #endif
  5322. return true;
  5323. }
  5324. inline bool mmap::is_open() const {
  5325. return is_open_empty_file ? true : addr_ != nullptr;
  5326. }
  5327. inline size_t mmap::size() const { return size_; }
  5328. inline const char *mmap::data() const {
  5329. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5330. }
  5331. inline void mmap::close() {
  5332. #if defined(_WIN32)
  5333. if (addr_) {
  5334. ::UnmapViewOfFile(addr_);
  5335. addr_ = nullptr;
  5336. }
  5337. if (hMapping_) {
  5338. ::CloseHandle(hMapping_);
  5339. hMapping_ = NULL;
  5340. }
  5341. if (hFile_ != INVALID_HANDLE_VALUE) {
  5342. ::CloseHandle(hFile_);
  5343. hFile_ = INVALID_HANDLE_VALUE;
  5344. }
  5345. is_open_empty_file = false;
  5346. #else
  5347. if (addr_ != nullptr) {
  5348. munmap(addr_, size_);
  5349. addr_ = nullptr;
  5350. }
  5351. if (fd_ != -1) {
  5352. ::close(fd_);
  5353. fd_ = -1;
  5354. }
  5355. #endif
  5356. size_ = 0;
  5357. }
  5358. inline int close_socket(socket_t sock) noexcept {
  5359. #ifdef _WIN32
  5360. return closesocket(sock);
  5361. #else
  5362. return close(sock);
  5363. #endif
  5364. }
  5365. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5366. ssize_t res = 0;
  5367. while (true) {
  5368. res = fn();
  5369. if (res < 0 && errno == EINTR) {
  5370. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5371. continue;
  5372. }
  5373. break;
  5374. }
  5375. return res;
  5376. }
  5377. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5378. return handle_EINTR([&]() {
  5379. return recv(sock,
  5380. #ifdef _WIN32
  5381. static_cast<char *>(ptr), static_cast<int>(size),
  5382. #else
  5383. ptr, size,
  5384. #endif
  5385. flags);
  5386. });
  5387. }
  5388. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5389. int flags) {
  5390. return handle_EINTR([&]() {
  5391. return send(sock,
  5392. #ifdef _WIN32
  5393. static_cast<const char *>(ptr), static_cast<int>(size),
  5394. #else
  5395. ptr, size,
  5396. #endif
  5397. flags);
  5398. });
  5399. }
  5400. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5401. #ifdef _WIN32
  5402. return ::WSAPoll(fds, nfds, timeout);
  5403. #else
  5404. return ::poll(fds, nfds, timeout);
  5405. #endif
  5406. }
  5407. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5408. time_t usec) {
  5409. struct pollfd pfd;
  5410. pfd.fd = sock;
  5411. pfd.events = events;
  5412. pfd.revents = 0;
  5413. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5414. // "return immediately", which callers here rely on to probe a socket.
  5415. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5416. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5417. }
  5418. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5419. return select_impl(sock, POLLIN, sec, usec);
  5420. }
  5421. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5422. return select_impl(sock, POLLOUT, sec, usec);
  5423. }
  5424. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5425. time_t usec) {
  5426. struct pollfd pfd_read;
  5427. pfd_read.fd = sock;
  5428. pfd_read.events = POLLIN | POLLOUT;
  5429. pfd_read.revents = 0;
  5430. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5431. auto poll_res =
  5432. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5433. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5434. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5435. auto error = 0;
  5436. socklen_t len = sizeof(error);
  5437. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5438. reinterpret_cast<char *>(&error), &len);
  5439. auto successful = res >= 0 && !error;
  5440. return successful ? Error::Success : Error::Connection;
  5441. }
  5442. return Error::Connection;
  5443. }
  5444. inline bool is_socket_alive(socket_t sock) {
  5445. const auto val = detail::select_read(sock, 0, 0);
  5446. if (val == 0) {
  5447. return true;
  5448. } else if (val < 0 && errno == EBADF) {
  5449. return false;
  5450. }
  5451. char buf[1];
  5452. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5453. }
  5454. class SocketStream final : public Stream {
  5455. public:
  5456. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5457. time_t write_timeout_sec, time_t write_timeout_usec,
  5458. time_t max_timeout_msec = 0,
  5459. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5460. (std::chrono::steady_clock::time_point::min)());
  5461. ~SocketStream() override;
  5462. bool is_readable() const override;
  5463. bool wait_readable() const override;
  5464. bool wait_writable() const override;
  5465. bool is_peer_alive() const override;
  5466. ssize_t read(char *ptr, size_t size) override;
  5467. ssize_t write(const char *ptr, size_t size) override;
  5468. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5469. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5470. socket_t socket() const override;
  5471. time_t duration() const override;
  5472. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5473. const char *buffered_data(size_t &size) const override;
  5474. void consume_buffered(size_t size) override;
  5475. // The caller has just seen this socket become readable. Lets the next read
  5476. // skip its own readiness wait, which would otherwise ask the kernel a
  5477. // question that was answered a moment ago. Consumed by that read.
  5478. void set_readable_hint() { readable_hint_ = true; }
  5479. private:
  5480. bool ensure_readable();
  5481. socket_t sock_;
  5482. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5483. // thread while a read is in flight -- that is the point of it, for a caller
  5484. // holding one connection and wanting control back to send on it.
  5485. std::atomic<time_t> read_timeout_sec_;
  5486. std::atomic<time_t> read_timeout_usec_;
  5487. time_t write_timeout_sec_;
  5488. time_t write_timeout_usec_;
  5489. time_t max_timeout_msec_;
  5490. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5491. std::vector<char> read_buff_;
  5492. size_t read_buff_off_ = 0;
  5493. size_t read_buff_content_size_ = 0;
  5494. bool readable_hint_ = false;
  5495. static const size_t read_buff_size_ = 1024l * 4;
  5496. };
  5497. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5498. time_t keep_alive_timeout_sec) {
  5499. using namespace std::chrono;
  5500. const auto interval_usec =
  5501. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5502. // Avoid expensive `steady_clock::now()` call for the first time
  5503. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5504. const auto start = steady_clock::now() - microseconds{interval_usec};
  5505. const auto timeout = seconds{keep_alive_timeout_sec};
  5506. while (true) {
  5507. if (svr_sock == INVALID_SOCKET) {
  5508. break; // Server socket is closed
  5509. }
  5510. auto val = select_read(sock, 0, interval_usec);
  5511. if (val < 0) {
  5512. break; // Ssocket error
  5513. } else if (val == 0) {
  5514. if (steady_clock::now() - start > timeout) {
  5515. break; // Timeout
  5516. }
  5517. } else {
  5518. return true; // Ready for read
  5519. }
  5520. }
  5521. return false;
  5522. }
  5523. // `has_buffered_request` reports whether the connection's stream already holds
  5524. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5525. // 9.3.2), so reading one request can pull the start of the next one into the
  5526. // stream's buffer; that request must be served without waiting for the socket
  5527. // to become readable again, since its bytes are no longer on the socket.
  5528. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5529. template <typename P, typename T>
  5530. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5531. socket_t sock,
  5532. size_t keep_alive_max_count,
  5533. time_t keep_alive_timeout_sec,
  5534. P has_buffered_request, T callback) {
  5535. assert(keep_alive_max_count > 0);
  5536. auto ret = false;
  5537. auto count = keep_alive_max_count;
  5538. while (count > 0) {
  5539. auto socket_readable = false;
  5540. if (!has_buffered_request()) {
  5541. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5542. socket_readable = true;
  5543. }
  5544. auto close_connection = count == 1;
  5545. auto connection_closed = false;
  5546. ret = callback(socket_readable, close_connection, connection_closed);
  5547. if (!ret || connection_closed) { break; }
  5548. count--;
  5549. }
  5550. return ret;
  5551. }
  5552. template <typename T>
  5553. inline bool
  5554. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5555. size_t keep_alive_max_count,
  5556. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5557. time_t read_timeout_usec, time_t write_timeout_sec,
  5558. time_t write_timeout_usec, T callback) {
  5559. // One stream per connection: its read buffer can already hold the start of
  5560. // the next, pipelined request.
  5561. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5562. write_timeout_sec, write_timeout_usec);
  5563. return process_server_socket_core(
  5564. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5565. [&]() { return strm.is_readable(); },
  5566. [&](bool socket_readable, bool close_connection,
  5567. bool &connection_closed) {
  5568. if (socket_readable) { strm.set_readable_hint(); }
  5569. return callback(strm, close_connection, connection_closed);
  5570. });
  5571. }
  5572. inline bool process_client_socket(
  5573. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5574. time_t write_timeout_sec, time_t write_timeout_usec,
  5575. time_t max_timeout_msec,
  5576. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5577. std::function<bool(Stream &)> callback) {
  5578. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5579. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5580. start_time);
  5581. return callback(strm);
  5582. }
  5583. inline int shutdown_socket(socket_t sock) noexcept {
  5584. #ifdef _WIN32
  5585. return shutdown(sock, SD_BOTH);
  5586. #else
  5587. return shutdown(sock, SHUT_RDWR);
  5588. #endif
  5589. }
  5590. // Half-closes the write side and drains any in-flight/queued bytes before
  5591. // the final shutdown+close. Closing with unread data in the receive queue
  5592. // (or bytes arriving after the receive side is closed) makes the stack send
  5593. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5594. // response as a failed read even though it was fully written.
  5595. inline void drain_and_close_socket(socket_t sock) noexcept {
  5596. #ifdef _WIN32
  5597. shutdown(sock, SD_SEND);
  5598. #else
  5599. shutdown(sock, SHUT_WR);
  5600. #endif
  5601. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5602. size_t total = 0;
  5603. const auto deadline = std::chrono::steady_clock::now() +
  5604. std::chrono::milliseconds(100); // bound #1
  5605. while (total < size_t(1024u * 1024u)) { // bound #2
  5606. const auto remaining =
  5607. std::chrono::duration_cast<std::chrono::microseconds>(
  5608. deadline - std::chrono::steady_clock::now())
  5609. .count();
  5610. if (remaining <= 0) { break; }
  5611. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5612. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5613. if (n <= 0) { break; }
  5614. total += static_cast<size_t>(n);
  5615. }
  5616. shutdown_socket(sock);
  5617. close_socket(sock);
  5618. }
  5619. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5620. if (s.size() > 1 && s[0] == '\0') {
  5621. auto ret = s;
  5622. ret[0] = '@';
  5623. return ret;
  5624. }
  5625. return s;
  5626. }
  5627. inline std::string
  5628. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5629. if (s.size() > 1 && s[0] == '@') {
  5630. auto ret = s;
  5631. ret[0] = '\0';
  5632. return ret;
  5633. }
  5634. return s;
  5635. }
  5636. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5637. const struct addrinfo *hints,
  5638. struct addrinfo **res, time_t timeout_sec) {
  5639. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5640. if (timeout_sec <= 0) {
  5641. // No timeout specified, use standard getaddrinfo
  5642. return getaddrinfo(node, service, hints, res);
  5643. }
  5644. #ifdef _WIN32
  5645. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5646. OVERLAPPED overlapped = {};
  5647. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5648. if (!event) { return EAI_FAIL; }
  5649. overlapped.hEvent = event;
  5650. PADDRINFOEXW result_addrinfo = nullptr;
  5651. HANDLE cancel_handle = nullptr;
  5652. ADDRINFOEXW hints_ex = {};
  5653. if (hints) {
  5654. hints_ex.ai_flags = hints->ai_flags;
  5655. hints_ex.ai_family = hints->ai_family;
  5656. hints_ex.ai_socktype = hints->ai_socktype;
  5657. hints_ex.ai_protocol = hints->ai_protocol;
  5658. }
  5659. auto wnode = u8string_to_wstring(node);
  5660. auto wservice = u8string_to_wstring(service);
  5661. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5662. hints ? &hints_ex : nullptr, &result_addrinfo,
  5663. nullptr, &overlapped, nullptr, &cancel_handle);
  5664. if (ret == WSA_IO_PENDING) {
  5665. auto wait_result =
  5666. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5667. if (wait_result == WAIT_TIMEOUT) {
  5668. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5669. ::CloseHandle(event);
  5670. return EAI_AGAIN;
  5671. }
  5672. DWORD bytes_returned;
  5673. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5674. &bytes_returned, FALSE)) {
  5675. ::CloseHandle(event);
  5676. return ::WSAGetLastError();
  5677. }
  5678. }
  5679. ::CloseHandle(event);
  5680. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5681. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5682. return 0;
  5683. }
  5684. return ret;
  5685. #elif TARGET_OS_MAC && defined(__clang__)
  5686. if (!node) { return EAI_NONAME; }
  5687. // macOS implementation using CFHost API for asynchronous DNS resolution
  5688. CFStringRef hostname_ref = CFStringCreateWithCString(
  5689. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5690. if (!hostname_ref) { return EAI_MEMORY; }
  5691. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5692. CFRelease(hostname_ref);
  5693. if (!host_ref) { return EAI_MEMORY; }
  5694. // Set up context for callback
  5695. struct CFHostContext {
  5696. bool completed = false;
  5697. bool success = false;
  5698. CFArrayRef addresses = nullptr;
  5699. std::mutex mutex;
  5700. std::condition_variable cv;
  5701. } context;
  5702. CFHostClientContext client_context;
  5703. memset(&client_context, 0, sizeof(client_context));
  5704. client_context.info = &context;
  5705. // Set callback
  5706. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5707. const CFStreamError *error, void *info) {
  5708. auto ctx = static_cast<CFHostContext *>(info);
  5709. std::lock_guard<std::mutex> lock(ctx->mutex);
  5710. if (error && error->error != 0) {
  5711. ctx->success = false;
  5712. } else {
  5713. Boolean hasBeenResolved;
  5714. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5715. if (ctx->addresses && hasBeenResolved) {
  5716. CFRetain(ctx->addresses);
  5717. ctx->success = true;
  5718. } else {
  5719. ctx->success = false;
  5720. }
  5721. }
  5722. ctx->completed = true;
  5723. ctx->cv.notify_one();
  5724. };
  5725. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5726. CFRelease(host_ref);
  5727. return EAI_SYSTEM;
  5728. }
  5729. // Schedule on run loop
  5730. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5731. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5732. // Start resolution
  5733. CFStreamError stream_error;
  5734. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5735. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5736. CFRelease(host_ref);
  5737. return EAI_FAIL;
  5738. }
  5739. // Wait for completion with timeout
  5740. auto timeout_time =
  5741. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5742. bool timed_out = false;
  5743. {
  5744. std::unique_lock<std::mutex> lock(context.mutex);
  5745. while (!context.completed) {
  5746. auto now = std::chrono::steady_clock::now();
  5747. if (now >= timeout_time) {
  5748. timed_out = true;
  5749. break;
  5750. }
  5751. // Run the runloop for a short time
  5752. lock.unlock();
  5753. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5754. lock.lock();
  5755. }
  5756. }
  5757. // Clean up
  5758. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5759. CFHostSetClient(host_ref, nullptr, nullptr);
  5760. if (timed_out || !context.completed) {
  5761. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5762. CFRelease(host_ref);
  5763. return EAI_AGAIN;
  5764. }
  5765. if (!context.success || !context.addresses) {
  5766. CFRelease(host_ref);
  5767. return EAI_NODATA;
  5768. }
  5769. // Convert CFArray to addrinfo
  5770. CFIndex count = CFArrayGetCount(context.addresses);
  5771. if (count == 0) {
  5772. CFRelease(context.addresses);
  5773. CFRelease(host_ref);
  5774. return EAI_NODATA;
  5775. }
  5776. struct addrinfo *result_addrinfo = nullptr;
  5777. struct addrinfo **current = &result_addrinfo;
  5778. for (CFIndex i = 0; i < count; i++) {
  5779. CFDataRef addr_data =
  5780. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5781. if (!addr_data) continue;
  5782. const struct sockaddr *sockaddr_ptr =
  5783. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5784. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5785. // Allocate addrinfo structure
  5786. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5787. if (!*current) {
  5788. freeaddrinfo(result_addrinfo);
  5789. CFRelease(context.addresses);
  5790. CFRelease(host_ref);
  5791. return EAI_MEMORY;
  5792. }
  5793. memset(*current, 0, sizeof(struct addrinfo));
  5794. // Set up addrinfo fields
  5795. (*current)->ai_family = sockaddr_ptr->sa_family;
  5796. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5797. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5798. (*current)->ai_addrlen = sockaddr_len;
  5799. // Copy sockaddr
  5800. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5801. if (!(*current)->ai_addr) {
  5802. freeaddrinfo(result_addrinfo);
  5803. CFRelease(context.addresses);
  5804. CFRelease(host_ref);
  5805. return EAI_MEMORY;
  5806. }
  5807. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5808. // Set port if service is specified
  5809. if (service && *service) {
  5810. int port = 0;
  5811. if (parse_port(service, strlen(service), port)) {
  5812. if (sockaddr_ptr->sa_family == AF_INET) {
  5813. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5814. ->sin_port = htons(static_cast<uint16_t>(port));
  5815. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5816. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5817. ->sin6_port = htons(static_cast<uint16_t>(port));
  5818. }
  5819. }
  5820. }
  5821. current = &((*current)->ai_next);
  5822. }
  5823. CFRelease(context.addresses);
  5824. CFRelease(host_ref);
  5825. *res = result_addrinfo;
  5826. return 0;
  5827. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5828. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5829. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5830. // the resolver worker still references the stack-local gaicb. The cancel
  5831. // path therefore waits (gai_suspend with no timeout) for the worker to
  5832. // actually finish before letting the stack frame go. The trade-off is that
  5833. // a wedged DNS server can hold this thread for the system resolver timeout
  5834. // (~30s by default) past the caller's connection timeout.
  5835. struct gaicb request{};
  5836. struct gaicb *requests[1] = {&request};
  5837. struct sigevent sevp{};
  5838. struct timespec timeout{timeout_sec, 0};
  5839. request.ar_name = node;
  5840. request.ar_service = service;
  5841. request.ar_request = hints;
  5842. sevp.sigev_notify = SIGEV_NONE;
  5843. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5844. if (rc != 0) { return rc; }
  5845. auto cleanup = scope_exit([&] {
  5846. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5847. });
  5848. int wait_result = gai_suspend(requests, 1, &timeout);
  5849. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5850. int gai_result = gai_error(&request);
  5851. if (gai_result == 0) {
  5852. *res = request.ar_result;
  5853. request.ar_result = nullptr;
  5854. return 0;
  5855. }
  5856. return gai_result;
  5857. }
  5858. gai_cancel(&request);
  5859. while (gai_error(&request) == EAI_INPROGRESS) {
  5860. gai_suspend(requests, 1, nullptr);
  5861. }
  5862. return wait_result;
  5863. #else
  5864. // Fallback implementation using thread-based timeout for other Unix systems.
  5865. struct GetAddrInfoState {
  5866. ~GetAddrInfoState() {
  5867. if (info) { freeaddrinfo(info); }
  5868. }
  5869. std::mutex mutex;
  5870. std::condition_variable result_cv;
  5871. bool completed = false;
  5872. int result = EAI_SYSTEM;
  5873. std::string node;
  5874. std::string service;
  5875. struct addrinfo hints;
  5876. struct addrinfo *info = nullptr;
  5877. };
  5878. // Allocate on the heap, so the resolver thread can keep using the data.
  5879. auto state = std::make_shared<GetAddrInfoState>();
  5880. if (node) { state->node = node; }
  5881. state->service = service;
  5882. state->hints = *hints;
  5883. std::thread resolve_thread([state]() {
  5884. auto thread_result =
  5885. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5886. &state->info);
  5887. std::lock_guard<std::mutex> lock(state->mutex);
  5888. state->result = thread_result;
  5889. state->completed = true;
  5890. state->result_cv.notify_one();
  5891. });
  5892. // Wait for completion or timeout
  5893. std::unique_lock<std::mutex> lock(state->mutex);
  5894. auto finished =
  5895. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5896. [&] { return state->completed; });
  5897. if (finished) {
  5898. // Operation completed within timeout
  5899. resolve_thread.join();
  5900. *res = state->info;
  5901. state->info = nullptr; // Pass ownership to caller
  5902. return state->result;
  5903. } else {
  5904. // Timeout occurred
  5905. resolve_thread.detach(); // Let the thread finish in background
  5906. return EAI_AGAIN; // Return timeout error
  5907. }
  5908. #endif
  5909. #else
  5910. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5911. return getaddrinfo(node, service, hints, res);
  5912. #endif
  5913. }
  5914. template <typename BindOrConnect>
  5915. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5916. int address_family, int socket_flags, bool tcp_nodelay,
  5917. bool ipv6_v6only, SocketOptions socket_options,
  5918. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5919. // Get address info
  5920. const char *node = nullptr;
  5921. struct addrinfo hints;
  5922. struct addrinfo *result;
  5923. memset(&hints, 0, sizeof(struct addrinfo));
  5924. hints.ai_socktype = SOCK_STREAM;
  5925. hints.ai_protocol = IPPROTO_IP;
  5926. if (!ip.empty()) {
  5927. node = ip.c_str();
  5928. // Ask getaddrinfo to convert IP in c-string to address
  5929. hints.ai_family = AF_UNSPEC;
  5930. hints.ai_flags = AI_NUMERICHOST;
  5931. } else {
  5932. if (!host.empty()) { node = host.c_str(); }
  5933. hints.ai_family = address_family;
  5934. hints.ai_flags = socket_flags;
  5935. }
  5936. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5937. if (hints.ai_family == AF_UNIX) {
  5938. const auto addrlen = host.length();
  5939. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5940. #ifdef SOCK_CLOEXEC
  5941. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5942. hints.ai_protocol);
  5943. #else
  5944. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5945. #endif
  5946. if (sock != INVALID_SOCKET) {
  5947. sockaddr_un addr{};
  5948. addr.sun_family = AF_UNIX;
  5949. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5950. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5951. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5952. hints.ai_addrlen = static_cast<socklen_t>(
  5953. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5954. #ifndef SOCK_CLOEXEC
  5955. #ifndef _WIN32
  5956. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5957. #endif
  5958. #endif
  5959. if (socket_options) { socket_options(sock); }
  5960. #ifdef _WIN32
  5961. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5962. // remove the option.
  5963. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5964. #endif
  5965. bool dummy;
  5966. if (!bind_or_connect(sock, hints, dummy)) {
  5967. close_socket(sock);
  5968. sock = INVALID_SOCKET;
  5969. }
  5970. }
  5971. return sock;
  5972. }
  5973. #endif
  5974. auto service = std::to_string(port);
  5975. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5976. timeout_sec)) {
  5977. #if defined __linux__ && !defined __ANDROID__
  5978. res_init();
  5979. #endif
  5980. return INVALID_SOCKET;
  5981. }
  5982. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5983. for (auto rp = result; rp; rp = rp->ai_next) {
  5984. // Create a socket
  5985. #ifdef _WIN32
  5986. auto sock =
  5987. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5988. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5989. /**
  5990. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5991. * and above the socket creation fails on older Windows Systems.
  5992. *
  5993. * Let's try to create a socket the old way in this case.
  5994. *
  5995. * Reference:
  5996. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5997. *
  5998. * WSA_FLAG_NO_HANDLE_INHERIT:
  5999. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6000. * SP1, and later
  6001. *
  6002. */
  6003. if (sock == INVALID_SOCKET) {
  6004. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6005. }
  6006. #else
  6007. #ifdef SOCK_CLOEXEC
  6008. auto sock =
  6009. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6010. #else
  6011. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6012. #endif
  6013. #endif
  6014. if (sock == INVALID_SOCKET) { continue; }
  6015. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6016. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6017. close_socket(sock);
  6018. continue;
  6019. }
  6020. #endif
  6021. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6022. if (rp->ai_family == AF_INET6) {
  6023. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6024. }
  6025. if (socket_options) { socket_options(sock); }
  6026. // bind or connect
  6027. auto quit = false;
  6028. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6029. close_socket(sock);
  6030. if (quit) { break; }
  6031. }
  6032. return INVALID_SOCKET;
  6033. }
  6034. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6035. #ifdef _WIN32
  6036. auto flags = nonblocking ? 1UL : 0UL;
  6037. ioctlsocket(sock, FIONBIO, &flags);
  6038. #else
  6039. auto flags = fcntl(sock, F_GETFL, 0);
  6040. fcntl(sock, F_SETFL,
  6041. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6042. #endif
  6043. }
  6044. inline bool is_connection_error() {
  6045. #ifdef _WIN32
  6046. return WSAGetLastError() != WSAEWOULDBLOCK;
  6047. #else
  6048. return errno != EINPROGRESS;
  6049. #endif
  6050. }
  6051. // accept() failed because the process or the network stack is temporarily out
  6052. // of resources. The listening socket is still usable, so back off briefly and
  6053. // try again.
  6054. inline bool is_accept_resource_error() {
  6055. #ifdef _WIN32
  6056. auto err = WSAGetLastError();
  6057. return err == WSAEMFILE || err == WSAENOBUFS;
  6058. #else
  6059. auto err = errno;
  6060. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6061. #endif
  6062. }
  6063. // accept() failed for a reason that says nothing about the listening socket:
  6064. // the pending connection went away before it could be accepted, or the call
  6065. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6066. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6067. // connection that way.
  6068. inline bool is_accept_transient_error() {
  6069. #ifdef _WIN32
  6070. auto err = WSAGetLastError();
  6071. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6072. err == WSAECONNABORTED;
  6073. #else
  6074. auto err = errno;
  6075. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6076. err == ECONNABORTED;
  6077. #endif
  6078. }
  6079. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6080. struct addrinfo hints;
  6081. struct addrinfo *result;
  6082. memset(&hints, 0, sizeof(struct addrinfo));
  6083. hints.ai_family = AF_UNSPEC;
  6084. hints.ai_socktype = SOCK_STREAM;
  6085. hints.ai_protocol = 0;
  6086. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6087. return false;
  6088. }
  6089. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6090. auto ret = false;
  6091. for (auto rp = result; rp; rp = rp->ai_next) {
  6092. const auto &ai = *rp;
  6093. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6094. ret = true;
  6095. break;
  6096. }
  6097. }
  6098. return ret;
  6099. }
  6100. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6101. #define USE_IF2IP
  6102. #endif
  6103. #ifdef USE_IF2IP
  6104. inline std::string if2ip(int address_family, const std::string &ifn) {
  6105. struct ifaddrs *ifap;
  6106. getifaddrs(&ifap);
  6107. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6108. std::string addr_candidate;
  6109. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6110. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6111. (AF_UNSPEC == address_family ||
  6112. ifa->ifa_addr->sa_family == address_family)) {
  6113. if (ifa->ifa_addr->sa_family == AF_INET) {
  6114. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6115. char buf[INET_ADDRSTRLEN];
  6116. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6117. return std::string(buf, INET_ADDRSTRLEN);
  6118. }
  6119. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6120. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6121. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6122. char buf[INET6_ADDRSTRLEN] = {};
  6123. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6124. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6125. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6126. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6127. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6128. } else {
  6129. return std::string(buf, INET6_ADDRSTRLEN);
  6130. }
  6131. }
  6132. }
  6133. }
  6134. }
  6135. }
  6136. return addr_candidate;
  6137. }
  6138. #endif
  6139. inline socket_t create_client_socket(
  6140. const std::string &host, const std::string &ip, int port,
  6141. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6142. SocketOptions socket_options, time_t connection_timeout_sec,
  6143. time_t connection_timeout_usec, time_t read_timeout_sec,
  6144. time_t read_timeout_usec, time_t write_timeout_sec,
  6145. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6146. auto sock = create_socket(
  6147. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6148. std::move(socket_options),
  6149. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6150. if (!intf.empty()) {
  6151. #ifdef USE_IF2IP
  6152. auto ip_from_if = if2ip(address_family, intf);
  6153. if (ip_from_if.empty()) { ip_from_if = intf; }
  6154. if (!bind_ip_address(sock2, ip_from_if)) {
  6155. error = Error::BindIPAddress;
  6156. return false;
  6157. }
  6158. #endif
  6159. }
  6160. set_nonblocking(sock2, true);
  6161. auto ret =
  6162. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6163. if (ret < 0) {
  6164. if (is_connection_error()) {
  6165. error = Error::Connection;
  6166. return false;
  6167. }
  6168. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6169. connection_timeout_usec);
  6170. if (error != Error::Success) {
  6171. if (error == Error::ConnectionTimeout) { quit = true; }
  6172. return false;
  6173. }
  6174. }
  6175. set_nonblocking(sock2, false);
  6176. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6177. read_timeout_usec);
  6178. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6179. write_timeout_usec);
  6180. error = Error::Success;
  6181. return true;
  6182. },
  6183. connection_timeout_sec); // Pass DNS timeout
  6184. if (sock != INVALID_SOCKET) {
  6185. error = Error::Success;
  6186. } else {
  6187. if (error == Error::Success) { error = Error::Connection; }
  6188. }
  6189. return sock;
  6190. }
  6191. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6192. socklen_t addr_len, std::string &ip, int &port) {
  6193. if (addr.ss_family == AF_INET) {
  6194. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6195. } else if (addr.ss_family == AF_INET6) {
  6196. port =
  6197. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6198. } else {
  6199. return false;
  6200. }
  6201. std::array<char, NI_MAXHOST> ipstr{};
  6202. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6203. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6204. 0, NI_NUMERICHOST)) {
  6205. return false;
  6206. }
  6207. ip = ipstr.data();
  6208. return true;
  6209. }
  6210. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6211. struct sockaddr_storage addr;
  6212. socklen_t addr_len = sizeof(addr);
  6213. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6214. &addr_len)) {
  6215. get_ip_and_port(addr, addr_len, ip, port);
  6216. }
  6217. }
  6218. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6219. struct sockaddr_storage addr;
  6220. socklen_t addr_len = sizeof(addr);
  6221. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6222. &addr_len)) {
  6223. #ifndef _WIN32
  6224. if (addr.ss_family == AF_UNIX) {
  6225. #if defined(__linux__)
  6226. struct ucred ucred;
  6227. socklen_t len = sizeof(ucred);
  6228. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6229. port = ucred.pid;
  6230. }
  6231. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6232. pid_t pid;
  6233. socklen_t len = sizeof(pid);
  6234. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6235. port = pid;
  6236. }
  6237. #endif
  6238. return;
  6239. }
  6240. #endif
  6241. get_ip_and_port(addr, addr_len, ip, port);
  6242. }
  6243. }
  6244. // Recursive form retained so operator""_t below can compute hashes for
  6245. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6246. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6247. // instead, which is iterative and stack-safe.
  6248. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6249. unsigned int h) {
  6250. return (l == 0)
  6251. ? h
  6252. : str2tag_core(
  6253. s + 1, l - 1,
  6254. // Unsets the 6 high bits of h, therefore no overflow happens
  6255. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6256. h * 33) ^
  6257. static_cast<unsigned char>(*s));
  6258. }
  6259. inline unsigned int str2tag(const std::string &s) {
  6260. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6261. // for compile-time UDL evaluation of short string literals, but at runtime
  6262. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6263. // would blow the stack with one frame per character.
  6264. unsigned int h = 0;
  6265. for (auto c : s) {
  6266. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6267. static_cast<unsigned char>(c);
  6268. }
  6269. return h;
  6270. }
  6271. namespace udl {
  6272. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6273. return str2tag_core(s, l, 0);
  6274. }
  6275. } // namespace udl
  6276. inline std::string
  6277. find_content_type(const std::string &path,
  6278. const std::map<std::string, std::string> &user_data,
  6279. const std::string &default_content_type) {
  6280. auto ext = file_extension(path);
  6281. auto it = user_data.find(ext);
  6282. if (it != user_data.end()) { return it->second; }
  6283. using udl::operator""_t;
  6284. switch (str2tag(ext)) {
  6285. default: return default_content_type;
  6286. case "css"_t: return "text/css";
  6287. case "csv"_t: return "text/csv";
  6288. case "htm"_t:
  6289. case "html"_t: return "text/html";
  6290. case "js"_t:
  6291. case "mjs"_t: return "text/javascript";
  6292. case "txt"_t: return "text/plain";
  6293. case "vtt"_t: return "text/vtt";
  6294. case "apng"_t: return "image/apng";
  6295. case "avif"_t: return "image/avif";
  6296. case "bmp"_t: return "image/bmp";
  6297. case "gif"_t: return "image/gif";
  6298. case "png"_t: return "image/png";
  6299. case "svg"_t: return "image/svg+xml";
  6300. case "webp"_t: return "image/webp";
  6301. case "ico"_t: return "image/x-icon";
  6302. case "tif"_t: return "image/tiff";
  6303. case "tiff"_t: return "image/tiff";
  6304. case "jpg"_t:
  6305. case "jpeg"_t: return "image/jpeg";
  6306. case "mp4"_t: return "video/mp4";
  6307. case "mpeg"_t: return "video/mpeg";
  6308. case "webm"_t: return "video/webm";
  6309. case "mp3"_t: return "audio/mp3";
  6310. case "mpga"_t: return "audio/mpeg";
  6311. case "weba"_t: return "audio/webm";
  6312. case "wav"_t: return "audio/wave";
  6313. case "otf"_t: return "font/otf";
  6314. case "ttf"_t: return "font/ttf";
  6315. case "woff"_t: return "font/woff";
  6316. case "woff2"_t: return "font/woff2";
  6317. case "7z"_t: return "application/x-7z-compressed";
  6318. case "atom"_t: return "application/atom+xml";
  6319. case "pdf"_t: return "application/pdf";
  6320. case "json"_t: return "application/json";
  6321. case "rss"_t: return "application/rss+xml";
  6322. case "tar"_t: return "application/x-tar";
  6323. case "xht"_t:
  6324. case "xhtml"_t: return "application/xhtml+xml";
  6325. case "xslt"_t: return "application/xslt+xml";
  6326. case "xml"_t: return "application/xml";
  6327. case "gz"_t: return "application/gzip";
  6328. case "zip"_t: return "application/zip";
  6329. case "wasm"_t: return "application/wasm";
  6330. }
  6331. }
  6332. inline std::string
  6333. extract_media_type(const std::string &content_type,
  6334. std::map<std::string, std::string> *params = nullptr) {
  6335. // Extract type/subtype from Content-Type value (RFC 2045)
  6336. // e.g. "application/json; charset=utf-8" -> "application/json"
  6337. auto media_type = content_type;
  6338. auto semicolon_pos = media_type.find(';');
  6339. if (semicolon_pos != std::string::npos) {
  6340. auto param_str = media_type.substr(semicolon_pos + 1);
  6341. media_type = media_type.substr(0, semicolon_pos);
  6342. if (params) {
  6343. // Parse parameters: key=value pairs separated by ';'
  6344. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6345. [&](const char *b, const char *e) {
  6346. std::string key;
  6347. std::string val;
  6348. divide_param_pair(b, e, key, val);
  6349. if (!key.empty()) {
  6350. params->emplace(trim_copy(key),
  6351. trim_double_quotes_copy(val));
  6352. }
  6353. });
  6354. }
  6355. }
  6356. // Trim whitespace from media type
  6357. return trim_copy(media_type);
  6358. }
  6359. inline bool can_compress_content_type(const std::string &content_type) {
  6360. using udl::operator""_t;
  6361. auto mime_type = extract_media_type(content_type);
  6362. auto tag = str2tag(mime_type);
  6363. switch (tag) {
  6364. case "image/svg+xml"_t:
  6365. case "application/javascript"_t:
  6366. case "application/x-javascript"_t:
  6367. case "application/json"_t:
  6368. case "application/ld+json"_t:
  6369. case "application/xml"_t:
  6370. case "application/xhtml+xml"_t:
  6371. case "application/rss+xml"_t:
  6372. case "application/atom+xml"_t:
  6373. case "application/xslt+xml"_t:
  6374. case "application/protobuf"_t: return true;
  6375. case "text/event-stream"_t: return false;
  6376. default: return !mime_type.rfind("text/", 0);
  6377. }
  6378. }
  6379. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6380. double &quality) {
  6381. quality = 1.0;
  6382. token.clear();
  6383. // Split on first ';': left = token name, right = parameters
  6384. const char *params_b = nullptr;
  6385. std::size_t params_len = 0;
  6386. divide(
  6387. b, static_cast<std::size_t>(e - b), ';',
  6388. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6389. auto r = trim(lb, lb + llen, 0, llen);
  6390. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6391. params_b = rb;
  6392. params_len = rlen;
  6393. });
  6394. if (token.empty()) { return false; }
  6395. if (params_len == 0) { return true; }
  6396. // Scan parameters for q= (stops on first match)
  6397. bool invalid = false;
  6398. split_find(params_b, params_b + params_len, ';',
  6399. (std::numeric_limits<size_t>::max)(),
  6400. [&](const char *pb, const char *pe) -> bool {
  6401. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6402. auto len = static_cast<size_t>(pe - pb);
  6403. if (len < 2) { return false; }
  6404. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6405. return false;
  6406. }
  6407. // Trim the value portion
  6408. auto r = trim(pb, pe, 2, len);
  6409. if (r.first >= r.second) {
  6410. invalid = true;
  6411. return true;
  6412. }
  6413. double v = 0.0;
  6414. auto res = from_chars(pb + r.first, pb + r.second, v);
  6415. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6416. v < 0.0 || v > 1.0) {
  6417. invalid = true;
  6418. return true;
  6419. }
  6420. quality = v;
  6421. return true;
  6422. });
  6423. return !invalid;
  6424. }
  6425. inline EncodingType encoding_type(const Request &req,
  6426. const std::string &content_type) {
  6427. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6428. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6429. if (s.empty()) { return EncodingType::None; }
  6430. // Single-pass: iterate tokens and track the best supported encoding.
  6431. // Server preference breaks ties (br > gzip > zstd).
  6432. EncodingType best = EncodingType::None;
  6433. double best_q = 0.0; // q=0 means "not acceptable"
  6434. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6435. auto priority = [](EncodingType t) -> int {
  6436. switch (t) {
  6437. case EncodingType::Brotli: return 0;
  6438. case EncodingType::Gzip: return 1;
  6439. case EncodingType::Zstd: return 2;
  6440. default: return 3;
  6441. }
  6442. };
  6443. std::string name;
  6444. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6445. double quality = 1.0;
  6446. if (!parse_quality(b, e, name, quality)) { return; }
  6447. if (quality <= 0.0) { return; }
  6448. EncodingType type = EncodingType::None;
  6449. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6450. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6451. #endif
  6452. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6453. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6454. type = EncodingType::Gzip;
  6455. }
  6456. #endif
  6457. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6458. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6459. type = EncodingType::Zstd;
  6460. }
  6461. #endif
  6462. if (type == EncodingType::None) { return; }
  6463. // Higher q-value wins; for equal q, server preference breaks ties
  6464. if (quality > best_q ||
  6465. (quality == best_q && priority(type) < priority(best))) {
  6466. best_q = quality;
  6467. best = type;
  6468. }
  6469. });
  6470. return best;
  6471. }
  6472. // `content_type` is taken separately because a file-backed response has not
  6473. // been given one yet when its coding has to be decided.
  6474. inline EncodingType encoding_type(const Request &req, const Response &res,
  6475. const std::string &content_type) {
  6476. // The response already names a content coding of its own: a handler serving
  6477. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6478. // point whose headers name the coding its files are stored in. Applying one
  6479. // on top of that would double-encode the body and append a second
  6480. // `Content-Encoding` field line.
  6481. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6482. return encoding_type(req, content_type);
  6483. }
  6484. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6485. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6486. }
  6487. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6488. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6489. if (type == EncodingType::Gzip) {
  6490. return detail::make_unique<gzip_compressor>();
  6491. }
  6492. #endif
  6493. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6494. if (type == EncodingType::Brotli) {
  6495. return detail::make_unique<brotli_compressor>();
  6496. }
  6497. #endif
  6498. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6499. if (type == EncodingType::Zstd) {
  6500. return detail::make_unique<zstd_compressor>();
  6501. }
  6502. #endif
  6503. (void)type;
  6504. return nullptr;
  6505. }
  6506. inline const char *encoding_name(EncodingType type) {
  6507. switch (type) {
  6508. case EncodingType::Gzip: return "gzip";
  6509. case EncodingType::Brotli: return "br";
  6510. case EncodingType::Zstd: return "zstd";
  6511. default: return "";
  6512. }
  6513. }
  6514. inline bool nocompressor::compress(const char *data, size_t data_length,
  6515. bool /*last*/, Callback callback) {
  6516. if (!data_length) { return true; }
  6517. return callback(data, data_length);
  6518. }
  6519. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6520. inline gzip_compressor::gzip_compressor() {
  6521. std::memset(&strm_, 0, sizeof(strm_));
  6522. strm_.zalloc = Z_NULL;
  6523. strm_.zfree = Z_NULL;
  6524. strm_.opaque = Z_NULL;
  6525. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6526. Z_DEFAULT_STRATEGY) == Z_OK;
  6527. }
  6528. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6529. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6530. bool last, Callback callback) {
  6531. assert(is_valid_);
  6532. do {
  6533. constexpr size_t max_avail_in =
  6534. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6535. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6536. (std::min)(data_length, max_avail_in));
  6537. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6538. data_length -= strm_.avail_in;
  6539. data += strm_.avail_in;
  6540. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6541. auto ret = Z_OK;
  6542. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6543. do {
  6544. strm_.avail_out = static_cast<uInt>(buff.size());
  6545. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6546. ret = deflate(&strm_, flush);
  6547. if (ret == Z_STREAM_ERROR) { return false; }
  6548. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6549. return false;
  6550. }
  6551. } while (strm_.avail_out == 0);
  6552. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6553. (flush == Z_NO_FLUSH && ret == Z_OK));
  6554. assert(strm_.avail_in == 0);
  6555. } while (data_length > 0);
  6556. return true;
  6557. }
  6558. inline gzip_decompressor::gzip_decompressor() {
  6559. std::memset(&strm_, 0, sizeof(strm_));
  6560. strm_.zalloc = Z_NULL;
  6561. strm_.zfree = Z_NULL;
  6562. strm_.opaque = Z_NULL;
  6563. // 15 is the value of wbits, which should be at the maximum possible value
  6564. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6565. // that the stream type should be automatically detected either gzip or
  6566. // deflate.
  6567. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6568. }
  6569. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6570. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6571. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6572. Callback callback) {
  6573. assert(is_valid_);
  6574. auto ret = Z_OK;
  6575. do {
  6576. constexpr size_t max_avail_in =
  6577. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6578. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6579. (std::min)(data_length, max_avail_in));
  6580. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6581. data_length -= strm_.avail_in;
  6582. data += strm_.avail_in;
  6583. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6584. while (strm_.avail_in > 0 && ret == Z_OK) {
  6585. strm_.avail_out = static_cast<uInt>(buff.size());
  6586. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6587. ret = inflate(&strm_, Z_NO_FLUSH);
  6588. assert(ret != Z_STREAM_ERROR);
  6589. switch (ret) {
  6590. case Z_NEED_DICT:
  6591. case Z_DATA_ERROR:
  6592. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6593. }
  6594. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6595. return false;
  6596. }
  6597. }
  6598. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6599. } while (data_length > 0);
  6600. return true;
  6601. }
  6602. #endif
  6603. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6604. inline brotli_compressor::brotli_compressor() {
  6605. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6606. }
  6607. inline brotli_compressor::~brotli_compressor() {
  6608. BrotliEncoderDestroyInstance(state_);
  6609. }
  6610. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6611. bool last, Callback callback) {
  6612. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6613. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6614. auto available_in = data_length;
  6615. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6616. for (;;) {
  6617. if (last) {
  6618. if (BrotliEncoderIsFinished(state_)) { break; }
  6619. } else {
  6620. if (!available_in) { break; }
  6621. }
  6622. auto available_out = buff.size();
  6623. auto next_out = buff.data();
  6624. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6625. &available_out, &next_out, nullptr)) {
  6626. return false;
  6627. }
  6628. auto output_bytes = buff.size() - available_out;
  6629. if (output_bytes) {
  6630. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6631. }
  6632. }
  6633. return true;
  6634. }
  6635. inline brotli_decompressor::brotli_decompressor() {
  6636. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6637. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6638. : BROTLI_DECODER_RESULT_ERROR;
  6639. }
  6640. inline brotli_decompressor::~brotli_decompressor() {
  6641. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6642. }
  6643. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6644. inline bool brotli_decompressor::decompress(const char *data,
  6645. size_t data_length,
  6646. Callback callback) {
  6647. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6648. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6649. return 0;
  6650. }
  6651. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6652. size_t avail_in = data_length;
  6653. size_t total_out;
  6654. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6655. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6656. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6657. char *next_out = buff.data();
  6658. size_t avail_out = buff.size();
  6659. decoder_r = BrotliDecoderDecompressStream(
  6660. decoder_s, &avail_in, &next_in, &avail_out,
  6661. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6662. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6663. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6664. }
  6665. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6666. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6667. }
  6668. #endif
  6669. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6670. inline zstd_compressor::zstd_compressor() {
  6671. ctx_ = ZSTD_createCCtx();
  6672. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6673. }
  6674. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6675. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6676. bool last, Callback callback) {
  6677. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6678. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6679. ZSTD_inBuffer input = {data, data_length, 0};
  6680. bool finished;
  6681. do {
  6682. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6683. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6684. if (ZSTD_isError(remaining)) { return false; }
  6685. if (!callback(buff.data(), output.pos)) { return false; }
  6686. finished = last ? (remaining == 0) : (input.pos == input.size);
  6687. } while (!finished);
  6688. return true;
  6689. }
  6690. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6691. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6692. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6693. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6694. Callback callback) {
  6695. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6696. ZSTD_inBuffer input = {data, data_length, 0};
  6697. while (input.pos < input.size) {
  6698. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6699. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6700. if (ZSTD_isError(remaining)) { return false; }
  6701. if (!callback(buff.data(), output.pos)) { return false; }
  6702. }
  6703. return true;
  6704. }
  6705. #endif
  6706. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6707. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6708. // unknown coding, and its payload would be handed back still compressed.
  6709. inline bool is_zlib_encoding(const std::string &encoding) {
  6710. return case_ignore::equal(encoding, "gzip") ||
  6711. case_ignore::equal(encoding, "deflate");
  6712. }
  6713. inline bool is_brotli_encoding(const std::string &encoding) {
  6714. return case_ignore::equal(encoding, "br");
  6715. }
  6716. inline bool is_zstd_encoding(const std::string &encoding) {
  6717. return case_ignore::equal(encoding, "zstd");
  6718. }
  6719. // Returns true if the content coding is one cpp-httplib is able to decompress
  6720. // when the corresponding support is compiled in.
  6721. inline bool is_known_content_encoding(const std::string &encoding) {
  6722. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6723. is_zstd_encoding(encoding);
  6724. }
  6725. inline std::unique_ptr<decompressor>
  6726. create_decompressor(const std::string &encoding) {
  6727. std::unique_ptr<decompressor> decompressor;
  6728. if (is_zlib_encoding(encoding)) {
  6729. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6730. decompressor = detail::make_unique<gzip_decompressor>();
  6731. #endif
  6732. } else if (is_brotli_encoding(encoding)) {
  6733. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6734. decompressor = detail::make_unique<brotli_decompressor>();
  6735. #endif
  6736. } else if (is_zstd_encoding(encoding)) {
  6737. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6738. decompressor = detail::make_unique<zstd_decompressor>();
  6739. #endif
  6740. }
  6741. return decompressor;
  6742. }
  6743. // Returns the best available compressor and its Content-Encoding name.
  6744. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6745. inline std::pair<std::unique_ptr<compressor>, const char *>
  6746. create_compressor() {
  6747. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6748. return {detail::make_unique<brotli_compressor>(), "br"};
  6749. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6750. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6751. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6752. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6753. #else
  6754. return {nullptr, nullptr};
  6755. #endif
  6756. }
  6757. inline bool is_prohibited_header_name(const std::string &name) {
  6758. using udl::operator""_t;
  6759. switch (str2tag(name)) {
  6760. case "REMOTE_ADDR"_t:
  6761. case "REMOTE_PORT"_t:
  6762. case "LOCAL_ADDR"_t:
  6763. case "LOCAL_PORT"_t: return true;
  6764. default: return false;
  6765. }
  6766. }
  6767. inline bool has_header(const Headers &headers, const std::string &key) {
  6768. if (is_prohibited_header_name(key)) { return false; }
  6769. return headers.find(key) != headers.end();
  6770. }
  6771. inline const char *get_header_value(const Headers &headers,
  6772. const std::string &key, const char *def,
  6773. size_t id) {
  6774. if (is_prohibited_header_name(key)) {
  6775. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6776. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6777. throw std::invalid_argument(msg);
  6778. #else
  6779. return "";
  6780. #endif
  6781. }
  6782. auto rng = headers.equal_range(key);
  6783. auto it = rng.first;
  6784. std::advance(it, static_cast<ssize_t>(id));
  6785. if (it != rng.second) { return it->second.c_str(); }
  6786. return def;
  6787. }
  6788. inline size_t get_header_value_count(const Headers &headers,
  6789. const std::string &key) {
  6790. return headers.count(key);
  6791. }
  6792. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6793. // list may be sent as several field lines, and the combined field value is
  6794. // those values joined by commas in the order they were received. Callers that
  6795. // parse such a list must work on the combined value; reading only the first
  6796. // occurrence silently drops whatever the later field lines carry.
  6797. inline std::string get_combined_header_value(const Headers &headers,
  6798. const std::string &key) {
  6799. std::string combined;
  6800. auto rng = headers.equal_range(key);
  6801. for (auto it = rng.first; it != rng.second; ++it) {
  6802. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6803. // elements, so an empty field line must not contribute a bare comma to the
  6804. // combined value.
  6805. if (it->second.empty()) { continue; }
  6806. if (!combined.empty()) { combined += ", "; }
  6807. combined += it->second;
  6808. }
  6809. return combined;
  6810. }
  6811. inline bool has_header_token(const Headers &headers, const std::string &key,
  6812. const std::string &token) {
  6813. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6814. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6815. // several lines. Match complete tokens rather than searching the raw value,
  6816. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6817. auto rng = headers.equal_range(key);
  6818. for (auto it = rng.first; it != rng.second; ++it) {
  6819. const auto &value = it->second;
  6820. if (split_find(value.data(), value.data() + value.size(), ',',
  6821. [&](const char *b, const char *e) {
  6822. return case_ignore::equal(std::string(b, e), token);
  6823. })) {
  6824. return true;
  6825. }
  6826. }
  6827. return false;
  6828. }
  6829. template <typename Map>
  6830. inline typename Map::mapped_type
  6831. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6832. auto rng = m.equal_range(key);
  6833. auto it = rng.first;
  6834. std::advance(it, static_cast<ssize_t>(id));
  6835. if (it != rng.second) { return it->second; }
  6836. return typename Map::mapped_type();
  6837. }
  6838. inline void set_header(Headers &headers, const std::string &key,
  6839. const std::string &val) {
  6840. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6841. }
  6842. inline bool read_headers(Stream &strm, Headers &headers) {
  6843. const auto bufsiz = 2048;
  6844. char buf[bufsiz];
  6845. stream_line_reader line_reader(strm, buf, bufsiz);
  6846. size_t header_count = 0;
  6847. for (;;) {
  6848. if (!line_reader.getline()) { return false; }
  6849. // Check if the line ends with CRLF.
  6850. auto line_terminator_len = 2;
  6851. if (line_reader.end_with_crlf()) {
  6852. // Blank line indicates end of headers.
  6853. if (line_reader.size() == 2) { break; }
  6854. } else {
  6855. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6856. // Blank line indicates end of headers.
  6857. if (line_reader.size() == 1) { break; }
  6858. line_terminator_len = 1;
  6859. #else
  6860. continue; // Skip invalid line.
  6861. #endif
  6862. }
  6863. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6864. // Check header count limit
  6865. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6866. // Exclude line terminator
  6867. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6868. if (!parse_header(line_reader.ptr(), end,
  6869. [&](const std::string &key, const std::string &val) {
  6870. headers.emplace(key, val);
  6871. })) {
  6872. return false;
  6873. }
  6874. header_count++;
  6875. }
  6876. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6877. // headers that have different values to prevent request smuggling.
  6878. auto cl_range = headers.equal_range("Content-Length");
  6879. if (cl_range.first != cl_range.second) {
  6880. const auto &first_val = cl_range.first->second;
  6881. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6882. if (it->second != first_val) { return false; }
  6883. }
  6884. }
  6885. return true;
  6886. }
  6887. inline bool parse_status_line(const char *line, std::string &version,
  6888. int &status, std::string &reason) {
  6889. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6890. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6891. #else
  6892. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6893. #endif
  6894. std::cmatch m;
  6895. if (!std::regex_match(line, m, re)) { return false; }
  6896. version = std::string(m[1]);
  6897. status = std::stoi(std::string(m[2]));
  6898. reason = std::string(m[3]);
  6899. return true;
  6900. }
  6901. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6902. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6903. struct WebSocketUpgradeResponse {
  6904. Error error = Error::Success;
  6905. int status = -1;
  6906. Headers headers;
  6907. std::string selected_subprotocol;
  6908. };
  6909. inline bool
  6910. read_websocket_upgrade_response(Stream &strm,
  6911. const std::string &expected_accept,
  6912. const std::string &offered_subprotocols,
  6913. WebSocketUpgradeResponse &upgrade) {
  6914. // Read status line
  6915. const auto bufsiz = 2048;
  6916. char buf[bufsiz];
  6917. stream_line_reader line_reader(strm, buf, bufsiz);
  6918. if (!line_reader.getline()) {
  6919. upgrade.error = Error::Read;
  6920. return false;
  6921. }
  6922. std::string version;
  6923. std::string reason;
  6924. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6925. upgrade.error = Error::WebSocketHandshake;
  6926. return false;
  6927. }
  6928. // Read the headers even for a rejection so the caller can see why the
  6929. // server refused the upgrade. A non-101 response may carry a body; it is
  6930. // deliberately left unread since the caller closes the socket right away.
  6931. if (!read_headers(strm, upgrade.headers)) {
  6932. upgrade.error = Error::Read;
  6933. return false;
  6934. }
  6935. const auto &headers = upgrade.headers;
  6936. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6937. upgrade.error = Error::WebSocketHandshake;
  6938. return false;
  6939. }
  6940. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6941. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6942. upgrade.error = Error::WebSocketHandshake;
  6943. return false;
  6944. }
  6945. // Verify Connection: Upgrade
  6946. if (!has_header_token(headers, "Connection", "upgrade")) {
  6947. upgrade.error = Error::WebSocketHandshake;
  6948. return false;
  6949. }
  6950. // Verify Sec-WebSocket-Accept header value
  6951. auto it = headers.find("Sec-WebSocket-Accept");
  6952. if (it == headers.end() || it->second != expected_accept) {
  6953. upgrade.error = Error::WebSocketHandshake;
  6954. return false;
  6955. }
  6956. // Extract negotiated subprotocol
  6957. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6958. if (proto_it != headers.end()) {
  6959. upgrade.selected_subprotocol = proto_it->second;
  6960. }
  6961. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  6962. if (!upgrade.selected_subprotocol.empty()) {
  6963. auto was_offered = false;
  6964. split(offered_subprotocols.data(),
  6965. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  6966. [&](const char *b, const char *e) {
  6967. if (std::string(b, e) == upgrade.selected_subprotocol) {
  6968. was_offered = true;
  6969. }
  6970. });
  6971. if (!was_offered) {
  6972. upgrade.error = Error::WebSocketHandshake;
  6973. return false;
  6974. }
  6975. }
  6976. return true;
  6977. }
  6978. enum class ReadContentResult {
  6979. Success, // Successfully read the content
  6980. PayloadTooLarge, // The content exceeds the specified payload limit
  6981. Error // An error occurred while reading the content
  6982. };
  6983. inline ReadContentResult read_content_with_length(
  6984. Stream &strm, size_t len, DownloadProgress progress,
  6985. ContentReceiverWithProgress out,
  6986. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6987. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6988. detail::BodyReader br;
  6989. br.stream = &strm;
  6990. br.has_content_length = true;
  6991. br.content_length = len;
  6992. br.payload_max_length = payload_max_length;
  6993. br.chunked = false;
  6994. br.bytes_read = 0;
  6995. br.last_error = Error::Success;
  6996. size_t r = 0;
  6997. while (r < len) {
  6998. auto read_len = static_cast<size_t>(len - r);
  6999. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7000. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7001. if (n <= 0) {
  7002. // Check if it was a payload size error
  7003. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7004. return ReadContentResult::PayloadTooLarge;
  7005. }
  7006. return ReadContentResult::Error;
  7007. }
  7008. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7009. return ReadContentResult::Error;
  7010. }
  7011. r += static_cast<size_t>(n);
  7012. if (progress) {
  7013. if (!progress(r, len)) { return ReadContentResult::Error; }
  7014. }
  7015. }
  7016. return ReadContentResult::Success;
  7017. }
  7018. inline ReadContentResult
  7019. read_content_without_length(Stream &strm, size_t payload_max_length,
  7020. ContentReceiverWithProgress out) {
  7021. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7022. size_t r = 0;
  7023. for (;;) {
  7024. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7025. if (n == 0) { return ReadContentResult::Success; }
  7026. if (n < 0) { return ReadContentResult::Error; }
  7027. // Check if adding this data would exceed the payload limit
  7028. if (payload_max_length > 0 &&
  7029. (r > payload_max_length ||
  7030. payload_max_length - r < static_cast<size_t>(n))) {
  7031. return ReadContentResult::PayloadTooLarge;
  7032. }
  7033. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7034. return ReadContentResult::Error;
  7035. }
  7036. r += static_cast<size_t>(n);
  7037. }
  7038. return ReadContentResult::Success;
  7039. }
  7040. template <typename T>
  7041. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7042. size_t payload_max_length,
  7043. ContentReceiverWithProgress out) {
  7044. detail::ChunkedDecoder dec(strm);
  7045. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7046. size_t total_len = 0;
  7047. for (;;) {
  7048. size_t chunk_offset = 0;
  7049. size_t chunk_total = 0;
  7050. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7051. if (n < 0) { return ReadContentResult::Error; }
  7052. if (n == 0) {
  7053. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7054. return ReadContentResult::Error;
  7055. }
  7056. return ReadContentResult::Success;
  7057. }
  7058. if (payload_max_length > 0 &&
  7059. (total_len > payload_max_length ||
  7060. payload_max_length - total_len < static_cast<size_t>(n))) {
  7061. return ReadContentResult::PayloadTooLarge;
  7062. }
  7063. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7064. return ReadContentResult::Error;
  7065. }
  7066. total_len += static_cast<size_t>(n);
  7067. }
  7068. }
  7069. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7070. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7071. // is the final transfer coding. A single field value may list several
  7072. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7073. // several Transfer-Encoding lines, which combine into one comma-separated
  7074. // list in the order the lines were received. Headers preserves that order,
  7075. // so the final coding is the last token of the last line. Match it
  7076. // case-insensitively rather than comparing the whole value against
  7077. // "chunked".
  7078. //
  7079. // Security: reading a chunked message as unframed leaves its body in the
  7080. // socket, where a keep-alive connection parses it as a smuggled request.
  7081. // Server::process_request() answers 400 and closes when the final coding is
  7082. // not chunked, so a request whose framing cannot be determined never
  7083. // reaches the "no body" path.
  7084. auto rng = headers.equal_range("Transfer-Encoding");
  7085. if (rng.first == rng.second) { return false; }
  7086. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7087. // combined list ending in nothing rather than inheriting the line before it.
  7088. std::string last_coding;
  7089. for (auto it = rng.first; it != rng.second; ++it) {
  7090. const auto &value = it->second;
  7091. last_coding.clear();
  7092. split(value.data(), value.data() + value.size(), ',',
  7093. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7094. }
  7095. return case_ignore::equal(last_coding, "chunked");
  7096. }
  7097. inline bool has_conflicting_content_length(const Headers &headers) {
  7098. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7099. // Content-Length is framed ambiguously. The body readers here delimit it by
  7100. // the transfer coding and drop Content-Length, while an intermediary may do
  7101. // the reverse, so the two disagree on where the body ends and a reused
  7102. // connection is desynchronised (request/response smuggling). Content-Length:
  7103. // 0 is tolerated for compatibility with existing peers.
  7104. return has_header(headers, "Transfer-Encoding") &&
  7105. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7106. }
  7107. template <typename T, typename U>
  7108. bool prepare_content_receiver(T &x, int &status,
  7109. ContentReceiverWithProgress receiver,
  7110. bool decompress, size_t payload_max_length,
  7111. bool &exceed_payload_max_length, U callback) {
  7112. if (decompress) {
  7113. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7114. std::unique_ptr<decompressor> decompressor;
  7115. if (!encoding.empty()) {
  7116. // A coding we know about but were not built with is an error. An
  7117. // unrecognized coding (including "identity") is left alone and the
  7118. // payload is passed through as-is, since some servers misuse the header,
  7119. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7120. decompressor = detail::create_decompressor(encoding);
  7121. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7122. status = StatusCode::UnsupportedMediaType_415;
  7123. return false;
  7124. }
  7125. }
  7126. if (decompressor) {
  7127. if (decompressor->is_valid()) {
  7128. size_t decompressed_size = 0;
  7129. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7130. size_t off, size_t len) {
  7131. return decompressor->decompress(
  7132. buf, n, [&](const char *buf2, size_t n2) {
  7133. // Guard against zip-bomb: check
  7134. // decompressed size against limit.
  7135. if (payload_max_length > 0 &&
  7136. (decompressed_size >= payload_max_length ||
  7137. n2 > payload_max_length - decompressed_size)) {
  7138. exceed_payload_max_length = true;
  7139. return false;
  7140. }
  7141. decompressed_size += n2;
  7142. return receiver(buf2, n2, off, len);
  7143. });
  7144. };
  7145. return callback(std::move(out));
  7146. } else {
  7147. status = StatusCode::InternalServerError_500;
  7148. return false;
  7149. }
  7150. }
  7151. }
  7152. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7153. size_t len) {
  7154. return receiver(buf, n, off, len);
  7155. };
  7156. return callback(std::move(out));
  7157. }
  7158. template <typename T>
  7159. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7160. DownloadProgress progress,
  7161. ContentReceiverWithProgress receiver, bool decompress) {
  7162. bool exceed_payload_max_length = false;
  7163. return prepare_content_receiver(
  7164. x, status, std::move(receiver), decompress, payload_max_length,
  7165. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7166. auto ret = true;
  7167. // Note: exceed_payload_max_length may also be set by the decompressor
  7168. // wrapper in prepare_content_receiver when the decompressed payload
  7169. // size exceeds the limit.
  7170. if (is_chunked_transfer_encoding(x.headers)) {
  7171. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7172. if (result == ReadContentResult::Success) {
  7173. ret = true;
  7174. } else if (result == ReadContentResult::PayloadTooLarge) {
  7175. exceed_payload_max_length = true;
  7176. ret = false;
  7177. } else {
  7178. ret = false;
  7179. }
  7180. } else if (!has_header(x.headers, "Content-Length")) {
  7181. auto result =
  7182. read_content_without_length(strm, payload_max_length, out);
  7183. if (result == ReadContentResult::Success) {
  7184. ret = true;
  7185. } else if (result == ReadContentResult::PayloadTooLarge) {
  7186. exceed_payload_max_length = true;
  7187. ret = false;
  7188. } else {
  7189. ret = false;
  7190. }
  7191. } else {
  7192. auto is_invalid_value = false;
  7193. auto len = get_header_value_u64(x.headers, "Content-Length",
  7194. (std::numeric_limits<size_t>::max)(),
  7195. 0, is_invalid_value);
  7196. if (is_invalid_value) {
  7197. ret = false;
  7198. } else if (len > 0) {
  7199. auto result = read_content_with_length(
  7200. strm, len, std::move(progress), out, payload_max_length);
  7201. ret = (result == ReadContentResult::Success);
  7202. if (result == ReadContentResult::PayloadTooLarge) {
  7203. exceed_payload_max_length = true;
  7204. }
  7205. }
  7206. }
  7207. if (!ret) {
  7208. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7209. : StatusCode::BadRequest_400;
  7210. }
  7211. return ret;
  7212. });
  7213. }
  7214. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7215. const std::string &path) {
  7216. // Neither the method nor the request target may carry CR/LF, SP or other
  7217. // control octets; otherwise a value smuggled into either splits the request
  7218. // line and injects headers or a whole request.
  7219. if (!fields::is_token(method)) { return -1; }
  7220. if (!fields::is_request_target(path)) { return -1; }
  7221. std::string s = method;
  7222. s += ' ';
  7223. s += path;
  7224. s += " HTTP/1.1\r\n";
  7225. return strm.write(s.data(), s.size());
  7226. }
  7227. inline ssize_t write_response_line(Stream &strm, int status) {
  7228. std::string s = "HTTP/1.1 ";
  7229. s += std::to_string(status);
  7230. s += ' ';
  7231. s += httplib::status_message(status);
  7232. s += "\r\n";
  7233. return strm.write(s.data(), s.size());
  7234. }
  7235. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7236. ssize_t write_len = 0;
  7237. for (const auto &x : headers) {
  7238. // Skip fields with invalid names or values to prevent response splitting
  7239. // via CR/LF injection, matching set_header(). The client validates request
  7240. // headers up front in check_and_write_headers, but the server passes
  7241. // res.headers straight to this writer, and res.headers is a public field
  7242. // an application can populate directly with request-derived values.
  7243. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7244. std::string s;
  7245. s = x.first;
  7246. s += ": ";
  7247. s += x.second;
  7248. s += "\r\n";
  7249. auto len = strm.write(s.data(), s.size());
  7250. if (len < 0) { return len; }
  7251. write_len += len;
  7252. }
  7253. auto len = strm.write("\r\n");
  7254. if (len < 0) { return len; }
  7255. write_len += len;
  7256. return write_len;
  7257. }
  7258. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7259. size_t offset = 0;
  7260. while (offset < l) {
  7261. auto length = strm.write(d + offset, l - offset);
  7262. if (length < 0) { return false; }
  7263. offset += static_cast<size_t>(length);
  7264. }
  7265. return true;
  7266. }
  7267. template <typename T>
  7268. inline bool write_content_with_progress(Stream &strm,
  7269. const ContentProvider &content_provider,
  7270. size_t offset, size_t length,
  7271. T is_shutting_down,
  7272. const UploadProgress &upload_progress,
  7273. Error &error) {
  7274. size_t end_offset = offset + length;
  7275. size_t start_offset = offset;
  7276. auto ok = true;
  7277. auto finished = false;
  7278. DataSink data_sink;
  7279. data_sink.write = [&](const char *d, size_t l) -> bool {
  7280. if (ok) {
  7281. if (write_data(strm, d, l)) {
  7282. offset += l;
  7283. if (upload_progress && length > 0) {
  7284. size_t current_written = offset - start_offset;
  7285. if (!upload_progress(current_written, length)) {
  7286. ok = false;
  7287. return false;
  7288. }
  7289. }
  7290. } else {
  7291. ok = false;
  7292. }
  7293. }
  7294. return ok;
  7295. };
  7296. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7297. // The body is framed by `length`, so a provider that reports itself done
  7298. // early has truncated it. Record that and let the short-body check below
  7299. // fail the write, rather than calling the provider again forever.
  7300. data_sink.done = [&]() { finished = true; };
  7301. while (offset < end_offset && !finished && !is_shutting_down()) {
  7302. auto last_offset = offset;
  7303. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7304. error = Error::Write;
  7305. return false;
  7306. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7307. error = Error::Canceled;
  7308. return false;
  7309. } else if (!ok) {
  7310. error = Error::Write;
  7311. return false;
  7312. }
  7313. // A provider that reports success without writing anything and without
  7314. // reporting itself done gets handed the same offset and length again on
  7315. // the next pass, so it would spin here for as long as the peer stays
  7316. // connected. Treat making no progress as a short body, like done() early.
  7317. if (!finished && offset == last_offset) {
  7318. error = Error::Write;
  7319. return false;
  7320. }
  7321. }
  7322. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7323. error = Error::Write;
  7324. return false;
  7325. }
  7326. error = Error::Success;
  7327. return true;
  7328. }
  7329. template <typename T>
  7330. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7331. size_t offset, size_t length, T is_shutting_down,
  7332. Error &error) {
  7333. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7334. is_shutting_down, nullptr, error);
  7335. }
  7336. template <typename T>
  7337. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7338. size_t offset, size_t length,
  7339. const T &is_shutting_down) {
  7340. auto error = Error::Success;
  7341. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7342. error);
  7343. }
  7344. template <typename T>
  7345. inline bool
  7346. write_content_without_length(Stream &strm,
  7347. const ContentProvider &content_provider,
  7348. const T &is_shutting_down) {
  7349. size_t offset = 0;
  7350. auto data_available = true;
  7351. auto ok = true;
  7352. DataSink data_sink;
  7353. data_sink.write = [&](const char *d, size_t l) -> bool {
  7354. if (ok) {
  7355. offset += l;
  7356. if (!write_data(strm, d, l)) { ok = false; }
  7357. }
  7358. return ok;
  7359. };
  7360. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7361. data_sink.done = [&](void) { data_available = false; };
  7362. while (data_available && !is_shutting_down()) {
  7363. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7364. return false;
  7365. } else if (!content_provider(offset, 0, data_sink)) {
  7366. return false;
  7367. } else if (!ok) {
  7368. return false;
  7369. }
  7370. }
  7371. return !data_available; // true only if done() was called, false if shutting
  7372. // down
  7373. }
  7374. // Runs a known-length content provider to completion and compresses what it
  7375. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7376. // by an mmap hands the compressor a pointer straight into the mapping.
  7377. inline bool compress_content_provider(const ContentProvider &content_provider,
  7378. size_t length, compressor &cmp,
  7379. std::string &out) {
  7380. size_t offset = 0;
  7381. auto ok = true;
  7382. auto finished = false;
  7383. DataSink data_sink;
  7384. auto append = [&](const char *data, size_t data_len) {
  7385. out.append(data, data_len);
  7386. return true;
  7387. };
  7388. data_sink.write = [&](const char *d, size_t l) -> bool {
  7389. if (!ok) { return false; }
  7390. offset += l;
  7391. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7392. return ok;
  7393. };
  7394. // The body is framed by `length`, so a provider that reports itself done
  7395. // early has truncated it; the short-body check below turns that into a
  7396. // failure rather than calling the provider again forever.
  7397. data_sink.done = [&]() { finished = true; };
  7398. while (offset < length && !finished) {
  7399. auto prev_offset = offset;
  7400. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7401. return false;
  7402. }
  7403. // No Stream to block on here, so a provider that keeps returning true
  7404. // without writing would spin. Treat a pass that made no progress as a
  7405. // failure.
  7406. if (offset == prev_offset) { return false; }
  7407. }
  7408. if (offset != length) { return false; }
  7409. return cmp.compress(nullptr, 0, true, append);
  7410. }
  7411. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7412. // and the file flag, so recording them has to come after; keeping all of it
  7413. // here means a third file-serving path cannot get that order wrong.
  7414. inline void set_file_content_provider(Response &res,
  7415. const std::shared_ptr<mmap> &m,
  7416. const std::string &content_type,
  7417. EncodingType encoding) {
  7418. res.set_content_provider(
  7419. m->size(), content_type,
  7420. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7421. sink.write(m->data() + offset, length);
  7422. return true;
  7423. });
  7424. res.is_file_content_provider_ = true;
  7425. res.content_coding_ = encoding;
  7426. }
  7427. template <typename T, typename U>
  7428. inline bool
  7429. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7430. const T &is_shutting_down, U &compressor, Error &error) {
  7431. size_t offset = 0;
  7432. auto data_available = true;
  7433. auto ok = true;
  7434. DataSink data_sink;
  7435. data_sink.write = [&](const char *d, size_t l) -> bool {
  7436. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7437. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7438. // zero-length chunk is the terminator, so it must not be emitted here.
  7439. if (ok && l > 0) {
  7440. offset += l;
  7441. std::string payload;
  7442. if (compressor.compress(d, l, false,
  7443. [&](const char *data, size_t data_len) {
  7444. payload.append(data, data_len);
  7445. return true;
  7446. })) {
  7447. if (!payload.empty()) {
  7448. // Emit chunked response header and footer for each chunk
  7449. auto chunk =
  7450. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7451. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7452. }
  7453. } else {
  7454. ok = false;
  7455. }
  7456. }
  7457. return ok;
  7458. };
  7459. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7460. auto done_with_trailer = [&](const Headers *trailer) {
  7461. if (!ok) { return; }
  7462. data_available = false;
  7463. std::string payload;
  7464. if (!compressor.compress(nullptr, 0, true,
  7465. [&](const char *data, size_t data_len) {
  7466. payload.append(data, data_len);
  7467. return true;
  7468. })) {
  7469. ok = false;
  7470. return;
  7471. }
  7472. if (!payload.empty()) {
  7473. // Emit chunked response header and footer for each chunk
  7474. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7475. if (!write_data(strm, chunk.data(), chunk.size())) {
  7476. ok = false;
  7477. return;
  7478. }
  7479. }
  7480. constexpr const char done_marker[] = "0\r\n";
  7481. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7482. // Trailer
  7483. if (trailer) {
  7484. for (const auto &kv : *trailer) {
  7485. // Skip fields with invalid names or values to prevent response
  7486. // splitting via CR/LF injection, matching set_header().
  7487. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7488. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7489. if (!write_data(strm, field_line.data(), field_line.size())) {
  7490. ok = false;
  7491. }
  7492. }
  7493. }
  7494. constexpr const char crlf[] = "\r\n";
  7495. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7496. };
  7497. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7498. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7499. done_with_trailer(&trailer);
  7500. };
  7501. while (data_available && !is_shutting_down()) {
  7502. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7503. error = Error::Write;
  7504. return false;
  7505. } else if (!content_provider(offset, 0, data_sink)) {
  7506. error = Error::Canceled;
  7507. return false;
  7508. } else if (!ok) {
  7509. error = Error::Write;
  7510. return false;
  7511. }
  7512. }
  7513. if (data_available) { // exited due to is_shutting_down(), not done()
  7514. error = Error::Write;
  7515. return false;
  7516. }
  7517. error = Error::Success;
  7518. return true;
  7519. }
  7520. template <typename T, typename U>
  7521. inline bool write_content_chunked(Stream &strm,
  7522. const ContentProvider &content_provider,
  7523. const T &is_shutting_down, U &compressor) {
  7524. auto error = Error::Success;
  7525. return write_content_chunked(strm, content_provider, is_shutting_down,
  7526. compressor, error);
  7527. }
  7528. template <typename T>
  7529. inline bool redirect(T &cli, Request &req, Response &res,
  7530. const std::string &path, const std::string &location,
  7531. Error &error) {
  7532. Request new_req = req;
  7533. new_req.path = path;
  7534. new_req.redirect_count_ -= 1;
  7535. if (res.status == StatusCode::SeeOther_303 &&
  7536. (req.method != "GET" && req.method != "HEAD")) {
  7537. new_req.method = "GET";
  7538. new_req.body.clear();
  7539. new_req.headers.clear();
  7540. new_req.content_length_ = 0;
  7541. new_req.content_provider_ = nullptr;
  7542. new_req.is_chunked_content_provider_ = false;
  7543. }
  7544. Response new_res;
  7545. auto ret = cli.send(new_req, new_res, error);
  7546. if (ret) {
  7547. req = std::move(new_req);
  7548. res = std::move(new_res);
  7549. if (res.location.empty()) { res.location = location; }
  7550. }
  7551. return ret;
  7552. }
  7553. inline std::string params_to_query_str(const Params &params) {
  7554. std::string query;
  7555. for (auto it = params.begin(); it != params.end(); ++it) {
  7556. if (it != params.begin()) { query += '&'; }
  7557. query += encode_query_component(it->first);
  7558. query += '=';
  7559. query += encode_query_component(it->second);
  7560. }
  7561. return query;
  7562. }
  7563. // Splits one "key=value" span of a query string at its first '='. A span with
  7564. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7565. // "?flag" keeps its name.
  7566. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7567. std::string &val) {
  7568. divide(b, static_cast<std::size_t>(e - b), '=',
  7569. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7570. std::size_t rhs_size) {
  7571. key.assign(lhs_data, lhs_size);
  7572. val.assign(rhs_data, rhs_size);
  7573. });
  7574. }
  7575. inline void parse_query_text(const char *data, std::size_t size,
  7576. Params &params) {
  7577. std::set<std::string> cache;
  7578. split(data, data + size, '&', [&](const char *b, const char *e) {
  7579. std::string kv(b, e);
  7580. if (cache.find(kv) != cache.end()) { return; }
  7581. cache.insert(std::move(kv));
  7582. std::string key;
  7583. std::string val;
  7584. divide_query_pair(b, e, key, val);
  7585. if (!key.empty()) {
  7586. params.emplace(decode_query_component(key), decode_query_component(val));
  7587. }
  7588. });
  7589. }
  7590. inline void parse_query_text(const std::string &s, Params &params) {
  7591. parse_query_text(s.data(), s.size(), params);
  7592. }
  7593. // Normalize a query string by decoding and re-encoding each key/value pair
  7594. // while preserving the original parameter order. This avoids double-encoding
  7595. // and ensures consistent encoding. It works on the raw string rather than
  7596. // parsing into Params and re-serializing, because that round trip cannot
  7597. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7598. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7599. // duplicated pairs.
  7600. inline std::string normalize_query_string(const std::string &query) {
  7601. std::string result;
  7602. split(query.data(), query.data() + query.size(), '&',
  7603. [&](const char *b, const char *e) {
  7604. std::string key;
  7605. std::string val;
  7606. divide_query_pair(b, e, key, val);
  7607. if (!key.empty()) {
  7608. auto dec_key = decode_query_component(key);
  7609. auto dec_val = decode_query_component(val);
  7610. if (!result.empty()) { result += '&'; }
  7611. result += encode_query_component(dec_key);
  7612. if (!val.empty() || std::find(b, e, '=') != e) {
  7613. result += '=';
  7614. result += encode_query_component(dec_val);
  7615. }
  7616. }
  7617. });
  7618. return result;
  7619. }
  7620. // Build the request target that goes on the wire from a caller-supplied path.
  7621. // Shared by the buffered send path and the streaming API so that both put the
  7622. // same bytes in the request line for the same input.
  7623. inline std::string encode_request_target(const std::string &target,
  7624. bool path_encode) {
  7625. // `substr(0, npos)` yields the whole string, which is what the no-query
  7626. // case needs.
  7627. auto query_pos = target.find('?');
  7628. auto path_part = target.substr(0, query_pos);
  7629. std::string query_part;
  7630. if (query_pos != std::string::npos) {
  7631. query_part = target.substr(query_pos + 1);
  7632. }
  7633. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7634. if (!query_part.empty()) {
  7635. // When path encoding is disabled the caller has supplied an already-encoded
  7636. // target and expects the exact bytes to be sent on the wire, so skip
  7637. // normalization for the query too. Normalizing would decode-then-re-encode
  7638. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7639. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7640. if (path_encode) {
  7641. auto normalized = normalize_query_string(query_part);
  7642. if (!normalized.empty()) {
  7643. result += '?';
  7644. result += normalized;
  7645. }
  7646. } else {
  7647. result += '?';
  7648. result += query_part;
  7649. }
  7650. }
  7651. return result;
  7652. }
  7653. inline bool parse_multipart_boundary(const std::string &content_type,
  7654. std::string &boundary) {
  7655. std::map<std::string, std::string> params;
  7656. extract_media_type(content_type, &params);
  7657. auto it = params.find("boundary");
  7658. if (it == params.end()) { return false; }
  7659. boundary = it->second;
  7660. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7661. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7662. // bytes costs a nearly full comparison at nearly every position: the
  7663. // boundary's length multiplies the worst-case cost of scanning a body.
  7664. return !boundary.empty() && boundary.size() <= 70;
  7665. }
  7666. inline void parse_disposition_params(const std::string &s, Params &params) {
  7667. std::set<std::string> cache;
  7668. split_unquoted(s.data(), s.data() + s.size(), ';',
  7669. [&](const char *b, const char *e) {
  7670. std::string kv(b, e);
  7671. if (cache.find(kv) != cache.end()) { return; }
  7672. cache.insert(kv);
  7673. std::string key;
  7674. std::string val;
  7675. divide_param_pair(b, e, key, val);
  7676. if (!key.empty()) {
  7677. params.emplace(trim_double_quotes_copy(key),
  7678. trim_double_quotes_copy(val));
  7679. }
  7680. });
  7681. }
  7682. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7683. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7684. #else
  7685. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7686. #endif
  7687. auto is_valid = [](const std::string &str) {
  7688. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7689. };
  7690. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7691. const auto pos = static_cast<size_t>(6);
  7692. const auto len = static_cast<size_t>(s.size() - 6);
  7693. auto all_valid_ranges = true;
  7694. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7695. if (!all_valid_ranges) { return; }
  7696. const auto it = std::find(b, e, '-');
  7697. if (it == e) {
  7698. all_valid_ranges = false;
  7699. return;
  7700. }
  7701. const auto lhs = std::string(b, it);
  7702. const auto rhs = std::string(it + 1, e);
  7703. if (!is_valid(lhs) || !is_valid(rhs)) {
  7704. all_valid_ranges = false;
  7705. return;
  7706. }
  7707. ssize_t first = -1;
  7708. if (!lhs.empty()) {
  7709. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7710. // would turn the range into a suffix range.
  7711. auto res =
  7712. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7713. if (res.ec != std::errc{}) {
  7714. all_valid_ranges = false;
  7715. return;
  7716. }
  7717. }
  7718. ssize_t last = -1;
  7719. if (!rhs.empty()) {
  7720. // An overflowing last-byte-pos is past any content length, so keeping
  7721. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7722. ssize_t v;
  7723. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7724. if (res.ec == std::errc{}) { last = v; }
  7725. }
  7726. if ((first == -1 && last == -1) ||
  7727. (first != -1 && last != -1 && first > last)) {
  7728. all_valid_ranges = false;
  7729. return;
  7730. }
  7731. ranges.emplace_back(first, last);
  7732. });
  7733. return all_valid_ranges && !ranges.empty();
  7734. }
  7735. return false;
  7736. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7737. }
  7738. #else
  7739. } catch (...) { return false; }
  7740. #endif
  7741. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7742. inline std::string remove_quoted_strings(const std::string &s) {
  7743. std::string out;
  7744. auto in_quotes = false;
  7745. for (size_t i = 0; i < s.size(); i++) {
  7746. if (s[i] == '"') {
  7747. in_quotes = !in_quotes;
  7748. } else if (!in_quotes) {
  7749. out += s[i];
  7750. } else if (s[i] == '\\') {
  7751. i++;
  7752. }
  7753. }
  7754. return out;
  7755. }
  7756. inline bool parse_accept_header(const std::string &s,
  7757. std::vector<std::string> &content_types) {
  7758. // Parameter values are not used here, so a quoted-string is dropped rather
  7759. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7760. if (s.find('"') != std::string::npos) {
  7761. return parse_accept_header(remove_quoted_strings(s), content_types);
  7762. }
  7763. content_types.clear();
  7764. // Empty string is considered valid (no preference)
  7765. if (s.empty()) { return true; }
  7766. struct AcceptEntry {
  7767. std::string media_type;
  7768. double quality;
  7769. int order;
  7770. };
  7771. std::vector<AcceptEntry> entries;
  7772. int order = 0;
  7773. bool has_invalid_entry = false;
  7774. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7775. // has to parse and ignore empty list elements, so a leading, trailing or
  7776. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7777. // split() skips them, and the header length limit bounds how many a sender
  7778. // can send, so ignoring all of them cannot be used as a denial-of-service
  7779. // vector.
  7780. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7781. std::string entry(b, e);
  7782. entry = trim_copy(entry);
  7783. AcceptEntry accept_entry;
  7784. accept_entry.order = order++;
  7785. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7786. accept_entry.media_type, accept_entry.quality)) {
  7787. has_invalid_entry = true;
  7788. return;
  7789. }
  7790. // Remove additional parameters from media type
  7791. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7792. // Basic validation of media type format
  7793. if (accept_entry.media_type.empty()) {
  7794. has_invalid_entry = true;
  7795. return;
  7796. }
  7797. // Check for basic media type format (should contain '/' or be '*')
  7798. if (accept_entry.media_type != "*" &&
  7799. accept_entry.media_type.find('/') == std::string::npos) {
  7800. has_invalid_entry = true;
  7801. return;
  7802. }
  7803. entries.push_back(std::move(accept_entry));
  7804. });
  7805. // Return false if any invalid entry was found
  7806. if (has_invalid_entry) { return false; }
  7807. // Sort by quality (descending), then by original order (ascending)
  7808. std::sort(entries.begin(), entries.end(),
  7809. [](const AcceptEntry &a, const AcceptEntry &b) {
  7810. if (a.quality != b.quality) {
  7811. return a.quality > b.quality; // Higher quality first
  7812. }
  7813. return a.order < b.order; // Earlier order first for same quality
  7814. });
  7815. // Extract sorted media types
  7816. content_types.reserve(entries.size());
  7817. for (auto &entry : entries) {
  7818. content_types.push_back(std::move(entry.media_type));
  7819. }
  7820. return true;
  7821. }
  7822. class FormDataParser {
  7823. public:
  7824. FormDataParser() = default;
  7825. void set_boundary(std::string &&boundary) {
  7826. boundary_ = std::move(boundary);
  7827. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7828. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7829. }
  7830. bool is_valid() const { return is_valid_; }
  7831. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7832. const ContentReceiver &content_callback) {
  7833. // Once the close delimiter has been seen the rest of the body is epilogue
  7834. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7835. // spread across reads is not copied in only to be erased right away.
  7836. if (state_ == 5) { return true; }
  7837. buf_append(buf, n);
  7838. while (buf_size() > 0) {
  7839. switch (state_) {
  7840. case 0: { // Initial boundary
  7841. auto pos = buf_find(dash_boundary_crlf_);
  7842. if (pos == buf_size()) {
  7843. // Not found yet: keep only a possible partial boundary at the tail so
  7844. // that a body which never contains the boundary cannot grow the
  7845. // buffer (and get rescanned from the start) without bound.
  7846. auto keep = dash_boundary_crlf_.size() - 1;
  7847. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7848. return true;
  7849. }
  7850. buf_erase(pos + dash_boundary_crlf_.size());
  7851. state_ = 1;
  7852. break;
  7853. }
  7854. case 1: { // New entry
  7855. clear_file_info();
  7856. state_ = 2;
  7857. break;
  7858. }
  7859. case 2: { // Headers
  7860. auto pos = buf_find(crlf_);
  7861. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7862. while (pos < buf_size()) {
  7863. // Empty line
  7864. if (pos == 0) {
  7865. if (!header_callback(file_)) {
  7866. is_valid_ = false;
  7867. return false;
  7868. }
  7869. buf_erase(crlf_.size());
  7870. state_ = 3;
  7871. break;
  7872. }
  7873. // Check header count limit
  7874. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7875. is_valid_ = false;
  7876. return false;
  7877. }
  7878. header_count_++;
  7879. const auto header = buf_head(pos);
  7880. if (!parse_header(header.data(), header.data() + header.size(),
  7881. [&](const std::string &, const std::string &) {})) {
  7882. is_valid_ = false;
  7883. return false;
  7884. }
  7885. // Parse and emplace space trimmed headers into a map
  7886. if (!parse_header(
  7887. header.data(), header.data() + header.size(),
  7888. [&](const std::string &key, const std::string &val) {
  7889. file_.headers.emplace(key, val);
  7890. })) {
  7891. is_valid_ = false;
  7892. return false;
  7893. }
  7894. constexpr const char header_content_type[] = "Content-Type:";
  7895. if (start_with_case_ignore(header, header_content_type)) {
  7896. file_.content_type =
  7897. trim_copy(header.substr(str_len(header_content_type)));
  7898. } else {
  7899. std::string disposition_params;
  7900. if (parse_content_disposition(header, disposition_params)) {
  7901. Params params;
  7902. parse_disposition_params(disposition_params, params);
  7903. auto it = params.find("name");
  7904. if (it != params.end()) {
  7905. file_.name = it->second;
  7906. } else {
  7907. is_valid_ = false;
  7908. return false;
  7909. }
  7910. it = params.find("filename");
  7911. if (it != params.end()) { file_.filename = it->second; }
  7912. it = params.find("filename*");
  7913. if (it != params.end()) {
  7914. // RFC 5987: only UTF-8 encoding is allowed
  7915. const auto &val = it->second;
  7916. constexpr const char utf8_prefix[] = "UTF-8''";
  7917. constexpr size_t prefix_len = str_len(utf8_prefix);
  7918. if (val.size() > prefix_len &&
  7919. start_with_case_ignore(val, utf8_prefix)) {
  7920. file_.filename = decode_path_component(
  7921. val.substr(prefix_len)); // override...
  7922. } else {
  7923. is_valid_ = false;
  7924. return false;
  7925. }
  7926. }
  7927. }
  7928. }
  7929. buf_erase(pos + crlf_.size());
  7930. pos = buf_find(crlf_);
  7931. }
  7932. if (state_ != 3) { return true; }
  7933. break;
  7934. }
  7935. case 3: { // Body
  7936. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7937. auto pos = buf_find(crlf_dash_boundary_);
  7938. if (pos < buf_size()) {
  7939. if (!content_callback(buf_data(), pos)) {
  7940. is_valid_ = false;
  7941. return false;
  7942. }
  7943. buf_erase(pos + crlf_dash_boundary_.size());
  7944. state_ = 4;
  7945. } else {
  7946. auto len = buf_size() - crlf_dash_boundary_.size();
  7947. if (len > 0) {
  7948. if (!content_callback(buf_data(), len)) {
  7949. is_valid_ = false;
  7950. return false;
  7951. }
  7952. buf_erase(len);
  7953. }
  7954. return true;
  7955. }
  7956. break;
  7957. }
  7958. case 4: { // Boundary
  7959. if (crlf_.size() > buf_size()) { return true; }
  7960. if (buf_start_with(crlf_)) {
  7961. buf_erase(crlf_.size());
  7962. state_ = 1;
  7963. } else if (buf_start_with(dash_)) {
  7964. buf_erase(dash_.size());
  7965. is_valid_ = true;
  7966. state_ = 5;
  7967. } else {
  7968. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7969. // accepted after a boundary; RFC 2046 allows transport-padding in
  7970. // between, but this parser has never supported it. Either way the
  7971. // body is already destined to be rejected, so fail now instead of
  7972. // buffering the rest of it. Both are two bytes, so the check above
  7973. // already guarantees enough buffered data to decide.
  7974. is_valid_ = false;
  7975. return false;
  7976. }
  7977. break;
  7978. }
  7979. case 5: { // Epilogue
  7980. buf_erase(buf_size());
  7981. break;
  7982. }
  7983. }
  7984. }
  7985. return true;
  7986. }
  7987. private:
  7988. void clear_file_info() {
  7989. file_.name.clear();
  7990. file_.filename.clear();
  7991. file_.content_type.clear();
  7992. file_.headers.clear();
  7993. header_count_ = 0;
  7994. }
  7995. bool start_with_case_ignore(const std::string &a, const char *b,
  7996. size_t offset = 0) const {
  7997. const auto b_len = strlen(b);
  7998. if (a.size() < offset + b_len) { return false; }
  7999. for (size_t i = 0; i < b_len; i++) {
  8000. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8001. return false;
  8002. }
  8003. }
  8004. return true;
  8005. }
  8006. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8007. // Returns true if header matches, with the params portion in `params_out`.
  8008. bool parse_content_disposition(const std::string &header,
  8009. std::string &params_out) const {
  8010. constexpr const char prefix[] = "Content-Disposition:";
  8011. constexpr size_t prefix_len = str_len(prefix);
  8012. if (!start_with_case_ignore(header, prefix)) { return false; }
  8013. // Skip whitespace after "Content-Disposition:"
  8014. auto pos = prefix_len;
  8015. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8016. pos++;
  8017. }
  8018. // Match "form-data;" (case-insensitive)
  8019. constexpr const char form_data[] = "form-data;";
  8020. constexpr size_t form_data_len = str_len(form_data);
  8021. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8022. pos += form_data_len;
  8023. // Skip whitespace after "form-data;"
  8024. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8025. pos++;
  8026. }
  8027. params_out = header.substr(pos);
  8028. return true;
  8029. }
  8030. const std::string dash_ = "--";
  8031. const std::string crlf_ = "\r\n";
  8032. std::string boundary_;
  8033. std::string dash_boundary_crlf_;
  8034. std::string crlf_dash_boundary_;
  8035. size_t state_ = 0;
  8036. bool is_valid_ = false;
  8037. FormData file_;
  8038. size_t header_count_ = 0;
  8039. // Buffer
  8040. bool start_with(const std::string &a, size_t spos, size_t epos,
  8041. const std::string &b) const {
  8042. if (epos - spos < b.size()) { return false; }
  8043. for (size_t i = 0; i < b.size(); i++) {
  8044. if (a[i + spos] != b[i]) { return false; }
  8045. }
  8046. return true;
  8047. }
  8048. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8049. const char *buf_data() const { return &buf_[buf_spos_]; }
  8050. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8051. bool buf_start_with(const std::string &s) const {
  8052. return start_with(buf_, buf_spos_, buf_epos_, s);
  8053. }
  8054. size_t buf_find(const std::string &s) const {
  8055. auto c = s.front();
  8056. size_t off = buf_spos_;
  8057. while (off < buf_epos_) {
  8058. auto pos = off;
  8059. while (true) {
  8060. if (pos == buf_epos_) { return buf_size(); }
  8061. if (buf_[pos] == c) { break; }
  8062. pos++;
  8063. }
  8064. auto remaining_size = buf_epos_ - pos;
  8065. if (s.size() > remaining_size) { return buf_size(); }
  8066. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8067. off = pos + 1;
  8068. }
  8069. return buf_size();
  8070. }
  8071. void buf_append(const char *data, size_t n) {
  8072. auto remaining_size = buf_size();
  8073. if (remaining_size > 0 && buf_spos_ > 0) {
  8074. for (size_t i = 0; i < remaining_size; i++) {
  8075. buf_[i] = buf_[buf_spos_ + i];
  8076. }
  8077. }
  8078. buf_spos_ = 0;
  8079. buf_epos_ = remaining_size;
  8080. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8081. for (size_t i = 0; i < n; i++) {
  8082. buf_[buf_epos_ + i] = data[i];
  8083. }
  8084. buf_epos_ += n;
  8085. }
  8086. void buf_erase(size_t size) { buf_spos_ += size; }
  8087. std::string buf_;
  8088. size_t buf_spos_ = 0;
  8089. size_t buf_epos_ = 0;
  8090. };
  8091. inline std::string random_string(size_t length) {
  8092. constexpr const char data[] =
  8093. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8094. thread_local auto engine([]() {
  8095. // std::random_device might actually be deterministic on some
  8096. // platforms, but due to lack of support in the c++ standard library,
  8097. // doing better requires either some ugly hacks or breaking portability.
  8098. std::random_device seed_gen;
  8099. // Request 128 bits of entropy for initialization
  8100. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8101. return std::mt19937(seed_sequence);
  8102. }());
  8103. std::string result;
  8104. for (size_t i = 0; i < length; i++) {
  8105. result += data[engine() % (sizeof(data) - 1)];
  8106. }
  8107. return result;
  8108. }
  8109. inline std::string make_multipart_data_boundary() {
  8110. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8111. }
  8112. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8113. auto valid = true;
  8114. for (size_t i = 0; i < boundary.size(); i++) {
  8115. auto c = boundary[i];
  8116. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8117. valid = false;
  8118. break;
  8119. }
  8120. }
  8121. return valid;
  8122. }
  8123. // Escape a multipart field name/filename following the WHATWG HTML standard
  8124. // ("escape a multipart form-data name"), which is what browsers send:
  8125. // '"' -> %22, CR -> %0D, LF -> %0A
  8126. // With escape_quote = false, only CR and LF are escaped; this is for header
  8127. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8128. inline std::string escape_multipart_field(const std::string &s,
  8129. bool escape_quote = true) {
  8130. std::string result;
  8131. result.reserve(s.size());
  8132. for (auto c : s) {
  8133. switch (c) {
  8134. case '"':
  8135. if (escape_quote) {
  8136. result += "%22";
  8137. } else {
  8138. result += c;
  8139. }
  8140. break;
  8141. case '\r': result += "%0D"; break;
  8142. case '\n': result += "%0A"; break;
  8143. default: result += c; break;
  8144. }
  8145. }
  8146. return result;
  8147. }
  8148. template <typename T>
  8149. inline std::string
  8150. serialize_multipart_formdata_item_begin(const T &item,
  8151. const std::string &boundary) {
  8152. std::string body = "--" + boundary + "\r\n";
  8153. body += "Content-Disposition: form-data; name=\"" +
  8154. escape_multipart_field(item.name) + "\"";
  8155. if (!item.filename.empty()) {
  8156. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8157. }
  8158. body += "\r\n";
  8159. if (!item.content_type.empty()) {
  8160. body +=
  8161. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8162. "\r\n";
  8163. }
  8164. body += "\r\n";
  8165. return body;
  8166. }
  8167. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8168. inline std::string
  8169. serialize_multipart_formdata_finish(const std::string &boundary) {
  8170. return "--" + boundary + "--\r\n";
  8171. }
  8172. inline std::string
  8173. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8174. return "multipart/form-data; boundary=" + boundary;
  8175. }
  8176. inline std::string
  8177. serialize_multipart_formdata(const UploadFormDataItems &items,
  8178. const std::string &boundary, bool finish = true) {
  8179. std::string body;
  8180. for (const auto &item : items) {
  8181. body += serialize_multipart_formdata_item_begin(item, boundary);
  8182. body += item.content + serialize_multipart_formdata_item_end();
  8183. }
  8184. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8185. return body;
  8186. }
  8187. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8188. const std::string &boundary) {
  8189. size_t total = 0;
  8190. for (const auto &item : items) {
  8191. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8192. total += item.content.size();
  8193. total += serialize_multipart_formdata_item_end().size();
  8194. }
  8195. total += serialize_multipart_formdata_finish(boundary).size();
  8196. return total;
  8197. }
  8198. struct MultipartSegment {
  8199. const char *data;
  8200. size_t size;
  8201. };
  8202. // NOTE: items must outlive the returned ContentProvider
  8203. // (safe for synchronous use inside Post/Put/Patch)
  8204. inline ContentProvider
  8205. make_multipart_content_provider(const UploadFormDataItems &items,
  8206. const std::string &boundary) {
  8207. // Own the per-item header strings and the finish string
  8208. std::vector<std::string> owned;
  8209. owned.reserve(items.size() + 1);
  8210. for (const auto &item : items)
  8211. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8212. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8213. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8214. std::vector<MultipartSegment> segs;
  8215. segs.reserve(items.size() * 3 + 1);
  8216. static const char crlf[] = "\r\n";
  8217. for (size_t i = 0; i < items.size(); i++) {
  8218. segs.push_back({owned[i].data(), owned[i].size()});
  8219. segs.push_back({items[i].content.data(), items[i].content.size()});
  8220. segs.push_back({crlf, 2});
  8221. }
  8222. segs.push_back({owned.back().data(), owned.back().size()});
  8223. struct MultipartState {
  8224. std::vector<std::string> owned;
  8225. std::vector<MultipartSegment> segs;
  8226. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8227. };
  8228. auto state = std::make_shared<MultipartState>();
  8229. state->owned = std::move(owned);
  8230. // `segs` holds raw pointers into owned strings; std::string move preserves
  8231. // the data pointer, so these pointers remain valid after the move above.
  8232. state->segs = std::move(segs);
  8233. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8234. // Buffer multiple small segments into fewer, larger writes to avoid
  8235. // excessive TCP packets when there are many form data items (#2410)
  8236. auto &buf = state->buf;
  8237. auto buf_size = buf.size();
  8238. size_t buf_len = 0;
  8239. size_t remaining = length;
  8240. // Find the first segment containing 'offset'
  8241. size_t pos = 0;
  8242. size_t seg_idx = 0;
  8243. for (; seg_idx < state->segs.size(); seg_idx++) {
  8244. const auto &seg = state->segs[seg_idx];
  8245. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8246. pos += seg.size;
  8247. }
  8248. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8249. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8250. const auto &seg = state->segs[seg_idx];
  8251. size_t available = seg.size - seg_offset;
  8252. size_t to_copy = (std::min)(available, remaining);
  8253. const char *src = seg.data + seg_offset;
  8254. seg_offset = 0; // only the first segment has a non-zero offset
  8255. while (to_copy > 0) {
  8256. size_t space = buf_size - buf_len;
  8257. size_t chunk = (std::min)(to_copy, space);
  8258. std::memcpy(buf.data() + buf_len, src, chunk);
  8259. buf_len += chunk;
  8260. src += chunk;
  8261. to_copy -= chunk;
  8262. remaining -= chunk;
  8263. if (buf_len == buf_size) {
  8264. if (!sink.write(buf.data(), buf_len)) { return false; }
  8265. buf_len = 0;
  8266. }
  8267. }
  8268. }
  8269. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8270. return true;
  8271. };
  8272. }
  8273. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8274. if (ranges.size() <= 1) return;
  8275. // Sort ranges by start position
  8276. std::sort(ranges.begin(), ranges.end(),
  8277. [](const Range &a, const Range &b) { return a.first < b.first; });
  8278. Ranges coalesced;
  8279. coalesced.reserve(ranges.size());
  8280. for (auto &r : ranges) {
  8281. auto first_pos = r.first;
  8282. auto last_pos = r.second;
  8283. // Handle special cases like in range_error
  8284. if (first_pos == -1 && last_pos == -1) {
  8285. first_pos = 0;
  8286. last_pos = static_cast<ssize_t>(content_length);
  8287. }
  8288. if (first_pos == -1) {
  8289. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8290. last_pos = static_cast<ssize_t>(content_length) - 1;
  8291. }
  8292. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8293. last_pos = static_cast<ssize_t>(content_length) - 1;
  8294. }
  8295. // Skip invalid ranges
  8296. if (!(0 <= first_pos && first_pos <= last_pos &&
  8297. last_pos < static_cast<ssize_t>(content_length))) {
  8298. continue;
  8299. }
  8300. // Coalesce with previous range if overlapping or adjacent (but not
  8301. // identical)
  8302. if (!coalesced.empty()) {
  8303. auto &prev = coalesced.back();
  8304. // Check if current range overlaps or is adjacent to previous range
  8305. // but don't coalesce identical ranges (allow duplicates)
  8306. if (first_pos <= prev.second + 1 &&
  8307. !(first_pos == prev.first && last_pos == prev.second)) {
  8308. // Extend the previous range
  8309. prev.second = (std::max)(prev.second, last_pos);
  8310. continue;
  8311. }
  8312. }
  8313. // Add new range
  8314. coalesced.emplace_back(first_pos, last_pos);
  8315. }
  8316. ranges = std::move(coalesced);
  8317. }
  8318. inline bool range_error(Request &req, Response &res) {
  8319. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8320. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8321. req.ranges.clear();
  8322. if (res.status == StatusCode::PartialContent_206) {
  8323. res.status = StatusCode::OK_200;
  8324. }
  8325. return false;
  8326. }
  8327. ssize_t content_len = static_cast<ssize_t>(
  8328. res.content_length_ ? res.content_length_ : res.body.size());
  8329. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8330. size_t overwrapping_count = 0;
  8331. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8332. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8333. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8334. // Too many ranges
  8335. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8336. for (auto &r : req.ranges) {
  8337. auto &first_pos = r.first;
  8338. auto &last_pos = r.second;
  8339. if (first_pos == -1 && last_pos == -1) {
  8340. first_pos = 0;
  8341. last_pos = content_len;
  8342. }
  8343. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8344. // selects the entire representation.
  8345. if (first_pos == -1) {
  8346. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8347. last_pos = content_len - 1;
  8348. }
  8349. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8350. // A client can limit the number of bytes requested without knowing the
  8351. // size of the selected representation. If the last-pos value is absent,
  8352. // or if the value is greater than or equal to the current length of the
  8353. // representation data, the byte range is interpreted as the remainder of
  8354. // the representation (i.e., the server replaces the value of last-pos
  8355. // with a value that is one less than the current length of the selected
  8356. // representation).
  8357. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8358. if (last_pos == -1 || last_pos >= content_len) {
  8359. last_pos = content_len - 1;
  8360. }
  8361. // Range must be within content length
  8362. if (!(0 <= first_pos && first_pos <= last_pos &&
  8363. last_pos <= content_len - 1)) {
  8364. return true;
  8365. }
  8366. // Request must not have more than two overlapping ranges
  8367. for (const auto &processed_range : processed_ranges) {
  8368. if (!(last_pos < processed_range.first ||
  8369. first_pos > processed_range.second)) {
  8370. overwrapping_count++;
  8371. if (overwrapping_count > 2) { return true; }
  8372. break; // Only count once per range
  8373. }
  8374. }
  8375. processed_ranges.emplace_back(first_pos, last_pos);
  8376. }
  8377. // After validation, coalesce overlapping ranges as per RFC 9110
  8378. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8379. }
  8380. return false;
  8381. }
  8382. inline std::pair<size_t, size_t>
  8383. get_range_offset_and_length(Range r, size_t content_length) {
  8384. assert(r.first != -1 && r.second != -1);
  8385. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8386. assert(r.first <= r.second &&
  8387. r.second < static_cast<ssize_t>(content_length));
  8388. (void)(content_length);
  8389. return std::make_pair(static_cast<size_t>(r.first),
  8390. static_cast<size_t>(r.second - r.first) + 1);
  8391. }
  8392. inline std::string make_content_range_header_field(
  8393. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8394. auto st = offset_and_length.first;
  8395. auto ed = st + offset_and_length.second - 1;
  8396. std::string field = "bytes ";
  8397. field += std::to_string(st);
  8398. field += '-';
  8399. field += std::to_string(ed);
  8400. field += '/';
  8401. field += std::to_string(content_length);
  8402. return field;
  8403. }
  8404. template <typename SToken, typename CToken, typename Content>
  8405. bool process_multipart_ranges_data(const Request &req,
  8406. const std::string &boundary,
  8407. const std::string &content_type,
  8408. size_t content_length, SToken stoken,
  8409. CToken ctoken, Content content) {
  8410. for (size_t i = 0; i < req.ranges.size(); i++) {
  8411. ctoken("--");
  8412. stoken(boundary);
  8413. ctoken("\r\n");
  8414. if (!content_type.empty()) {
  8415. ctoken("Content-Type: ");
  8416. stoken(content_type);
  8417. ctoken("\r\n");
  8418. }
  8419. auto offset_and_length =
  8420. get_range_offset_and_length(req.ranges[i], content_length);
  8421. ctoken("Content-Range: ");
  8422. stoken(make_content_range_header_field(offset_and_length, content_length));
  8423. ctoken("\r\n");
  8424. ctoken("\r\n");
  8425. if (!content(offset_and_length.first, offset_and_length.second)) {
  8426. return false;
  8427. }
  8428. ctoken("\r\n");
  8429. }
  8430. ctoken("--");
  8431. stoken(boundary);
  8432. ctoken("--");
  8433. return true;
  8434. }
  8435. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8436. const std::string &boundary,
  8437. const std::string &content_type,
  8438. size_t content_length,
  8439. std::string &data) {
  8440. process_multipart_ranges_data(
  8441. req, boundary, content_type, content_length,
  8442. [&](const std::string &token) { data += token; },
  8443. [&](const std::string &token) { data += token; },
  8444. [&](size_t offset, size_t length) {
  8445. assert(offset + length <= content_length);
  8446. data += res.body.substr(offset, length);
  8447. return true;
  8448. });
  8449. }
  8450. inline size_t get_multipart_ranges_data_length(const Request &req,
  8451. const std::string &boundary,
  8452. const std::string &content_type,
  8453. size_t content_length) {
  8454. size_t data_length = 0;
  8455. process_multipart_ranges_data(
  8456. req, boundary, content_type, content_length,
  8457. [&](const std::string &token) { data_length += token.size(); },
  8458. [&](const std::string &token) { data_length += token.size(); },
  8459. [&](size_t /*offset*/, size_t length) {
  8460. data_length += length;
  8461. return true;
  8462. });
  8463. return data_length;
  8464. }
  8465. template <typename T>
  8466. inline bool
  8467. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8468. const std::string &boundary,
  8469. const std::string &content_type,
  8470. size_t content_length, const T &is_shutting_down) {
  8471. return process_multipart_ranges_data(
  8472. req, boundary, content_type, content_length,
  8473. [&](const std::string &token) { strm.write(token); },
  8474. [&](const std::string &token) { strm.write(token); },
  8475. [&](size_t offset, size_t length) {
  8476. return write_content(strm, res.content_provider_, offset, length,
  8477. is_shutting_down);
  8478. });
  8479. }
  8480. inline bool has_framed_body(const Request &req) {
  8481. return is_chunked_transfer_encoding(req.headers) ||
  8482. req.get_header_value_u64("Content-Length") > 0;
  8483. }
  8484. inline bool is_connection_persistent(const Request &req) {
  8485. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8486. if (req.version == "HTTP/1.0" &&
  8487. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8488. return false;
  8489. }
  8490. return true;
  8491. }
  8492. inline bool expect_content(const Request &req) {
  8493. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8494. req.method == "DELETE") {
  8495. return true;
  8496. }
  8497. return has_framed_body(req);
  8498. }
  8499. #ifdef _WIN32
  8500. class WSInit {
  8501. public:
  8502. WSInit() {
  8503. WSADATA wsaData;
  8504. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8505. }
  8506. ~WSInit() {
  8507. if (is_valid_) WSACleanup();
  8508. }
  8509. bool is_valid_ = false;
  8510. };
  8511. static WSInit wsinit_;
  8512. #endif
  8513. // RFC 9110 Section 11.6.1 defines a challenge list as
  8514. // WWW-Authenticate = #challenge
  8515. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8516. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8517. // so a server may offer several schemes, each with its own comma-separated
  8518. // auth-param list, in either order and either as separate field lines or
  8519. // packed into one. Splitting on every comma would break apart a challenge's
  8520. // own param list; splitting only on the first space would miss a Digest
  8521. // challenge that isn't first. Split on commas that aren't inside a
  8522. // quoted-string instead, then track which scheme each resulting segment
  8523. // belongs to: a segment whose text before "=" contains whitespace (or that
  8524. // has no "=" at all) starts a new challenge named by its leading token.
  8525. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8526. std::vector<std::string> segments;
  8527. size_t start = 0;
  8528. auto in_quotes = false;
  8529. for (size_t i = 0; i < s.size(); i++) {
  8530. auto c = s[i];
  8531. if (in_quotes) {
  8532. if (c == '\\' && i + 1 < s.size()) {
  8533. i++;
  8534. } else if (c == '"') {
  8535. in_quotes = false;
  8536. }
  8537. } else if (c == '"') {
  8538. in_quotes = true;
  8539. } else if (c == ',') {
  8540. segments.push_back(s.substr(start, i - start));
  8541. start = i + 1;
  8542. }
  8543. }
  8544. segments.push_back(s.substr(start));
  8545. return segments;
  8546. }
  8547. inline std::string unescape_quoted_pairs(const std::string &s) {
  8548. std::string out;
  8549. out.reserve(s.size());
  8550. for (size_t i = 0; i < s.size(); i++) {
  8551. if (s[i] == '\\' && i + 1 < s.size()) {
  8552. out += s[++i];
  8553. } else {
  8554. out += s[i];
  8555. }
  8556. }
  8557. return out;
  8558. }
  8559. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8560. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8561. // quoted-pair, so the recipient recovers the original value.
  8562. inline std::string escape_quoted_pairs(const std::string &s) {
  8563. std::string out;
  8564. out.reserve(s.size());
  8565. for (auto c : s) {
  8566. if (c == '\\' || c == '"') { out += '\\'; }
  8567. out += c;
  8568. }
  8569. return out;
  8570. }
  8571. inline bool parse_www_authenticate(const Response &res,
  8572. std::map<std::string, std::string> &auth,
  8573. bool is_proxy) {
  8574. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8575. auto combined = get_combined_header_value(res.headers, auth_key);
  8576. if (combined.empty()) { return false; }
  8577. auto found_digest = false;
  8578. auto in_digest_challenge = false;
  8579. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8580. auto segment = trim_copy(raw_segment);
  8581. if (segment.empty()) { continue; }
  8582. auto eq_pos = segment.find('=');
  8583. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8584. // for the first segment of a challenge, "<scheme> <key>") must be
  8585. // trimmed before its boundaries are inspected.
  8586. auto key_part = trim_copy(
  8587. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8588. auto space_pos = key_part.find_last_of(" \t");
  8589. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8590. // "<scheme>[ <key>]" starts a new challenge.
  8591. auto scheme_end =
  8592. space_pos == std::string::npos ? key_part.size() : space_pos;
  8593. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8594. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8595. // from one challenge is never paired with another's algorithm.
  8596. in_digest_challenge =
  8597. !found_digest &&
  8598. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8599. if (in_digest_challenge) { found_digest = true; }
  8600. if (space_pos == std::string::npos) {
  8601. // Bare scheme (or a token68), no auth-param on this segment.
  8602. continue;
  8603. }
  8604. key_part = key_part.substr(space_pos + 1);
  8605. }
  8606. if (!in_digest_challenge) { continue; }
  8607. auto val = trim_copy(segment.substr(eq_pos + 1));
  8608. auto unquoted = trim_double_quotes_copy(val);
  8609. if (unquoted.size() != val.size()) {
  8610. unquoted = unescape_quoted_pairs(unquoted);
  8611. }
  8612. auth[std::move(key_part)] = std::move(unquoted);
  8613. }
  8614. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8615. // make_digest_authentication_header() dereferences both unconditionally, so
  8616. // a challenge missing either can't produce a usable Authorization header.
  8617. // Treat it the same as no Digest challenge at all.
  8618. return found_digest && auth.find("realm") != auth.end() &&
  8619. auth.find("nonce") != auth.end();
  8620. }
  8621. class ContentProviderAdapter {
  8622. public:
  8623. explicit ContentProviderAdapter(
  8624. ContentProviderWithoutLength &&content_provider)
  8625. : content_provider_(std::move(content_provider)) {}
  8626. bool operator()(size_t offset, size_t, DataSink &sink) {
  8627. return content_provider_(offset, sink);
  8628. }
  8629. private:
  8630. ContentProviderWithoutLength content_provider_;
  8631. };
  8632. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8633. namespace fields {
  8634. inline bool is_token_char(char c) {
  8635. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8636. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8637. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8638. }
  8639. inline bool is_token(const std::string &s) {
  8640. if (s.empty()) { return false; }
  8641. for (auto c : s) {
  8642. if (!is_token_char(c)) { return false; }
  8643. }
  8644. return true;
  8645. }
  8646. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8647. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8648. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8649. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8650. inline bool is_field_content(const std::string &s) {
  8651. if (s.empty()) { return true; }
  8652. if (s.size() == 1) {
  8653. return is_field_vchar(s[0]);
  8654. } else if (s.size() == 2) {
  8655. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8656. } else {
  8657. size_t i = 0;
  8658. if (!is_field_vchar(s[i])) { return false; }
  8659. i++;
  8660. while (i < s.size() - 1) {
  8661. auto c = s[i++];
  8662. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8663. } else {
  8664. return false;
  8665. }
  8666. }
  8667. return is_field_vchar(s[i]);
  8668. }
  8669. }
  8670. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8671. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8672. return is_field_name(name) && is_field_value(value);
  8673. }
  8674. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8675. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8676. inline bool is_request_target(const std::string &s) {
  8677. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8678. }
  8679. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8680. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8681. inline bool is_host(const std::string &s) {
  8682. return std::all_of(s.begin(), s.end(), [](char c) {
  8683. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8684. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8685. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8686. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8687. });
  8688. }
  8689. } // namespace fields
  8690. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8691. WebSocketUpgradeResponse &upgrade) {
  8692. // Generate random Sec-WebSocket-Key
  8693. thread_local std::mt19937 rng(std::random_device{}());
  8694. std::string key_bytes(16, '\0');
  8695. for (size_t i = 0; i < 16; i += 4) {
  8696. auto r = rng();
  8697. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8698. }
  8699. auto client_key = base64_encode(key_bytes);
  8700. req.headers.erase("Upgrade");
  8701. req.headers.erase("Connection");
  8702. req.headers.erase("Sec-WebSocket-Key");
  8703. req.headers.erase("Sec-WebSocket-Version");
  8704. req.headers.emplace("Upgrade", "websocket");
  8705. req.headers.emplace("Connection", "Upgrade");
  8706. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8707. req.headers.emplace("Sec-WebSocket-Version", "13");
  8708. // Build the request in memory first, like ClientImpl::write_request does.
  8709. // Writing straight to the socket would leak a request line onto the wire
  8710. // before check_and_write_headers gets a chance to reject an invalid header,
  8711. // and would emit one small write per header.
  8712. BufferStream bstrm;
  8713. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8714. upgrade.error = Error::Write;
  8715. return false;
  8716. }
  8717. auto error = Error::Success;
  8718. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8719. upgrade.error = error;
  8720. return false;
  8721. }
  8722. const auto &data = bstrm.get_buffer();
  8723. if (!write_data(strm, data.data(), data.size())) {
  8724. upgrade.error = Error::Write;
  8725. return false;
  8726. }
  8727. // Verify 101 response and Sec-WebSocket-Accept header
  8728. auto expected_accept = websocket_accept_key(client_key);
  8729. auto offered_subprotocols =
  8730. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8731. return read_websocket_upgrade_response(strm, expected_accept,
  8732. offered_subprotocols, upgrade);
  8733. }
  8734. inline bool is_ip_address(const std::string &host) {
  8735. struct in_addr addr4;
  8736. struct in6_addr addr6;
  8737. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8738. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8739. }
  8740. // Resolve where a client should connect for `host`, honoring a user-supplied
  8741. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8742. // supplying the Host header and SNI; only the connection target changes.
  8743. //
  8744. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8745. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8746. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8747. // absent or empty mapping leaves `host` as the connection target; without the
  8748. // empty check the value would reach getaddrinfo as a null node and silently
  8749. // resolve to loopback.
  8750. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8751. const std::string &host, std::string &connect_host,
  8752. std::string &ip) {
  8753. connect_host = host;
  8754. ip.clear();
  8755. auto it = addr_map.find(host);
  8756. if (it == addr_map.end() || it->second.empty()) { return; }
  8757. if (is_ip_address(it->second)) {
  8758. ip = it->second;
  8759. } else {
  8760. connect_host = it->second;
  8761. }
  8762. }
  8763. } // namespace detail
  8764. /*
  8765. * Group 2: detail namespace - SSL common utilities
  8766. */
  8767. #ifdef CPPHTTPLIB_SSL_ENABLED
  8768. namespace detail {
  8769. class SSLSocketStream final : public Stream {
  8770. public:
  8771. SSLSocketStream(
  8772. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8773. time_t read_timeout_usec, time_t write_timeout_sec,
  8774. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8775. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8776. (std::chrono::steady_clock::time_point::min)());
  8777. ~SSLSocketStream() override;
  8778. bool is_readable() const override;
  8779. bool wait_readable() const override;
  8780. bool wait_writable() const override;
  8781. bool is_peer_alive() const override;
  8782. ssize_t read(char *ptr, size_t size) override;
  8783. ssize_t write(const char *ptr, size_t size) override;
  8784. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8785. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8786. socket_t socket() const override;
  8787. time_t duration() const override;
  8788. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8789. // See SocketStream::set_readable_hint().
  8790. void set_readable_hint() { readable_hint_ = true; }
  8791. private:
  8792. bool ensure_readable();
  8793. socket_t sock_;
  8794. tls::session_t session_;
  8795. time_t read_timeout_sec_;
  8796. time_t read_timeout_usec_;
  8797. time_t write_timeout_sec_;
  8798. time_t write_timeout_usec_;
  8799. time_t max_timeout_msec_;
  8800. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8801. bool readable_hint_ = false;
  8802. };
  8803. // A TLS stream for WebSocket connections, where the receive path and the
  8804. // send path (application send() plus the heartbeat ping thread) run on
  8805. // different threads. A single TLS session must never be entered
  8806. // concurrently, so every call into the session is serialized by one mutex.
  8807. //
  8808. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8809. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8810. // call under the lock, then waits for readiness with select() outside the
  8811. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8812. // blocked waiting for data never stalls a concurrent sender.
  8813. //
  8814. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8815. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8816. class WebSocketSSLStream final : public Stream {
  8817. public:
  8818. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8819. time_t read_timeout_sec, time_t read_timeout_usec,
  8820. time_t write_timeout_sec, time_t write_timeout_usec);
  8821. ~WebSocketSSLStream() override;
  8822. bool is_readable() const override;
  8823. bool wait_readable() const override;
  8824. bool wait_writable() const override;
  8825. ssize_t read(char *ptr, size_t size) override;
  8826. ssize_t write(const char *ptr, size_t size) override;
  8827. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8828. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8829. socket_t socket() const override;
  8830. time_t duration() const override;
  8831. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8832. private:
  8833. mutable std::mutex session_mutex_;
  8834. socket_t sock_;
  8835. tls::session_t session_;
  8836. // WebSocket::close() shortens the read timeout from the closing thread
  8837. // while the receive thread is inside wait_readable(), so these two are read
  8838. // and written concurrently. The write timeouts are never mutated.
  8839. std::atomic<time_t> read_timeout_sec_;
  8840. std::atomic<time_t> read_timeout_usec_;
  8841. time_t write_timeout_sec_;
  8842. time_t write_timeout_usec_;
  8843. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8844. };
  8845. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8846. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8847. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8848. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8849. unsigned int hash_length = 0;
  8850. unsigned char hash[EVP_MAX_MD_SIZE];
  8851. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8852. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8853. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8854. std::stringstream ss;
  8855. for (auto i = 0u; i < hash_length; ++i) {
  8856. ss << std::hex << std::setw(2) << std::setfill('0')
  8857. << static_cast<unsigned int>(hash[i]);
  8858. }
  8859. return ss.str();
  8860. }
  8861. inline std::string MD5(const std::string &s) {
  8862. return message_digest(s, EVP_md5());
  8863. }
  8864. inline std::string SHA_256(const std::string &s) {
  8865. return message_digest(s, EVP_sha256());
  8866. }
  8867. inline std::string SHA_512(const std::string &s) {
  8868. return message_digest(s, EVP_sha512());
  8869. }
  8870. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8871. namespace {
  8872. template <size_t N>
  8873. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8874. std::stringstream ss;
  8875. for (size_t i = 0; i < N; ++i) {
  8876. ss << std::hex << std::setw(2) << std::setfill('0')
  8877. << static_cast<unsigned int>(hash[i]);
  8878. }
  8879. return ss.str();
  8880. }
  8881. } // namespace
  8882. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8883. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8884. // initialized once. PSA state is process-global; do not free it.
  8885. inline bool ensure_mbedtls_psa_crypto() {
  8886. static std::once_flag once;
  8887. static bool ok = false;
  8888. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8889. return ok;
  8890. }
  8891. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8892. unsigned char *out, size_t out_size) {
  8893. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8894. size_t olen = 0;
  8895. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8896. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8897. olen == out_size;
  8898. }
  8899. #endif
  8900. inline std::string MD5(const std::string &s) {
  8901. unsigned char hash[16];
  8902. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8903. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8904. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8905. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8906. hash);
  8907. #else
  8908. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8909. hash);
  8910. #endif
  8911. return hash_to_hex(hash);
  8912. }
  8913. inline std::string SHA_256(const std::string &s) {
  8914. unsigned char hash[32];
  8915. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8916. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8917. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8918. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8919. hash, 0);
  8920. #else
  8921. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8922. s.size(), hash, 0);
  8923. #endif
  8924. return hash_to_hex(hash);
  8925. }
  8926. inline std::string SHA_512(const std::string &s) {
  8927. unsigned char hash[64];
  8928. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8929. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8930. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8931. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8932. hash, 0);
  8933. #else
  8934. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8935. s.size(), hash, 0);
  8936. #endif
  8937. return hash_to_hex(hash);
  8938. }
  8939. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8940. namespace {
  8941. template <size_t N>
  8942. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8943. std::stringstream ss;
  8944. for (size_t i = 0; i < N; ++i) {
  8945. ss << std::hex << std::setw(2) << std::setfill('0')
  8946. << static_cast<unsigned int>(hash[i]);
  8947. }
  8948. return ss.str();
  8949. }
  8950. } // namespace
  8951. inline std::string MD5(const std::string &s) {
  8952. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8953. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8954. static_cast<word32>(s.size()), hash);
  8955. return hash_to_hex(hash);
  8956. }
  8957. inline std::string SHA_256(const std::string &s) {
  8958. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8959. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8960. static_cast<word32>(s.size()), hash);
  8961. return hash_to_hex(hash);
  8962. }
  8963. inline std::string SHA_512(const std::string &s) {
  8964. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8965. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8966. static_cast<word32>(s.size()), hash);
  8967. return hash_to_hex(hash);
  8968. }
  8969. #endif
  8970. template <typename T>
  8971. inline bool process_server_socket_ssl(
  8972. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8973. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8974. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8975. time_t write_timeout_usec, T callback) {
  8976. // See process_server_socket(). The TLS library keeps already decrypted bytes
  8977. // of a pipelined request, which keep_alive() cannot see on the socket.
  8978. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8979. write_timeout_sec, write_timeout_usec);
  8980. return process_server_socket_core(
  8981. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8982. [&]() { return strm.is_readable(); },
  8983. [&](bool socket_readable, bool close_connection,
  8984. bool &connection_closed) {
  8985. if (socket_readable) { strm.set_readable_hint(); }
  8986. return callback(strm, close_connection, connection_closed);
  8987. });
  8988. }
  8989. template <typename T>
  8990. inline bool process_client_socket_ssl(
  8991. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8992. time_t read_timeout_usec, time_t write_timeout_sec,
  8993. time_t write_timeout_usec, time_t max_timeout_msec,
  8994. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8995. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8996. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8997. start_time);
  8998. return callback(strm);
  8999. }
  9000. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9001. const Request &req, const std::map<std::string, std::string> &auth,
  9002. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9003. const std::string &password, bool is_proxy = false) {
  9004. std::string nc;
  9005. {
  9006. std::stringstream ss;
  9007. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9008. nc = ss.str();
  9009. }
  9010. std::string qop;
  9011. if (auth.find("qop") != auth.end()) {
  9012. qop = auth.at("qop");
  9013. if (qop.find("auth-int") != std::string::npos) {
  9014. qop = "auth-int";
  9015. } else if (qop.find("auth") != std::string::npos) {
  9016. qop = "auth";
  9017. } else {
  9018. qop.clear();
  9019. }
  9020. }
  9021. std::string algo = "MD5";
  9022. if (auth.find("algorithm") != auth.end()) {
  9023. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9024. // not a token would otherwise be emitted verbatim and could carry commas
  9025. // or quotes that inject further auth-params into the header below.
  9026. const auto &a = auth.at("algorithm");
  9027. if (fields::is_token(a)) { algo = a; }
  9028. }
  9029. std::string response;
  9030. {
  9031. auto H = algo == "SHA-256" ? detail::SHA_256
  9032. : algo == "SHA-512" ? detail::SHA_512
  9033. : detail::MD5;
  9034. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9035. auto A2 = req.method + ":" + req.path;
  9036. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9037. if (qop.empty()) {
  9038. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9039. } else {
  9040. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9041. ":" + qop + ":" + H(A2));
  9042. }
  9043. }
  9044. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9045. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9046. // close the string early. realm, nonce and opaque come straight from the
  9047. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9048. // without this a crafted challenge injects extra auth-params into the header.
  9049. auto field =
  9050. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9051. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9052. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9053. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9054. "\", algorithm=" + algo +
  9055. (qop.empty() ? ", response=\""
  9056. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9057. "\", response=\"") +
  9058. response + "\"" +
  9059. (opaque.empty()
  9060. ? ""
  9061. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9062. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9063. return std::make_pair(key, field);
  9064. }
  9065. inline bool match_hostname(const std::string &pattern,
  9066. const std::string &hostname) {
  9067. // Exact match (case-insensitive)
  9068. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  9069. // Split both pattern and hostname into components by '.'
  9070. std::vector<std::string> pattern_components;
  9071. if (!pattern.empty()) {
  9072. split(pattern.data(), pattern.data() + pattern.size(), '.',
  9073. [&](const char *b, const char *e) {
  9074. pattern_components.emplace_back(b, e);
  9075. });
  9076. }
  9077. std::vector<std::string> host_components;
  9078. if (!hostname.empty()) {
  9079. split(hostname.data(), hostname.data() + hostname.size(), '.',
  9080. [&](const char *b, const char *e) {
  9081. host_components.emplace_back(b, e);
  9082. });
  9083. }
  9084. // Component count must match
  9085. if (host_components.size() != pattern_components.size()) { return false; }
  9086. // Compare each component with wildcard support
  9087. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9088. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9089. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9090. auto itr = pattern_components.begin();
  9091. for (const auto &h : host_components) {
  9092. auto &p = *itr;
  9093. auto is_leftmost = itr == pattern_components.begin();
  9094. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9095. bool partial_match = false;
  9096. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9097. const auto prefix_length = p.size() - 1;
  9098. if (prefix_length == 0) {
  9099. partial_match = true;
  9100. } else if (h.size() >= prefix_length) {
  9101. partial_match =
  9102. std::equal(p.begin(),
  9103. p.begin() + static_cast<std::string::difference_type>(
  9104. prefix_length),
  9105. h.begin(), [](const char ca, const char cb) {
  9106. return detail::case_ignore::to_lower(ca) ==
  9107. detail::case_ignore::to_lower(cb);
  9108. });
  9109. }
  9110. }
  9111. if (!partial_match) { return false; }
  9112. }
  9113. ++itr;
  9114. }
  9115. return true;
  9116. }
  9117. #ifdef _WIN32
  9118. // Verify certificate using Windows CertGetCertificateChain API.
  9119. // This provides real-time certificate validation with Windows Update
  9120. // integration, independent of the TLS backend.
  9121. inline bool verify_cert_with_windows_schannel(
  9122. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9123. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9124. if (der_cert.empty()) { return false; }
  9125. out_error = 0;
  9126. // Create Windows certificate context from DER data
  9127. auto cert_context = CertCreateCertificateContext(
  9128. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9129. static_cast<DWORD>(der_cert.size()));
  9130. if (!cert_context) {
  9131. out_error = GetLastError();
  9132. return false;
  9133. }
  9134. auto cert_guard =
  9135. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9136. // Give CryptoAPI the certificates the server sent. Without them it follows
  9137. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9138. std::vector<tls::cert_t> peer_certs;
  9139. tls::get_peer_certs(session, peer_certs);
  9140. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9141. auto store_guard = scope_exit([&] {
  9142. for (auto cert : peer_certs) {
  9143. tls::free_cert(cert);
  9144. }
  9145. if (store) { CertCloseStore(store, 0); }
  9146. });
  9147. for (auto cert : peer_certs) {
  9148. std::vector<unsigned char> der;
  9149. if (store && tls::get_cert_der(cert, der)) {
  9150. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9151. static_cast<DWORD>(der.size()),
  9152. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9153. }
  9154. }
  9155. // Setup chain parameters
  9156. CERT_CHAIN_PARA chain_para = {};
  9157. chain_para.cbSize = sizeof(chain_para);
  9158. // Require the server authentication usage along the chain, which also
  9159. // rejects roots that Windows trusts only for other purposes.
  9160. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9161. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9162. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9163. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9164. // Build certificate chain with revocation checking
  9165. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9166. auto chain_result = CertGetCertificateChain(
  9167. nullptr, cert_context, nullptr, store, &chain_para,
  9168. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9169. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9170. nullptr, &chain_context);
  9171. if (!chain_result || !chain_context) {
  9172. out_error = GetLastError();
  9173. return false;
  9174. }
  9175. auto chain_guard =
  9176. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9177. // Verify SSL policy
  9178. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9179. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9180. #ifdef AUTHTYPE_SERVER
  9181. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9182. #endif
  9183. std::wstring whost;
  9184. if (verify_hostname) {
  9185. whost = u8string_to_wstring(hostname.c_str());
  9186. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9187. }
  9188. CERT_CHAIN_POLICY_PARA policy_para = {};
  9189. policy_para.cbSize = sizeof(policy_para);
  9190. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9191. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9192. #else
  9193. policy_para.dwFlags = 0;
  9194. #endif
  9195. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9196. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9197. policy_status.cbSize = sizeof(policy_status);
  9198. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9199. &policy_para, &policy_status)) {
  9200. out_error = GetLastError();
  9201. return false;
  9202. }
  9203. if (policy_status.dwError != 0) {
  9204. out_error = policy_status.dwError;
  9205. return false;
  9206. }
  9207. return true;
  9208. }
  9209. #endif // _WIN32
  9210. // Loads CA file/dir configuration and applies the system CA policy to a
  9211. // client TLS context. PEM data and native stores are applied to the context
  9212. // directly at set time; has_custom_store reflects them for the Auto policy
  9213. // decision.
  9214. inline bool load_client_ca_config(tls::ctx_t ctx,
  9215. const std::string &ca_cert_file_path,
  9216. const std::string &ca_cert_dir_path,
  9217. bool has_custom_store, SystemCAMode mode,
  9218. uint64_t &backend_error) {
  9219. auto ret = true;
  9220. if (!ca_cert_file_path.empty()) {
  9221. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9222. backend_error = tls::get_error();
  9223. ret = false;
  9224. }
  9225. } else if (!ca_cert_dir_path.empty()) {
  9226. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9227. backend_error = tls::get_error();
  9228. ret = false;
  9229. }
  9230. }
  9231. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9232. !ca_cert_dir_path.empty() || has_custom_store;
  9233. if (mode == SystemCAMode::Enabled ||
  9234. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9235. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9236. }
  9237. return ret;
  9238. }
  9239. // The parts of session setup that only SSLClient needs, plus the handful
  9240. // WebSocketClient also exposes; everything else takes the defaults, which is
  9241. // what keeps the two clients on one implementation.
  9242. struct ClientTlsSessionOptions {
  9243. // Both SSLClient and WebSocketClient expose this independently of
  9244. // certificate verification.
  9245. bool server_hostname_verification = true;
  9246. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9247. // When non-null, guards session creation against concurrent use of the
  9248. // context. A WebSocketClient is not safe to use from several threads to
  9249. // begin with, so it passes nothing.
  9250. std::mutex *ctx_mutex = nullptr;
  9251. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9252. // The caller decides whether Schannel has anything to say about this
  9253. // connection; see SSLClient::initialize_ssl().
  9254. bool windows_cert_verification = false;
  9255. // A server certificate verifier works on the backend's chain verification,
  9256. // so the backend keeps deciding and Schannel only adds its own check.
  9257. bool server_certificate_verifier_set = false;
  9258. #endif
  9259. };
  9260. // Filled in on failure for callers that report error details.
  9261. struct ClientTlsSessionError {
  9262. Error error = Error::Success;
  9263. int ssl_error = 0;
  9264. uint64_t backend_error = 0;
  9265. };
  9266. // Establishes a client TLS session on an already connected socket. On failure
  9267. // the session is left for the caller to free: SSLClient frees it right away,
  9268. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9269. inline bool setup_client_tls_session(
  9270. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9271. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9272. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9273. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9274. using namespace tls;
  9275. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9276. if (out_error) {
  9277. out_error->error = error;
  9278. out_error->ssl_error = ssl_error;
  9279. out_error->backend_error = backend_error;
  9280. }
  9281. return false;
  9282. };
  9283. if (!ctx) {
  9284. session = nullptr;
  9285. return fail(Error::SSLConnection, 0, 0);
  9286. }
  9287. // With Windows verification on and no server certificate verifier set,
  9288. // Schannel is the only chain verifier. The backend's trust store is a
  9289. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9290. // demand, so the backend's verdict is not used.
  9291. auto windows_verifies_chain = false;
  9292. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9293. windows_verifies_chain = options.windows_cert_verification &&
  9294. !options.server_certificate_verifier_set;
  9295. #endif
  9296. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9297. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9298. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9299. // Schannel verifies the chain instead, chain verification happens during
  9300. // the handshake even for IP hosts; the certificate identity is verified
  9301. // post-handshake via verify_hostname().
  9302. set_verify_client(ctx,
  9303. server_certificate_verification && !windows_verifies_chain);
  9304. #endif
  9305. {
  9306. std::unique_lock<std::mutex> guard;
  9307. if (options.ctx_mutex) {
  9308. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9309. }
  9310. session = create_session(ctx, sock);
  9311. }
  9312. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9313. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9314. // their identity is checked post-handshake below instead. On Mbed TLS and
  9315. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9316. // options.server_hostname_verification is threaded through here.
  9317. if (!is_ip_address(host)) {
  9318. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9319. return fail(Error::SSLConnection, 0, get_error());
  9320. }
  9321. }
  9322. TlsError tls_err;
  9323. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9324. &tls_err)) {
  9325. auto error = Error::SSLConnection;
  9326. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9327. error = Error::SSLServerVerification;
  9328. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9329. error = Error::SSLServerHostnameVerification;
  9330. }
  9331. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9332. }
  9333. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9334. if (options.session_verifier) {
  9335. verification_status = options.session_verifier(session);
  9336. }
  9337. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9338. return fail(Error::SSLServerVerification, 0, get_error());
  9339. }
  9340. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9341. server_certificate_verification) {
  9342. if (!windows_verifies_chain) {
  9343. auto verify_result = get_verify_result(session);
  9344. if (verify_result != 0) {
  9345. return fail(Error::SSLServerVerification, 0,
  9346. static_cast<uint64_t>(verify_result));
  9347. }
  9348. }
  9349. auto server_cert = get_peer_cert(session);
  9350. if (!server_cert) {
  9351. return fail(Error::SSLServerVerification, 0, get_error());
  9352. }
  9353. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9354. // Identity check against the peer certificate, post-handshake for all
  9355. // backends. For IP hosts this is the only identity verification, since no
  9356. // hostname is bound during the handshake.
  9357. if (options.server_hostname_verification) {
  9358. if (!verify_hostname(server_cert, host.c_str())) {
  9359. return fail(Error::SSLServerHostnameVerification, 0,
  9360. hostname_mismatch_code());
  9361. }
  9362. }
  9363. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9364. // Windows Schannel verification, which lets Windows fetch missing roots
  9365. // and intermediates on demand. It must not be skipped: unless a server
  9366. // certificate verifier is set, it is the only chain check.
  9367. if (options.windows_cert_verification) {
  9368. std::vector<unsigned char> der;
  9369. uint64_t wincrypt_error = 0;
  9370. if (!get_cert_der(server_cert, der) ||
  9371. !verify_cert_with_windows_schannel(
  9372. der, host, options.server_hostname_verification, wincrypt_error,
  9373. session)) {
  9374. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9375. }
  9376. }
  9377. #endif
  9378. }
  9379. return true;
  9380. }
  9381. } // namespace detail
  9382. #endif // CPPHTTPLIB_SSL_ENABLED
  9383. /*
  9384. * Group 3: httplib namespace - Non-SSL public API implementations
  9385. */
  9386. inline void default_socket_options(socket_t sock) {
  9387. set_socket_opt(sock, SOL_SOCKET,
  9388. #ifdef SO_REUSEPORT
  9389. SO_REUSEPORT,
  9390. #else
  9391. SO_REUSEADDR,
  9392. #endif
  9393. 1);
  9394. }
  9395. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9396. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9397. sizeof(optval));
  9398. }
  9399. inline std::string get_bearer_token_auth(const Request &req) {
  9400. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9401. // than the prefix carries no token.
  9402. constexpr const char bearer_prefix[] = "Bearer ";
  9403. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9404. auto value = req.get_header_value("Authorization");
  9405. if (value.size() >= bearer_prefix_len &&
  9406. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9407. bearer_prefix)) {
  9408. return value.substr(bearer_prefix_len);
  9409. }
  9410. return "";
  9411. }
  9412. inline const char *status_message(int status) {
  9413. switch (status) {
  9414. case StatusCode::Continue_100: return "Continue";
  9415. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9416. case StatusCode::Processing_102: return "Processing";
  9417. case StatusCode::EarlyHints_103: return "Early Hints";
  9418. case StatusCode::OK_200: return "OK";
  9419. case StatusCode::Created_201: return "Created";
  9420. case StatusCode::Accepted_202: return "Accepted";
  9421. case StatusCode::NonAuthoritativeInformation_203:
  9422. return "Non-Authoritative Information";
  9423. case StatusCode::NoContent_204: return "No Content";
  9424. case StatusCode::ResetContent_205: return "Reset Content";
  9425. case StatusCode::PartialContent_206: return "Partial Content";
  9426. case StatusCode::MultiStatus_207: return "Multi-Status";
  9427. case StatusCode::AlreadyReported_208: return "Already Reported";
  9428. case StatusCode::IMUsed_226: return "IM Used";
  9429. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9430. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9431. case StatusCode::Found_302: return "Found";
  9432. case StatusCode::SeeOther_303: return "See Other";
  9433. case StatusCode::NotModified_304: return "Not Modified";
  9434. case StatusCode::UseProxy_305: return "Use Proxy";
  9435. case StatusCode::unused_306: return "unused";
  9436. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9437. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9438. case StatusCode::BadRequest_400: return "Bad Request";
  9439. case StatusCode::Unauthorized_401: return "Unauthorized";
  9440. case StatusCode::PaymentRequired_402: return "Payment Required";
  9441. case StatusCode::Forbidden_403: return "Forbidden";
  9442. case StatusCode::NotFound_404: return "Not Found";
  9443. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9444. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9445. case StatusCode::ProxyAuthenticationRequired_407:
  9446. return "Proxy Authentication Required";
  9447. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9448. case StatusCode::Conflict_409: return "Conflict";
  9449. case StatusCode::Gone_410: return "Gone";
  9450. case StatusCode::LengthRequired_411: return "Length Required";
  9451. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9452. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9453. case StatusCode::UriTooLong_414: return "URI Too Long";
  9454. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9455. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9456. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9457. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9458. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9459. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9460. case StatusCode::Locked_423: return "Locked";
  9461. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9462. case StatusCode::TooEarly_425: return "Too Early";
  9463. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9464. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9465. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9466. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9467. return "Request Header Fields Too Large";
  9468. case StatusCode::UnavailableForLegalReasons_451:
  9469. return "Unavailable For Legal Reasons";
  9470. case StatusCode::NotImplemented_501: return "Not Implemented";
  9471. case StatusCode::BadGateway_502: return "Bad Gateway";
  9472. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9473. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9474. case StatusCode::HttpVersionNotSupported_505:
  9475. return "HTTP Version Not Supported";
  9476. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9477. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9478. case StatusCode::LoopDetected_508: return "Loop Detected";
  9479. case StatusCode::NotExtended_510: return "Not Extended";
  9480. case StatusCode::NetworkAuthenticationRequired_511:
  9481. return "Network Authentication Required";
  9482. default:
  9483. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9484. }
  9485. }
  9486. inline std::string to_string(const Error error) {
  9487. switch (error) {
  9488. case Error::Success: return "Success (no error)";
  9489. case Error::Unknown: return "Unknown";
  9490. case Error::Connection: return "Could not establish connection";
  9491. case Error::BindIPAddress: return "Failed to bind IP address";
  9492. case Error::Read: return "Failed to read connection";
  9493. case Error::Write: return "Failed to write connection";
  9494. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9495. case Error::Canceled: return "Connection handling canceled";
  9496. case Error::SSLConnection: return "SSL connection failed";
  9497. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9498. case Error::SSLServerVerification: return "SSL server verification failed";
  9499. case Error::SSLServerHostnameVerification:
  9500. return "SSL server hostname verification failed";
  9501. case Error::UnsupportedMultipartBoundaryChars:
  9502. return "Unsupported HTTP multipart boundary characters";
  9503. case Error::Compression: return "Compression failed";
  9504. case Error::ConnectionTimeout: return "Connection timed out";
  9505. case Error::ProxyConnection: return "Proxy connection failed";
  9506. case Error::ConnectionClosed: return "Connection closed by server";
  9507. case Error::Timeout: return "Read timeout";
  9508. case Error::ResourceExhaustion: return "Resource exhaustion";
  9509. case Error::TooManyFormDataFiles: return "Too many form data files";
  9510. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9511. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9512. case Error::ExceedMaxSocketDescriptorCount:
  9513. return "Exceeded maximum socket descriptor count";
  9514. case Error::InvalidRequestLine: return "Invalid request line";
  9515. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9516. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9517. case Error::InvalidHeaders: return "Invalid headers";
  9518. case Error::MultipartParsing: return "Multipart parsing failed";
  9519. case Error::OpenFile: return "Failed to open file";
  9520. case Error::Listen: return "Failed to listen on socket";
  9521. case Error::GetSockName: return "Failed to get socket name";
  9522. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9523. case Error::HTTPParsing: return "HTTP parsing failed";
  9524. case Error::InvalidRangeHeader: return "Invalid Range header";
  9525. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9526. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9527. case Error::UserCallbackException: return "User callback threw an exception";
  9528. default: break;
  9529. }
  9530. return "Invalid";
  9531. }
  9532. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9533. os << to_string(obj);
  9534. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9535. return os;
  9536. }
  9537. inline std::string hosted_at(const std::string &hostname) {
  9538. std::vector<std::string> addrs;
  9539. hosted_at(hostname, addrs);
  9540. if (addrs.empty()) { return std::string(); }
  9541. return addrs[0];
  9542. }
  9543. inline void hosted_at(const std::string &hostname,
  9544. std::vector<std::string> &addrs) {
  9545. struct addrinfo hints;
  9546. struct addrinfo *result;
  9547. memset(&hints, 0, sizeof(struct addrinfo));
  9548. hints.ai_family = AF_UNSPEC;
  9549. hints.ai_socktype = SOCK_STREAM;
  9550. hints.ai_protocol = 0;
  9551. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9552. &result, 0)) {
  9553. #if defined __linux__ && !defined __ANDROID__
  9554. res_init();
  9555. #endif
  9556. return;
  9557. }
  9558. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9559. for (auto rp = result; rp; rp = rp->ai_next) {
  9560. const auto &addr =
  9561. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9562. std::string ip;
  9563. auto dummy = -1;
  9564. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9565. dummy)) {
  9566. addrs.emplace_back(std::move(ip));
  9567. }
  9568. }
  9569. }
  9570. inline std::string encode_uri_component(const std::string &value) {
  9571. std::ostringstream escaped;
  9572. escaped.fill('0');
  9573. escaped << std::hex;
  9574. for (auto c : value) {
  9575. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9576. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9577. escaped << c;
  9578. } else {
  9579. escaped << std::uppercase;
  9580. escaped << '%' << std::setw(2)
  9581. << static_cast<int>(static_cast<unsigned char>(c));
  9582. escaped << std::nouppercase;
  9583. }
  9584. }
  9585. return escaped.str();
  9586. }
  9587. inline std::string encode_uri(const std::string &value) {
  9588. std::ostringstream escaped;
  9589. escaped.fill('0');
  9590. escaped << std::hex;
  9591. for (auto c : value) {
  9592. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9593. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9594. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9595. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9596. escaped << c;
  9597. } else {
  9598. escaped << std::uppercase;
  9599. escaped << '%' << std::setw(2)
  9600. << static_cast<int>(static_cast<unsigned char>(c));
  9601. escaped << std::nouppercase;
  9602. }
  9603. }
  9604. return escaped.str();
  9605. }
  9606. inline std::string decode_uri_component(const std::string &value) {
  9607. std::string result;
  9608. for (size_t i = 0; i < value.size(); i++) {
  9609. if (value[i] == '%' && i + 2 < value.size()) {
  9610. auto val = 0;
  9611. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9612. result += static_cast<char>(val);
  9613. i += 2;
  9614. } else {
  9615. result += value[i];
  9616. }
  9617. } else {
  9618. result += value[i];
  9619. }
  9620. }
  9621. return result;
  9622. }
  9623. inline std::string decode_uri(const std::string &value) {
  9624. std::string result;
  9625. for (size_t i = 0; i < value.size(); i++) {
  9626. if (value[i] == '%' && i + 2 < value.size()) {
  9627. auto val = 0;
  9628. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9629. auto c = static_cast<char>(val);
  9630. // Keep escapes of the reserved characters that encode_uri leaves
  9631. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9632. // delimiter is not promoted into a real one (as with JS decodeURI).
  9633. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9634. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9635. c == '#') {
  9636. result += value[i];
  9637. result += value[i + 1];
  9638. result += value[i + 2];
  9639. } else {
  9640. result += c;
  9641. }
  9642. i += 2;
  9643. } else {
  9644. result += value[i];
  9645. }
  9646. } else {
  9647. result += value[i];
  9648. }
  9649. }
  9650. return result;
  9651. }
  9652. inline std::string encode_path_component(const std::string &component) {
  9653. std::string result;
  9654. result.reserve(component.size() * 3);
  9655. for (size_t i = 0; i < component.size(); i++) {
  9656. auto c = static_cast<unsigned char>(component[i]);
  9657. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9658. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9659. c == '_' || c == '~') {
  9660. result += static_cast<char>(c);
  9661. }
  9662. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9663. // "," / ";" / "="
  9664. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9665. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9666. c == '=') {
  9667. result += static_cast<char>(c);
  9668. }
  9669. // Colon is allowed in path segments except first segment
  9670. else if (c == ':') {
  9671. result += static_cast<char>(c);
  9672. }
  9673. // @ is allowed in path
  9674. else if (c == '@') {
  9675. result += static_cast<char>(c);
  9676. } else {
  9677. result += '%';
  9678. char hex[3];
  9679. snprintf(hex, sizeof(hex), "%02X", c);
  9680. result.append(hex, 2);
  9681. }
  9682. }
  9683. return result;
  9684. }
  9685. inline std::string decode_path_component(const std::string &component) {
  9686. std::string result;
  9687. result.reserve(component.size());
  9688. for (size_t i = 0; i < component.size(); i++) {
  9689. if (component[i] == '%' && i + 1 < component.size()) {
  9690. if (component[i + 1] == 'u') {
  9691. // Unicode %uXXXX encoding
  9692. auto val = 0;
  9693. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9694. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9695. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9696. char buff[4];
  9697. size_t len = detail::to_utf8(val, buff);
  9698. if (len > 0) { result.append(buff, len); }
  9699. i += 5; // 'u0000'
  9700. } else {
  9701. result += component[i];
  9702. }
  9703. } else {
  9704. // Standard %XX encoding
  9705. auto val = 0;
  9706. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9707. // 2 digits hex codes
  9708. result += static_cast<char>(val);
  9709. i += 2; // 'XX'
  9710. } else {
  9711. result += component[i];
  9712. }
  9713. }
  9714. } else {
  9715. result += component[i];
  9716. }
  9717. }
  9718. return result;
  9719. }
  9720. inline std::string encode_query_component(const std::string &component,
  9721. bool space_as_plus) {
  9722. std::string result;
  9723. result.reserve(component.size() * 3);
  9724. for (size_t i = 0; i < component.size(); i++) {
  9725. auto c = static_cast<unsigned char>(component[i]);
  9726. // Unreserved characters per RFC 3986
  9727. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9728. c == '_' || c == '~') {
  9729. result += static_cast<char>(c);
  9730. }
  9731. // Space handling
  9732. else if (c == ' ') {
  9733. if (space_as_plus) {
  9734. result += '+';
  9735. } else {
  9736. result += "%20";
  9737. }
  9738. }
  9739. // Plus sign handling
  9740. else if (c == '+') {
  9741. if (space_as_plus) {
  9742. result += "%2B";
  9743. } else {
  9744. result += static_cast<char>(c);
  9745. }
  9746. }
  9747. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9748. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9749. c == '*' || c == ',' || c == ';') {
  9750. result += static_cast<char>(c);
  9751. }
  9752. // Colon and @ are allowed in query
  9753. else if (c == ':' || c == '@') {
  9754. result += static_cast<char>(c);
  9755. }
  9756. // Forward slash is allowed in query values
  9757. else if (c == '/') {
  9758. result += static_cast<char>(c);
  9759. }
  9760. // Question mark is allowed in query values (after first ?)
  9761. else if (c == '?') {
  9762. result += static_cast<char>(c);
  9763. } else {
  9764. result += '%';
  9765. char hex[3];
  9766. snprintf(hex, sizeof(hex), "%02X", c);
  9767. result.append(hex, 2);
  9768. }
  9769. }
  9770. return result;
  9771. }
  9772. inline std::string decode_query_component(const std::string &component,
  9773. bool plus_as_space) {
  9774. std::string result;
  9775. result.reserve(component.size());
  9776. for (size_t i = 0; i < component.size(); i++) {
  9777. if (component[i] == '%' && i + 2 < component.size()) {
  9778. auto val = 0;
  9779. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9780. result += static_cast<char>(val);
  9781. i += 2;
  9782. } else {
  9783. result += component[i];
  9784. }
  9785. } else if (component[i] == '+' && plus_as_space) {
  9786. result += ' '; // + becomes space in form-urlencoded
  9787. } else {
  9788. result += component[i];
  9789. }
  9790. }
  9791. return result;
  9792. }
  9793. inline std::string sanitize_filename(const std::string &filename) {
  9794. // Extract basename: find the last path separator (/ or \)
  9795. auto pos = filename.find_last_of("/\\");
  9796. auto result =
  9797. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9798. // Strip null bytes
  9799. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9800. // Trim whitespace
  9801. {
  9802. auto start = result.find_first_not_of(" \t");
  9803. auto end = result.find_last_not_of(" \t");
  9804. result = (start == std::string::npos)
  9805. ? ""
  9806. : result.substr(start, end - start + 1);
  9807. }
  9808. // Reject . and ..
  9809. if (result == "." || result == "..") { return ""; }
  9810. return result;
  9811. }
  9812. inline std::string append_query_params(const std::string &path,
  9813. const Params &params) {
  9814. std::string path_with_query = path;
  9815. thread_local const std::regex re("[^?]+\\?.*");
  9816. auto delm = std::regex_match(path, re) ? '&' : '?';
  9817. path_with_query += delm + detail::params_to_query_str(params);
  9818. return path_with_query;
  9819. }
  9820. // Header utilities
  9821. inline std::pair<std::string, std::string>
  9822. make_range_header(const Ranges &ranges) {
  9823. std::string field = "bytes=";
  9824. auto i = 0;
  9825. for (const auto &r : ranges) {
  9826. if (i != 0) { field += ", "; }
  9827. if (r.first != -1) { field += std::to_string(r.first); }
  9828. field += '-';
  9829. if (r.second != -1) { field += std::to_string(r.second); }
  9830. i++;
  9831. }
  9832. return std::make_pair("Range", std::move(field));
  9833. }
  9834. inline std::pair<std::string, std::string>
  9835. make_basic_authentication_header(const std::string &username,
  9836. const std::string &password, bool is_proxy) {
  9837. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9838. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9839. return std::make_pair(key, std::move(field));
  9840. }
  9841. inline std::pair<std::string, std::string>
  9842. make_bearer_token_authentication_header(const std::string &token,
  9843. bool is_proxy = false) {
  9844. auto field = "Bearer " + token;
  9845. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9846. return std::make_pair(key, std::move(field));
  9847. }
  9848. // Request implementation
  9849. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9850. size_t id) const {
  9851. return detail::get_header_value_u64(headers, key, def, id);
  9852. }
  9853. inline bool Request::has_header(const std::string &key) const {
  9854. return detail::has_header(headers, key);
  9855. }
  9856. inline std::string Request::get_header_value(const std::string &key,
  9857. const char *def, size_t id) const {
  9858. return detail::get_header_value(headers, key, def, id);
  9859. }
  9860. inline size_t Request::get_header_value_count(const std::string &key) const {
  9861. return detail::get_header_value_count(headers, key);
  9862. }
  9863. inline void Request::set_header(const std::string &key,
  9864. const std::string &val) {
  9865. detail::set_header(headers, key, val);
  9866. }
  9867. inline bool Request::has_trailer(const std::string &key) const {
  9868. return trailers.find(key) != trailers.end();
  9869. }
  9870. inline std::string Request::get_trailer_value(const std::string &key,
  9871. size_t id) const {
  9872. return detail::get_multimap_value(trailers, key, id);
  9873. }
  9874. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9875. return trailers.count(key);
  9876. }
  9877. inline bool Request::has_param(const std::string &key) const {
  9878. return params.find(key) != params.end();
  9879. }
  9880. inline std::string Request::get_param_value(const std::string &key,
  9881. size_t id) const {
  9882. return detail::get_multimap_value(params, key, id);
  9883. }
  9884. inline std::vector<std::string>
  9885. Request::get_param_values(const std::string &key) const {
  9886. auto rng = params.equal_range(key);
  9887. std::vector<std::string> values;
  9888. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9889. for (auto it = rng.first; it != rng.second; ++it) {
  9890. values.push_back(it->second);
  9891. }
  9892. return values;
  9893. }
  9894. inline size_t Request::get_param_value_count(const std::string &key) const {
  9895. return params.count(key);
  9896. }
  9897. inline bool Request::is_multipart_form_data() const {
  9898. const auto &content_type = get_header_value("Content-Type");
  9899. return detail::extract_media_type(content_type) == "multipart/form-data";
  9900. }
  9901. // Multipart FormData implementation
  9902. inline std::string MultipartFormData::get_field(const std::string &key,
  9903. size_t id) const {
  9904. auto rng = fields.equal_range(key);
  9905. auto it = rng.first;
  9906. std::advance(it, static_cast<ssize_t>(id));
  9907. if (it != rng.second) { return it->second.content; }
  9908. return std::string();
  9909. }
  9910. inline std::vector<std::string>
  9911. MultipartFormData::get_fields(const std::string &key) const {
  9912. std::vector<std::string> values;
  9913. auto rng = fields.equal_range(key);
  9914. for (auto it = rng.first; it != rng.second; it++) {
  9915. values.push_back(it->second.content);
  9916. }
  9917. return values;
  9918. }
  9919. inline bool MultipartFormData::has_field(const std::string &key) const {
  9920. return fields.find(key) != fields.end();
  9921. }
  9922. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9923. return fields.count(key);
  9924. }
  9925. inline FormData MultipartFormData::get_file(const std::string &key,
  9926. size_t id) const {
  9927. return detail::get_multimap_value(files, key, id);
  9928. }
  9929. inline std::vector<FormData>
  9930. MultipartFormData::get_files(const std::string &key) const {
  9931. std::vector<FormData> values;
  9932. auto rng = files.equal_range(key);
  9933. for (auto it = rng.first; it != rng.second; it++) {
  9934. values.push_back(it->second);
  9935. }
  9936. return values;
  9937. }
  9938. inline bool MultipartFormData::has_file(const std::string &key) const {
  9939. return files.find(key) != files.end();
  9940. }
  9941. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9942. return files.count(key);
  9943. }
  9944. // Multipart FormData writer implementation
  9945. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9946. return detail::is_multipart_boundary_chars_valid(boundary);
  9947. }
  9948. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9949. : boundary_(detail::make_multipart_data_boundary()) {}
  9950. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9951. : boundary_(std::move(boundary)) {}
  9952. inline const std::string &MultipartFormDataWriter::boundary() const {
  9953. return boundary_;
  9954. }
  9955. inline std::string MultipartFormDataWriter::content_type() const {
  9956. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9957. }
  9958. inline std::string
  9959. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9960. return detail::serialize_multipart_formdata(items, boundary_);
  9961. }
  9962. inline size_t MultipartFormDataWriter::content_length(
  9963. const UploadFormDataItems &items) const {
  9964. return detail::get_multipart_content_length(items, boundary_);
  9965. }
  9966. inline std::string
  9967. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9968. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9969. }
  9970. inline std::string MultipartFormDataWriter::item_end() {
  9971. return detail::serialize_multipart_formdata_item_end();
  9972. }
  9973. inline std::string MultipartFormDataWriter::finish() const {
  9974. return detail::serialize_multipart_formdata_finish(boundary_);
  9975. }
  9976. // Response implementation
  9977. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9978. size_t id) const {
  9979. return detail::get_header_value_u64(headers, key, def, id);
  9980. }
  9981. inline bool Response::has_header(const std::string &key) const {
  9982. return headers.find(key) != headers.end();
  9983. }
  9984. inline std::string Response::get_header_value(const std::string &key,
  9985. const char *def,
  9986. size_t id) const {
  9987. return detail::get_header_value(headers, key, def, id);
  9988. }
  9989. inline size_t Response::get_header_value_count(const std::string &key) const {
  9990. return detail::get_header_value_count(headers, key);
  9991. }
  9992. inline void Response::set_header(const std::string &key,
  9993. const std::string &val) {
  9994. detail::set_header(headers, key, val);
  9995. }
  9996. inline bool Response::has_trailer(const std::string &key) const {
  9997. return trailers.find(key) != trailers.end();
  9998. }
  9999. inline std::string Response::get_trailer_value(const std::string &key,
  10000. size_t id) const {
  10001. return detail::get_multimap_value(trailers, key, id);
  10002. }
  10003. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10004. return trailers.count(key);
  10005. }
  10006. inline void Response::set_redirect(const std::string &url, int stat) {
  10007. if (detail::fields::is_field_value(url)) {
  10008. set_header("Location", url);
  10009. if (300 <= stat && stat < 400) {
  10010. this->status = stat;
  10011. } else {
  10012. this->status = StatusCode::Found_302;
  10013. }
  10014. }
  10015. }
  10016. inline void Response::set_content(const char *s, size_t n,
  10017. const std::string &content_type) {
  10018. body.assign(s, n);
  10019. auto rng = headers.equal_range("Content-Type");
  10020. headers.erase(rng.first, rng.second);
  10021. set_header("Content-Type", content_type);
  10022. content_coding_ = detail::EncodingType::None;
  10023. }
  10024. inline void Response::set_content(const std::string &s,
  10025. const std::string &content_type) {
  10026. set_content(s.data(), s.size(), content_type);
  10027. }
  10028. inline void Response::set_content(std::string &&s,
  10029. const std::string &content_type) {
  10030. body = std::move(s);
  10031. auto rng = headers.equal_range("Content-Type");
  10032. headers.erase(rng.first, rng.second);
  10033. set_header("Content-Type", content_type);
  10034. content_coding_ = detail::EncodingType::None;
  10035. }
  10036. inline void Response::set_content_provider(
  10037. size_t in_length, const std::string &content_type, ContentProvider provider,
  10038. ContentProviderResourceReleaser resource_releaser) {
  10039. set_header("Content-Type", content_type);
  10040. content_length_ = in_length;
  10041. if (in_length > 0) { content_provider_ = std::move(provider); }
  10042. content_provider_resource_releaser_ = std::move(resource_releaser);
  10043. is_chunked_content_provider_ = false;
  10044. is_file_content_provider_ = false;
  10045. content_coding_ = detail::EncodingType::None;
  10046. }
  10047. inline void Response::set_content_provider(
  10048. const std::string &content_type, ContentProviderWithoutLength provider,
  10049. ContentProviderResourceReleaser resource_releaser) {
  10050. set_header("Content-Type", content_type);
  10051. content_length_ = 0;
  10052. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10053. content_provider_resource_releaser_ = std::move(resource_releaser);
  10054. is_chunked_content_provider_ = false;
  10055. is_file_content_provider_ = false;
  10056. content_coding_ = detail::EncodingType::None;
  10057. }
  10058. inline void Response::set_chunked_content_provider(
  10059. const std::string &content_type, ContentProviderWithoutLength provider,
  10060. ContentProviderResourceReleaser resource_releaser) {
  10061. set_header("Content-Type", content_type);
  10062. content_length_ = 0;
  10063. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10064. content_provider_resource_releaser_ = std::move(resource_releaser);
  10065. is_chunked_content_provider_ = true;
  10066. is_file_content_provider_ = false;
  10067. content_coding_ = detail::EncodingType::None;
  10068. }
  10069. inline void Response::set_file_content(const std::string &path,
  10070. const std::string &content_type) {
  10071. file_content_path_ = path;
  10072. file_content_content_type_ = content_type;
  10073. }
  10074. inline void Response::set_file_content(const std::string &path) {
  10075. file_content_path_ = path;
  10076. }
  10077. // Result implementation
  10078. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10079. size_t def,
  10080. size_t id) const {
  10081. return detail::get_header_value_u64(request_headers_, key, def, id);
  10082. }
  10083. inline bool Result::has_request_header(const std::string &key) const {
  10084. return request_headers_.find(key) != request_headers_.end();
  10085. }
  10086. inline std::string Result::get_request_header_value(const std::string &key,
  10087. const char *def,
  10088. size_t id) const {
  10089. return detail::get_header_value(request_headers_, key, def, id);
  10090. }
  10091. inline size_t
  10092. Result::get_request_header_value_count(const std::string &key) const {
  10093. return request_headers_.count(key);
  10094. }
  10095. // Stream implementation
  10096. inline ssize_t Stream::write(const char *ptr) {
  10097. return write(ptr, strlen(ptr));
  10098. }
  10099. inline ssize_t Stream::write(const std::string &s) {
  10100. return write(s.data(), s.size());
  10101. }
  10102. // BodyReader implementation
  10103. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10104. if (!stream) {
  10105. last_error = Error::Connection;
  10106. return -1;
  10107. }
  10108. if (eof) { return 0; }
  10109. if (!chunked) {
  10110. // Content-Length based reading
  10111. if (has_content_length && bytes_read >= content_length) {
  10112. eof = true;
  10113. return 0;
  10114. }
  10115. auto to_read = len;
  10116. if (has_content_length) {
  10117. auto remaining = content_length - bytes_read;
  10118. to_read = (std::min)(len, remaining);
  10119. }
  10120. auto n = stream->read(buf, to_read);
  10121. if (n < 0) {
  10122. last_error = stream->get_error();
  10123. if (last_error == Error::Success) { last_error = Error::Read; }
  10124. eof = true;
  10125. return n;
  10126. }
  10127. if (n == 0) {
  10128. // Unexpected EOF before content_length
  10129. last_error = stream->get_error();
  10130. if (last_error == Error::Success) { last_error = Error::Read; }
  10131. eof = true;
  10132. return 0;
  10133. }
  10134. bytes_read += static_cast<size_t>(n);
  10135. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10136. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10137. last_error = Error::ExceedMaxPayloadSize;
  10138. eof = true;
  10139. return -1;
  10140. }
  10141. return n;
  10142. }
  10143. // Chunked transfer encoding: delegate to shared decoder instance.
  10144. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10145. size_t chunk_offset = 0;
  10146. size_t chunk_total = 0;
  10147. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10148. if (n < 0) {
  10149. last_error = stream->get_error();
  10150. if (last_error == Error::Success) { last_error = Error::Read; }
  10151. eof = true;
  10152. return n;
  10153. }
  10154. if (n == 0) {
  10155. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10156. eof = true;
  10157. return 0;
  10158. }
  10159. bytes_read += static_cast<size_t>(n);
  10160. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10161. last_error = Error::ExceedMaxPayloadSize;
  10162. eof = true;
  10163. return -1;
  10164. }
  10165. return n;
  10166. }
  10167. // ThreadPool implementation
  10168. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10169. time_t idle_timeout_sec)
  10170. : base_thread_count_(n), max_queued_requests_(mqr),
  10171. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10172. shutdown_(false) {
  10173. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10174. if (max_n != 0 && max_n < n) {
  10175. std::string msg = "max_threads must be >= base_threads";
  10176. throw std::invalid_argument(msg);
  10177. }
  10178. #endif
  10179. max_thread_count_ = max_n == 0 ? n : max_n;
  10180. threads_.reserve(base_thread_count_);
  10181. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10182. try {
  10183. #endif
  10184. for (size_t i = 0; i < base_thread_count_; i++) {
  10185. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10186. }
  10187. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10188. } catch (...) {
  10189. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10190. // signal the workers we already spawned to exit and join them so the
  10191. // vector destructor does not see joinable threads (which would call
  10192. // std::terminate). Then rethrow so the caller learns of the failure.
  10193. {
  10194. std::unique_lock<std::mutex> lock(mutex_);
  10195. shutdown_ = true;
  10196. }
  10197. cond_.notify_all();
  10198. for (auto &t : threads_) {
  10199. if (t.joinable()) { t.join(); }
  10200. }
  10201. throw;
  10202. }
  10203. #endif
  10204. }
  10205. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10206. {
  10207. std::unique_lock<std::mutex> lock(mutex_);
  10208. if (shutdown_) { return false; }
  10209. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10210. return false;
  10211. }
  10212. jobs_.push_back(std::move(fn));
  10213. // Spawn a dynamic thread if no idle threads and under max
  10214. if (idle_thread_count_ == 0 &&
  10215. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10216. cleanup_finished_threads();
  10217. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10218. }
  10219. }
  10220. cond_.notify_one();
  10221. return true;
  10222. }
  10223. inline void ThreadPool::shutdown() {
  10224. {
  10225. std::unique_lock<std::mutex> lock(mutex_);
  10226. shutdown_ = true;
  10227. }
  10228. cond_.notify_all();
  10229. for (auto &t : threads_) {
  10230. if (t.joinable()) { t.join(); }
  10231. }
  10232. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10233. // with worker threads that call move_to_finished() concurrently.
  10234. std::list<std::thread> remaining_dynamic;
  10235. {
  10236. std::unique_lock<std::mutex> lock(mutex_);
  10237. remaining_dynamic = std::move(dynamic_threads_);
  10238. }
  10239. for (auto &t : remaining_dynamic) {
  10240. if (t.joinable()) { t.join(); }
  10241. }
  10242. std::unique_lock<std::mutex> lock(mutex_);
  10243. cleanup_finished_threads();
  10244. }
  10245. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10246. // Must be called with mutex_ held
  10247. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10248. if (it->get_id() == id) {
  10249. finished_threads_.push_back(std::move(*it));
  10250. dynamic_threads_.erase(it);
  10251. return;
  10252. }
  10253. }
  10254. }
  10255. inline void ThreadPool::cleanup_finished_threads() {
  10256. // Must be called with mutex_ held
  10257. for (auto &t : finished_threads_) {
  10258. if (t.joinable()) { t.join(); }
  10259. }
  10260. finished_threads_.clear();
  10261. }
  10262. inline void ThreadPool::worker(bool is_dynamic) {
  10263. for (;;) {
  10264. std::function<void()> fn;
  10265. {
  10266. std::unique_lock<std::mutex> lock(mutex_);
  10267. idle_thread_count_++;
  10268. if (is_dynamic) {
  10269. auto has_work =
  10270. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10271. [&] { return !jobs_.empty() || shutdown_; });
  10272. if (!has_work) {
  10273. // Timed out with no work - exit this dynamic thread
  10274. idle_thread_count_--;
  10275. move_to_finished(std::this_thread::get_id());
  10276. break;
  10277. }
  10278. } else {
  10279. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10280. }
  10281. idle_thread_count_--;
  10282. if (shutdown_ && jobs_.empty()) { break; }
  10283. fn = std::move(jobs_.front());
  10284. jobs_.pop_front();
  10285. }
  10286. assert(true == static_cast<bool>(fn));
  10287. fn();
  10288. }
  10289. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10290. !defined(LIBRESSL_VERSION_NUMBER)
  10291. OPENSSL_thread_stop();
  10292. #endif
  10293. }
  10294. /*
  10295. * Group 1 (continued): detail namespace - Stream implementations
  10296. */
  10297. namespace detail {
  10298. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10299. time_t timeout_sec, time_t timeout_usec,
  10300. time_t &actual_timeout_sec,
  10301. time_t &actual_timeout_usec) {
  10302. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10303. auto actual_timeout_msec =
  10304. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10305. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10306. actual_timeout_sec = actual_timeout_msec / 1000;
  10307. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10308. }
  10309. // Socket stream implementation
  10310. inline SocketStream::SocketStream(
  10311. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10312. time_t write_timeout_sec, time_t write_timeout_usec,
  10313. time_t max_timeout_msec,
  10314. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10315. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10316. read_timeout_usec_(read_timeout_usec),
  10317. write_timeout_sec_(write_timeout_sec),
  10318. write_timeout_usec_(write_timeout_usec),
  10319. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10320. read_buff_(read_buff_size_, 0) {}
  10321. inline SocketStream::~SocketStream() = default;
  10322. inline bool SocketStream::is_readable() const {
  10323. return read_buff_off_ < read_buff_content_size_;
  10324. }
  10325. inline bool SocketStream::wait_readable() const {
  10326. if (max_timeout_msec_ <= 0) {
  10327. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10328. }
  10329. time_t read_timeout_sec;
  10330. time_t read_timeout_usec;
  10331. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10332. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10333. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10334. }
  10335. inline bool SocketStream::wait_writable() const {
  10336. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10337. }
  10338. inline bool SocketStream::ensure_readable() {
  10339. if (readable_hint_) {
  10340. readable_hint_ = false;
  10341. return true;
  10342. }
  10343. return wait_readable();
  10344. }
  10345. inline const char *SocketStream::buffered_data(size_t &size) const {
  10346. size = read_buff_content_size_ - read_buff_off_;
  10347. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10348. }
  10349. inline void SocketStream::consume_buffered(size_t size) {
  10350. assert(size <= read_buff_content_size_ - read_buff_off_);
  10351. read_buff_off_ += size;
  10352. }
  10353. inline bool SocketStream::is_peer_alive() const {
  10354. return detail::is_socket_alive(sock_);
  10355. }
  10356. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10357. #ifdef _WIN32
  10358. size =
  10359. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10360. #else
  10361. size = (std::min)(size,
  10362. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10363. #endif
  10364. if (read_buff_off_ < read_buff_content_size_) {
  10365. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10366. if (size <= remaining_size) {
  10367. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10368. read_buff_off_ += size;
  10369. return static_cast<ssize_t>(size);
  10370. } else {
  10371. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10372. read_buff_off_ += remaining_size;
  10373. return static_cast<ssize_t>(remaining_size);
  10374. }
  10375. }
  10376. if (!ensure_readable()) {
  10377. error_ = Error::Timeout;
  10378. return -1;
  10379. }
  10380. read_buff_off_ = 0;
  10381. read_buff_content_size_ = 0;
  10382. if (size < read_buff_size_) {
  10383. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10384. CPPHTTPLIB_RECV_FLAGS);
  10385. if (n <= 0) {
  10386. if (n == 0) {
  10387. error_ = Error::ConnectionClosed;
  10388. } else {
  10389. error_ = Error::Read;
  10390. }
  10391. return n;
  10392. } else if (n <= static_cast<ssize_t>(size)) {
  10393. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10394. return n;
  10395. } else {
  10396. memcpy(ptr, read_buff_.data(), size);
  10397. read_buff_off_ = size;
  10398. read_buff_content_size_ = static_cast<size_t>(n);
  10399. return static_cast<ssize_t>(size);
  10400. }
  10401. } else {
  10402. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10403. if (n <= 0) {
  10404. if (n == 0) {
  10405. error_ = Error::ConnectionClosed;
  10406. } else {
  10407. error_ = Error::Read;
  10408. }
  10409. }
  10410. return n;
  10411. }
  10412. }
  10413. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10414. if (!wait_writable()) { return -1; }
  10415. #if defined(_WIN32) && !defined(_WIN64)
  10416. size =
  10417. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10418. #endif
  10419. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10420. }
  10421. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10422. int &port) const {
  10423. return detail::get_remote_ip_and_port(sock_, ip, port);
  10424. }
  10425. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10426. int &port) const {
  10427. return detail::get_local_ip_and_port(sock_, ip, port);
  10428. }
  10429. inline socket_t SocketStream::socket() const { return sock_; }
  10430. inline time_t SocketStream::duration() const {
  10431. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10432. std::chrono::steady_clock::now() - start_time_)
  10433. .count();
  10434. }
  10435. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10436. read_timeout_sec_ = sec;
  10437. read_timeout_usec_ = usec;
  10438. }
  10439. // Buffer stream implementation
  10440. inline bool BufferStream::is_readable() const { return true; }
  10441. inline bool BufferStream::wait_readable() const { return true; }
  10442. inline bool BufferStream::wait_writable() const { return true; }
  10443. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10444. #if defined(_MSC_VER) && _MSC_VER < 1910
  10445. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10446. #else
  10447. auto len_read = buffer.copy(ptr, size, position);
  10448. #endif
  10449. position += static_cast<size_t>(len_read);
  10450. return static_cast<ssize_t>(len_read);
  10451. }
  10452. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10453. buffer.append(ptr, size);
  10454. return static_cast<ssize_t>(size);
  10455. }
  10456. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10457. int & /*port*/) const {}
  10458. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10459. int & /*port*/) const {}
  10460. inline socket_t BufferStream::socket() const { return 0; }
  10461. inline time_t BufferStream::duration() const { return 0; }
  10462. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10463. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10464. : MatcherBase(pattern) {
  10465. constexpr const char marker[] = "/:";
  10466. // One past the last ending position of a path param substring
  10467. std::size_t last_param_end = 0;
  10468. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10469. // Needed to ensure that parameter names are unique during matcher
  10470. // construction
  10471. // If exceptions are disabled, only last duplicate path
  10472. // parameter will be set
  10473. std::unordered_set<std::string> param_name_set;
  10474. #endif
  10475. while (true) {
  10476. const auto marker_pos = pattern.find(
  10477. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10478. if (marker_pos == std::string::npos) { break; }
  10479. static_fragments_.push_back(
  10480. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10481. const auto param_name_start = marker_pos + str_len(marker);
  10482. auto sep_pos = pattern.find(separator, param_name_start);
  10483. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10484. auto param_name =
  10485. pattern.substr(param_name_start, sep_pos - param_name_start);
  10486. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10487. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10488. std::string msg = "Encountered path parameter '" + param_name +
  10489. "' multiple times in route pattern '" + pattern + "'.";
  10490. throw std::invalid_argument(msg);
  10491. }
  10492. #endif
  10493. param_names_.push_back(std::move(param_name));
  10494. last_param_end = sep_pos + 1;
  10495. }
  10496. if (last_param_end < pattern.length()) {
  10497. static_fragments_.push_back(pattern.substr(last_param_end));
  10498. }
  10499. }
  10500. inline bool PathParamsMatcher::match(Request &request) const {
  10501. request.matches = std::smatch();
  10502. request.path_params.clear();
  10503. // A pattern without parameters is just a literal path to compare against
  10504. if (param_names_.empty()) { return request.path == pattern(); }
  10505. request.path_params.reserve(param_names_.size());
  10506. // One past the position at which the path matched the pattern last time
  10507. std::size_t starting_pos = 0;
  10508. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10509. const auto &fragment = static_fragments_[i];
  10510. if (starting_pos + fragment.length() > request.path.length()) {
  10511. return false;
  10512. }
  10513. // Avoid unnecessary allocation by using strncmp instead of substr +
  10514. // comparison
  10515. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10516. fragment.length()) != 0) {
  10517. return false;
  10518. }
  10519. starting_pos += fragment.length();
  10520. // Should only happen when we have a static fragment after a param
  10521. // Example: '/users/:id/subscriptions'
  10522. // The 'subscriptions' fragment here does not have a corresponding param
  10523. if (i >= param_names_.size()) { continue; }
  10524. auto sep_pos = request.path.find(separator, starting_pos);
  10525. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10526. const auto &param_name = param_names_[i];
  10527. request.path_params.emplace(
  10528. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10529. // Mark everything up to '/' as matched
  10530. starting_pos = sep_pos + 1;
  10531. }
  10532. // Returns false if the path is longer than the pattern
  10533. return starting_pos >= request.path.length();
  10534. }
  10535. inline bool RegexMatcher::match(Request &request) const {
  10536. request.path_params.clear();
  10537. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10538. // a non-match rather than risking a stack overflow in std::regex_match.
  10539. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10540. return false;
  10541. }
  10542. return std::regex_match(request.path, request.matches, regex_);
  10543. }
  10544. // Enclose IPv6 address in brackets if needed
  10545. inline std::string prepare_host_string(const std::string &host) {
  10546. // Enclose IPv6 address in brackets (but not if already enclosed)
  10547. if (host.find(':') == std::string::npos ||
  10548. (!host.empty() && host[0] == '[')) {
  10549. // IPv4, hostname, or already bracketed IPv6
  10550. return host;
  10551. } else {
  10552. // IPv6 address without brackets
  10553. return "[" + host + "]";
  10554. }
  10555. }
  10556. inline std::string make_host_and_port_string(const std::string &host, int port,
  10557. bool is_ssl) {
  10558. auto result = prepare_host_string(host);
  10559. // Append port if not default
  10560. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10561. ; // do nothing
  10562. } else {
  10563. result += ":" + std::to_string(port);
  10564. }
  10565. return result;
  10566. }
  10567. // Create "host:port" string always including port number (for CONNECT method)
  10568. inline std::string
  10569. make_host_and_port_string_always_port(const std::string &host, int port) {
  10570. return prepare_host_string(host) + ":" + std::to_string(port);
  10571. }
  10572. // Value for the Host header a client sends when the caller supplied none.
  10573. // Only the value: callers decide where in their header list it goes.
  10574. inline std::string make_default_host_header_value(const std::string &host,
  10575. int port, bool is_ssl,
  10576. int address_family) {
  10577. if (address_family == AF_UNIX) { return "localhost"; }
  10578. return make_host_and_port_string(host, port, is_ssl);
  10579. }
  10580. inline void add_default_user_agent_header(Request &req) {
  10581. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10582. if (!req.has_header("User-Agent")) {
  10583. req.set_header("User-Agent",
  10584. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10585. }
  10586. #else
  10587. (void)req;
  10588. #endif
  10589. }
  10590. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10591. NormalizedTarget normalize_target(const std::string &host);
  10592. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10593. bool host_matches_no_proxy(const NormalizedTarget &target,
  10594. const std::vector<NoProxyEntry> &entries);
  10595. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10596. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10597. if (prefix_bits == 0) { return true; }
  10598. int full_bytes = prefix_bits / 8;
  10599. int rem_bits = prefix_bits % 8;
  10600. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10601. static_cast<size_t>(full_bytes)) != 0) {
  10602. return false;
  10603. }
  10604. if (rem_bits == 0) { return true; }
  10605. auto i = static_cast<size_t>(full_bytes);
  10606. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10607. return (ip[i] & mask) == (net[i] & mask);
  10608. }
  10609. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10610. if (token.empty()) { return false; }
  10611. if (token == "*") {
  10612. out.kind = NoProxyKind::Wildcard;
  10613. return true;
  10614. }
  10615. auto slash = token.find('/');
  10616. std::string addr_part =
  10617. (slash == std::string::npos) ? token : token.substr(0, slash);
  10618. std::string prefix_part =
  10619. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10620. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10621. // don't silently treat it as a /32 (or /128).
  10622. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10623. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10624. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10625. // when brackets are present.
  10626. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10627. addr_part.back() == ']';
  10628. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10629. if (!bracketed) {
  10630. struct in_addr v4;
  10631. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10632. int prefix = 32;
  10633. if (!prefix_part.empty() &&
  10634. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10635. prefix)) {
  10636. return false;
  10637. }
  10638. out.kind = NoProxyKind::IPv4Cidr;
  10639. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10640. out.prefix_bits = prefix;
  10641. return true;
  10642. }
  10643. }
  10644. struct in6_addr v6;
  10645. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10646. int prefix = 128;
  10647. if (!prefix_part.empty() &&
  10648. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10649. prefix)) {
  10650. return false;
  10651. }
  10652. out.kind = NoProxyKind::IPv6Cidr;
  10653. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10654. out.prefix_bits = prefix;
  10655. return true;
  10656. }
  10657. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10658. // the entry is malformed — don't fall through to the hostname branch.
  10659. if (bracketed) { return false; }
  10660. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10661. if (slash != std::string::npos) { return false; }
  10662. // Port-specific entries (host:port) are not supported.
  10663. if (token.find(':') != std::string::npos) { return false; }
  10664. std::string hostname = case_ignore::to_lower(token);
  10665. while (!hostname.empty() && hostname.front() == '.') {
  10666. hostname.erase(hostname.begin());
  10667. }
  10668. while (!hostname.empty() && hostname.back() == '.') {
  10669. hostname.pop_back();
  10670. }
  10671. if (hostname.empty()) { return false; }
  10672. out.kind = NoProxyKind::HostnameSuffix;
  10673. out.hostname_pattern = std::move(hostname);
  10674. return true;
  10675. }
  10676. inline NormalizedTarget normalize_target(const std::string &host) {
  10677. NormalizedTarget t;
  10678. std::string h = host;
  10679. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10680. h = h.substr(1, h.size() - 2);
  10681. }
  10682. // Strip a single trailing dot so "example.com." canonicalizes to
  10683. // "example.com".
  10684. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10685. t.hostname = case_ignore::to_lower(h);
  10686. if (!t.hostname.empty()) {
  10687. struct in_addr v4;
  10688. struct in6_addr v6;
  10689. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10690. t.is_ipv4 = true;
  10691. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10692. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10693. t.is_ipv6 = true;
  10694. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10695. }
  10696. }
  10697. return t;
  10698. }
  10699. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10700. const std::vector<NoProxyEntry> &entries) {
  10701. if (target.hostname.empty()) { return false; }
  10702. for (const auto &e : entries) {
  10703. switch (e.kind) {
  10704. case NoProxyKind::Wildcard: return true;
  10705. case NoProxyKind::IPv4Cidr:
  10706. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10707. return true;
  10708. }
  10709. break;
  10710. case NoProxyKind::IPv6Cidr:
  10711. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10712. return true;
  10713. }
  10714. break;
  10715. case NoProxyKind::HostnameSuffix:
  10716. if (target.is_ipv4 || target.is_ipv6) { break; }
  10717. if (target.hostname == e.hostname_pattern) { return true; }
  10718. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10719. // an entry of "example.com".
  10720. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10721. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10722. if (target.hostname[offset - 1] == '.' &&
  10723. target.hostname.compare(offset, e.hostname_pattern.size(),
  10724. e.hostname_pattern) == 0) {
  10725. return true;
  10726. }
  10727. }
  10728. break;
  10729. }
  10730. }
  10731. return false;
  10732. }
  10733. template <typename T>
  10734. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10735. T header_writer, Error &error) {
  10736. for (const auto &h : headers) {
  10737. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10738. error = Error::InvalidHeaders;
  10739. return false;
  10740. }
  10741. }
  10742. if (header_writer(strm, headers) <= 0) {
  10743. error = Error::Write;
  10744. return false;
  10745. }
  10746. return true;
  10747. }
  10748. } // namespace detail
  10749. /*
  10750. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10751. */
  10752. #ifdef CPPHTTPLIB_SSL_ENABLED
  10753. namespace detail {
  10754. // SSL socket stream implementation
  10755. inline SSLSocketStream::SSLSocketStream(
  10756. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10757. time_t read_timeout_usec, time_t write_timeout_sec,
  10758. time_t write_timeout_usec, time_t max_timeout_msec,
  10759. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10760. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10761. read_timeout_usec_(read_timeout_usec),
  10762. write_timeout_sec_(write_timeout_sec),
  10763. write_timeout_usec_(write_timeout_usec),
  10764. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10765. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10766. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10767. // Note: create_session() also clears this, but SSLClient currently
  10768. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10769. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10770. // SSL session was created.
  10771. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10772. #endif
  10773. }
  10774. inline SSLSocketStream::~SSLSocketStream() = default;
  10775. inline bool SSLSocketStream::is_readable() const {
  10776. return tls::pending(session_) > 0;
  10777. }
  10778. inline bool SSLSocketStream::wait_readable() const {
  10779. if (max_timeout_msec_ <= 0) {
  10780. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10781. }
  10782. time_t read_timeout_sec;
  10783. time_t read_timeout_usec;
  10784. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10785. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10786. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10787. }
  10788. inline bool SSLSocketStream::wait_writable() const {
  10789. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10790. !tls::is_peer_closed(session_, sock_);
  10791. }
  10792. inline bool SSLSocketStream::ensure_readable() {
  10793. if (readable_hint_) {
  10794. readable_hint_ = false;
  10795. return true;
  10796. }
  10797. return wait_readable();
  10798. }
  10799. inline bool SSLSocketStream::is_peer_alive() const {
  10800. return !tls::is_peer_closed(session_, sock_);
  10801. }
  10802. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10803. if (tls::pending(session_) > 0) {
  10804. tls::TlsError err;
  10805. auto ret = tls::read(session_, ptr, size, err);
  10806. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10807. error_ = Error::ConnectionClosed;
  10808. }
  10809. return ret;
  10810. } else if (ensure_readable()) {
  10811. tls::TlsError err;
  10812. auto ret = tls::read(session_, ptr, size, err);
  10813. if (ret < 0) {
  10814. auto n = 1000;
  10815. #ifdef _WIN32
  10816. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10817. (err.code == tls::ErrorCode::SyscallError &&
  10818. WSAGetLastError() == WSAETIMEDOUT))) {
  10819. #else
  10820. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10821. #endif
  10822. if (tls::pending(session_) > 0) {
  10823. return tls::read(session_, ptr, size, err);
  10824. } else if (wait_readable()) {
  10825. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10826. ret = tls::read(session_, ptr, size, err);
  10827. if (ret >= 0) { return ret; }
  10828. } else {
  10829. break;
  10830. }
  10831. }
  10832. assert(ret < 0);
  10833. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10834. error_ = Error::ConnectionClosed;
  10835. }
  10836. return ret;
  10837. } else {
  10838. error_ = Error::Timeout;
  10839. return -1;
  10840. }
  10841. }
  10842. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10843. if (wait_writable()) {
  10844. auto handle_size =
  10845. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10846. tls::TlsError err;
  10847. auto ret = tls::write(session_, ptr, handle_size, err);
  10848. if (ret < 0) {
  10849. auto n = 1000;
  10850. #ifdef _WIN32
  10851. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10852. (err.code == tls::ErrorCode::SyscallError &&
  10853. WSAGetLastError() == WSAETIMEDOUT))) {
  10854. #else
  10855. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10856. #endif
  10857. if (wait_writable()) {
  10858. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10859. ret = tls::write(session_, ptr, handle_size, err);
  10860. if (ret >= 0) { return ret; }
  10861. } else {
  10862. break;
  10863. }
  10864. }
  10865. assert(ret < 0);
  10866. }
  10867. return ret;
  10868. }
  10869. return -1;
  10870. }
  10871. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10872. int &port) const {
  10873. detail::get_remote_ip_and_port(sock_, ip, port);
  10874. }
  10875. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10876. int &port) const {
  10877. detail::get_local_ip_and_port(sock_, ip, port);
  10878. }
  10879. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10880. inline time_t SSLSocketStream::duration() const {
  10881. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10882. std::chrono::steady_clock::now() - start_time_)
  10883. .count();
  10884. }
  10885. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10886. read_timeout_sec_ = sec;
  10887. read_timeout_usec_ = usec;
  10888. }
  10889. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10890. tls::session_t session,
  10891. time_t read_timeout_sec,
  10892. time_t read_timeout_usec,
  10893. time_t write_timeout_sec,
  10894. time_t write_timeout_usec)
  10895. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10896. read_timeout_usec_(read_timeout_usec),
  10897. write_timeout_sec_(write_timeout_sec),
  10898. write_timeout_usec_(write_timeout_usec),
  10899. start_time_(std::chrono::steady_clock::now()) {
  10900. // The receive and send paths run on different threads, so each TLS call is
  10901. // driven in non-blocking mode and readiness is awaited with select()
  10902. // outside the session lock. Set the socket non-blocking once here; it is
  10903. // never flipped back, so no thread races on the flag.
  10904. detail::set_nonblocking(sock_, true);
  10905. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10906. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10907. #endif
  10908. }
  10909. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10910. inline bool WebSocketSSLStream::is_readable() const {
  10911. std::lock_guard<std::mutex> guard(session_mutex_);
  10912. return tls::pending(session_) > 0;
  10913. }
  10914. inline bool WebSocketSSLStream::wait_readable() const {
  10915. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10916. }
  10917. inline bool WebSocketSSLStream::wait_writable() const {
  10918. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10919. // that probe toggles the socket's blocking flag, which would race with the
  10920. // concurrent reader on a permanently non-blocking socket.
  10921. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10922. }
  10923. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10924. tls::TlsError err;
  10925. auto n = 1000;
  10926. while (--n >= 0) {
  10927. {
  10928. std::lock_guard<std::mutex> guard(session_mutex_);
  10929. auto ret = tls::read(session_, ptr, size, err);
  10930. if (ret > 0) { return ret; }
  10931. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10932. error_ = Error::ConnectionClosed;
  10933. return ret;
  10934. }
  10935. }
  10936. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10937. // direction: the send path shares this session, so output it left pending
  10938. // has to be flushed before more input can be decrypted. Anything else is
  10939. // a hard error.
  10940. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10941. #ifdef _WIN32
  10942. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10943. needs_readable =
  10944. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10945. WSAGetLastError() == WSAETIMEDOUT);
  10946. #endif
  10947. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10948. error_ = Error::Read;
  10949. return -1;
  10950. }
  10951. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10952. error_ = Error::Timeout;
  10953. return -1;
  10954. }
  10955. }
  10956. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10957. // to tell a timeout from a close would otherwise see whatever the previous
  10958. // failure left behind (error_ is never cleared on success).
  10959. error_ = Error::Read;
  10960. return -1;
  10961. }
  10962. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10963. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10964. tls::TlsError err;
  10965. auto n = 1000;
  10966. while (--n >= 0) {
  10967. {
  10968. std::lock_guard<std::mutex> guard(session_mutex_);
  10969. auto ret = tls::write(session_, ptr, handle_size, err);
  10970. if (ret >= 0) { return ret; }
  10971. }
  10972. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10973. // or a post-handshake message must be consumed before the record goes
  10974. // out. Anything else is a hard error.
  10975. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10976. #ifdef _WIN32
  10977. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10978. needs_writable =
  10979. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10980. WSAGetLastError() == WSAETIMEDOUT);
  10981. #endif
  10982. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10983. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10984. }
  10985. return -1;
  10986. }
  10987. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10988. int &port) const {
  10989. detail::get_remote_ip_and_port(sock_, ip, port);
  10990. }
  10991. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10992. int &port) const {
  10993. detail::get_local_ip_and_port(sock_, ip, port);
  10994. }
  10995. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10996. inline time_t WebSocketSSLStream::duration() const {
  10997. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10998. std::chrono::steady_clock::now() - start_time_)
  10999. .count();
  11000. }
  11001. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11002. read_timeout_sec_ = sec;
  11003. read_timeout_usec_ = usec;
  11004. }
  11005. } // namespace detail
  11006. #endif // CPPHTTPLIB_SSL_ENABLED
  11007. /*
  11008. * Group 4: Server implementation
  11009. */
  11010. // HTTP server implementation
  11011. inline Server::Server()
  11012. : new_task_queue([] {
  11013. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11014. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11015. }) {
  11016. #ifndef _WIN32
  11017. signal(SIGPIPE, SIG_IGN);
  11018. #endif
  11019. }
  11020. inline Server::~Server() = default;
  11021. inline std::unique_ptr<detail::MatcherBase>
  11022. Server::make_matcher(const std::string &pattern) {
  11023. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11024. // a path params pattern
  11025. if (pattern.find("/:") != std::string::npos) {
  11026. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11027. }
  11028. // A pattern with no regex metacharacter only has to be compared literally,
  11029. // which is what PathParamsMatcher already does when it captures no
  11030. // parameter, so std::regex is only worth building for the patterns that
  11031. // actually need it
  11032. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11033. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11034. }
  11035. return detail::make_unique<detail::RegexMatcher>(pattern);
  11036. }
  11037. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11038. return add_handler(get_handlers_, pattern, std::move(handler));
  11039. }
  11040. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11041. return add_handler(post_handlers_, pattern, std::move(handler));
  11042. }
  11043. inline Server &Server::Post(const std::string &pattern,
  11044. HandlerWithContentReader handler) {
  11045. return add_handler(post_handlers_for_content_reader_, pattern,
  11046. std::move(handler));
  11047. }
  11048. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11049. return add_handler(put_handlers_, pattern, std::move(handler));
  11050. }
  11051. inline Server &Server::Put(const std::string &pattern,
  11052. HandlerWithContentReader handler) {
  11053. return add_handler(put_handlers_for_content_reader_, pattern,
  11054. std::move(handler));
  11055. }
  11056. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11057. return add_handler(patch_handlers_, pattern, std::move(handler));
  11058. }
  11059. inline Server &Server::Patch(const std::string &pattern,
  11060. HandlerWithContentReader handler) {
  11061. return add_handler(patch_handlers_for_content_reader_, pattern,
  11062. std::move(handler));
  11063. }
  11064. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11065. return add_handler(delete_handlers_, pattern, std::move(handler));
  11066. }
  11067. inline Server &Server::Delete(const std::string &pattern,
  11068. HandlerWithContentReader handler) {
  11069. return add_handler(delete_handlers_for_content_reader_, pattern,
  11070. std::move(handler));
  11071. }
  11072. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11073. return add_handler(options_handlers_, pattern, std::move(handler));
  11074. }
  11075. inline const std::set<std::string> &Server::builtin_methods() {
  11076. thread_local const std::set<std::string> methods{
  11077. "GET", "HEAD", "POST", "PUT", "DELETE",
  11078. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11079. return methods;
  11080. }
  11081. inline Server::CustomHandlerEntry *
  11082. Server::custom_entry_for_registration(const std::string &method) {
  11083. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11084. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11085. // routing() before the custom tables are consulted, so a route registered
  11086. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11087. // there and would be reachable, but they carry protocol-level meaning
  11088. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11089. // library does not route.
  11090. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11091. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11092. has_invalid_registration_ = true;
  11093. return nullptr;
  11094. }
  11095. return &custom_handlers_[method];
  11096. }
  11097. inline Server &Server::CustomRoute(const std::string &method,
  11098. const std::string &pattern,
  11099. Handler handler) {
  11100. auto *entry = custom_entry_for_registration(method);
  11101. if (!entry) { return *this; }
  11102. return add_handler(entry->handlers, pattern, std::move(handler));
  11103. }
  11104. inline Server &Server::CustomRoute(const std::string &method,
  11105. const std::string &pattern,
  11106. HandlerWithContentReader handler) {
  11107. auto *entry = custom_entry_for_registration(method);
  11108. if (!entry) { return *this; }
  11109. return add_handler(entry->handlers_for_content_reader, pattern,
  11110. std::move(handler));
  11111. }
  11112. inline const Server::CustomHandlerEntry *
  11113. Server::find_custom_entry(const std::string &method) const {
  11114. // find() alone would be correct here. The empty() check is what keeps the
  11115. // per-request cost off servers that never call CustomRoute(), which is the
  11116. // overwhelmingly common case; keep it rather than walking into the tree.
  11117. if (custom_handlers_.empty()) { return nullptr; }
  11118. auto it = custom_handlers_.find(method);
  11119. return it == custom_handlers_.end() ? nullptr : &it->second;
  11120. }
  11121. inline Server &Server::WebSocket(const std::string &pattern,
  11122. WebSocketHandler handler) {
  11123. websocket_handlers_.push_back(
  11124. {make_matcher(pattern), std::move(handler), nullptr});
  11125. return *this;
  11126. }
  11127. inline Server &Server::WebSocket(const std::string &pattern,
  11128. WebSocketHandler handler,
  11129. SubProtocolSelector sub_protocol_selector) {
  11130. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11131. std::move(sub_protocol_selector)});
  11132. return *this;
  11133. }
  11134. inline bool Server::set_base_dir(const std::string &dir,
  11135. const std::string &mount_point) {
  11136. return set_mount_point(mount_point, dir);
  11137. }
  11138. inline bool Server::set_mount_point(const std::string &mount_point,
  11139. const std::string &dir, Headers headers) {
  11140. detail::FileStat stat(dir);
  11141. if (stat.is_dir()) {
  11142. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11143. if (!mnt.empty() && mnt[0] == '/') {
  11144. std::string resolved_base;
  11145. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11146. #if defined(_WIN32)
  11147. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11148. resolved_base += '\\';
  11149. }
  11150. #else
  11151. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11152. #endif
  11153. }
  11154. base_dirs_.push_back(
  11155. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11156. return true;
  11157. }
  11158. }
  11159. return false;
  11160. }
  11161. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11162. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11163. if (it->mount_point == mount_point) {
  11164. base_dirs_.erase(it);
  11165. return true;
  11166. }
  11167. }
  11168. return false;
  11169. }
  11170. inline Server &
  11171. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11172. const std::string &mime) {
  11173. file_extension_and_mimetype_map_[ext] = mime;
  11174. return *this;
  11175. }
  11176. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11177. default_file_mimetype_ = mime;
  11178. return *this;
  11179. }
  11180. inline Server &Server::set_file_request_handler(Handler handler) {
  11181. file_request_handler_ = std::move(handler);
  11182. return *this;
  11183. }
  11184. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11185. std::true_type) {
  11186. error_handler_ = std::move(handler);
  11187. return *this;
  11188. }
  11189. inline Server &Server::set_error_handler_core(Handler handler,
  11190. std::false_type) {
  11191. error_handler_ = [handler](const Request &req, Response &res) {
  11192. handler(req, res);
  11193. return HandlerResponse::Handled;
  11194. };
  11195. return *this;
  11196. }
  11197. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11198. exception_handler_ = std::move(handler);
  11199. return *this;
  11200. }
  11201. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11202. pre_routing_handler_ = std::move(handler);
  11203. return *this;
  11204. }
  11205. inline Server &Server::set_post_routing_handler(Handler handler) {
  11206. post_routing_handler_ = std::move(handler);
  11207. return *this;
  11208. }
  11209. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11210. pre_request_handler_ = std::move(handler);
  11211. return *this;
  11212. }
  11213. inline Server &Server::set_logger(Logger logger) {
  11214. logger_ = std::move(logger);
  11215. return *this;
  11216. }
  11217. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11218. error_logger_ = std::move(error_logger);
  11219. return *this;
  11220. }
  11221. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11222. pre_compression_logger_ = std::move(logger);
  11223. return *this;
  11224. }
  11225. inline Server &
  11226. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11227. expect_100_continue_handler_ = std::move(handler);
  11228. return *this;
  11229. }
  11230. inline Server &Server::set_start_handler(StartHandler handler) {
  11231. start_handler_ = std::move(handler);
  11232. return *this;
  11233. }
  11234. inline Server &Server::set_address_family(int family) {
  11235. address_family_ = family;
  11236. return *this;
  11237. }
  11238. inline Server &Server::set_tcp_nodelay(bool on) {
  11239. tcp_nodelay_ = on;
  11240. return *this;
  11241. }
  11242. inline Server &Server::set_ipv6_v6only(bool on) {
  11243. ipv6_v6only_ = on;
  11244. return *this;
  11245. }
  11246. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11247. socket_options_ = std::move(socket_options);
  11248. return *this;
  11249. }
  11250. inline Server &Server::set_default_headers(Headers headers) {
  11251. default_headers_ = std::move(headers);
  11252. return *this;
  11253. }
  11254. inline Server &Server::set_header_writer(
  11255. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11256. header_writer_ = writer;
  11257. return *this;
  11258. }
  11259. inline Server &
  11260. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11261. trusted_proxies_ = proxies;
  11262. return *this;
  11263. }
  11264. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11265. keep_alive_max_count_ = count;
  11266. return *this;
  11267. }
  11268. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11269. keep_alive_timeout_sec_ = sec;
  11270. return *this;
  11271. }
  11272. template <class Rep, class Period>
  11273. inline Server &Server::set_keep_alive_timeout(
  11274. const std::chrono::duration<Rep, Period> &duration) {
  11275. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11276. set_keep_alive_timeout(sec);
  11277. });
  11278. return *this;
  11279. }
  11280. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11281. read_timeout_sec_ = sec;
  11282. read_timeout_usec_ = usec;
  11283. return *this;
  11284. }
  11285. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11286. write_timeout_sec_ = sec;
  11287. write_timeout_usec_ = usec;
  11288. return *this;
  11289. }
  11290. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11291. idle_interval_sec_ = sec;
  11292. idle_interval_usec_ = usec;
  11293. return *this;
  11294. }
  11295. inline Server &Server::set_payload_max_length(size_t length) {
  11296. payload_max_length_ = length;
  11297. return *this;
  11298. }
  11299. inline Server &Server::set_static_file_compression(bool on) {
  11300. static_file_compression_ = on;
  11301. return *this;
  11302. }
  11303. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11304. static_file_compression_min_length_ = length;
  11305. return *this;
  11306. }
  11307. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11308. static_file_compression_max_length_ = length;
  11309. return *this;
  11310. }
  11311. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11312. websocket_max_missed_pongs_ = count;
  11313. return *this;
  11314. }
  11315. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11316. websocket_ping_interval_sec_ = sec;
  11317. return *this;
  11318. }
  11319. template <class Rep, class Period>
  11320. inline Server &Server::set_websocket_ping_interval(
  11321. const std::chrono::duration<Rep, Period> &duration) {
  11322. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11323. set_websocket_ping_interval(sec);
  11324. });
  11325. return *this;
  11326. }
  11327. inline bool Server::bind_to_port(const std::string &host, int port,
  11328. int socket_flags) {
  11329. auto ret = bind_internal(host, port, socket_flags);
  11330. if (ret == -1) { is_decommissioned = true; }
  11331. return ret >= 0;
  11332. }
  11333. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11334. auto ret = bind_internal(host, 0, socket_flags);
  11335. if (ret == -1) { is_decommissioned = true; }
  11336. return ret;
  11337. }
  11338. inline bool Server::listen_after_bind() { return listen_internal(); }
  11339. inline bool Server::listen(const std::string &host, int port,
  11340. int socket_flags) {
  11341. return bind_to_port(host, port, socket_flags) && listen_internal();
  11342. }
  11343. inline bool Server::is_running() const { return is_running_; }
  11344. inline void Server::wait_until_ready() const {
  11345. while (!is_running_ && !is_decommissioned) {
  11346. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11347. }
  11348. }
  11349. inline void Server::stop() noexcept {
  11350. // Release the listening socket whether or not the accept loop is running:
  11351. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11352. // exchange is what makes this safe to call concurrently with the accept loop.
  11353. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11354. if (sock != INVALID_SOCKET) {
  11355. detail::shutdown_socket(sock);
  11356. detail::close_socket(sock);
  11357. }
  11358. is_decommissioned = false;
  11359. }
  11360. inline void Server::decommission() { is_decommissioned = true; }
  11361. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11362. auto len = strlen(s);
  11363. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11364. len -= 2;
  11365. {
  11366. size_t count = 0;
  11367. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11368. switch (count) {
  11369. case 0: req.method = std::string(b, e); break;
  11370. case 1: req.target = std::string(b, e); break;
  11371. case 2: req.version = std::string(b, e); break;
  11372. default: break;
  11373. }
  11374. count++;
  11375. });
  11376. if (count != 3) { return false; }
  11377. }
  11378. // A method outside the built-in set is accepted only when a handler has been
  11379. // registered for it with CustomRoute().
  11380. const auto &methods = builtin_methods();
  11381. if (methods.find(req.method) == methods.end() &&
  11382. !find_custom_entry(req.method)) {
  11383. output_error_log(Error::InvalidHTTPMethod, &req);
  11384. return false;
  11385. }
  11386. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11387. output_error_log(Error::InvalidHTTPVersion, &req);
  11388. return false;
  11389. }
  11390. if (!detail::fields::is_request_target(req.target)) { return false; }
  11391. {
  11392. // Skip URL fragment
  11393. for (size_t i = 0; i < req.target.size(); i++) {
  11394. if (req.target[i] == '#') {
  11395. req.target.erase(i);
  11396. break;
  11397. }
  11398. }
  11399. detail::divide(req.target, '?',
  11400. [&](const char *lhs_data, std::size_t lhs_size,
  11401. const char *rhs_data, std::size_t rhs_size) {
  11402. req.path =
  11403. decode_path_component(std::string(lhs_data, lhs_size));
  11404. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11405. });
  11406. }
  11407. return true;
  11408. }
  11409. inline bool Server::write_response(Stream &strm, bool close_connection,
  11410. Request &req, Response &res) {
  11411. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11412. // incorrectly to the error content.
  11413. req.ranges.clear();
  11414. return write_response_core(strm, close_connection, req, res, false);
  11415. }
  11416. inline bool Server::write_response_with_content(Stream &strm,
  11417. bool close_connection,
  11418. const Request &req,
  11419. Response &res) {
  11420. return write_response_core(strm, close_connection, req, res, true);
  11421. }
  11422. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11423. const Request &req, Response &res,
  11424. bool need_apply_ranges) {
  11425. assert(res.status != -1);
  11426. if (400 <= res.status && error_handler_ &&
  11427. error_handler_(req, res) == HandlerResponse::Handled) {
  11428. need_apply_ranges = true;
  11429. }
  11430. std::string content_type;
  11431. std::string boundary;
  11432. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11433. // Prepare additional headers
  11434. if (close_connection ||
  11435. detail::has_header_token(req.headers, "Connection", "close") ||
  11436. 400 <= res.status || // Don't leave connections open after errors
  11437. // The client withholds the body until `100 Continue`, which was never
  11438. // sent, so whether and when the body follows is unknown.
  11439. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11440. res.set_header("Connection", "close");
  11441. } else {
  11442. std::string s = "timeout=";
  11443. s += std::to_string(keep_alive_timeout_sec_);
  11444. s += ", max=";
  11445. s += std::to_string(keep_alive_max_count_);
  11446. res.set_header("Keep-Alive", s);
  11447. }
  11448. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11449. !res.has_header("Content-Type")) {
  11450. res.set_header("Content-Type", "text/plain");
  11451. }
  11452. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11453. !res.has_header("Content-Length")) {
  11454. res.set_header("Content-Length", "0");
  11455. }
  11456. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11457. res.set_header("Accept-Ranges", "bytes");
  11458. }
  11459. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11460. // Response line and headers
  11461. detail::BufferStream bstrm;
  11462. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11463. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11464. // Combine a small body with the headers so the whole response leaves in a
  11465. // single write. A large body is written on its own instead: a copy of it
  11466. // costs more than the extra write saves.
  11467. auto send_body = req.method != "HEAD";
  11468. auto body_is_separate = false;
  11469. auto provider_done = false;
  11470. if (send_body && !res.body.empty() && !res.content_provider_) {
  11471. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11472. bstrm.write(res.body.data(), res.body.size());
  11473. } else {
  11474. body_is_separate = true;
  11475. }
  11476. } else if (send_body && res.content_provider_ &&
  11477. res.is_file_content_provider_ &&
  11478. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11479. // A small file is read into the same buffer. Other providers may produce
  11480. // their data over time, so they are never held back.
  11481. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11482. return false;
  11483. }
  11484. provider_done = true;
  11485. }
  11486. // Log before writing to avoid race condition with client-side code that
  11487. // accesses logger-captured data immediately after receiving the response.
  11488. output_log(req, res);
  11489. // Flush buffer
  11490. auto &data = bstrm.get_buffer();
  11491. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11492. if (body_is_separate) {
  11493. return detail::write_data(strm, res.body.data(), res.body.size());
  11494. }
  11495. // Streaming body
  11496. if (send_body && res.content_provider_) {
  11497. if (!provider_done &&
  11498. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11499. return false;
  11500. }
  11501. res.content_provider_success_ = true;
  11502. }
  11503. return true;
  11504. }
  11505. inline bool
  11506. Server::write_content_with_provider(Stream &strm, const Request &req,
  11507. Response &res, const std::string &boundary,
  11508. const std::string &content_type) {
  11509. auto is_shutting_down = [this]() {
  11510. return this->svr_sock_ == INVALID_SOCKET;
  11511. };
  11512. if (res.content_length_ > 0) {
  11513. // Only a 206 response is served as a partial representation, matching the
  11514. // condition `apply_ranges()` used to decide the Content-Length and the
  11515. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11516. // only for a 2xx status, slicing under any other status would write a body
  11517. // that disagrees with the header already sent, from an unchecked offset.
  11518. auto is_partial =
  11519. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11520. if (!is_partial) {
  11521. return detail::write_content(strm, res.content_provider_, 0,
  11522. res.content_length_, is_shutting_down);
  11523. } else if (req.ranges.size() == 1) {
  11524. auto offset_and_length = detail::get_range_offset_and_length(
  11525. req.ranges[0], res.content_length_);
  11526. return detail::write_content(strm, res.content_provider_,
  11527. offset_and_length.first,
  11528. offset_and_length.second, is_shutting_down);
  11529. } else {
  11530. return detail::write_multipart_ranges_data(
  11531. strm, req, res, boundary, content_type, res.content_length_,
  11532. is_shutting_down);
  11533. }
  11534. } else {
  11535. if (res.is_chunked_content_provider_) {
  11536. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11537. // re-negotiating here would disagree with them, e.g. once a handler's
  11538. // own Content-Encoding header suppresses the negotiation.
  11539. auto compressor = detail::make_compressor(res.content_coding_);
  11540. if (!compressor) {
  11541. compressor = detail::make_unique<detail::nocompressor>();
  11542. }
  11543. return detail::write_content_chunked(strm, res.content_provider_,
  11544. is_shutting_down, *compressor);
  11545. } else {
  11546. return detail::write_content_without_length(strm, res.content_provider_,
  11547. is_shutting_down);
  11548. }
  11549. }
  11550. }
  11551. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11552. FormFields::iterator cur_field;
  11553. FormFiles::iterator cur_file;
  11554. auto is_text_field = false;
  11555. size_t count = 0;
  11556. if (read_content_core(
  11557. strm, req, res,
  11558. // Regular
  11559. [&](const char *buf, size_t n) {
  11560. // Prevent arithmetic overflow when checking sizes.
  11561. // Avoid computing (req.body.size() + n) directly because
  11562. // adding two unsigned `size_t` values can wrap around and
  11563. // produce a small result instead of indicating overflow.
  11564. // Instead, check using subtraction: ensure `n` does not
  11565. // exceed the remaining capacity `max_size() - size()`.
  11566. if (req.body.size() >= req.body.max_size() ||
  11567. n > req.body.max_size() - req.body.size()) {
  11568. return false;
  11569. }
  11570. // Limit decompressed body size to payload_max_length_ to protect
  11571. // against "zip bomb" attacks where a small compressed payload
  11572. // decompresses to a massive size.
  11573. if (payload_max_length_ > 0 &&
  11574. (req.body.size() >= payload_max_length_ ||
  11575. n > payload_max_length_ - req.body.size())) {
  11576. return false;
  11577. }
  11578. req.body.append(buf, n);
  11579. return true;
  11580. },
  11581. // Multipart FormData
  11582. [&](const FormData &file) {
  11583. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11584. output_error_log(Error::TooManyFormDataFiles, &req);
  11585. return false;
  11586. }
  11587. if (file.filename.empty()) {
  11588. cur_field = req.form.fields.emplace(
  11589. file.name, FormField{file.name, file.content, file.headers});
  11590. is_text_field = true;
  11591. } else {
  11592. cur_file = req.form.files.emplace(file.name, file);
  11593. is_text_field = false;
  11594. }
  11595. return true;
  11596. },
  11597. [&](const char *buf, size_t n) {
  11598. if (is_text_field) {
  11599. auto &content = cur_field->second.content;
  11600. if (content.size() + n > content.max_size()) { return false; }
  11601. content.append(buf, n);
  11602. } else {
  11603. auto &content = cur_file->second.content;
  11604. if (content.size() + n > content.max_size()) { return false; }
  11605. content.append(buf, n);
  11606. }
  11607. return true;
  11608. })) {
  11609. const auto &content_type = req.get_header_value("Content-Type");
  11610. if (detail::extract_media_type(content_type) ==
  11611. "application/x-www-form-urlencoded") {
  11612. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11613. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11614. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11615. return false;
  11616. }
  11617. detail::parse_query_text(req.body, req.params);
  11618. }
  11619. return true;
  11620. }
  11621. return false;
  11622. }
  11623. inline bool Server::read_content_with_content_receiver(
  11624. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11625. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11626. return read_content_core(strm, req, res, std::move(receiver),
  11627. std::move(multipart_header),
  11628. std::move(multipart_receiver));
  11629. }
  11630. inline bool Server::read_content_core(
  11631. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11632. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11633. detail::FormDataParser multipart_form_data_parser;
  11634. ContentReceiverWithProgress out;
  11635. if (req.is_multipart_form_data()) {
  11636. const auto &content_type = req.get_header_value("Content-Type");
  11637. std::string boundary;
  11638. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11639. res.status = StatusCode::BadRequest_400;
  11640. output_error_log(Error::MultipartParsing, &req);
  11641. return false;
  11642. }
  11643. multipart_form_data_parser.set_boundary(std::move(boundary));
  11644. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11645. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11646. multipart_receiver);
  11647. };
  11648. } else {
  11649. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11650. size_t /*len*/) { return receiver(buf, n); };
  11651. }
  11652. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11653. // For non-SSL builds we still scan non-persistent connections for stray
  11654. // body bytes so the payload limit is enforced (413). On keep-alive,
  11655. // pending bytes may be the next request (issue #2450), so skip.
  11656. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11657. if (!req.has_header("Content-Length") &&
  11658. !detail::is_chunked_transfer_encoding(req.headers)) {
  11659. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11660. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11661. auto has_data = strm.is_readable();
  11662. if (!has_data) {
  11663. auto s = strm.socket();
  11664. if (s != INVALID_SOCKET) {
  11665. has_data = detail::select_read(s, 0, 0) > 0;
  11666. }
  11667. }
  11668. if (has_data) {
  11669. // Route through the same decompressing reader used by the
  11670. // length-framed and chunked paths below, so payload_max_length_ is
  11671. // enforced on the decompressed size here too instead of only on the
  11672. // compressed wire bytes.
  11673. return detail::read_content(strm, req, payload_max_length_, res.status,
  11674. nullptr, out, true);
  11675. }
  11676. }
  11677. return true;
  11678. }
  11679. #else
  11680. if (!req.has_header("Content-Length") &&
  11681. !detail::is_chunked_transfer_encoding(req.headers)) {
  11682. return true;
  11683. }
  11684. #endif
  11685. // The client is waiting for this before it sends the body.
  11686. if (req.expect_100_continue_pending_) {
  11687. req.expect_100_continue_pending_ = false;
  11688. detail::write_response_line(strm, StatusCode::Continue_100);
  11689. strm.write("\r\n");
  11690. }
  11691. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11692. out, true)) {
  11693. return false;
  11694. }
  11695. req.body_consumed_ = true;
  11696. if (req.is_multipart_form_data()) {
  11697. if (!multipart_form_data_parser.is_valid()) {
  11698. res.status = StatusCode::BadRequest_400;
  11699. output_error_log(Error::MultipartParsing, &req);
  11700. return false;
  11701. }
  11702. }
  11703. return true;
  11704. }
  11705. inline bool Server::handle_file_request(Request &req, Response &res) {
  11706. for (const auto &entry : base_dirs_) {
  11707. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11708. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11709. // One that already ends in '/' (the root mount among them) carries its own
  11710. // boundary; set_mount_point() guarantees the mount point is not empty.
  11711. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11712. (entry.mount_point.back() == '/' ||
  11713. req.path.size() == entry.mount_point.size() ||
  11714. req.path[entry.mount_point.size()] == '/')) {
  11715. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11716. if (detail::is_valid_path(sub_path)) {
  11717. auto path = entry.base_dir + sub_path;
  11718. if (path.back() == '/') { path += "index.html"; }
  11719. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11720. // but symlinks/junctions can still escape the base directory.
  11721. if (!entry.resolved_base_dir.empty()) {
  11722. std::string resolved_path;
  11723. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11724. !detail::is_path_within_base(resolved_path,
  11725. entry.resolved_base_dir)) {
  11726. res.status = StatusCode::Forbidden_403;
  11727. return true;
  11728. }
  11729. }
  11730. detail::FileStat stat(path);
  11731. if (stat.is_dir()) {
  11732. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11733. return true;
  11734. }
  11735. if (stat.is_file()) {
  11736. for (const auto &kv : entry.headers) {
  11737. res.set_header(kv.first, kv.second);
  11738. }
  11739. auto content_type_of = [&]() {
  11740. return detail::find_content_type(
  11741. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11742. };
  11743. // Only the ETag needs the content type this early, and only to name
  11744. // the coding. Deciding it here would otherwise put a regex in front
  11745. // of the 304 below, which serving a file never used to pay for.
  11746. std::string content_type;
  11747. auto encoding = detail::EncodingType::None;
  11748. if (static_file_compression_) {
  11749. content_type = content_type_of();
  11750. encoding =
  11751. static_file_encoding(req, res, content_type, stat.size());
  11752. }
  11753. // The ETag names the representation actually sent, so a client that
  11754. // cached the compressed form revalidates against the compressed ETag
  11755. // and still gets a 304, while one that took identity keeps the plain
  11756. // ETag.
  11757. auto etag = detail::compute_etag(
  11758. stat, encoding == detail::EncodingType::None
  11759. ? std::string()
  11760. : std::string("-") + detail::encoding_name(encoding));
  11761. if (!etag.empty()) { res.set_header("ETag", etag); }
  11762. auto mtime = stat.mtime();
  11763. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11764. if (!last_modified.empty()) {
  11765. res.set_header("Last-Modified", last_modified);
  11766. }
  11767. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11768. check_if_range(req, etag, mtime);
  11769. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11770. if (!mm->is_open()) {
  11771. output_error_log(Error::OpenFile, &req);
  11772. return false;
  11773. }
  11774. if (!static_file_compression_) { content_type = content_type_of(); }
  11775. detail::set_file_content_provider(res, mm, content_type, encoding);
  11776. if (req.method != "HEAD" && file_request_handler_) {
  11777. file_request_handler_(req, res);
  11778. }
  11779. return true;
  11780. } else {
  11781. output_error_log(Error::OpenFile, &req);
  11782. }
  11783. }
  11784. }
  11785. }
  11786. return false;
  11787. }
  11788. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11789. const std::string &etag,
  11790. time_t mtime) const {
  11791. // Handle conditional GET:
  11792. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11793. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11794. if (req.has_header("If-None-Match")) {
  11795. if (!etag.empty()) {
  11796. auto val =
  11797. detail::get_combined_header_value(req.headers, "If-None-Match");
  11798. // NOTE: We use exact string matching here. This works correctly
  11799. // because our server always generates weak ETags (W/"..."), and
  11800. // clients typically send back the same ETag they received.
  11801. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11802. // If-None-Match, where W/"x" and "x" would match, but this
  11803. // simplified implementation requires exact matches.
  11804. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11805. [&](const char *b, const char *e) {
  11806. auto seg_len = static_cast<size_t>(e - b);
  11807. return (seg_len == 1 && *b == '*') ||
  11808. (seg_len == etag.size() &&
  11809. std::equal(b, e, etag.begin()));
  11810. });
  11811. if (ret) {
  11812. res.status = StatusCode::NotModified_304;
  11813. return true;
  11814. }
  11815. }
  11816. } else if (req.has_header("If-Modified-Since")) {
  11817. auto val = req.get_header_value("If-Modified-Since");
  11818. auto t = detail::parse_http_date(val);
  11819. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11820. res.status = StatusCode::NotModified_304;
  11821. return true;
  11822. }
  11823. }
  11824. return false;
  11825. }
  11826. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11827. time_t mtime) const {
  11828. // Handle If-Range for partial content requests (RFC 9110
  11829. // Section 13.1.5). If-Range is only evaluated when Range header is
  11830. // present. If the validator matches, serve partial content; otherwise
  11831. // serve full content.
  11832. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11833. auto val = req.get_header_value("If-Range");
  11834. auto is_valid_range = [&]() {
  11835. if (detail::is_strong_etag(val)) {
  11836. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11837. // comparison.
  11838. return (!etag.empty() && val == etag);
  11839. } else if (detail::is_weak_etag(val)) {
  11840. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11841. return false;
  11842. } else {
  11843. // HTTP-date comparison
  11844. auto t = detail::parse_http_date(val);
  11845. return (t != static_cast<time_t>(-1) && mtime <= t);
  11846. }
  11847. };
  11848. if (!is_valid_range()) {
  11849. // Validator doesn't match: ignore Range and serve full content
  11850. req.ranges.clear();
  11851. return false;
  11852. }
  11853. }
  11854. return true;
  11855. }
  11856. inline socket_t
  11857. Server::create_server_socket(const std::string &host, int port,
  11858. int socket_flags,
  11859. SocketOptions socket_options) const {
  11860. return detail::create_socket(
  11861. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11862. ipv6_v6only_, std::move(socket_options),
  11863. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11864. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11865. output_error_log(Error::BindIPAddress, nullptr);
  11866. return false;
  11867. }
  11868. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11869. output_error_log(Error::Listen, nullptr);
  11870. return false;
  11871. }
  11872. return true;
  11873. });
  11874. }
  11875. inline int Server::bind_internal(const std::string &host, int port,
  11876. int socket_flags) {
  11877. if (is_decommissioned) { return -1; }
  11878. if (!is_valid()) { return -1; }
  11879. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11880. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11881. if (port == 0) {
  11882. struct sockaddr_storage addr;
  11883. socklen_t addr_len = sizeof(addr);
  11884. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11885. &addr_len) == -1) {
  11886. output_error_log(Error::GetSockName, nullptr);
  11887. return -1;
  11888. }
  11889. if (addr.ss_family == AF_INET) {
  11890. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11891. } else if (addr.ss_family == AF_INET6) {
  11892. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11893. } else {
  11894. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11895. return -1;
  11896. }
  11897. } else {
  11898. return port;
  11899. }
  11900. }
  11901. inline bool Server::listen_internal() {
  11902. // A stop() between bind and listen leaves nothing to accept on. Report
  11903. // failure instead of returning success without ever serving, and mark the
  11904. // server decommissioned the way any failed listen does so that a concurrent
  11905. // wait_until_ready() wakes up instead of spinning forever.
  11906. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11907. is_decommissioned = true;
  11908. return false;
  11909. }
  11910. auto ret = true;
  11911. is_running_ = true;
  11912. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11913. if (start_handler_) { start_handler_(); }
  11914. {
  11915. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11916. while (svr_sock_ != INVALID_SOCKET) {
  11917. #ifndef _WIN32
  11918. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11919. #endif
  11920. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11921. idle_interval_usec_);
  11922. if (val == 0) { // Timeout
  11923. task_queue->on_idle();
  11924. continue;
  11925. }
  11926. #ifndef _WIN32
  11927. }
  11928. #endif
  11929. #if defined _WIN32
  11930. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11931. // OVERLAPPED
  11932. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11933. #elif defined SOCK_CLOEXEC
  11934. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11935. #else
  11936. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11937. #endif
  11938. if (sock == INVALID_SOCKET) {
  11939. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11940. // touches the CRT errno, so the two have to be asked platform by
  11941. // platform rather than by testing errno here.
  11942. if (detail::is_accept_resource_error()) {
  11943. // The per-process descriptor limit or the network stack's buffer
  11944. // space has been reached. Try to accept new connections after a
  11945. // short sleep.
  11946. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11947. continue;
  11948. } else if (detail::is_accept_transient_error()) {
  11949. continue;
  11950. }
  11951. // Take the descriptor out of svr_sock_ before closing it: a later
  11952. // stop() would otherwise shutdown()/close() a value the OS may have
  11953. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11954. // gone. The exchange also settles the race with a concurrent stop(),
  11955. // since whichever side takes the descriptor closes it exactly once.
  11956. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11957. if (listen_sock != INVALID_SOCKET) {
  11958. detail::close_socket(listen_sock);
  11959. ret = false;
  11960. output_error_log(Error::Connection, nullptr);
  11961. } else {
  11962. ; // The server socket was closed by user.
  11963. }
  11964. break;
  11965. }
  11966. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11967. read_timeout_sec_, read_timeout_usec_);
  11968. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11969. write_timeout_sec_, write_timeout_usec_);
  11970. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11971. if (!task_queue->enqueue(
  11972. [this, sock]() { process_and_close_socket(sock); })) {
  11973. output_error_log(Error::ResourceExhaustion, nullptr);
  11974. detail::shutdown_socket(sock);
  11975. detail::close_socket(sock);
  11976. }
  11977. }
  11978. task_queue->shutdown();
  11979. }
  11980. is_decommissioned = !ret;
  11981. return ret;
  11982. }
  11983. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11984. if (pre_routing_handler_ &&
  11985. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11986. return true;
  11987. }
  11988. // File handler
  11989. if ((req.method == "GET" || req.method == "HEAD") &&
  11990. handle_file_request(req, res)) {
  11991. return true;
  11992. }
  11993. const auto *custom = find_custom_entry(req.method);
  11994. // The second clause mirrors what expect_content() does unconditionally for
  11995. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11996. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11997. // `allprop`) would skip its handler and fall through to 404.
  11998. if (detail::expect_content(req) ||
  11999. (custom && !custom->handlers_for_content_reader.empty())) {
  12000. // Content reader handler
  12001. {
  12002. // Track whether the ContentReader was aborted due to the decompressed
  12003. // payload exceeding `payload_max_length_`.
  12004. // The user handler runs after the lambda returns, so we must restore the
  12005. // 413 status if the handler overwrites it.
  12006. bool content_reader_payload_too_large = false;
  12007. ContentReader reader(
  12008. [&](ContentReceiver receiver) {
  12009. auto result = read_content_with_content_receiver(
  12010. strm, req, res, std::move(receiver), nullptr, nullptr);
  12011. if (!result) {
  12012. output_error_log(Error::Read, &req);
  12013. if (res.status == StatusCode::PayloadTooLarge_413) {
  12014. content_reader_payload_too_large = true;
  12015. }
  12016. }
  12017. return result;
  12018. },
  12019. [&](FormDataHeader header, ContentReceiver receiver) {
  12020. auto result = read_content_with_content_receiver(
  12021. strm, req, res, nullptr, std::move(header),
  12022. std::move(receiver));
  12023. if (!result) {
  12024. output_error_log(Error::Read, &req);
  12025. if (res.status == StatusCode::PayloadTooLarge_413) {
  12026. content_reader_payload_too_large = true;
  12027. }
  12028. }
  12029. return result;
  12030. });
  12031. bool dispatched = false;
  12032. if (req.method == "POST") {
  12033. dispatched = dispatch_request_for_content_reader(
  12034. req, res, std::move(reader), post_handlers_for_content_reader_);
  12035. } else if (req.method == "PUT") {
  12036. dispatched = dispatch_request_for_content_reader(
  12037. req, res, std::move(reader), put_handlers_for_content_reader_);
  12038. } else if (req.method == "PATCH") {
  12039. dispatched = dispatch_request_for_content_reader(
  12040. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12041. } else if (req.method == "DELETE") {
  12042. dispatched = dispatch_request_for_content_reader(
  12043. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12044. } else if (custom) {
  12045. dispatched = dispatch_request_for_content_reader(
  12046. req, res, std::move(reader), custom->handlers_for_content_reader);
  12047. }
  12048. if (dispatched) {
  12049. if (content_reader_payload_too_large) {
  12050. // Enforce the limit: override any status the handler may have set
  12051. // and return false so the error path sends a plain 413 response.
  12052. res.status = StatusCode::PayloadTooLarge_413;
  12053. res.body.clear();
  12054. res.content_length_ = 0;
  12055. res.content_provider_ = nullptr;
  12056. return false;
  12057. }
  12058. return true;
  12059. }
  12060. }
  12061. // NOTE: `req.body` is not read here. For a regular handler the body is
  12062. // read inside dispatch_request(), after the route has matched and the
  12063. // pre-request handler has approved the request, so that a rejected
  12064. // request (e.g. failed authentication) never forces us to buffer a
  12065. // potentially large body.
  12066. }
  12067. // Regular handler
  12068. if (req.method == "GET" || req.method == "HEAD") {
  12069. return dispatch_request(req, res, get_handlers_, strm);
  12070. } else if (req.method == "POST") {
  12071. return dispatch_request(req, res, post_handlers_, strm);
  12072. } else if (req.method == "PUT") {
  12073. return dispatch_request(req, res, put_handlers_, strm);
  12074. } else if (req.method == "DELETE") {
  12075. return dispatch_request(req, res, delete_handlers_, strm);
  12076. } else if (req.method == "OPTIONS") {
  12077. return dispatch_request(req, res, options_handlers_, strm);
  12078. } else if (req.method == "PATCH") {
  12079. return dispatch_request(req, res, patch_handlers_, strm);
  12080. } else if (custom) {
  12081. return dispatch_request(req, res, custom->handlers, strm);
  12082. }
  12083. res.status = StatusCode::BadRequest_400;
  12084. return false;
  12085. }
  12086. inline bool Server::dispatch_request(Request &req, Response &res,
  12087. const Handlers &handlers, Stream &strm) {
  12088. for (const auto &x : handlers) {
  12089. const auto &matcher = x.first;
  12090. const auto &handler = x.second;
  12091. if (matcher->match(req)) {
  12092. req.matched_route = matcher->pattern();
  12093. // Run the pre-request handler before reading the body so a rejected
  12094. // request (e.g. failed authentication) never forces us to buffer a
  12095. // potentially large body. `req.matched_route` is available here.
  12096. if (pre_request_handler_ &&
  12097. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12098. return true;
  12099. }
  12100. // The route matched and the request was approved; read the body now.
  12101. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12102. output_error_log(Error::Read, &req);
  12103. return false;
  12104. }
  12105. handler(req, res);
  12106. return true;
  12107. }
  12108. }
  12109. return false;
  12110. }
  12111. // Decides the content coding for a response served straight from a file. Both
  12112. // the ETag, which has to name the representation actually sent, and
  12113. // `apply_static_file_compression()` go through this, so the two cannot drift
  12114. // apart.
  12115. inline detail::EncodingType
  12116. Server::static_file_encoding(const Request &req, const Response &res,
  12117. const std::string &content_type,
  12118. size_t length) const {
  12119. if (!static_file_compression_) { return detail::EncodingType::None; }
  12120. // Nothing to compress, and an empty file already answers with
  12121. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12122. // turn an empty body into a 20-byte gzip stream.
  12123. if (length == 0) { return detail::EncodingType::None; }
  12124. // A file that already fits in a single packet gains nothing from being made
  12125. // smaller, since it still travels in that one segment, and a file of a few
  12126. // bytes comes out larger than it went in.
  12127. if (length < static_file_compression_min_length_) {
  12128. return detail::EncodingType::None;
  12129. }
  12130. // RFC 9110 applies Range to the representation after content coding, so a
  12131. // compressed 206 would mean compressing the whole file and then slicing it.
  12132. // Serve ranges from the identity representation instead.
  12133. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12134. if (static_file_compression_max_length_ > 0 &&
  12135. length > static_file_compression_max_length_) {
  12136. return detail::EncodingType::None;
  12137. }
  12138. return detail::encoding_type(req, res, content_type);
  12139. }
  12140. // Compresses a file-backed content provider into `res.body` and takes over the
  12141. // framing headers. Returns false when the response is left untouched.
  12142. inline bool Server::apply_static_file_compression(const Request &req,
  12143. Response &res) const {
  12144. auto type = res.content_coding_;
  12145. if (type == detail::EncodingType::None || !res.content_provider_) {
  12146. return false;
  12147. }
  12148. auto compressor = detail::make_compressor(type);
  12149. if (!compressor) { return false; }
  12150. output_pre_compression_log(req, res);
  12151. std::string compressed;
  12152. if (!detail::compress_content_provider(res.content_provider_,
  12153. res.content_length_, *compressor,
  12154. compressed)) {
  12155. return false;
  12156. }
  12157. res.body.swap(compressed);
  12158. // The provider was consumed in full, so a resource releaser registered with
  12159. // it should hear about a success when the response goes away.
  12160. res.content_provider_success_ = true;
  12161. res.content_provider_ = nullptr;
  12162. res.content_length_ = 0;
  12163. res.content_coding_ = detail::EncodingType::None;
  12164. res.set_header("Content-Encoding", detail::encoding_name(type));
  12165. res.set_header("Vary", "Accept-Encoding");
  12166. res.set_header("Content-Length", std::to_string(res.body.size()));
  12167. return true;
  12168. }
  12169. inline void Server::apply_ranges(const Request &req, Response &res,
  12170. std::string &content_type,
  12171. std::string &boundary) const {
  12172. // A known-length content provider leaves `res.body` empty, so the compressor
  12173. // at the end of this function never runs for one (issue #2545). A file-backed
  12174. // provider is fully readable right here, so compress it and answer with an
  12175. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12176. // takes the same path as `set_content()` from here on. Range requests never
  12177. // get a content coding, so `Content-Range` still names identity bytes and
  12178. // none of the framing below applies.
  12179. if (apply_static_file_compression(req, res)) { return; }
  12180. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12181. auto it = res.headers.find("Content-Type");
  12182. if (it != res.headers.end()) {
  12183. content_type = it->second;
  12184. res.headers.erase(it);
  12185. }
  12186. boundary = detail::make_multipart_data_boundary();
  12187. res.set_header("Content-Type",
  12188. "multipart/byteranges; boundary=" + boundary);
  12189. }
  12190. auto type = detail::encoding_type(req, res);
  12191. if (res.body.empty()) {
  12192. if (res.content_length_ > 0) {
  12193. size_t length = 0;
  12194. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12195. length = res.content_length_;
  12196. } else if (req.ranges.size() == 1) {
  12197. auto offset_and_length = detail::get_range_offset_and_length(
  12198. req.ranges[0], res.content_length_);
  12199. length = offset_and_length.second;
  12200. auto content_range = detail::make_content_range_header_field(
  12201. offset_and_length, res.content_length_);
  12202. res.set_header("Content-Range", content_range);
  12203. } else {
  12204. length = detail::get_multipart_ranges_data_length(
  12205. req, boundary, content_type, res.content_length_);
  12206. }
  12207. res.set_header("Content-Length", std::to_string(length));
  12208. } else {
  12209. if (res.content_provider_) {
  12210. if (res.is_chunked_content_provider_) {
  12211. res.set_header("Transfer-Encoding", "chunked");
  12212. res.content_coding_ = type;
  12213. if (type != detail::EncodingType::None) {
  12214. res.set_header("Content-Encoding", detail::encoding_name(type));
  12215. res.set_header("Vary", "Accept-Encoding");
  12216. }
  12217. }
  12218. }
  12219. }
  12220. } else {
  12221. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12222. ;
  12223. } else if (req.ranges.size() == 1) {
  12224. auto offset_and_length =
  12225. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12226. auto offset = offset_and_length.first;
  12227. auto length = offset_and_length.second;
  12228. auto content_range = detail::make_content_range_header_field(
  12229. offset_and_length, res.body.size());
  12230. res.set_header("Content-Range", content_range);
  12231. assert(offset + length <= res.body.size());
  12232. res.body = res.body.substr(offset, length);
  12233. } else {
  12234. std::string data;
  12235. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12236. res.body.size(), data);
  12237. res.body.swap(data);
  12238. }
  12239. if (type != detail::EncodingType::None) {
  12240. output_pre_compression_log(req, res);
  12241. if (auto compressor = detail::make_compressor(type)) {
  12242. std::string compressed;
  12243. if (compressor->compress(res.body.data(), res.body.size(), true,
  12244. [&](const char *data, size_t data_len) {
  12245. compressed.append(data, data_len);
  12246. return true;
  12247. })) {
  12248. res.body.swap(compressed);
  12249. res.set_header("Content-Encoding", detail::encoding_name(type));
  12250. res.set_header("Vary", "Accept-Encoding");
  12251. }
  12252. }
  12253. }
  12254. res.content_length_ = res.body.size();
  12255. res.set_header("Content-Length", std::to_string(res.content_length_));
  12256. }
  12257. }
  12258. inline bool Server::dispatch_request_for_content_reader(
  12259. Request &req, Response &res, ContentReader content_reader,
  12260. const HandlersForContentReader &handlers) const {
  12261. for (const auto &x : handlers) {
  12262. const auto &matcher = x.first;
  12263. const auto &handler = x.second;
  12264. if (matcher->match(req)) {
  12265. req.matched_route = matcher->pattern();
  12266. if (!pre_request_handler_ ||
  12267. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12268. handler(req, res, content_reader);
  12269. }
  12270. return true;
  12271. }
  12272. }
  12273. return false;
  12274. }
  12275. inline std::string
  12276. get_client_ip(const std::string &x_forwarded_for,
  12277. const std::vector<std::string> &trusted_proxies) {
  12278. // X-Forwarded-For is a comma-separated list per RFC 7239
  12279. std::vector<std::string> ip_list;
  12280. detail::split(x_forwarded_for.data(),
  12281. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12282. [&](const char *b, const char *e) {
  12283. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12284. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12285. });
  12286. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12287. // no segments. Signal "no client IP derived" with an empty string so the
  12288. // caller can fall back to the connection-level remote address.
  12289. if (ip_list.empty()) { return std::string(); }
  12290. // Each hop appends the address it received the request from, so the rightmost
  12291. // entries are the ones written by our own infrastructure while the leftmost
  12292. // are whatever the original client chose to send. Walk from the right and
  12293. // skip trusted proxies; the first address that is not a trusted proxy is the
  12294. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12295. // from the left instead lets a client forge an arbitrary address by following
  12296. // it with a trusted proxy's address, which the left-to-right scan then
  12297. // returned as the client.
  12298. for (size_t i = ip_list.size(); i-- > 0;) {
  12299. const auto &ip = ip_list[i];
  12300. auto is_trusted_proxy =
  12301. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12302. [&](const std::string &proxy) { return ip == proxy; });
  12303. if (!is_trusted_proxy) { return ip; }
  12304. }
  12305. // Every hop was a trusted proxy; fall back to the first entry.
  12306. return ip_list.front();
  12307. }
  12308. inline bool
  12309. Server::process_request(Stream &strm, const std::string &remote_addr,
  12310. int remote_port, const std::string &local_addr,
  12311. int local_port, bool close_connection,
  12312. bool &connection_closed,
  12313. const std::function<void(Request &)> &setup_request,
  12314. bool *websocket_upgraded) {
  12315. std::array<char, 2048> buf{};
  12316. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12317. // Connection has been closed on client
  12318. if (!line_reader.getline()) { return false; }
  12319. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12320. // clients send an extra CRLF after a request body, which would otherwise be
  12321. // parsed as the next request on a persistent connection.
  12322. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12323. return false;
  12324. }
  12325. Request req;
  12326. req.start_time_ = std::chrono::steady_clock::now();
  12327. req.remote_addr = remote_addr;
  12328. req.remote_port = remote_port;
  12329. req.local_addr = local_addr;
  12330. req.local_port = local_port;
  12331. Response res;
  12332. res.version = "HTTP/1.1";
  12333. res.headers = default_headers_;
  12334. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12335. // close the connection after that response, whichever path wrote it (an
  12336. // error status, a handler, or a rejected request). Reading on would also
  12337. // parse whatever the client sent next on a connection it considers done.
  12338. auto honor_connection_close = detail::scope_exit([&] {
  12339. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12340. connection_closed = true;
  12341. }
  12342. });
  12343. // Request line and headers. A rejected message leaves the rest of it (and
  12344. // any body) unread, so the connection cannot be reused: the leftover bytes
  12345. // would be parsed as the next request.
  12346. if (!parse_request_line(line_reader.ptr(), req)) {
  12347. connection_closed = true;
  12348. res.status = StatusCode::BadRequest_400;
  12349. output_error_log(Error::InvalidRequestLine, &req);
  12350. return write_response(strm, close_connection, req, res);
  12351. }
  12352. // Request headers
  12353. if (!detail::read_headers(strm, req.headers)) {
  12354. connection_closed = true;
  12355. res.status = StatusCode::BadRequest_400;
  12356. output_error_log(Error::InvalidHeaders, &req);
  12357. return write_response(strm, close_connection, req, res);
  12358. }
  12359. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12360. // which would otherwise let an intermediary and this parser disagree on
  12361. // where the body ends and enable request smuggling. Three cases: a
  12362. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12363. // or empty), which would otherwise be read as "no body"; a non-zero
  12364. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12365. // tolerated for compatibility with existing clients); and a
  12366. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12367. // length undeterminable. None of them may fall through to the "no body"
  12368. // path, or the body bytes are parsed as the next request on a persistent
  12369. // connection.
  12370. auto is_invalid_content_length = false;
  12371. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12372. is_invalid_content_length);
  12373. if (is_invalid_content_length ||
  12374. detail::has_conflicting_content_length(req.headers) ||
  12375. (req.has_header("Transfer-Encoding") &&
  12376. !detail::is_chunked_transfer_encoding(req.headers))) {
  12377. connection_closed = true;
  12378. res.status = StatusCode::BadRequest_400;
  12379. return write_response(strm, close_connection, req, res);
  12380. }
  12381. // RFC 9112 §3.2: Reject more than one Host field line or an invalid Host
  12382. // value, so that every recipient of the request sees the same authority.
  12383. if (req.get_header_value_count("Host") > 1 ||
  12384. !detail::fields::is_host(req.get_header_value("Host"))) {
  12385. connection_closed = true;
  12386. res.status = StatusCode::BadRequest_400;
  12387. output_error_log(Error::InvalidHeaders, &req);
  12388. return write_response(strm, close_connection, req, res);
  12389. }
  12390. // Check if the request URI doesn't exceed the limit
  12391. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12392. connection_closed = true;
  12393. res.status = StatusCode::UriTooLong_414;
  12394. output_error_log(Error::ExceedUriMaxLength, &req);
  12395. return write_response(strm, close_connection, req, res);
  12396. }
  12397. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12398. connection_closed = true;
  12399. }
  12400. if (req.version == "HTTP/1.0" &&
  12401. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12402. connection_closed = true;
  12403. }
  12404. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12405. // itself a trusted proxy. Otherwise any direct client could spoof
  12406. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12407. auto is_trusted_peer = std::any_of(
  12408. trusted_proxies_.begin(), trusted_proxies_.end(),
  12409. [&](const std::string &proxy) { return proxy == remote_addr; });
  12410. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12411. // Some proxies append the address they observed as a separate
  12412. // X-Forwarded-For field line instead of extending the one the client sent
  12413. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12414. // be scanned. Reading only the first occurrence would hand back the
  12415. // client-supplied, and therefore forgeable, value.
  12416. auto x_forwarded_for =
  12417. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12418. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12419. req.remote_addr = derived.empty() ? remote_addr : derived;
  12420. } else {
  12421. req.remote_addr = remote_addr;
  12422. }
  12423. req.remote_port = remote_port;
  12424. req.local_addr = local_addr;
  12425. req.local_port = local_port;
  12426. if (req.has_header("Accept")) {
  12427. auto accept_header =
  12428. detail::get_combined_header_value(req.headers, "Accept");
  12429. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12430. connection_closed = true;
  12431. res.status = StatusCode::BadRequest_400;
  12432. output_error_log(Error::HTTPParsing, &req);
  12433. return write_response(strm, close_connection, req, res);
  12434. }
  12435. }
  12436. if (req.has_header("Range")) {
  12437. const auto &range_header_value = req.get_header_value("Range");
  12438. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12439. connection_closed = true;
  12440. res.status = StatusCode::RangeNotSatisfiable_416;
  12441. output_error_log(Error::InvalidRangeHeader, &req);
  12442. return write_response(strm, close_connection, req, res);
  12443. }
  12444. }
  12445. if (setup_request) { setup_request(req); }
  12446. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12447. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12448. // must be ignored. An expectation we do not recognize is left alone; the
  12449. // 417 the section allows for one is a MAY, not a requirement.
  12450. //
  12451. // `100 Continue` itself is deferred until the body is actually read (see
  12452. // read_content_core), so a request rejected by a later handler never
  12453. // invites the client to send a body nobody will read.
  12454. if (req.version != "HTTP/1.0" &&
  12455. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12456. int status = StatusCode::Continue_100;
  12457. if (expect_100_continue_handler_) {
  12458. status = expect_100_continue_handler_(req, res);
  12459. }
  12460. if (status == StatusCode::Continue_100) {
  12461. req.expect_100_continue_pending_ = true;
  12462. } else {
  12463. if (res.status == -1) { res.status = status; }
  12464. connection_closed = true;
  12465. return write_response(strm, true, req, res);
  12466. }
  12467. }
  12468. // Setup `is_connection_closed` method
  12469. auto sock = strm.socket();
  12470. req.is_connection_closed = [sock]() {
  12471. return !detail::is_socket_alive(sock);
  12472. };
  12473. // WebSocket upgrade
  12474. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12475. // that authentication and other middleware can reject the request with an
  12476. // HTTP response (e.g., 401) before the protocol switches.
  12477. if (detail::is_websocket_upgrade(req)) {
  12478. if (pre_routing_handler_ &&
  12479. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12480. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12481. return write_response_with_content(strm, close_connection, req, res);
  12482. }
  12483. // Find matching WebSocket handler
  12484. for (const auto &entry : websocket_handlers_) {
  12485. if (entry.matcher->match(req)) {
  12486. req.matched_route = entry.matcher->pattern();
  12487. if (pre_request_handler_ &&
  12488. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12489. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12490. return write_response_with_content(strm, close_connection, req, res);
  12491. }
  12492. // Compute accept key
  12493. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12494. auto accept_key = detail::websocket_accept_key(client_key);
  12495. // Negotiate subprotocol
  12496. std::string selected_subprotocol;
  12497. if (entry.sub_protocol_selector) {
  12498. auto protocol_header = detail::get_combined_header_value(
  12499. req.headers, "Sec-WebSocket-Protocol");
  12500. if (!protocol_header.empty()) {
  12501. std::vector<std::string> protocols;
  12502. detail::split(protocol_header.data(),
  12503. protocol_header.data() + protocol_header.size(), ',',
  12504. [&](const char *b, const char *e) {
  12505. protocols.emplace_back(b, e);
  12506. });
  12507. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12508. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12509. if (std::find(protocols.begin(), protocols.end(),
  12510. selected_subprotocol) == protocols.end()) {
  12511. selected_subprotocol.clear();
  12512. }
  12513. }
  12514. }
  12515. // Send 101 Switching Protocols
  12516. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12517. "Upgrade: websocket\r\n"
  12518. "Connection: Upgrade\r\n"
  12519. "Sec-WebSocket-Accept: " +
  12520. accept_key + "\r\n";
  12521. if (!selected_subprotocol.empty()) {
  12522. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12523. return false;
  12524. }
  12525. handshake_response +=
  12526. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12527. }
  12528. handshake_response += "\r\n";
  12529. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12530. 0) {
  12531. return false;
  12532. }
  12533. connection_closed = true;
  12534. if (websocket_upgraded) { *websocket_upgraded = true; }
  12535. {
  12536. #ifdef CPPHTTPLIB_SSL_ENABLED
  12537. if (req.ssl) {
  12538. // wss: the heartbeat ping thread and the read path enter the same
  12539. // TLS session from different threads. Hand the WebSocket a stream
  12540. // that serializes every TLS call, so the shared SSLSocketStream on
  12541. // the plain HTTP/HTTPS paths stays untouched.
  12542. auto ws_strm =
  12543. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12544. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12545. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12546. write_timeout_sec_, write_timeout_usec_));
  12547. ws::WebSocket ws(std::move(ws_strm), req, true,
  12548. websocket_ping_interval_sec_,
  12549. websocket_max_missed_pongs_);
  12550. entry.handler(req, ws);
  12551. return true;
  12552. }
  12553. #endif
  12554. // Use WebSocket-specific read timeout instead of HTTP timeout
  12555. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12556. 0);
  12557. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12558. websocket_max_missed_pongs_);
  12559. entry.handler(req, ws);
  12560. }
  12561. return true;
  12562. }
  12563. }
  12564. // No matching handler - fall through to 404
  12565. }
  12566. // Routing
  12567. auto routed = false;
  12568. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12569. routed = routing(req, res, strm);
  12570. #else
  12571. try {
  12572. routed = routing(req, res, strm);
  12573. } catch (std::exception &) {
  12574. if (exception_handler_) {
  12575. auto ep = std::current_exception();
  12576. exception_handler_(req, res, ep);
  12577. routed = true;
  12578. } else {
  12579. res.status = StatusCode::InternalServerError_500;
  12580. }
  12581. } catch (...) {
  12582. if (exception_handler_) {
  12583. auto ep = std::current_exception();
  12584. exception_handler_(req, res, ep);
  12585. routed = true;
  12586. } else {
  12587. res.status = StatusCode::InternalServerError_500;
  12588. }
  12589. }
  12590. #endif
  12591. auto ret = false;
  12592. if (routed) {
  12593. if (res.status == -1) {
  12594. res.status = req.ranges.empty() ? StatusCode::OK_200
  12595. : StatusCode::PartialContent_206;
  12596. }
  12597. // Serve file content by using a content provider
  12598. auto file_open_error = false;
  12599. if (!res.file_content_path_.empty()) {
  12600. const auto &path = res.file_content_path_;
  12601. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12602. if (!mm->is_open()) {
  12603. res.body.clear();
  12604. res.content_length_ = 0;
  12605. res.content_provider_ = nullptr;
  12606. res.status = StatusCode::NotFound_404;
  12607. output_error_log(Error::OpenFile, &req);
  12608. file_open_error = true;
  12609. } else {
  12610. auto content_type = res.file_content_content_type_;
  12611. if (content_type.empty()) {
  12612. content_type = detail::find_content_type(
  12613. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12614. }
  12615. detail::set_file_content_provider(
  12616. res, mm, content_type,
  12617. static_file_encoding(req, res, content_type, mm->size()));
  12618. }
  12619. }
  12620. if (file_open_error) {
  12621. ret = write_response(strm, close_connection, req, res);
  12622. } else if (detail::range_error(req, res)) {
  12623. res.body.clear();
  12624. res.content_length_ = 0;
  12625. res.content_provider_ = nullptr;
  12626. res.status = StatusCode::RangeNotSatisfiable_416;
  12627. ret = write_response(strm, close_connection, req, res);
  12628. } else {
  12629. ret = write_response_with_content(strm, close_connection, req, res);
  12630. }
  12631. } else {
  12632. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12633. ret = write_response(strm, close_connection, req, res);
  12634. }
  12635. // Drain any unconsumed framed body to prevent request smuggling on
  12636. // keep-alive. Without framing there is no body to drain — reading would
  12637. // consume the next request (issue #2450). If the response has committed the
  12638. // connection to close, there is no next request to protect.
  12639. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12640. !detail::has_header_token(res.headers, "Connection", "close")) {
  12641. int dummy_status;
  12642. if (!detail::read_content(
  12643. strm, req, payload_max_length_, dummy_status, nullptr,
  12644. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12645. connection_closed = true;
  12646. }
  12647. }
  12648. return ret;
  12649. }
  12650. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12651. inline bool Server::process_and_close_socket(socket_t sock) {
  12652. std::string remote_addr;
  12653. int remote_port = 0;
  12654. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12655. std::string local_addr;
  12656. int local_port = 0;
  12657. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12658. bool websocket_upgraded = false;
  12659. auto ret = serve_guarded([&]() {
  12660. return detail::process_server_socket(
  12661. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12662. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12663. write_timeout_usec_,
  12664. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12665. return process_request(strm, remote_addr, remote_port, local_addr,
  12666. local_port, close_connection,
  12667. connection_closed, nullptr,
  12668. &websocket_upgraded);
  12669. });
  12670. });
  12671. detail::drain_and_close_socket(sock);
  12672. return ret;
  12673. }
  12674. inline void Server::output_log(const Request &req, const Response &res) const {
  12675. if (logger_) {
  12676. std::lock_guard<std::mutex> guard(logger_mutex_);
  12677. logger_(req, res);
  12678. }
  12679. }
  12680. inline void Server::output_pre_compression_log(const Request &req,
  12681. const Response &res) const {
  12682. if (pre_compression_logger_) {
  12683. std::lock_guard<std::mutex> guard(logger_mutex_);
  12684. pre_compression_logger_(req, res);
  12685. }
  12686. }
  12687. inline void Server::output_error_log(const Error &err,
  12688. const Request *req) const {
  12689. if (error_logger_) {
  12690. std::lock_guard<std::mutex> guard(logger_mutex_);
  12691. error_logger_(err, req);
  12692. }
  12693. }
  12694. /*
  12695. * Group 5: ClientImpl and Client (Universal) implementation
  12696. */
  12697. // HTTP client implementation
  12698. inline ClientImpl::ClientImpl(const std::string &host)
  12699. : ClientImpl(host, 80, std::string(), std::string()) {}
  12700. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12701. : ClientImpl(host, port, std::string(), std::string()) {}
  12702. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12703. const std::string &client_cert_path,
  12704. const std::string &client_key_path)
  12705. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12706. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12707. inline ClientImpl::~ClientImpl() {
  12708. // Wait until all the requests in flight are handled.
  12709. size_t retry_count = 10;
  12710. while (retry_count-- > 0) {
  12711. {
  12712. std::lock_guard<std::mutex> guard(socket_mutex_);
  12713. if (socket_requests_in_flight_ == 0) { break; }
  12714. }
  12715. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12716. }
  12717. std::lock_guard<std::mutex> guard(socket_mutex_);
  12718. shutdown_socket(socket_);
  12719. close_socket(socket_);
  12720. }
  12721. inline bool ClientImpl::is_valid() const { return true; }
  12722. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12723. client_cert_path_ = rhs.client_cert_path_;
  12724. client_key_path_ = rhs.client_key_path_;
  12725. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12726. read_timeout_sec_ = rhs.read_timeout_sec_;
  12727. read_timeout_usec_ = rhs.read_timeout_usec_;
  12728. write_timeout_sec_ = rhs.write_timeout_sec_;
  12729. write_timeout_usec_ = rhs.write_timeout_usec_;
  12730. max_timeout_msec_ = rhs.max_timeout_msec_;
  12731. basic_auth_username_ = rhs.basic_auth_username_;
  12732. basic_auth_password_ = rhs.basic_auth_password_;
  12733. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12734. keep_alive_ = rhs.keep_alive_;
  12735. follow_location_ = rhs.follow_location_;
  12736. path_encode_ = rhs.path_encode_;
  12737. address_family_ = rhs.address_family_;
  12738. tcp_nodelay_ = rhs.tcp_nodelay_;
  12739. ipv6_v6only_ = rhs.ipv6_v6only_;
  12740. socket_options_ = rhs.socket_options_;
  12741. compress_ = rhs.compress_;
  12742. decompress_ = rhs.decompress_;
  12743. payload_max_length_ = rhs.payload_max_length_;
  12744. has_payload_max_length_ = rhs.has_payload_max_length_;
  12745. interface_ = rhs.interface_;
  12746. proxy_host_ = rhs.proxy_host_;
  12747. proxy_port_ = rhs.proxy_port_;
  12748. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12749. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12750. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12751. no_proxy_entries_ = rhs.no_proxy_entries_;
  12752. logger_ = rhs.logger_;
  12753. error_logger_ = rhs.error_logger_;
  12754. #ifdef CPPHTTPLIB_SSL_ENABLED
  12755. digest_auth_username_ = rhs.digest_auth_username_;
  12756. digest_auth_password_ = rhs.digest_auth_password_;
  12757. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12758. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12759. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12760. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12761. server_certificate_verification_ = rhs.server_certificate_verification_;
  12762. server_hostname_verification_ = rhs.server_hostname_verification_;
  12763. system_ca_mode_ = rhs.system_ca_mode_;
  12764. #endif
  12765. }
  12766. inline bool
  12767. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12768. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12769. if (no_proxy_entries_.empty()) { return true; }
  12770. // host_ is const so its normalized form is invariant; cache it. The
  12771. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12772. if (host == host_) {
  12773. if (!host_normalized_valid_) {
  12774. host_normalized_ = detail::normalize_target(host_);
  12775. host_normalized_valid_ = true;
  12776. }
  12777. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12778. }
  12779. auto target = detail::normalize_target(host);
  12780. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12781. }
  12782. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12783. if (is_proxy_enabled_for_host(host_)) {
  12784. return detail::create_client_socket(
  12785. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12786. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12787. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12788. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12789. }
  12790. // Check is custom IP or hostname specified for host_
  12791. std::string connect_host;
  12792. std::string ip;
  12793. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12794. return detail::create_client_socket(
  12795. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12796. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12797. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12798. write_timeout_usec_, interface_, error);
  12799. }
  12800. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12801. Error &error) {
  12802. auto sock = create_client_socket(error);
  12803. if (sock == INVALID_SOCKET) { return false; }
  12804. socket.sock = sock;
  12805. return true;
  12806. }
  12807. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12808. return create_and_connect_socket(socket, error);
  12809. }
  12810. inline bool ClientImpl::setup_proxy_connection(
  12811. Socket & /*socket*/,
  12812. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12813. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12814. return true;
  12815. }
  12816. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12817. bool /*shutdown_gracefully*/) {
  12818. // If there are any requests in flight from threads other than us, then it's
  12819. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12820. assert(socket_requests_in_flight_ == 0 ||
  12821. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12822. }
  12823. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12824. if (socket.sock == INVALID_SOCKET) { return; }
  12825. detail::shutdown_socket(socket.sock);
  12826. }
  12827. inline void ClientImpl::close_socket(Socket &socket) {
  12828. // If there are requests in flight in another thread, usually closing
  12829. // the socket will be fine and they will simply receive an error when
  12830. // using the closed socket, but it is still a bug since rarely the OS
  12831. // may reassign the socket id to be used for a new socket, and then
  12832. // suddenly they will be operating on a live socket that is different
  12833. // than the one they intended!
  12834. assert(socket_requests_in_flight_ == 0 ||
  12835. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12836. // It is also a bug if this happens while SSL is still active
  12837. #ifdef CPPHTTPLIB_SSL_ENABLED
  12838. assert(socket.ssl == nullptr);
  12839. #endif
  12840. if (socket.sock == INVALID_SOCKET) { return; }
  12841. detail::close_socket(socket.sock);
  12842. socket.sock = INVALID_SOCKET;
  12843. }
  12844. inline void ClientImpl::disconnect(bool gracefully) {
  12845. shutdown_ssl(socket_, gracefully);
  12846. shutdown_socket(socket_);
  12847. close_socket(socket_);
  12848. }
  12849. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12850. Response &res,
  12851. bool skip_100_continue) const {
  12852. std::array<char, 2048> buf{};
  12853. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12854. if (!line_reader.getline()) { return false; }
  12855. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12856. res.reason)) {
  12857. return req.method == "CONNECT";
  12858. }
  12859. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12860. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12861. if (!line_reader.getline()) { return false; } // CRLF
  12862. if (!line_reader.getline()) { return false; } // next response line
  12863. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12864. res.reason)) {
  12865. return false;
  12866. }
  12867. }
  12868. return true;
  12869. }
  12870. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12871. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12872. auto ret = send_(req, res, error);
  12873. if (error == Error::SSLPeerCouldBeClosed_) {
  12874. assert(!ret);
  12875. ret = send_(req, res, error);
  12876. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12877. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12878. }
  12879. return ret;
  12880. }
  12881. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12882. {
  12883. std::lock_guard<std::mutex> guard(socket_mutex_);
  12884. // Set this to false immediately - if it ever gets set to true by the end
  12885. // of the request, we know another thread instructed us to close the
  12886. // socket.
  12887. socket_should_be_closed_when_request_is_done_ = false;
  12888. auto is_alive = false;
  12889. if (socket_.is_open()) {
  12890. is_alive = detail::is_socket_alive(socket_.sock);
  12891. #ifdef CPPHTTPLIB_SSL_ENABLED
  12892. if (is_alive && is_ssl()) {
  12893. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12894. is_alive = false;
  12895. }
  12896. }
  12897. #endif
  12898. if (!is_alive) {
  12899. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12900. disconnect(/*gracefully=*/false);
  12901. }
  12902. }
  12903. if (!is_alive) {
  12904. if (!ensure_socket_connection(socket_, error)) {
  12905. output_error_log(error, &req);
  12906. return false;
  12907. }
  12908. {
  12909. auto success = true;
  12910. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12911. error)) {
  12912. if (!success) { output_error_log(error, &req); }
  12913. return success;
  12914. }
  12915. }
  12916. }
  12917. // Mark the current socket as being in use so that it cannot be closed by
  12918. // anyone else while this request is ongoing, even though we will be
  12919. // releasing the mutex.
  12920. if (socket_requests_in_flight_ > 1) {
  12921. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12922. }
  12923. socket_requests_in_flight_ += 1;
  12924. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12925. }
  12926. for (const auto &header : default_headers_) {
  12927. if (req.headers.find(header.first) == req.headers.end()) {
  12928. req.headers.insert(header);
  12929. }
  12930. }
  12931. auto ret = false;
  12932. auto close_connection = !keep_alive_;
  12933. auto se = detail::scope_exit([&]() {
  12934. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12935. std::lock_guard<std::mutex> guard(socket_mutex_);
  12936. socket_requests_in_flight_ -= 1;
  12937. if (socket_requests_in_flight_ <= 0) {
  12938. assert(socket_requests_in_flight_ == 0);
  12939. socket_requests_are_from_thread_ = std::thread::id();
  12940. }
  12941. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12942. !ret) {
  12943. disconnect(/*gracefully=*/true);
  12944. }
  12945. });
  12946. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12947. return handle_request(strm, req, res, close_connection, error);
  12948. });
  12949. if (!ret) {
  12950. if (error == Error::Success) {
  12951. error = Error::Unknown;
  12952. output_error_log(error, &req);
  12953. }
  12954. }
  12955. return ret;
  12956. }
  12957. inline Result ClientImpl::send(const Request &req) {
  12958. auto req2 = req;
  12959. return send_(std::move(req2));
  12960. }
  12961. inline Result ClientImpl::send_(Request &&req) {
  12962. auto res = detail::make_unique<Response>();
  12963. auto error = Error::Success;
  12964. auto ret = send(req, *res, error);
  12965. #ifdef CPPHTTPLIB_SSL_ENABLED
  12966. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12967. last_ssl_error_, last_backend_error_};
  12968. #else
  12969. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12970. #endif
  12971. }
  12972. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12973. const std::string &ct) {
  12974. (void)for_stream;
  12975. // Default headers are meant for the origin and may carry its credentials, so
  12976. // keep them off the CONNECT request the proxy reads.
  12977. if (r.method != "CONNECT") {
  12978. for (const auto &header : default_headers_) {
  12979. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12980. }
  12981. }
  12982. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12983. // prepend it rather than appending it after the caller's own fields.
  12984. if (!r.has_header("Host")) {
  12985. r.headers.emplace_front(
  12986. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12987. address_family_));
  12988. }
  12989. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12990. if (!r.content_receiver) {
  12991. if (!r.has_header("Accept-Encoding")) {
  12992. std::string accept_encoding;
  12993. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12994. accept_encoding = "br";
  12995. #endif
  12996. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12997. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12998. accept_encoding += "gzip, deflate";
  12999. #endif
  13000. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13001. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13002. accept_encoding += "zstd";
  13003. #endif
  13004. r.set_header("Accept-Encoding", accept_encoding);
  13005. }
  13006. detail::add_default_user_agent_header(r);
  13007. }
  13008. if (!r.body.empty()) {
  13009. if (!ct.empty() && !r.has_header("Content-Type")) {
  13010. r.headers.emplace("Content-Type", ct);
  13011. }
  13012. if (!r.has_header("Content-Length")) {
  13013. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13014. }
  13015. }
  13016. }
  13017. inline ClientImpl::StreamHandle
  13018. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13019. const Params &params, const Headers &headers,
  13020. const std::string &body,
  13021. const std::string &content_type) {
  13022. StreamHandle handle;
  13023. handle.response = detail::make_unique<Response>();
  13024. handle.error = Error::Success;
  13025. // Encode the target exactly like the buffered send path does, so that the
  13026. // same `path` produces the same request line through either API.
  13027. auto raw_query_path =
  13028. params.empty() ? path : append_query_params(path, params);
  13029. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13030. handle.connection_ = detail::make_unique<ClientConnection>();
  13031. {
  13032. std::lock_guard<std::mutex> guard(socket_mutex_);
  13033. auto is_alive = false;
  13034. if (socket_.is_open()) {
  13035. is_alive = detail::is_socket_alive(socket_.sock);
  13036. #ifdef CPPHTTPLIB_SSL_ENABLED
  13037. if (is_alive && is_ssl()) {
  13038. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13039. is_alive = false;
  13040. }
  13041. }
  13042. #endif
  13043. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13044. }
  13045. if (!is_alive) {
  13046. if (!ensure_socket_connection(socket_, handle.error)) {
  13047. handle.response.reset();
  13048. return handle;
  13049. }
  13050. {
  13051. auto success = true;
  13052. auto start_time = std::chrono::steady_clock::now();
  13053. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13054. success, handle.error)) {
  13055. if (!success) { handle.response.reset(); }
  13056. return handle;
  13057. }
  13058. }
  13059. }
  13060. transfer_socket_ownership_to_handle(handle);
  13061. }
  13062. #ifdef CPPHTTPLIB_SSL_ENABLED
  13063. if (is_ssl() && handle.connection_->session) {
  13064. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13065. handle.connection_->sock, handle.connection_->session,
  13066. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13067. write_timeout_usec_);
  13068. } else {
  13069. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13070. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13071. write_timeout_sec_, write_timeout_usec_);
  13072. }
  13073. #else
  13074. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13075. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13076. write_timeout_sec_, write_timeout_usec_);
  13077. #endif
  13078. handle.stream_ = handle.socket_stream_.get();
  13079. Request req;
  13080. req.method = method;
  13081. req.path = query_path;
  13082. req.headers = headers;
  13083. req.body = body;
  13084. prepare_default_headers(req, true, content_type);
  13085. auto &strm = *handle.stream_;
  13086. // Build the request line and headers in memory first, like write_request()
  13087. // does, so that a rejected header leaves nothing on the wire.
  13088. {
  13089. detail::BufferStream bstrm;
  13090. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13091. handle.error = Error::Write;
  13092. handle.response.reset();
  13093. return handle;
  13094. }
  13095. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13096. handle.error)) {
  13097. handle.response.reset();
  13098. return handle;
  13099. }
  13100. const auto &data = bstrm.get_buffer();
  13101. if (!detail::write_data(strm, data.data(), data.size())) {
  13102. handle.error = Error::Write;
  13103. handle.response.reset();
  13104. return handle;
  13105. }
  13106. }
  13107. if (!body.empty()) {
  13108. if (strm.write(body.data(), body.size()) < 0) {
  13109. handle.error = Error::Write;
  13110. handle.response.reset();
  13111. return handle;
  13112. }
  13113. }
  13114. if (!read_response_line(strm, req, *handle.response) ||
  13115. !detail::read_headers(strm, handle.response->headers)) {
  13116. handle.error = Error::Read;
  13117. handle.response.reset();
  13118. return handle;
  13119. }
  13120. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13121. // (204/304) response legitimately carries framing headers with no body.
  13122. if (method != "HEAD" &&
  13123. handle.response->status != StatusCode::NoContent_204 &&
  13124. handle.response->status != StatusCode::NotModified_304 &&
  13125. detail::has_conflicting_content_length(handle.response->headers)) {
  13126. handle.error = Error::Read;
  13127. handle.response.reset();
  13128. return handle;
  13129. }
  13130. handle.body_reader_.stream = handle.stream_;
  13131. handle.body_reader_.payload_max_length = payload_max_length_;
  13132. if (handle.response->has_header("Content-Length")) {
  13133. bool is_invalid = false;
  13134. auto content_length = detail::get_header_value_u64(
  13135. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13136. if (is_invalid) {
  13137. handle.error = Error::Read;
  13138. handle.response.reset();
  13139. return handle;
  13140. }
  13141. handle.body_reader_.has_content_length = true;
  13142. handle.body_reader_.content_length = content_length;
  13143. }
  13144. handle.body_reader_.chunked =
  13145. detail::is_chunked_transfer_encoding(handle.response->headers);
  13146. auto content_encoding = detail::get_combined_header_value(
  13147. handle.response->headers, "Content-Encoding");
  13148. if (!content_encoding.empty()) {
  13149. // Same policy as prepare_content_receiver(): reject a coding we know about
  13150. // but were not built with, pass an unrecognized one through as-is.
  13151. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13152. if (!handle.decompressor_) {
  13153. if (detail::is_known_content_encoding(content_encoding)) {
  13154. handle.error = Error::UnsupportedContentEncoding;
  13155. handle.response.reset();
  13156. return handle;
  13157. }
  13158. } else if (!handle.decompressor_->is_valid()) {
  13159. handle.error = Error::Compression;
  13160. handle.response.reset();
  13161. return handle;
  13162. }
  13163. }
  13164. return handle;
  13165. }
  13166. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13167. if (!is_valid() || !response) { return -1; }
  13168. if (decompressor_) { return read_with_decompression(buf, len); }
  13169. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13170. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13171. trailers_parsed_ = true;
  13172. if (body_reader_.chunked_decoder) {
  13173. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13174. response->trailers, response->headers)) {
  13175. return n;
  13176. }
  13177. } else {
  13178. detail::ChunkedDecoder dec(*stream_);
  13179. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13180. return n;
  13181. }
  13182. }
  13183. }
  13184. return n;
  13185. }
  13186. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13187. size_t len) {
  13188. if (decompress_offset_ < decompress_buffer_.size()) {
  13189. auto available = decompress_buffer_.size() - decompress_offset_;
  13190. auto to_copy = (std::min)(len, available);
  13191. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13192. decompress_offset_ += to_copy;
  13193. decompressed_bytes_read_ += to_copy;
  13194. return static_cast<ssize_t>(to_copy);
  13195. }
  13196. decompress_buffer_.clear();
  13197. decompress_offset_ = 0;
  13198. constexpr size_t kDecompressionBufferSize = 8192;
  13199. char compressed_buf[kDecompressionBufferSize];
  13200. while (true) {
  13201. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13202. sizeof(compressed_buf));
  13203. if (n <= 0) { return n; }
  13204. bool decompress_ok = decompressor_->decompress(
  13205. compressed_buf, static_cast<size_t>(n),
  13206. [this](const char *data, size_t data_len) {
  13207. decompress_buffer_.append(data, data_len);
  13208. auto limit = body_reader_.payload_max_length;
  13209. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13210. return false;
  13211. }
  13212. return true;
  13213. });
  13214. if (!decompress_ok) {
  13215. body_reader_.last_error = Error::Read;
  13216. return -1;
  13217. }
  13218. if (!decompress_buffer_.empty()) { break; }
  13219. }
  13220. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13221. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13222. decompress_offset_ = to_copy;
  13223. decompressed_bytes_read_ += to_copy;
  13224. return static_cast<ssize_t>(to_copy);
  13225. }
  13226. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13227. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13228. return;
  13229. }
  13230. trailers_parsed_ = true;
  13231. const auto bufsiz = 128;
  13232. char line_buf[bufsiz];
  13233. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13234. if (!line_reader.getline()) { return; }
  13235. if (!detail::parse_trailers(line_reader, response->trailers,
  13236. response->headers)) {
  13237. return;
  13238. }
  13239. }
  13240. namespace detail {
  13241. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13242. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13243. size_t &out_chunk_offset,
  13244. size_t &out_chunk_total) {
  13245. if (finished) { return 0; }
  13246. if (chunk_remaining == 0) {
  13247. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13248. if (!lr.getline()) { return -1; }
  13249. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13250. // the line terminator is never mistaken for line content.
  13251. const char *eol = lr.ptr() + lr.size();
  13252. if (lr.end_with_crlf()) {
  13253. eol -= 2;
  13254. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13255. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13256. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13257. // has to come off here or the check below would reject the line.
  13258. eol -= 1;
  13259. }
  13260. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13261. const char *p = lr.ptr();
  13262. int v = 0;
  13263. if (p == eol || !is_hex(*p, v)) { return -1; }
  13264. size_t chunk_len = 0;
  13265. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13266. for (; p < eol && is_hex(*p, v); ++p) {
  13267. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13268. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13269. }
  13270. while (p < eol && is_space_or_tab(*p)) {
  13271. ++p;
  13272. }
  13273. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13274. // terminator, and it is built from tokens and quoted-strings, so it never
  13275. // holds a CR, LF or any other control character. getline() reads up to the
  13276. // CRLF, so a bare LF left in here would be swallowed as extension text
  13277. // while an intermediary that ends the line on it delimits the chunks
  13278. // differently, and the two disagree on where the body ends (request
  13279. // smuggling).
  13280. if (p < eol && *p != ';') { return -1; }
  13281. for (; p < eol; ++p) {
  13282. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13283. }
  13284. if (chunk_len == 0) {
  13285. chunk_remaining = 0;
  13286. finished = true;
  13287. out_chunk_offset = 0;
  13288. out_chunk_total = 0;
  13289. return 0;
  13290. }
  13291. chunk_remaining = chunk_len;
  13292. last_chunk_total = chunk_remaining;
  13293. last_chunk_offset = 0;
  13294. }
  13295. auto to_read = (std::min)(chunk_remaining, len);
  13296. auto n = strm.read(buf, to_read);
  13297. if (n <= 0) { return -1; }
  13298. auto offset_before = last_chunk_offset;
  13299. last_chunk_offset += static_cast<size_t>(n);
  13300. chunk_remaining -= static_cast<size_t>(n);
  13301. out_chunk_offset = offset_before;
  13302. out_chunk_total = last_chunk_total;
  13303. if (chunk_remaining == 0) {
  13304. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13305. if (!lr.getline()) { return -1; }
  13306. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13307. }
  13308. return n;
  13309. }
  13310. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13311. const Headers &src_headers) {
  13312. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13313. if (!lr.getline()) { return false; }
  13314. return parse_trailers(lr, dest, src_headers);
  13315. }
  13316. } // namespace detail
  13317. inline void
  13318. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13319. handle.connection_->sock = socket_.sock;
  13320. #ifdef CPPHTTPLIB_SSL_ENABLED
  13321. handle.connection_->session = socket_.ssl;
  13322. socket_.ssl = nullptr;
  13323. #endif
  13324. socket_.sock = INVALID_SOCKET;
  13325. }
  13326. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13327. Response &res, bool close_connection,
  13328. Error &error) {
  13329. if (req.path.empty()) {
  13330. error = Error::Connection;
  13331. output_error_log(error, &req);
  13332. return false;
  13333. }
  13334. auto req_save = req;
  13335. bool ret;
  13336. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13337. auto req2 = req;
  13338. req2.path = "http://" +
  13339. detail::make_host_and_port_string(host_, port_, false) +
  13340. req.path;
  13341. ret = process_request(strm, req2, res, close_connection, error);
  13342. req = std::move(req2);
  13343. req.path = req_save.path;
  13344. } else {
  13345. ret = process_request(strm, req, res, close_connection, error);
  13346. }
  13347. if (!ret) { return false; }
  13348. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13349. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13350. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13351. // for this to be safe.
  13352. // This is safe to call because handle_request is only called by send_
  13353. // which locks the request mutex during the process. It would be a bug
  13354. // to call it from a different thread since it's a thread-safety issue
  13355. // to do these things to the socket if another thread is using the socket.
  13356. std::lock_guard<std::mutex> guard(socket_mutex_);
  13357. disconnect(/*gracefully=*/true);
  13358. }
  13359. if (300 < res.status && res.status < 400 && follow_location_) {
  13360. req = std::move(req_save);
  13361. ret = redirect(req, res, error);
  13362. }
  13363. #ifdef CPPHTTPLIB_SSL_ENABLED
  13364. if ((res.status == StatusCode::Unauthorized_401 ||
  13365. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13366. req.authorization_count_ < 5) {
  13367. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13368. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13369. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13370. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13371. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13372. return ret;
  13373. }
  13374. const auto &username =
  13375. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13376. const auto &password =
  13377. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13378. if (!username.empty() && !password.empty()) {
  13379. std::map<std::string, std::string> auth;
  13380. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13381. Request new_req = req;
  13382. new_req.authorization_count_ += 1;
  13383. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13384. : "Authorization");
  13385. new_req.headers.insert(detail::make_digest_authentication_header(
  13386. req, auth, new_req.authorization_count_, detail::random_string(10),
  13387. username, password, is_proxy));
  13388. Response new_res;
  13389. ret = send(new_req, new_res, error);
  13390. if (ret) { res = std::move(new_res); }
  13391. }
  13392. }
  13393. }
  13394. #endif
  13395. return ret;
  13396. }
  13397. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13398. if (req.redirect_count_ == 0) {
  13399. error = Error::ExceedRedirectCount;
  13400. output_error_log(error, &req);
  13401. return false;
  13402. }
  13403. auto location = res.get_header_value("location");
  13404. if (location.empty()) { return false; }
  13405. detail::UrlComponents uc;
  13406. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13407. uc)) {
  13408. return false;
  13409. }
  13410. // Only follow http/https redirects
  13411. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13412. return false;
  13413. }
  13414. auto scheme = is_ssl() ? "https" : "http";
  13415. auto next_scheme = std::move(uc.scheme);
  13416. auto next_host = std::move(uc.host);
  13417. auto port_str = std::move(uc.port);
  13418. auto next_path = std::move(uc.path);
  13419. auto next_query = std::move(uc.query);
  13420. auto next_port = port_;
  13421. if (!port_str.empty()) {
  13422. if (!detail::parse_port(port_str, next_port)) { return false; }
  13423. } else if (!next_scheme.empty()) {
  13424. next_port = next_scheme == "https" ? 443 : 80;
  13425. }
  13426. if (next_scheme.empty()) { next_scheme = scheme; }
  13427. if (next_host.empty()) { next_host = host_; }
  13428. if (next_path.empty()) { next_path = "/"; }
  13429. auto path = std::move(next_path) + next_query;
  13430. // Same host redirect - use current client
  13431. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13432. return detail::redirect(*this, req, res, path, location, error);
  13433. }
  13434. // Cross-host/scheme redirect - create new client with robust setup
  13435. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13436. path, location, error);
  13437. }
  13438. // New method for robust redirect client creation
  13439. inline bool ClientImpl::create_redirect_client(
  13440. const std::string &scheme, const std::string &host, int port, Request &req,
  13441. Response &res, const std::string &path, const std::string &location,
  13442. Error &error) {
  13443. // Determine if we need SSL
  13444. auto need_ssl = (scheme == "https");
  13445. // Clean up request headers that are host/client specific
  13446. // Remove headers that should not be carried over to new host
  13447. auto headers_to_remove = std::vector<std::string>{
  13448. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13449. for (const auto &header_name : headers_to_remove) {
  13450. auto it = req.headers.find(header_name);
  13451. while (it != req.headers.end()) {
  13452. it = req.headers.erase(it);
  13453. it = req.headers.find(header_name);
  13454. }
  13455. }
  13456. // Create appropriate client type and handle redirect
  13457. if (need_ssl) {
  13458. #ifdef CPPHTTPLIB_SSL_ENABLED
  13459. // Create SSL client for HTTPS redirect
  13460. SSLClient redirect_client(host, port);
  13461. // Setup basic client configuration first
  13462. setup_redirect_client(redirect_client);
  13463. redirect_client.enable_server_certificate_verification(
  13464. server_certificate_verification_);
  13465. redirect_client.enable_server_hostname_verification(
  13466. server_hostname_verification_);
  13467. redirect_client.system_ca_mode_ = system_ca_mode_;
  13468. // Transfer CA certificate to redirect client
  13469. if (!ca_cert_pem_.empty()) {
  13470. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13471. ca_cert_pem_.size());
  13472. }
  13473. if (!ca_cert_file_path_.empty()) {
  13474. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13475. }
  13476. // Client certificates are set through constructor for SSLClient
  13477. // NOTE: SSLClient constructor already takes client_cert_path and
  13478. // client_key_path so we need to create it properly if client certs are
  13479. // needed
  13480. // Execute the redirect
  13481. return detail::redirect(redirect_client, req, res, path, location, error);
  13482. #else
  13483. // SSL not supported - set appropriate error
  13484. error = Error::SSLConnection;
  13485. output_error_log(error, &req);
  13486. return false;
  13487. #endif
  13488. } else {
  13489. // HTTP redirect
  13490. ClientImpl redirect_client(host, port);
  13491. // Setup client with robust configuration
  13492. setup_redirect_client(redirect_client);
  13493. // Execute the redirect
  13494. return detail::redirect(redirect_client, req, res, path, location, error);
  13495. }
  13496. }
  13497. // New method for robust client setup (based on basic_manual_redirect.cpp
  13498. // logic)
  13499. template <typename ClientType>
  13500. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13501. // Copy basic settings first
  13502. client.set_connection_timeout(connection_timeout_sec_);
  13503. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13504. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13505. client.set_keep_alive(keep_alive_);
  13506. client.set_follow_location(
  13507. true); // Enable redirects to handle multi-step redirects
  13508. client.set_path_encode(path_encode_);
  13509. client.set_compress(compress_);
  13510. client.set_decompress(decompress_);
  13511. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13512. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13513. // 15.4, credentials must not be forwarded when redirecting to a different
  13514. // host. This function is only called for cross-host redirects; same-host
  13515. // redirects are handled directly in ClientImpl::redirect().
  13516. // Copy the proxy configuration unconditionally; the per-target bypass is
  13517. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13518. // still use the proxy.
  13519. client.no_proxy_entries_ = no_proxy_entries_;
  13520. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13521. client.set_proxy(proxy_host_, proxy_port_);
  13522. if (!proxy_basic_auth_username_.empty()) {
  13523. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13524. proxy_basic_auth_password_);
  13525. }
  13526. if (!proxy_bearer_token_auth_token_.empty()) {
  13527. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13528. }
  13529. #ifdef CPPHTTPLIB_SSL_ENABLED
  13530. if (!proxy_digest_auth_username_.empty()) {
  13531. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13532. proxy_digest_auth_password_);
  13533. }
  13534. #endif
  13535. }
  13536. // Copy network and socket settings
  13537. client.set_address_family(address_family_);
  13538. client.set_tcp_nodelay(tcp_nodelay_);
  13539. client.set_ipv6_v6only(ipv6_v6only_);
  13540. if (socket_options_) { client.set_socket_options(socket_options_); }
  13541. if (!interface_.empty()) { client.set_interface(interface_); }
  13542. // Copy logging and headers
  13543. if (logger_) { client.set_logger(logger_); }
  13544. if (error_logger_) { client.set_error_logger(error_logger_); }
  13545. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13546. // Each new client should generate its own headers based on its target host
  13547. }
  13548. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13549. const Request &req,
  13550. Error &error) const {
  13551. auto is_shutting_down = []() { return false; };
  13552. if (req.is_chunked_content_provider_) {
  13553. auto compressor = compress_ ? detail::create_compressor().first
  13554. : std::unique_ptr<detail::compressor>();
  13555. if (!compressor) {
  13556. compressor = detail::make_unique<detail::nocompressor>();
  13557. }
  13558. return detail::write_content_chunked(strm, req.content_provider_,
  13559. is_shutting_down, *compressor, error);
  13560. } else {
  13561. return detail::write_content_with_progress(
  13562. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13563. req.upload_progress, error);
  13564. }
  13565. }
  13566. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13567. bool close_connection, Error &error,
  13568. bool skip_body, bool &rejected_locally) {
  13569. rejected_locally = false;
  13570. // Prepare additional headers
  13571. if (close_connection) {
  13572. if (!req.has_header("Connection")) {
  13573. req.set_header("Connection", "close");
  13574. }
  13575. }
  13576. std::string ct_for_defaults;
  13577. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13578. ct_for_defaults = "text/plain";
  13579. }
  13580. prepare_default_headers(req, false, ct_for_defaults);
  13581. if (req.body.empty()) {
  13582. if (req.content_provider_) {
  13583. if (!req.is_chunked_content_provider_) {
  13584. if (!req.has_header("Content-Length")) {
  13585. auto length = std::to_string(req.content_length_);
  13586. req.set_header("Content-Length", length);
  13587. }
  13588. }
  13589. } else {
  13590. if (req.method == "POST" || req.method == "PUT" ||
  13591. req.method == "PATCH") {
  13592. req.set_header("Content-Length", "0");
  13593. }
  13594. }
  13595. }
  13596. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13597. // it opens is read by the origin. Each credential goes only to its own hop.
  13598. auto is_connect = req.method == "CONNECT";
  13599. if (!is_connect && !req.has_header("Authorization")) {
  13600. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13601. req.headers.insert(make_basic_authentication_header(
  13602. basic_auth_username_, basic_auth_password_, false));
  13603. } else if (!bearer_token_auth_token_.empty()) {
  13604. req.headers.insert(make_bearer_token_authentication_header(
  13605. bearer_token_auth_token_, false));
  13606. }
  13607. }
  13608. // Proxy-Authorization is only sent when the proxy reads this message —
  13609. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13610. // would leak proxy credentials to the destination server.
  13611. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13612. if (!proxy_basic_auth_username_.empty() &&
  13613. !proxy_basic_auth_password_.empty() &&
  13614. !req.has_header("Proxy-Authorization")) {
  13615. req.headers.insert(make_basic_authentication_header(
  13616. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13617. }
  13618. if (!proxy_bearer_token_auth_token_.empty() &&
  13619. !req.has_header("Proxy-Authorization")) {
  13620. req.headers.insert(make_bearer_token_authentication_header(
  13621. proxy_bearer_token_auth_token_, true));
  13622. }
  13623. }
  13624. // Request line and headers
  13625. {
  13626. detail::BufferStream bstrm;
  13627. // Extract the query from req.path. The encoding itself is delegated to
  13628. // `encode_request_target`; the raw query is still needed here to decide
  13629. // between populating `req.params` from it and falling back to building a
  13630. // query out of caller-supplied `req.params`.
  13631. auto query_pos = req.path.find('?');
  13632. auto query_part = query_pos == std::string::npos
  13633. ? std::string()
  13634. : req.path.substr(query_pos + 1);
  13635. auto path_with_query =
  13636. detail::encode_request_target(req.path, path_encode_);
  13637. if (!query_part.empty()) {
  13638. // The query already came in through `req.path`; still populate
  13639. // `req.params` for handlers/users who read them.
  13640. detail::parse_query_text(query_part, req.params);
  13641. } else if (!req.params.empty()) {
  13642. // No query in `req.path`; build one from `req.params` so existing
  13643. // callers that pass `Params` separately continue to work.
  13644. path_with_query = append_query_params(path_with_query, req.params);
  13645. }
  13646. // Write request line and headers
  13647. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13648. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13649. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13650. // fail the request cleanly instead of emitting a request-line-less,
  13651. // header-injecting request.
  13652. error = Error::Write;
  13653. rejected_locally = true;
  13654. output_error_log(error, &req);
  13655. return false;
  13656. }
  13657. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13658. error)) {
  13659. rejected_locally = true;
  13660. output_error_log(error, &req);
  13661. return false;
  13662. }
  13663. // Flush buffer
  13664. auto &data = bstrm.get_buffer();
  13665. if (!detail::write_data(strm, data.data(), data.size())) {
  13666. error = Error::Write;
  13667. output_error_log(error, &req);
  13668. return false;
  13669. }
  13670. }
  13671. // After sending request line and headers, wait briefly for an early server
  13672. // response (e.g. 4xx) and avoid sending a potentially large request body
  13673. // unnecessarily. This workaround is only enabled on Windows because Unix
  13674. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13675. // buffering can accept large writes even when the peer already responded.
  13676. // Check the stream first (which covers SSL via `is_readable()`), then
  13677. // fall back to select on the socket. Only perform the wait for very large
  13678. // request bodies to avoid interfering with normal small requests and
  13679. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13680. // response. Skip this check when using Expect: 100-continue, as the protocol
  13681. // handles early responses properly.
  13682. #if defined(_WIN32)
  13683. if (!skip_body &&
  13684. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13685. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13686. auto start = std::chrono::high_resolution_clock::now();
  13687. for (;;) {
  13688. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13689. // from SSL internals. If the underlying socket is readable, assume an
  13690. // early response may be present.
  13691. auto sock = strm.socket();
  13692. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13693. return false;
  13694. }
  13695. // Fallback to stream-level check for non-socket streams or when the
  13696. // socket isn't reporting readable. Avoid using `is_readable()` for
  13697. // SSL, since `SSL_pending()` may report buffered records that do not
  13698. // indicate a complete application-level response yet.
  13699. if (!is_ssl() && strm.is_readable()) { return false; }
  13700. auto now = std::chrono::high_resolution_clock::now();
  13701. auto elapsed =
  13702. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13703. .count();
  13704. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13705. break;
  13706. }
  13707. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13708. }
  13709. }
  13710. #endif
  13711. // Body
  13712. if (skip_body) { return true; }
  13713. return write_request_body(strm, req, error);
  13714. }
  13715. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13716. Error &error) {
  13717. if (req.body.empty()) {
  13718. return write_content_with_provider(strm, req, error);
  13719. }
  13720. if (req.upload_progress) {
  13721. auto body_size = req.body.size();
  13722. size_t written = 0;
  13723. auto data = req.body.data();
  13724. while (written < body_size) {
  13725. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13726. if (!detail::write_data(strm, data + written, to_write)) {
  13727. error = Error::Write;
  13728. output_error_log(error, &req);
  13729. return false;
  13730. }
  13731. written += to_write;
  13732. if (!req.upload_progress(written, body_size)) {
  13733. error = Error::Canceled;
  13734. output_error_log(error, &req);
  13735. return false;
  13736. }
  13737. }
  13738. } else {
  13739. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13740. error = Error::Write;
  13741. output_error_log(error, &req);
  13742. return false;
  13743. }
  13744. }
  13745. return true;
  13746. }
  13747. inline std::unique_ptr<Response>
  13748. ClientImpl::send_with_content_provider_and_receiver(
  13749. Request &req, const char *body, size_t content_length,
  13750. ContentProvider content_provider,
  13751. ContentProviderWithoutLength content_provider_without_length,
  13752. const std::string &content_type, ContentReceiver content_receiver,
  13753. Error &error) {
  13754. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13755. auto enc = compress_
  13756. ? detail::create_compressor()
  13757. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13758. nullptr, nullptr);
  13759. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13760. if (enc.first && !content_provider_without_length) {
  13761. auto &compressor = enc.first;
  13762. if (content_provider) {
  13763. auto ok = true;
  13764. auto finished = false;
  13765. size_t offset = 0;
  13766. DataSink data_sink;
  13767. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13768. if (ok) {
  13769. auto last = offset + data_len == content_length;
  13770. auto ret = compressor->compress(
  13771. data, data_len, last,
  13772. [&](const char *compressed_data, size_t compressed_data_len) {
  13773. req.body.append(compressed_data, compressed_data_len);
  13774. return true;
  13775. });
  13776. if (ret) {
  13777. offset += data_len;
  13778. } else {
  13779. ok = false;
  13780. }
  13781. }
  13782. return ok;
  13783. };
  13784. // As in detail::write_content_with_progress(): the body is framed by
  13785. // content_length, so a provider that finishes early has truncated it.
  13786. // Stop and report that instead of calling the provider forever.
  13787. data_sink.done = [&]() { finished = true; };
  13788. while (ok && !finished && offset < content_length) {
  13789. if (!content_provider(offset, content_length - offset, data_sink)) {
  13790. error = Error::Canceled;
  13791. output_error_log(error, &req);
  13792. return nullptr;
  13793. }
  13794. }
  13795. // A short body here means either the provider stopped early or the
  13796. // compressor gave up. The branch below reports a failing compressor as
  13797. // Error::Compression, so keep the two distinguishable.
  13798. if (offset < content_length) {
  13799. error = ok ? Error::Write : Error::Compression;
  13800. output_error_log(error, &req);
  13801. return nullptr;
  13802. }
  13803. } else {
  13804. if (!compressor->compress(body, content_length, true,
  13805. [&](const char *data, size_t data_len) {
  13806. req.body.append(data, data_len);
  13807. return true;
  13808. })) {
  13809. error = Error::Compression;
  13810. output_error_log(error, &req);
  13811. return nullptr;
  13812. }
  13813. }
  13814. } else {
  13815. if (content_provider) {
  13816. req.content_length_ = content_length;
  13817. req.content_provider_ = std::move(content_provider);
  13818. req.is_chunked_content_provider_ = false;
  13819. } else if (content_provider_without_length) {
  13820. req.content_length_ = 0;
  13821. req.content_provider_ = detail::ContentProviderAdapter(
  13822. std::move(content_provider_without_length));
  13823. req.is_chunked_content_provider_ = true;
  13824. req.set_header("Transfer-Encoding", "chunked");
  13825. } else {
  13826. req.body.assign(body, content_length);
  13827. }
  13828. }
  13829. if (content_receiver) {
  13830. req.content_receiver =
  13831. [content_receiver](const char *data, size_t data_length,
  13832. size_t /*offset*/, size_t /*total_length*/) {
  13833. return content_receiver(data, data_length);
  13834. };
  13835. }
  13836. auto res = detail::make_unique<Response>();
  13837. return send(req, *res, error) ? std::move(res) : nullptr;
  13838. }
  13839. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13840. const std::string &method, const std::string &path, const Headers &headers,
  13841. const char *body, size_t content_length, ContentProvider content_provider,
  13842. ContentProviderWithoutLength content_provider_without_length,
  13843. const std::string &content_type, ContentReceiver content_receiver,
  13844. UploadProgress progress) {
  13845. Request req;
  13846. req.method = method;
  13847. req.headers = headers;
  13848. req.path = path;
  13849. req.upload_progress = std::move(progress);
  13850. if (max_timeout_msec_ > 0) {
  13851. req.start_time_ = std::chrono::steady_clock::now();
  13852. }
  13853. auto error = Error::Success;
  13854. auto res = send_with_content_provider_and_receiver(
  13855. req, body, content_length, std::move(content_provider),
  13856. std::move(content_provider_without_length), content_type,
  13857. std::move(content_receiver), error);
  13858. #ifdef CPPHTTPLIB_SSL_ENABLED
  13859. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13860. last_backend_error_};
  13861. #else
  13862. return Result{std::move(res), error, std::move(req.headers)};
  13863. #endif
  13864. }
  13865. inline void ClientImpl::output_log(const Request &req,
  13866. const Response &res) const {
  13867. if (logger_) {
  13868. std::lock_guard<std::mutex> guard(logger_mutex_);
  13869. logger_(req, res);
  13870. }
  13871. }
  13872. inline void ClientImpl::output_error_log(const Error &err,
  13873. const Request *req) const {
  13874. if (error_logger_) {
  13875. std::lock_guard<std::mutex> guard(logger_mutex_);
  13876. error_logger_(err, req);
  13877. }
  13878. }
  13879. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13880. Response &res, bool close_connection,
  13881. Error &error) {
  13882. // Auto-add Expect: 100-continue for large bodies
  13883. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13884. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13885. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13886. req.set_header("Expect", "100-continue");
  13887. }
  13888. }
  13889. // Check for Expect: 100-continue
  13890. auto expect_100_continue =
  13891. detail::has_header_token(req.headers, "Expect", "100-continue");
  13892. // Send request (skip body if using Expect: 100-continue)
  13893. auto rejected_locally = false;
  13894. auto write_request_success =
  13895. write_request(strm, req, close_connection, error, expect_100_continue,
  13896. rejected_locally);
  13897. // A failed write normally still reads the response below, since the server
  13898. // may have answered early (e.g. 413/414) and closed while the body was being
  13899. // sent. A request rejected before any byte reached the socket gets no such
  13900. // response, and waiting for one would block until the read timeout.
  13901. if (rejected_locally) { return false; }
  13902. #ifdef CPPHTTPLIB_SSL_ENABLED
  13903. if (is_ssl() && !expect_100_continue) {
  13904. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13905. if (!is_proxy_enabled) {
  13906. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13907. error = Error::SSLPeerCouldBeClosed_;
  13908. output_error_log(error, &req);
  13909. return false;
  13910. }
  13911. }
  13912. }
  13913. #endif
  13914. // Handle Expect: 100-continue.
  13915. //
  13916. // Wait for an interim/early response by attempting to read the status line
  13917. // under a short timeout, instead of trusting raw socket readability. Over
  13918. // TLS, post-handshake records (e.g. session tickets) make the socket
  13919. // readable without any HTTP response being available; relying on
  13920. // `select_read` there caused the body to be withheld forever and the
  13921. // request to fail with `Read` (#2458). If no status line arrives within the
  13922. // timeout, send the body anyway (matching curl's behavior).
  13923. auto status_line_read = false;
  13924. if (expect_100_continue && write_request_success) {
  13925. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13926. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13927. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13928. strm.set_read_timeout(sec, usec);
  13929. status_line_read = read_response_line(strm, req, res, false);
  13930. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13931. }
  13932. if (!status_line_read) {
  13933. // No interim response within the timeout: send the body and handle the
  13934. // response as usual.
  13935. if (!write_request_body(strm, req, error)) { return false; }
  13936. expect_100_continue = false; // Switch to normal response handling
  13937. }
  13938. }
  13939. // Receive response and headers
  13940. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13941. if ((!status_line_read &&
  13942. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13943. !detail::read_headers(strm, res.headers)) {
  13944. if (write_request_success) { error = Error::Read; }
  13945. output_error_log(error, &req);
  13946. return false;
  13947. }
  13948. if (!write_request_success) { return false; }
  13949. // Handle Expect: 100-continue response
  13950. if (expect_100_continue) {
  13951. if (res.status == StatusCode::Continue_100) {
  13952. // Server accepted, send the body
  13953. if (!write_request_body(strm, req, error)) { return false; }
  13954. // Read the actual response
  13955. res.headers.clear();
  13956. res.body.clear();
  13957. if (!read_response_line(strm, req, res) ||
  13958. !detail::read_headers(strm, res.headers)) {
  13959. error = Error::Read;
  13960. output_error_log(error, &req);
  13961. return false;
  13962. }
  13963. }
  13964. // If not 100 Continue, server returned an error; proceed with that response
  13965. }
  13966. // Body
  13967. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13968. req.method != "CONNECT") {
  13969. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13970. // whose final transfer coding is not chunked is not ambiguous: its body
  13971. // runs until the server closes the connection, so it is not rejected.
  13972. // HEAD/204 are excluded above and a 304 carries no body.
  13973. if (res.status != StatusCode::NotModified_304 &&
  13974. detail::has_conflicting_content_length(res.headers)) {
  13975. error = Error::Read;
  13976. output_error_log(error, &req);
  13977. return false;
  13978. }
  13979. auto redirect = 300 < res.status && res.status < 400 &&
  13980. res.status != StatusCode::NotModified_304 &&
  13981. follow_location_;
  13982. if (req.response_handler && !redirect) {
  13983. if (!req.response_handler(res)) {
  13984. error = Error::Canceled;
  13985. output_error_log(error, &req);
  13986. return false;
  13987. }
  13988. }
  13989. auto out =
  13990. req.content_receiver
  13991. ? static_cast<ContentReceiverWithProgress>(
  13992. [&](const char *buf, size_t n, size_t off, size_t len) {
  13993. if (redirect) { return true; }
  13994. auto ret = req.content_receiver(buf, n, off, len);
  13995. if (!ret) {
  13996. error = Error::Canceled;
  13997. output_error_log(error, &req);
  13998. }
  13999. return ret;
  14000. })
  14001. : static_cast<ContentReceiverWithProgress>(
  14002. [&](const char *buf, size_t n, size_t /*off*/,
  14003. size_t /*len*/) {
  14004. assert(res.body.size() + n <= res.body.max_size());
  14005. if (payload_max_length_ > 0 &&
  14006. (res.body.size() >= payload_max_length_ ||
  14007. n > payload_max_length_ - res.body.size())) {
  14008. return false;
  14009. }
  14010. res.body.append(buf, n);
  14011. return true;
  14012. });
  14013. auto progress = [&](size_t current, size_t total) {
  14014. if (!req.download_progress || redirect) { return true; }
  14015. auto ret = req.download_progress(current, total);
  14016. if (!ret) {
  14017. error = Error::Canceled;
  14018. output_error_log(error, &req);
  14019. }
  14020. return ret;
  14021. };
  14022. if (res.has_header("Content-Length")) {
  14023. if (!req.content_receiver) {
  14024. auto len = res.get_header_value_u64("Content-Length");
  14025. if (len > res.body.max_size()) {
  14026. error = Error::Read;
  14027. output_error_log(error, &req);
  14028. return false;
  14029. }
  14030. // Cap the reservation by payload_max_length_ to avoid OOM when a
  14031. // hostile or malformed server sends an enormous Content-Length.
  14032. // The actual body read below is bounded by payload_max_length_,
  14033. // so reserving more than that is never useful.
  14034. auto reserve_len = static_cast<size_t>(len);
  14035. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  14036. reserve_len = payload_max_length_;
  14037. }
  14038. res.body.reserve(reserve_len);
  14039. }
  14040. }
  14041. if (res.status != StatusCode::NotModified_304) {
  14042. auto content_status = 0;
  14043. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14044. ? (std::numeric_limits<size_t>::max)()
  14045. : payload_max_length_;
  14046. if (!detail::read_content(strm, res, max_length, content_status,
  14047. std::move(progress), std::move(out),
  14048. decompress_)) {
  14049. if (error != Error::Canceled) {
  14050. // Tell the caller apart from a plain read failure when the body could
  14051. // not be decoded because of its Content-Encoding.
  14052. switch (content_status) {
  14053. case StatusCode::UnsupportedMediaType_415:
  14054. error = Error::UnsupportedContentEncoding;
  14055. break;
  14056. case StatusCode::InternalServerError_500:
  14057. error = Error::Compression;
  14058. break;
  14059. default: error = Error::Read; break;
  14060. }
  14061. }
  14062. output_error_log(error, &req);
  14063. return false;
  14064. }
  14065. }
  14066. }
  14067. // Log
  14068. output_log(req, res);
  14069. return true;
  14070. }
  14071. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14072. const std::string &boundary, const UploadFormDataItems &items,
  14073. const FormDataProviderItems &provider_items) const {
  14074. size_t cur_item = 0;
  14075. size_t cur_start = 0;
  14076. // cur_item and cur_start are copied to within the std::function and
  14077. // maintain state between successive calls
  14078. return [&, cur_item, cur_start](size_t offset,
  14079. DataSink &sink) mutable -> bool {
  14080. if (!offset && !items.empty()) {
  14081. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14082. return true;
  14083. } else if (cur_item < provider_items.size()) {
  14084. if (!cur_start) {
  14085. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14086. provider_items[cur_item], boundary);
  14087. offset += begin.size();
  14088. cur_start = offset;
  14089. sink.os << begin;
  14090. }
  14091. DataSink cur_sink;
  14092. auto has_data = true;
  14093. cur_sink.write = sink.write;
  14094. // Forward is_writable so a provider item asking whether it may keep
  14095. // going gets the outer sink's answer rather than the default `true`.
  14096. cur_sink.is_writable = sink.is_writable;
  14097. cur_sink.done = [&]() { has_data = false; };
  14098. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14099. return false;
  14100. }
  14101. if (!has_data) {
  14102. sink.os << detail::serialize_multipart_formdata_item_end();
  14103. cur_item++;
  14104. cur_start = 0;
  14105. }
  14106. return true;
  14107. } else {
  14108. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14109. sink.done();
  14110. return true;
  14111. }
  14112. };
  14113. }
  14114. inline bool ClientImpl::process_socket(
  14115. const Socket &socket,
  14116. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14117. std::function<bool(Stream &strm)> callback) {
  14118. return detail::process_client_socket(
  14119. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14120. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14121. }
  14122. inline bool ClientImpl::is_ssl() const { return false; }
  14123. inline Result ClientImpl::Get(const std::string &path,
  14124. DownloadProgress progress) {
  14125. return Get(path, Headers(), std::move(progress));
  14126. }
  14127. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14128. DownloadProgress progress) {
  14129. return Get(path, params, Headers(), std::move(progress));
  14130. }
  14131. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14132. const Headers &headers,
  14133. DownloadProgress progress) {
  14134. if (params.empty()) { return Get(path, headers); }
  14135. std::string path_with_query = append_query_params(path, params);
  14136. return Get(path_with_query, headers, std::move(progress));
  14137. }
  14138. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14139. DownloadProgress progress) {
  14140. Request req;
  14141. req.method = "GET";
  14142. req.path = path;
  14143. req.headers = headers;
  14144. req.download_progress = std::move(progress);
  14145. if (max_timeout_msec_ > 0) {
  14146. req.start_time_ = std::chrono::steady_clock::now();
  14147. }
  14148. return send_(std::move(req));
  14149. }
  14150. inline Result ClientImpl::Get(const std::string &path,
  14151. ContentReceiver content_receiver,
  14152. DownloadProgress progress) {
  14153. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14154. std::move(progress));
  14155. }
  14156. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14157. ContentReceiver content_receiver,
  14158. DownloadProgress progress) {
  14159. return Get(path, headers, nullptr, std::move(content_receiver),
  14160. std::move(progress));
  14161. }
  14162. inline Result ClientImpl::Get(const std::string &path,
  14163. ResponseHandler response_handler,
  14164. ContentReceiver content_receiver,
  14165. DownloadProgress progress) {
  14166. return Get(path, Headers(), std::move(response_handler),
  14167. std::move(content_receiver), std::move(progress));
  14168. }
  14169. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14170. ResponseHandler response_handler,
  14171. ContentReceiver content_receiver,
  14172. DownloadProgress progress) {
  14173. Request req;
  14174. req.method = "GET";
  14175. req.path = path;
  14176. req.headers = headers;
  14177. req.response_handler = std::move(response_handler);
  14178. req.content_receiver =
  14179. [content_receiver](const char *data, size_t data_length,
  14180. size_t /*offset*/, size_t /*total_length*/) {
  14181. return content_receiver(data, data_length);
  14182. };
  14183. req.download_progress = std::move(progress);
  14184. if (max_timeout_msec_ > 0) {
  14185. req.start_time_ = std::chrono::steady_clock::now();
  14186. }
  14187. return send_(std::move(req));
  14188. }
  14189. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14190. const Headers &headers,
  14191. ContentReceiver content_receiver,
  14192. DownloadProgress progress) {
  14193. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14194. std::move(progress));
  14195. }
  14196. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14197. const Headers &headers,
  14198. ResponseHandler response_handler,
  14199. ContentReceiver content_receiver,
  14200. DownloadProgress progress) {
  14201. if (params.empty()) {
  14202. return Get(path, headers, std::move(response_handler),
  14203. std::move(content_receiver), std::move(progress));
  14204. }
  14205. std::string path_with_query = append_query_params(path, params);
  14206. return Get(path_with_query, headers, std::move(response_handler),
  14207. std::move(content_receiver), std::move(progress));
  14208. }
  14209. inline Result ClientImpl::Head(const std::string &path) {
  14210. return Head(path, Headers());
  14211. }
  14212. inline Result ClientImpl::Head(const std::string &path,
  14213. const Headers &headers) {
  14214. Request req;
  14215. req.method = "HEAD";
  14216. req.headers = headers;
  14217. req.path = path;
  14218. if (max_timeout_msec_ > 0) {
  14219. req.start_time_ = std::chrono::steady_clock::now();
  14220. }
  14221. return send_(std::move(req));
  14222. }
  14223. inline Result ClientImpl::Post(const std::string &path) {
  14224. return Post(path, std::string(), std::string());
  14225. }
  14226. inline Result ClientImpl::Post(const std::string &path,
  14227. const Headers &headers) {
  14228. return Post(path, headers, nullptr, 0, std::string());
  14229. }
  14230. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14231. size_t content_length,
  14232. const std::string &content_type,
  14233. UploadProgress progress) {
  14234. return Post(path, Headers(), body, content_length, content_type, progress);
  14235. }
  14236. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14237. const std::string &content_type,
  14238. UploadProgress progress) {
  14239. return Post(path, Headers(), body, content_type, progress);
  14240. }
  14241. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14242. return Post(path, Headers(), params);
  14243. }
  14244. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14245. ContentProvider content_provider,
  14246. const std::string &content_type,
  14247. UploadProgress progress) {
  14248. return Post(path, Headers(), content_length, std::move(content_provider),
  14249. content_type, progress);
  14250. }
  14251. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14252. ContentProvider content_provider,
  14253. const std::string &content_type,
  14254. ContentReceiver content_receiver,
  14255. UploadProgress progress) {
  14256. return Post(path, Headers(), content_length, std::move(content_provider),
  14257. content_type, std::move(content_receiver), progress);
  14258. }
  14259. inline Result ClientImpl::Post(const std::string &path,
  14260. ContentProviderWithoutLength content_provider,
  14261. const std::string &content_type,
  14262. UploadProgress progress) {
  14263. return Post(path, Headers(), std::move(content_provider), content_type,
  14264. progress);
  14265. }
  14266. inline Result ClientImpl::Post(const std::string &path,
  14267. ContentProviderWithoutLength content_provider,
  14268. const std::string &content_type,
  14269. ContentReceiver content_receiver,
  14270. UploadProgress progress) {
  14271. return Post(path, Headers(), std::move(content_provider), content_type,
  14272. std::move(content_receiver), progress);
  14273. }
  14274. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14275. const Params &params) {
  14276. auto query = detail::params_to_query_str(params);
  14277. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14278. }
  14279. inline Result ClientImpl::Post(const std::string &path,
  14280. const UploadFormDataItems &items,
  14281. UploadProgress progress) {
  14282. return Post(path, Headers(), items, progress);
  14283. }
  14284. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14285. const UploadFormDataItems &items,
  14286. UploadProgress progress) {
  14287. const auto &boundary = detail::make_multipart_data_boundary();
  14288. const auto &content_type =
  14289. detail::serialize_multipart_formdata_get_content_type(boundary);
  14290. auto content_length = detail::get_multipart_content_length(items, boundary);
  14291. return Post(path, headers, content_length,
  14292. detail::make_multipart_content_provider(items, boundary),
  14293. content_type, progress);
  14294. }
  14295. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14296. const UploadFormDataItems &items,
  14297. const std::string &boundary,
  14298. UploadProgress progress) {
  14299. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14300. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14301. }
  14302. const auto &content_type =
  14303. detail::serialize_multipart_formdata_get_content_type(boundary);
  14304. auto content_length = detail::get_multipart_content_length(items, boundary);
  14305. return Post(path, headers, content_length,
  14306. detail::make_multipart_content_provider(items, boundary),
  14307. content_type, progress);
  14308. }
  14309. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14310. const char *body, size_t content_length,
  14311. const std::string &content_type,
  14312. UploadProgress progress) {
  14313. return send_with_content_provider_and_receiver(
  14314. "POST", path, headers, body, content_length, nullptr, nullptr,
  14315. content_type, nullptr, progress);
  14316. }
  14317. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14318. const std::string &body,
  14319. const std::string &content_type,
  14320. UploadProgress progress) {
  14321. return send_with_content_provider_and_receiver(
  14322. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14323. content_type, nullptr, progress);
  14324. }
  14325. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14326. size_t content_length,
  14327. ContentProvider content_provider,
  14328. const std::string &content_type,
  14329. UploadProgress progress) {
  14330. return send_with_content_provider_and_receiver(
  14331. "POST", path, headers, nullptr, content_length,
  14332. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14333. }
  14334. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14335. size_t content_length,
  14336. ContentProvider content_provider,
  14337. const std::string &content_type,
  14338. ContentReceiver content_receiver,
  14339. DownloadProgress progress) {
  14340. return send_with_content_provider_and_receiver(
  14341. "POST", path, headers, nullptr, content_length,
  14342. std::move(content_provider), nullptr, content_type,
  14343. std::move(content_receiver), std::move(progress));
  14344. }
  14345. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14346. ContentProviderWithoutLength content_provider,
  14347. const std::string &content_type,
  14348. UploadProgress progress) {
  14349. return send_with_content_provider_and_receiver(
  14350. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14351. content_type, nullptr, progress);
  14352. }
  14353. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14354. ContentProviderWithoutLength content_provider,
  14355. const std::string &content_type,
  14356. ContentReceiver content_receiver,
  14357. DownloadProgress progress) {
  14358. return send_with_content_provider_and_receiver(
  14359. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14360. content_type, std::move(content_receiver), std::move(progress));
  14361. }
  14362. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14363. const UploadFormDataItems &items,
  14364. const FormDataProviderItems &provider_items,
  14365. UploadProgress progress) {
  14366. const auto &boundary = detail::make_multipart_data_boundary();
  14367. const auto &content_type =
  14368. detail::serialize_multipart_formdata_get_content_type(boundary);
  14369. return send_with_content_provider_and_receiver(
  14370. "POST", path, headers, nullptr, 0, nullptr,
  14371. get_multipart_content_provider(boundary, items, provider_items),
  14372. content_type, nullptr, progress);
  14373. }
  14374. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14375. const std::string &body,
  14376. const std::string &content_type,
  14377. ContentReceiver content_receiver,
  14378. DownloadProgress progress) {
  14379. Request req;
  14380. req.method = "POST";
  14381. req.path = path;
  14382. req.headers = headers;
  14383. req.body = body;
  14384. req.content_receiver =
  14385. [content_receiver](const char *data, size_t data_length,
  14386. size_t /*offset*/, size_t /*total_length*/) {
  14387. return content_receiver(data, data_length);
  14388. };
  14389. req.download_progress = std::move(progress);
  14390. if (max_timeout_msec_ > 0) {
  14391. req.start_time_ = std::chrono::steady_clock::now();
  14392. }
  14393. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14394. return send_(std::move(req));
  14395. }
  14396. inline Result ClientImpl::Put(const std::string &path) {
  14397. return Put(path, std::string(), std::string());
  14398. }
  14399. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14400. return Put(path, headers, nullptr, 0, std::string());
  14401. }
  14402. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14403. size_t content_length,
  14404. const std::string &content_type,
  14405. UploadProgress progress) {
  14406. return Put(path, Headers(), body, content_length, content_type, progress);
  14407. }
  14408. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14409. const std::string &content_type,
  14410. UploadProgress progress) {
  14411. return Put(path, Headers(), body, content_type, progress);
  14412. }
  14413. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14414. return Put(path, Headers(), params);
  14415. }
  14416. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14417. ContentProvider content_provider,
  14418. const std::string &content_type,
  14419. UploadProgress progress) {
  14420. return Put(path, Headers(), content_length, std::move(content_provider),
  14421. content_type, progress);
  14422. }
  14423. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14424. ContentProvider content_provider,
  14425. const std::string &content_type,
  14426. ContentReceiver content_receiver,
  14427. UploadProgress progress) {
  14428. return Put(path, Headers(), content_length, std::move(content_provider),
  14429. content_type, std::move(content_receiver), progress);
  14430. }
  14431. inline Result ClientImpl::Put(const std::string &path,
  14432. ContentProviderWithoutLength content_provider,
  14433. const std::string &content_type,
  14434. UploadProgress progress) {
  14435. return Put(path, Headers(), std::move(content_provider), content_type,
  14436. progress);
  14437. }
  14438. inline Result ClientImpl::Put(const std::string &path,
  14439. ContentProviderWithoutLength content_provider,
  14440. const std::string &content_type,
  14441. ContentReceiver content_receiver,
  14442. UploadProgress progress) {
  14443. return Put(path, Headers(), std::move(content_provider), content_type,
  14444. std::move(content_receiver), progress);
  14445. }
  14446. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14447. const Params &params) {
  14448. auto query = detail::params_to_query_str(params);
  14449. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14450. }
  14451. inline Result ClientImpl::Put(const std::string &path,
  14452. const UploadFormDataItems &items,
  14453. UploadProgress progress) {
  14454. return Put(path, Headers(), items, progress);
  14455. }
  14456. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14457. const UploadFormDataItems &items,
  14458. UploadProgress progress) {
  14459. const auto &boundary = detail::make_multipart_data_boundary();
  14460. const auto &content_type =
  14461. detail::serialize_multipart_formdata_get_content_type(boundary);
  14462. auto content_length = detail::get_multipart_content_length(items, boundary);
  14463. return Put(path, headers, content_length,
  14464. detail::make_multipart_content_provider(items, boundary),
  14465. content_type, progress);
  14466. }
  14467. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14468. const UploadFormDataItems &items,
  14469. const std::string &boundary,
  14470. UploadProgress progress) {
  14471. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14472. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14473. }
  14474. const auto &content_type =
  14475. detail::serialize_multipart_formdata_get_content_type(boundary);
  14476. auto content_length = detail::get_multipart_content_length(items, boundary);
  14477. return Put(path, headers, content_length,
  14478. detail::make_multipart_content_provider(items, boundary),
  14479. content_type, progress);
  14480. }
  14481. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14482. const char *body, size_t content_length,
  14483. const std::string &content_type,
  14484. UploadProgress progress) {
  14485. return send_with_content_provider_and_receiver(
  14486. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14487. content_type, nullptr, progress);
  14488. }
  14489. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14490. const std::string &body,
  14491. const std::string &content_type,
  14492. UploadProgress progress) {
  14493. return send_with_content_provider_and_receiver(
  14494. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14495. content_type, nullptr, progress);
  14496. }
  14497. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14498. size_t content_length,
  14499. ContentProvider content_provider,
  14500. const std::string &content_type,
  14501. UploadProgress progress) {
  14502. return send_with_content_provider_and_receiver(
  14503. "PUT", path, headers, nullptr, content_length,
  14504. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14505. }
  14506. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14507. size_t content_length,
  14508. ContentProvider content_provider,
  14509. const std::string &content_type,
  14510. ContentReceiver content_receiver,
  14511. UploadProgress progress) {
  14512. return send_with_content_provider_and_receiver(
  14513. "PUT", path, headers, nullptr, content_length,
  14514. std::move(content_provider), nullptr, content_type,
  14515. std::move(content_receiver), progress);
  14516. }
  14517. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14518. ContentProviderWithoutLength content_provider,
  14519. const std::string &content_type,
  14520. UploadProgress progress) {
  14521. return send_with_content_provider_and_receiver(
  14522. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14523. content_type, nullptr, progress);
  14524. }
  14525. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14526. ContentProviderWithoutLength content_provider,
  14527. const std::string &content_type,
  14528. ContentReceiver content_receiver,
  14529. UploadProgress progress) {
  14530. return send_with_content_provider_and_receiver(
  14531. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14532. content_type, std::move(content_receiver), progress);
  14533. }
  14534. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14535. const UploadFormDataItems &items,
  14536. const FormDataProviderItems &provider_items,
  14537. UploadProgress progress) {
  14538. const auto &boundary = detail::make_multipart_data_boundary();
  14539. const auto &content_type =
  14540. detail::serialize_multipart_formdata_get_content_type(boundary);
  14541. return send_with_content_provider_and_receiver(
  14542. "PUT", path, headers, nullptr, 0, nullptr,
  14543. get_multipart_content_provider(boundary, items, provider_items),
  14544. content_type, nullptr, progress);
  14545. }
  14546. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14547. const std::string &body,
  14548. const std::string &content_type,
  14549. ContentReceiver content_receiver,
  14550. DownloadProgress progress) {
  14551. Request req;
  14552. req.method = "PUT";
  14553. req.path = path;
  14554. req.headers = headers;
  14555. req.body = body;
  14556. req.content_receiver =
  14557. [content_receiver](const char *data, size_t data_length,
  14558. size_t /*offset*/, size_t /*total_length*/) {
  14559. return content_receiver(data, data_length);
  14560. };
  14561. req.download_progress = std::move(progress);
  14562. if (max_timeout_msec_ > 0) {
  14563. req.start_time_ = std::chrono::steady_clock::now();
  14564. }
  14565. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14566. return send_(std::move(req));
  14567. }
  14568. inline Result ClientImpl::Patch(const std::string &path) {
  14569. return Patch(path, std::string(), std::string());
  14570. }
  14571. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14572. UploadProgress progress) {
  14573. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14574. }
  14575. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14576. size_t content_length,
  14577. const std::string &content_type,
  14578. UploadProgress progress) {
  14579. return Patch(path, Headers(), body, content_length, content_type, progress);
  14580. }
  14581. inline Result ClientImpl::Patch(const std::string &path,
  14582. const std::string &body,
  14583. const std::string &content_type,
  14584. UploadProgress progress) {
  14585. return Patch(path, Headers(), body, content_type, progress);
  14586. }
  14587. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14588. return Patch(path, Headers(), params);
  14589. }
  14590. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14591. ContentProvider content_provider,
  14592. const std::string &content_type,
  14593. UploadProgress progress) {
  14594. return Patch(path, Headers(), content_length, std::move(content_provider),
  14595. content_type, progress);
  14596. }
  14597. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14598. ContentProvider content_provider,
  14599. const std::string &content_type,
  14600. ContentReceiver content_receiver,
  14601. UploadProgress progress) {
  14602. return Patch(path, Headers(), content_length, std::move(content_provider),
  14603. content_type, std::move(content_receiver), progress);
  14604. }
  14605. inline Result ClientImpl::Patch(const std::string &path,
  14606. ContentProviderWithoutLength content_provider,
  14607. const std::string &content_type,
  14608. UploadProgress progress) {
  14609. return Patch(path, Headers(), std::move(content_provider), content_type,
  14610. progress);
  14611. }
  14612. inline Result ClientImpl::Patch(const std::string &path,
  14613. ContentProviderWithoutLength content_provider,
  14614. const std::string &content_type,
  14615. ContentReceiver content_receiver,
  14616. UploadProgress progress) {
  14617. return Patch(path, Headers(), std::move(content_provider), content_type,
  14618. std::move(content_receiver), progress);
  14619. }
  14620. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14621. const Params &params) {
  14622. auto query = detail::params_to_query_str(params);
  14623. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14624. }
  14625. inline Result ClientImpl::Patch(const std::string &path,
  14626. const UploadFormDataItems &items,
  14627. UploadProgress progress) {
  14628. return Patch(path, Headers(), items, progress);
  14629. }
  14630. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14631. const UploadFormDataItems &items,
  14632. UploadProgress progress) {
  14633. const auto &boundary = detail::make_multipart_data_boundary();
  14634. const auto &content_type =
  14635. detail::serialize_multipart_formdata_get_content_type(boundary);
  14636. auto content_length = detail::get_multipart_content_length(items, boundary);
  14637. return Patch(path, headers, content_length,
  14638. detail::make_multipart_content_provider(items, boundary),
  14639. content_type, progress);
  14640. }
  14641. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14642. const UploadFormDataItems &items,
  14643. const std::string &boundary,
  14644. UploadProgress progress) {
  14645. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14646. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14647. }
  14648. const auto &content_type =
  14649. detail::serialize_multipart_formdata_get_content_type(boundary);
  14650. auto content_length = detail::get_multipart_content_length(items, boundary);
  14651. return Patch(path, headers, content_length,
  14652. detail::make_multipart_content_provider(items, boundary),
  14653. content_type, progress);
  14654. }
  14655. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14656. const char *body, size_t content_length,
  14657. const std::string &content_type,
  14658. UploadProgress progress) {
  14659. return send_with_content_provider_and_receiver(
  14660. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14661. content_type, nullptr, progress);
  14662. }
  14663. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14664. const std::string &body,
  14665. const std::string &content_type,
  14666. UploadProgress progress) {
  14667. return send_with_content_provider_and_receiver(
  14668. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14669. content_type, nullptr, progress);
  14670. }
  14671. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14672. size_t content_length,
  14673. ContentProvider content_provider,
  14674. const std::string &content_type,
  14675. UploadProgress progress) {
  14676. return send_with_content_provider_and_receiver(
  14677. "PATCH", path, headers, nullptr, content_length,
  14678. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14679. }
  14680. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14681. size_t content_length,
  14682. ContentProvider content_provider,
  14683. const std::string &content_type,
  14684. ContentReceiver content_receiver,
  14685. UploadProgress progress) {
  14686. return send_with_content_provider_and_receiver(
  14687. "PATCH", path, headers, nullptr, content_length,
  14688. std::move(content_provider), nullptr, content_type,
  14689. std::move(content_receiver), progress);
  14690. }
  14691. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14692. ContentProviderWithoutLength content_provider,
  14693. const std::string &content_type,
  14694. UploadProgress progress) {
  14695. return send_with_content_provider_and_receiver(
  14696. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14697. content_type, nullptr, progress);
  14698. }
  14699. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14700. ContentProviderWithoutLength content_provider,
  14701. const std::string &content_type,
  14702. ContentReceiver content_receiver,
  14703. UploadProgress progress) {
  14704. return send_with_content_provider_and_receiver(
  14705. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14706. content_type, std::move(content_receiver), progress);
  14707. }
  14708. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14709. const UploadFormDataItems &items,
  14710. const FormDataProviderItems &provider_items,
  14711. UploadProgress progress) {
  14712. const auto &boundary = detail::make_multipart_data_boundary();
  14713. const auto &content_type =
  14714. detail::serialize_multipart_formdata_get_content_type(boundary);
  14715. return send_with_content_provider_and_receiver(
  14716. "PATCH", path, headers, nullptr, 0, nullptr,
  14717. get_multipart_content_provider(boundary, items, provider_items),
  14718. content_type, nullptr, progress);
  14719. }
  14720. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14721. const std::string &body,
  14722. const std::string &content_type,
  14723. ContentReceiver content_receiver,
  14724. DownloadProgress progress) {
  14725. Request req;
  14726. req.method = "PATCH";
  14727. req.path = path;
  14728. req.headers = headers;
  14729. req.body = body;
  14730. req.content_receiver =
  14731. [content_receiver](const char *data, size_t data_length,
  14732. size_t /*offset*/, size_t /*total_length*/) {
  14733. return content_receiver(data, data_length);
  14734. };
  14735. req.download_progress = std::move(progress);
  14736. if (max_timeout_msec_ > 0) {
  14737. req.start_time_ = std::chrono::steady_clock::now();
  14738. }
  14739. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14740. return send_(std::move(req));
  14741. }
  14742. inline Result ClientImpl::Delete(const std::string &path,
  14743. DownloadProgress progress) {
  14744. return Delete(path, Headers(), std::string(), std::string(), progress);
  14745. }
  14746. inline Result ClientImpl::Delete(const std::string &path,
  14747. const Headers &headers,
  14748. DownloadProgress progress) {
  14749. return Delete(path, headers, std::string(), std::string(), progress);
  14750. }
  14751. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14752. size_t content_length,
  14753. const std::string &content_type,
  14754. DownloadProgress progress) {
  14755. return Delete(path, Headers(), body, content_length, content_type, progress);
  14756. }
  14757. inline Result ClientImpl::Delete(const std::string &path,
  14758. const std::string &body,
  14759. const std::string &content_type,
  14760. DownloadProgress progress) {
  14761. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14762. progress);
  14763. }
  14764. inline Result ClientImpl::Delete(const std::string &path,
  14765. const Headers &headers,
  14766. const std::string &body,
  14767. const std::string &content_type,
  14768. DownloadProgress progress) {
  14769. return Delete(path, headers, body.data(), body.size(), content_type,
  14770. progress);
  14771. }
  14772. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14773. DownloadProgress progress) {
  14774. return Delete(path, Headers(), params, progress);
  14775. }
  14776. inline Result ClientImpl::Delete(const std::string &path,
  14777. const Headers &headers, const Params &params,
  14778. DownloadProgress progress) {
  14779. auto query = detail::params_to_query_str(params);
  14780. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14781. progress);
  14782. }
  14783. inline Result ClientImpl::Delete(const std::string &path,
  14784. const Headers &headers, const char *body,
  14785. size_t content_length,
  14786. const std::string &content_type,
  14787. DownloadProgress progress) {
  14788. Request req;
  14789. req.method = "DELETE";
  14790. req.headers = headers;
  14791. req.path = path;
  14792. req.download_progress = std::move(progress);
  14793. if (max_timeout_msec_ > 0) {
  14794. req.start_time_ = std::chrono::steady_clock::now();
  14795. }
  14796. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14797. req.body.assign(body, content_length);
  14798. return send_(std::move(req));
  14799. }
  14800. inline Result ClientImpl::Options(const std::string &path) {
  14801. return Options(path, Headers());
  14802. }
  14803. inline Result ClientImpl::Options(const std::string &path,
  14804. const Headers &headers) {
  14805. Request req;
  14806. req.method = "OPTIONS";
  14807. req.headers = headers;
  14808. req.path = path;
  14809. if (max_timeout_msec_ > 0) {
  14810. req.start_time_ = std::chrono::steady_clock::now();
  14811. }
  14812. return send_(std::move(req));
  14813. }
  14814. inline void ClientImpl::stop() {
  14815. std::lock_guard<std::mutex> guard(socket_mutex_);
  14816. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14817. // do is to shutdown_socket, so that threads using this socket suddenly
  14818. // discover they can't read/write any more and error out. Everything else
  14819. // (closing the socket, shutting ssl down) is unsafe because these actions
  14820. // are not thread-safe.
  14821. if (socket_requests_in_flight_ > 0) {
  14822. shutdown_socket(socket_);
  14823. // Aside from that, we set a flag for the socket to be closed when we're
  14824. // done.
  14825. socket_should_be_closed_when_request_is_done_ = true;
  14826. return;
  14827. }
  14828. disconnect(/*gracefully=*/true);
  14829. }
  14830. inline std::string ClientImpl::host() const { return host_; }
  14831. inline int ClientImpl::port() const { return port_; }
  14832. inline size_t ClientImpl::is_socket_open() const {
  14833. std::lock_guard<std::mutex> guard(socket_mutex_);
  14834. return socket_.is_open();
  14835. }
  14836. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14837. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14838. connection_timeout_sec_ = sec;
  14839. connection_timeout_usec_ = usec;
  14840. }
  14841. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14842. read_timeout_sec_ = sec;
  14843. read_timeout_usec_ = usec;
  14844. }
  14845. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14846. write_timeout_sec_ = sec;
  14847. write_timeout_usec_ = usec;
  14848. }
  14849. inline void ClientImpl::set_max_timeout(time_t msec) {
  14850. max_timeout_msec_ = msec;
  14851. }
  14852. inline void ClientImpl::set_basic_auth(const std::string &username,
  14853. const std::string &password) {
  14854. basic_auth_username_ = username;
  14855. basic_auth_password_ = password;
  14856. }
  14857. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14858. bearer_token_auth_token_ = token;
  14859. }
  14860. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14861. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14862. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14863. inline void
  14864. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14865. addr_map_ = std::move(addr_map);
  14866. }
  14867. inline void ClientImpl::set_default_headers(Headers headers) {
  14868. default_headers_ = std::move(headers);
  14869. }
  14870. inline void ClientImpl::set_header_writer(
  14871. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14872. header_writer_ = writer;
  14873. }
  14874. inline void ClientImpl::set_address_family(int family) {
  14875. address_family_ = family;
  14876. }
  14877. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14878. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14879. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14880. socket_options_ = std::move(socket_options);
  14881. }
  14882. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14883. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14884. inline void ClientImpl::set_payload_max_length(size_t length) {
  14885. payload_max_length_ = length;
  14886. has_payload_max_length_ = true;
  14887. }
  14888. inline void ClientImpl::set_interface(const std::string &intf) {
  14889. interface_ = intf;
  14890. }
  14891. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14892. proxy_host_ = host;
  14893. proxy_port_ = port;
  14894. std::lock_guard<std::mutex> guard(socket_mutex_);
  14895. disconnect(/*gracefully=*/true);
  14896. }
  14897. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14898. const std::string &password) {
  14899. proxy_basic_auth_username_ = username;
  14900. proxy_basic_auth_password_ = password;
  14901. }
  14902. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14903. proxy_bearer_token_auth_token_ = token;
  14904. }
  14905. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14906. std::vector<detail::NoProxyEntry> parsed;
  14907. parsed.reserve(patterns.size());
  14908. for (const auto &p : patterns) {
  14909. auto trimmed = detail::trim_copy(p);
  14910. if (trimmed.empty()) { continue; }
  14911. detail::NoProxyEntry entry;
  14912. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14913. parsed.push_back(std::move(entry));
  14914. }
  14915. }
  14916. no_proxy_entries_ = std::move(parsed);
  14917. std::lock_guard<std::mutex> guard(socket_mutex_);
  14918. disconnect(/*gracefully=*/true);
  14919. }
  14920. #ifdef CPPHTTPLIB_SSL_ENABLED
  14921. inline void ClientImpl::set_digest_auth(const std::string &username,
  14922. const std::string &password) {
  14923. digest_auth_username_ = username;
  14924. digest_auth_password_ = password;
  14925. }
  14926. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14927. const std::string &ca_cert_dir_path) {
  14928. ca_cert_file_path_ = ca_cert_file_path;
  14929. ca_cert_dir_path_ = ca_cert_dir_path;
  14930. }
  14931. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14932. const std::string &password) {
  14933. proxy_digest_auth_username_ = username;
  14934. proxy_digest_auth_password_ = password;
  14935. }
  14936. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14937. server_certificate_verification_ = enabled;
  14938. }
  14939. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14940. server_hostname_verification_ = enabled;
  14941. }
  14942. inline void ClientImpl::enable_system_ca(bool enabled) {
  14943. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14944. }
  14945. #endif
  14946. inline void ClientImpl::set_logger(Logger logger) {
  14947. logger_ = std::move(logger);
  14948. }
  14949. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14950. error_logger_ = std::move(error_logger);
  14951. }
  14952. /*
  14953. * SSL/TLS Common Implementation
  14954. */
  14955. inline ClientConnection::~ClientConnection() {
  14956. #ifdef CPPHTTPLIB_SSL_ENABLED
  14957. if (session) {
  14958. tls::shutdown(session, true);
  14959. tls::free_session(session);
  14960. session = nullptr;
  14961. }
  14962. #endif
  14963. if (sock != INVALID_SOCKET) {
  14964. detail::close_socket(sock);
  14965. sock = INVALID_SOCKET;
  14966. }
  14967. }
  14968. // Universal client implementation
  14969. inline Client::Client(const std::string &scheme_host_port)
  14970. : Client(scheme_host_port, std::string(), std::string()) {}
  14971. inline Client::Client(const std::string &scheme_host_port,
  14972. const std::string &client_cert_path,
  14973. const std::string &client_key_path) {
  14974. detail::UrlComponents uc;
  14975. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14976. auto &scheme = uc.scheme;
  14977. #ifdef CPPHTTPLIB_SSL_ENABLED
  14978. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14979. #else
  14980. if (!scheme.empty() && scheme != "http") {
  14981. #endif
  14982. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14983. std::string msg = "'" + scheme + "' scheme is not supported.";
  14984. throw std::invalid_argument(msg);
  14985. #endif
  14986. return;
  14987. }
  14988. auto is_ssl = scheme == "https";
  14989. auto host = std::move(uc.host);
  14990. auto port = is_ssl ? 443 : 80;
  14991. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14992. if (is_ssl) {
  14993. #ifdef CPPHTTPLIB_SSL_ENABLED
  14994. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14995. client_key_path);
  14996. is_ssl_ = is_ssl;
  14997. #endif
  14998. } else {
  14999. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15000. client_key_path);
  15001. }
  15002. } else {
  15003. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15004. // if port param below changes.
  15005. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15006. client_cert_path, client_key_path);
  15007. }
  15008. }
  15009. inline Client::Client(const std::string &host, int port)
  15010. : Client(host, port, std::string(), std::string()) {}
  15011. inline Client::Client(const std::string &host, int port,
  15012. const std::string &client_cert_path,
  15013. const std::string &client_key_path)
  15014. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15015. client_key_path)) {}
  15016. inline Client::~Client() = default;
  15017. inline bool Client::is_valid() const {
  15018. return cli_ != nullptr && cli_->is_valid();
  15019. }
  15020. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15021. return cli_->Get(path, std::move(progress));
  15022. }
  15023. inline Result Client::Get(const std::string &path, const Headers &headers,
  15024. DownloadProgress progress) {
  15025. return cli_->Get(path, headers, std::move(progress));
  15026. }
  15027. inline Result Client::Get(const std::string &path,
  15028. ContentReceiver content_receiver,
  15029. DownloadProgress progress) {
  15030. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15031. }
  15032. inline Result Client::Get(const std::string &path, const Headers &headers,
  15033. ContentReceiver content_receiver,
  15034. DownloadProgress progress) {
  15035. return cli_->Get(path, headers, std::move(content_receiver),
  15036. std::move(progress));
  15037. }
  15038. inline Result Client::Get(const std::string &path,
  15039. ResponseHandler response_handler,
  15040. ContentReceiver content_receiver,
  15041. DownloadProgress progress) {
  15042. return cli_->Get(path, std::move(response_handler),
  15043. std::move(content_receiver), std::move(progress));
  15044. }
  15045. inline Result Client::Get(const std::string &path, const Headers &headers,
  15046. ResponseHandler response_handler,
  15047. ContentReceiver content_receiver,
  15048. DownloadProgress progress) {
  15049. return cli_->Get(path, headers, std::move(response_handler),
  15050. std::move(content_receiver), std::move(progress));
  15051. }
  15052. inline Result Client::Get(const std::string &path, const Params &params,
  15053. DownloadProgress progress) {
  15054. return cli_->Get(path, params, std::move(progress));
  15055. }
  15056. inline Result Client::Get(const std::string &path, const Params &params,
  15057. const Headers &headers, DownloadProgress progress) {
  15058. return cli_->Get(path, params, headers, std::move(progress));
  15059. }
  15060. inline Result Client::Get(const std::string &path, const Params &params,
  15061. const Headers &headers,
  15062. ContentReceiver content_receiver,
  15063. DownloadProgress progress) {
  15064. return cli_->Get(path, params, headers, std::move(content_receiver),
  15065. std::move(progress));
  15066. }
  15067. inline Result Client::Get(const std::string &path, const Params &params,
  15068. const Headers &headers,
  15069. ResponseHandler response_handler,
  15070. ContentReceiver content_receiver,
  15071. DownloadProgress progress) {
  15072. return cli_->Get(path, params, headers, std::move(response_handler),
  15073. std::move(content_receiver), std::move(progress));
  15074. }
  15075. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15076. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15077. return cli_->Head(path, headers);
  15078. }
  15079. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15080. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15081. return cli_->Post(path, headers);
  15082. }
  15083. inline Result Client::Post(const std::string &path, const char *body,
  15084. size_t content_length,
  15085. const std::string &content_type,
  15086. UploadProgress progress) {
  15087. return cli_->Post(path, body, content_length, content_type, progress);
  15088. }
  15089. inline Result Client::Post(const std::string &path, const Headers &headers,
  15090. const char *body, size_t content_length,
  15091. const std::string &content_type,
  15092. UploadProgress progress) {
  15093. return cli_->Post(path, headers, body, content_length, content_type,
  15094. progress);
  15095. }
  15096. inline Result Client::Post(const std::string &path, const std::string &body,
  15097. const std::string &content_type,
  15098. UploadProgress progress) {
  15099. return cli_->Post(path, body, content_type, progress);
  15100. }
  15101. inline Result Client::Post(const std::string &path, const Headers &headers,
  15102. const std::string &body,
  15103. const std::string &content_type,
  15104. UploadProgress progress) {
  15105. return cli_->Post(path, headers, body, content_type, progress);
  15106. }
  15107. inline Result Client::Post(const std::string &path, size_t content_length,
  15108. ContentProvider content_provider,
  15109. const std::string &content_type,
  15110. UploadProgress progress) {
  15111. return cli_->Post(path, content_length, std::move(content_provider),
  15112. content_type, progress);
  15113. }
  15114. inline Result Client::Post(const std::string &path, size_t content_length,
  15115. ContentProvider content_provider,
  15116. const std::string &content_type,
  15117. ContentReceiver content_receiver,
  15118. UploadProgress progress) {
  15119. return cli_->Post(path, content_length, std::move(content_provider),
  15120. content_type, std::move(content_receiver), progress);
  15121. }
  15122. inline Result Client::Post(const std::string &path,
  15123. ContentProviderWithoutLength content_provider,
  15124. const std::string &content_type,
  15125. UploadProgress progress) {
  15126. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15127. }
  15128. inline Result Client::Post(const std::string &path,
  15129. ContentProviderWithoutLength content_provider,
  15130. const std::string &content_type,
  15131. ContentReceiver content_receiver,
  15132. UploadProgress progress) {
  15133. return cli_->Post(path, std::move(content_provider), content_type,
  15134. std::move(content_receiver), progress);
  15135. }
  15136. inline Result Client::Post(const std::string &path, const Headers &headers,
  15137. size_t content_length,
  15138. ContentProvider content_provider,
  15139. const std::string &content_type,
  15140. UploadProgress progress) {
  15141. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15142. content_type, progress);
  15143. }
  15144. inline Result Client::Post(const std::string &path, const Headers &headers,
  15145. size_t content_length,
  15146. ContentProvider content_provider,
  15147. const std::string &content_type,
  15148. ContentReceiver content_receiver,
  15149. DownloadProgress progress) {
  15150. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15151. content_type, std::move(content_receiver), progress);
  15152. }
  15153. inline Result Client::Post(const std::string &path, const Headers &headers,
  15154. ContentProviderWithoutLength content_provider,
  15155. const std::string &content_type,
  15156. UploadProgress progress) {
  15157. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15158. progress);
  15159. }
  15160. inline Result Client::Post(const std::string &path, const Headers &headers,
  15161. ContentProviderWithoutLength content_provider,
  15162. const std::string &content_type,
  15163. ContentReceiver content_receiver,
  15164. DownloadProgress progress) {
  15165. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15166. std::move(content_receiver), progress);
  15167. }
  15168. inline Result Client::Post(const std::string &path, const Params &params) {
  15169. return cli_->Post(path, params);
  15170. }
  15171. inline Result Client::Post(const std::string &path, const Headers &headers,
  15172. const Params &params) {
  15173. return cli_->Post(path, headers, params);
  15174. }
  15175. inline Result Client::Post(const std::string &path,
  15176. const UploadFormDataItems &items,
  15177. UploadProgress progress) {
  15178. return cli_->Post(path, items, progress);
  15179. }
  15180. inline Result Client::Post(const std::string &path, const Headers &headers,
  15181. const UploadFormDataItems &items,
  15182. UploadProgress progress) {
  15183. return cli_->Post(path, headers, items, progress);
  15184. }
  15185. inline Result Client::Post(const std::string &path, const Headers &headers,
  15186. const UploadFormDataItems &items,
  15187. const std::string &boundary,
  15188. UploadProgress progress) {
  15189. return cli_->Post(path, headers, items, boundary, progress);
  15190. }
  15191. inline Result Client::Post(const std::string &path, const Headers &headers,
  15192. const UploadFormDataItems &items,
  15193. const FormDataProviderItems &provider_items,
  15194. UploadProgress progress) {
  15195. return cli_->Post(path, headers, items, provider_items, progress);
  15196. }
  15197. inline Result Client::Post(const std::string &path, const Headers &headers,
  15198. const std::string &body,
  15199. const std::string &content_type,
  15200. ContentReceiver content_receiver,
  15201. DownloadProgress progress) {
  15202. return cli_->Post(path, headers, body, content_type,
  15203. std::move(content_receiver), progress);
  15204. }
  15205. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15206. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15207. return cli_->Put(path, headers);
  15208. }
  15209. inline Result Client::Put(const std::string &path, const char *body,
  15210. size_t content_length,
  15211. const std::string &content_type,
  15212. UploadProgress progress) {
  15213. return cli_->Put(path, body, content_length, content_type, progress);
  15214. }
  15215. inline Result Client::Put(const std::string &path, const Headers &headers,
  15216. const char *body, size_t content_length,
  15217. const std::string &content_type,
  15218. UploadProgress progress) {
  15219. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15220. }
  15221. inline Result Client::Put(const std::string &path, const std::string &body,
  15222. const std::string &content_type,
  15223. UploadProgress progress) {
  15224. return cli_->Put(path, body, content_type, progress);
  15225. }
  15226. inline Result Client::Put(const std::string &path, const Headers &headers,
  15227. const std::string &body,
  15228. const std::string &content_type,
  15229. UploadProgress progress) {
  15230. return cli_->Put(path, headers, body, content_type, progress);
  15231. }
  15232. inline Result Client::Put(const std::string &path, size_t content_length,
  15233. ContentProvider content_provider,
  15234. const std::string &content_type,
  15235. UploadProgress progress) {
  15236. return cli_->Put(path, content_length, std::move(content_provider),
  15237. content_type, progress);
  15238. }
  15239. inline Result Client::Put(const std::string &path, size_t content_length,
  15240. ContentProvider content_provider,
  15241. const std::string &content_type,
  15242. ContentReceiver content_receiver,
  15243. UploadProgress progress) {
  15244. return cli_->Put(path, content_length, std::move(content_provider),
  15245. content_type, std::move(content_receiver), progress);
  15246. }
  15247. inline Result Client::Put(const std::string &path,
  15248. ContentProviderWithoutLength content_provider,
  15249. const std::string &content_type,
  15250. UploadProgress progress) {
  15251. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15252. }
  15253. inline Result Client::Put(const std::string &path,
  15254. ContentProviderWithoutLength content_provider,
  15255. const std::string &content_type,
  15256. ContentReceiver content_receiver,
  15257. UploadProgress progress) {
  15258. return cli_->Put(path, std::move(content_provider), content_type,
  15259. std::move(content_receiver), progress);
  15260. }
  15261. inline Result Client::Put(const std::string &path, const Headers &headers,
  15262. size_t content_length,
  15263. ContentProvider content_provider,
  15264. const std::string &content_type,
  15265. UploadProgress progress) {
  15266. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15267. content_type, progress);
  15268. }
  15269. inline Result Client::Put(const std::string &path, const Headers &headers,
  15270. size_t content_length,
  15271. ContentProvider content_provider,
  15272. const std::string &content_type,
  15273. ContentReceiver content_receiver,
  15274. UploadProgress progress) {
  15275. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15276. content_type, std::move(content_receiver), progress);
  15277. }
  15278. inline Result Client::Put(const std::string &path, const Headers &headers,
  15279. ContentProviderWithoutLength content_provider,
  15280. const std::string &content_type,
  15281. UploadProgress progress) {
  15282. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15283. progress);
  15284. }
  15285. inline Result Client::Put(const std::string &path, const Headers &headers,
  15286. ContentProviderWithoutLength content_provider,
  15287. const std::string &content_type,
  15288. ContentReceiver content_receiver,
  15289. UploadProgress progress) {
  15290. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15291. std::move(content_receiver), progress);
  15292. }
  15293. inline Result Client::Put(const std::string &path, const Params &params) {
  15294. return cli_->Put(path, params);
  15295. }
  15296. inline Result Client::Put(const std::string &path, const Headers &headers,
  15297. const Params &params) {
  15298. return cli_->Put(path, headers, params);
  15299. }
  15300. inline Result Client::Put(const std::string &path,
  15301. const UploadFormDataItems &items,
  15302. UploadProgress progress) {
  15303. return cli_->Put(path, items, progress);
  15304. }
  15305. inline Result Client::Put(const std::string &path, const Headers &headers,
  15306. const UploadFormDataItems &items,
  15307. UploadProgress progress) {
  15308. return cli_->Put(path, headers, items, progress);
  15309. }
  15310. inline Result Client::Put(const std::string &path, const Headers &headers,
  15311. const UploadFormDataItems &items,
  15312. const std::string &boundary,
  15313. UploadProgress progress) {
  15314. return cli_->Put(path, headers, items, boundary, progress);
  15315. }
  15316. inline Result Client::Put(const std::string &path, const Headers &headers,
  15317. const UploadFormDataItems &items,
  15318. const FormDataProviderItems &provider_items,
  15319. UploadProgress progress) {
  15320. return cli_->Put(path, headers, items, provider_items, progress);
  15321. }
  15322. inline Result Client::Put(const std::string &path, const Headers &headers,
  15323. const std::string &body,
  15324. const std::string &content_type,
  15325. ContentReceiver content_receiver,
  15326. DownloadProgress progress) {
  15327. return cli_->Put(path, headers, body, content_type, content_receiver,
  15328. progress);
  15329. }
  15330. inline Result Client::Patch(const std::string &path) {
  15331. return cli_->Patch(path);
  15332. }
  15333. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15334. return cli_->Patch(path, headers);
  15335. }
  15336. inline Result Client::Patch(const std::string &path, const char *body,
  15337. size_t content_length,
  15338. const std::string &content_type,
  15339. UploadProgress progress) {
  15340. return cli_->Patch(path, body, content_length, content_type, progress);
  15341. }
  15342. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15343. const char *body, size_t content_length,
  15344. const std::string &content_type,
  15345. UploadProgress progress) {
  15346. return cli_->Patch(path, headers, body, content_length, content_type,
  15347. progress);
  15348. }
  15349. inline Result Client::Patch(const std::string &path, const std::string &body,
  15350. const std::string &content_type,
  15351. UploadProgress progress) {
  15352. return cli_->Patch(path, body, content_type, progress);
  15353. }
  15354. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15355. const std::string &body,
  15356. const std::string &content_type,
  15357. UploadProgress progress) {
  15358. return cli_->Patch(path, headers, body, content_type, progress);
  15359. }
  15360. inline Result Client::Patch(const std::string &path, size_t content_length,
  15361. ContentProvider content_provider,
  15362. const std::string &content_type,
  15363. UploadProgress progress) {
  15364. return cli_->Patch(path, content_length, std::move(content_provider),
  15365. content_type, progress);
  15366. }
  15367. inline Result Client::Patch(const std::string &path, size_t content_length,
  15368. ContentProvider content_provider,
  15369. const std::string &content_type,
  15370. ContentReceiver content_receiver,
  15371. UploadProgress progress) {
  15372. return cli_->Patch(path, content_length, std::move(content_provider),
  15373. content_type, std::move(content_receiver), progress);
  15374. }
  15375. inline Result Client::Patch(const std::string &path,
  15376. ContentProviderWithoutLength content_provider,
  15377. const std::string &content_type,
  15378. UploadProgress progress) {
  15379. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15380. }
  15381. inline Result Client::Patch(const std::string &path,
  15382. ContentProviderWithoutLength content_provider,
  15383. const std::string &content_type,
  15384. ContentReceiver content_receiver,
  15385. UploadProgress progress) {
  15386. return cli_->Patch(path, std::move(content_provider), content_type,
  15387. std::move(content_receiver), progress);
  15388. }
  15389. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15390. size_t content_length,
  15391. ContentProvider content_provider,
  15392. const std::string &content_type,
  15393. UploadProgress progress) {
  15394. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15395. content_type, progress);
  15396. }
  15397. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15398. size_t content_length,
  15399. ContentProvider content_provider,
  15400. const std::string &content_type,
  15401. ContentReceiver content_receiver,
  15402. UploadProgress progress) {
  15403. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15404. content_type, std::move(content_receiver), progress);
  15405. }
  15406. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15407. ContentProviderWithoutLength content_provider,
  15408. const std::string &content_type,
  15409. UploadProgress progress) {
  15410. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15411. progress);
  15412. }
  15413. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15414. ContentProviderWithoutLength content_provider,
  15415. const std::string &content_type,
  15416. ContentReceiver content_receiver,
  15417. UploadProgress progress) {
  15418. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15419. std::move(content_receiver), progress);
  15420. }
  15421. inline Result Client::Patch(const std::string &path, const Params &params) {
  15422. return cli_->Patch(path, params);
  15423. }
  15424. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15425. const Params &params) {
  15426. return cli_->Patch(path, headers, params);
  15427. }
  15428. inline Result Client::Patch(const std::string &path,
  15429. const UploadFormDataItems &items,
  15430. UploadProgress progress) {
  15431. return cli_->Patch(path, items, progress);
  15432. }
  15433. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15434. const UploadFormDataItems &items,
  15435. UploadProgress progress) {
  15436. return cli_->Patch(path, headers, items, progress);
  15437. }
  15438. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15439. const UploadFormDataItems &items,
  15440. const std::string &boundary,
  15441. UploadProgress progress) {
  15442. return cli_->Patch(path, headers, items, boundary, progress);
  15443. }
  15444. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15445. const UploadFormDataItems &items,
  15446. const FormDataProviderItems &provider_items,
  15447. UploadProgress progress) {
  15448. return cli_->Patch(path, headers, items, provider_items, progress);
  15449. }
  15450. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15451. const std::string &body,
  15452. const std::string &content_type,
  15453. ContentReceiver content_receiver,
  15454. DownloadProgress progress) {
  15455. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15456. progress);
  15457. }
  15458. inline Result Client::Delete(const std::string &path,
  15459. DownloadProgress progress) {
  15460. return cli_->Delete(path, progress);
  15461. }
  15462. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15463. DownloadProgress progress) {
  15464. return cli_->Delete(path, headers, progress);
  15465. }
  15466. inline Result Client::Delete(const std::string &path, const char *body,
  15467. size_t content_length,
  15468. const std::string &content_type,
  15469. DownloadProgress progress) {
  15470. return cli_->Delete(path, body, content_length, content_type, progress);
  15471. }
  15472. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15473. const char *body, size_t content_length,
  15474. const std::string &content_type,
  15475. DownloadProgress progress) {
  15476. return cli_->Delete(path, headers, body, content_length, content_type,
  15477. progress);
  15478. }
  15479. inline Result Client::Delete(const std::string &path, const std::string &body,
  15480. const std::string &content_type,
  15481. DownloadProgress progress) {
  15482. return cli_->Delete(path, body, content_type, progress);
  15483. }
  15484. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15485. const std::string &body,
  15486. const std::string &content_type,
  15487. DownloadProgress progress) {
  15488. return cli_->Delete(path, headers, body, content_type, progress);
  15489. }
  15490. inline Result Client::Delete(const std::string &path, const Params &params,
  15491. DownloadProgress progress) {
  15492. return cli_->Delete(path, params, progress);
  15493. }
  15494. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15495. const Params &params, DownloadProgress progress) {
  15496. return cli_->Delete(path, headers, params, progress);
  15497. }
  15498. inline Result Client::Options(const std::string &path) {
  15499. return cli_->Options(path);
  15500. }
  15501. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15502. return cli_->Options(path, headers);
  15503. }
  15504. inline ClientImpl::StreamHandle
  15505. Client::open_stream(const std::string &method, const std::string &path,
  15506. const Params &params, const Headers &headers,
  15507. const std::string &body, const std::string &content_type) {
  15508. return cli_->open_stream(method, path, params, headers, body, content_type);
  15509. }
  15510. inline bool Client::send(Request &req, Response &res, Error &error) {
  15511. return cli_->send(req, res, error);
  15512. }
  15513. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15514. inline void Client::stop() { cli_->stop(); }
  15515. inline std::string Client::host() const { return cli_->host(); }
  15516. inline int Client::port() const { return cli_->port(); }
  15517. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15518. inline socket_t Client::socket() const { return cli_->socket(); }
  15519. inline void
  15520. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15521. cli_->set_hostname_addr_map(std::move(addr_map));
  15522. }
  15523. inline void Client::set_default_headers(Headers headers) {
  15524. cli_->set_default_headers(std::move(headers));
  15525. }
  15526. inline void Client::set_header_writer(
  15527. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15528. cli_->set_header_writer(writer);
  15529. }
  15530. inline void Client::set_address_family(int family) {
  15531. cli_->set_address_family(family);
  15532. }
  15533. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15534. inline void Client::set_socket_options(SocketOptions socket_options) {
  15535. cli_->set_socket_options(std::move(socket_options));
  15536. }
  15537. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15538. cli_->set_connection_timeout(sec, usec);
  15539. }
  15540. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15541. cli_->set_read_timeout(sec, usec);
  15542. }
  15543. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15544. cli_->set_write_timeout(sec, usec);
  15545. }
  15546. inline void Client::set_basic_auth(const std::string &username,
  15547. const std::string &password) {
  15548. cli_->set_basic_auth(username, password);
  15549. }
  15550. inline void Client::set_bearer_token_auth(const std::string &token) {
  15551. cli_->set_bearer_token_auth(token);
  15552. }
  15553. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15554. inline void Client::set_follow_location(bool on) {
  15555. cli_->set_follow_location(on);
  15556. }
  15557. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15558. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15559. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15560. inline void Client::set_payload_max_length(size_t length) {
  15561. cli_->set_payload_max_length(length);
  15562. }
  15563. inline void Client::set_interface(const std::string &intf) {
  15564. cli_->set_interface(intf);
  15565. }
  15566. inline void Client::set_proxy(const std::string &host, int port) {
  15567. cli_->set_proxy(host, port);
  15568. }
  15569. inline void Client::set_proxy_basic_auth(const std::string &username,
  15570. const std::string &password) {
  15571. cli_->set_proxy_basic_auth(username, password);
  15572. }
  15573. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15574. cli_->set_proxy_bearer_token_auth(token);
  15575. }
  15576. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15577. cli_->set_no_proxy(patterns);
  15578. }
  15579. inline void Client::set_logger(Logger logger) {
  15580. cli_->set_logger(std::move(logger));
  15581. }
  15582. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15583. cli_->set_error_logger(std::move(error_logger));
  15584. }
  15585. /*
  15586. * Group 6: SSL Server and Client implementation
  15587. */
  15588. #ifdef CPPHTTPLIB_SSL_ENABLED
  15589. // SSL HTTP server implementation
  15590. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15591. const char *client_ca_cert_file_path,
  15592. const char *client_ca_cert_dir_path,
  15593. const char *private_key_password) {
  15594. using namespace tls;
  15595. ctx_ = create_server_context();
  15596. if (!ctx_) { return; }
  15597. // Load server certificate and private key
  15598. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15599. private_key_password)) {
  15600. last_ssl_error_ = static_cast<int>(get_error());
  15601. free_context(ctx_);
  15602. ctx_ = nullptr;
  15603. return;
  15604. }
  15605. // Load client CA certificates for client authentication
  15606. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15607. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15608. client_ca_cert_dir_path)) {
  15609. last_ssl_error_ = static_cast<int>(get_error());
  15610. free_context(ctx_);
  15611. ctx_ = nullptr;
  15612. return;
  15613. }
  15614. // Enable client certificate verification
  15615. set_verify_client(ctx_, true);
  15616. }
  15617. }
  15618. inline SSLServer::SSLServer(const PemMemory &pem) {
  15619. using namespace tls;
  15620. ctx_ = create_server_context();
  15621. if (ctx_) {
  15622. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15623. pem.private_key_password)) {
  15624. last_ssl_error_ = static_cast<int>(get_error());
  15625. free_context(ctx_);
  15626. ctx_ = nullptr;
  15627. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15628. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15629. last_ssl_error_ = static_cast<int>(get_error());
  15630. free_context(ctx_);
  15631. ctx_ = nullptr;
  15632. } else {
  15633. set_verify_client(ctx_, true);
  15634. }
  15635. }
  15636. }
  15637. }
  15638. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15639. using namespace tls;
  15640. ctx_ = create_server_context();
  15641. if (ctx_) {
  15642. if (!setup_callback(ctx_)) {
  15643. free_context(ctx_);
  15644. ctx_ = nullptr;
  15645. }
  15646. }
  15647. }
  15648. inline SSLServer::~SSLServer() {
  15649. if (ctx_) { tls::free_context(ctx_); }
  15650. }
  15651. inline bool SSLServer::is_valid() const {
  15652. return ctx_ != nullptr && Server::is_valid();
  15653. }
  15654. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15655. using namespace tls;
  15656. // Create TLS session with mutex protection
  15657. session_t session = nullptr;
  15658. {
  15659. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15660. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15661. }
  15662. if (!session) {
  15663. last_ssl_error_ = static_cast<int>(get_error());
  15664. detail::shutdown_socket(sock);
  15665. detail::close_socket(sock);
  15666. return false;
  15667. }
  15668. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15669. bool handshake_done = false;
  15670. bool ret = false;
  15671. bool websocket_upgraded = false;
  15672. auto cleanup = detail::scope_exit([&] {
  15673. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15674. free_session(session);
  15675. detail::shutdown_socket(sock);
  15676. detail::close_socket(sock);
  15677. });
  15678. // Perform TLS accept handshake with timeout
  15679. TlsError tls_err;
  15680. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15681. &tls_err)) {
  15682. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15683. // Map TlsError to legacy ssl_error for backward compatibility
  15684. if (tls_err.code == ErrorCode::WantRead) {
  15685. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15686. } else if (tls_err.code == ErrorCode::WantWrite) {
  15687. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15688. } else {
  15689. last_ssl_error_ = SSL_ERROR_SSL;
  15690. }
  15691. #else
  15692. last_ssl_error_ = static_cast<int>(get_error());
  15693. #endif
  15694. return false;
  15695. }
  15696. handshake_done = true;
  15697. std::string remote_addr;
  15698. int remote_port = 0;
  15699. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15700. std::string local_addr;
  15701. int local_port = 0;
  15702. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15703. ret = serve_guarded([&]() {
  15704. return detail::process_server_socket_ssl(
  15705. svr_sock_, session, sock, keep_alive_max_count_,
  15706. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15707. write_timeout_sec_, write_timeout_usec_,
  15708. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15709. return process_request(
  15710. strm, remote_addr, remote_port, local_addr, local_port,
  15711. close_connection, connection_closed,
  15712. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15713. });
  15714. });
  15715. return ret;
  15716. }
  15717. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15718. const char *key_pem,
  15719. const char *client_ca_pem,
  15720. const char *password) {
  15721. if (!ctx_) { return false; }
  15722. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15723. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15724. return false;
  15725. }
  15726. if (client_ca_pem) {
  15727. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15728. }
  15729. return true;
  15730. }
  15731. // SSL HTTP client implementation
  15732. inline SSLClient::~SSLClient() {
  15733. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15734. // base function rather than the derived function once we get to the
  15735. // base class destructor, and won't free the SSL (causing a leak).
  15736. // This must happen before the context is freed below: some backends
  15737. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15738. // context, so freeing the context first leaves close_notify reading
  15739. // freed memory.
  15740. shutdown_ssl_impl(socket_, true);
  15741. if (ctx_) {
  15742. tls::free_context(ctx_);
  15743. ctx_ = nullptr;
  15744. }
  15745. }
  15746. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15747. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15748. shutdown_ssl_impl(socket, shutdown_gracefully);
  15749. }
  15750. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15751. bool shutdown_gracefully) {
  15752. if (socket.sock == INVALID_SOCKET) {
  15753. assert(socket.ssl == nullptr);
  15754. return;
  15755. }
  15756. if (socket.ssl) {
  15757. tls::shutdown(socket.ssl, shutdown_gracefully);
  15758. {
  15759. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15760. tls::free_session(socket.ssl);
  15761. }
  15762. socket.ssl = nullptr;
  15763. }
  15764. assert(socket.ssl == nullptr);
  15765. }
  15766. inline bool SSLClient::process_socket(
  15767. const Socket &socket,
  15768. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15769. std::function<bool(Stream &strm)> callback) {
  15770. assert(socket.ssl);
  15771. return detail::process_client_socket_ssl(
  15772. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15773. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15774. std::move(callback));
  15775. }
  15776. inline bool SSLClient::is_ssl() const { return true; }
  15777. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15778. if (!is_valid()) {
  15779. error = Error::SSLConnection;
  15780. return false;
  15781. }
  15782. return ClientImpl::create_and_connect_socket(socket, error);
  15783. }
  15784. inline bool SSLClient::setup_proxy_connection(
  15785. Socket &socket,
  15786. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15787. Response &res, bool &success, Error &error) {
  15788. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15789. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15790. return false;
  15791. }
  15792. if (!initialize_ssl(socket, error)) {
  15793. success = false;
  15794. return false;
  15795. }
  15796. return true;
  15797. }
  15798. // Assumes that socket_mutex_ is locked and that there are no requests in
  15799. // flight
  15800. inline bool SSLClient::connect_with_proxy(
  15801. Socket &socket,
  15802. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15803. Response &res, bool &success, Error &error) {
  15804. success = true;
  15805. Response proxy_res;
  15806. if (!detail::process_client_socket(
  15807. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15808. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15809. start_time, [&](Stream &strm) {
  15810. Request req2;
  15811. req2.method = "CONNECT";
  15812. req2.path =
  15813. detail::make_host_and_port_string_always_port(host_, port_);
  15814. if (max_timeout_msec_ > 0) {
  15815. req2.start_time_ = std::chrono::steady_clock::now();
  15816. }
  15817. return process_request(strm, req2, proxy_res, false, error);
  15818. })) {
  15819. // Thread-safe to close everything because we are assuming there are no
  15820. // requests in flight
  15821. shutdown_ssl(socket, true);
  15822. shutdown_socket(socket);
  15823. close_socket(socket);
  15824. success = false;
  15825. return false;
  15826. }
  15827. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15828. if (!proxy_digest_auth_username_.empty() &&
  15829. !proxy_digest_auth_password_.empty()) {
  15830. std::map<std::string, std::string> auth;
  15831. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15832. // Close the current socket and create a new one for the authenticated
  15833. // request
  15834. shutdown_ssl(socket, true);
  15835. shutdown_socket(socket);
  15836. close_socket(socket);
  15837. // Create a new socket for the authenticated CONNECT request
  15838. if (!ensure_socket_connection(socket, error)) {
  15839. success = false;
  15840. output_error_log(error, nullptr);
  15841. return false;
  15842. }
  15843. proxy_res = Response();
  15844. if (!detail::process_client_socket(
  15845. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15846. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15847. start_time, [&](Stream &strm) {
  15848. Request req3;
  15849. req3.method = "CONNECT";
  15850. req3.path = detail::make_host_and_port_string_always_port(
  15851. host_, port_);
  15852. req3.headers.insert(detail::make_digest_authentication_header(
  15853. req3, auth, 1, detail::random_string(10),
  15854. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15855. true));
  15856. if (max_timeout_msec_ > 0) {
  15857. req3.start_time_ = std::chrono::steady_clock::now();
  15858. }
  15859. return process_request(strm, req3, proxy_res, false, error);
  15860. })) {
  15861. // Thread-safe to close everything because we are assuming there are
  15862. // no requests in flight
  15863. shutdown_ssl(socket, true);
  15864. shutdown_socket(socket);
  15865. close_socket(socket);
  15866. success = false;
  15867. return false;
  15868. }
  15869. }
  15870. }
  15871. }
  15872. // If status code is not 200, proxy request is failed.
  15873. // Set error to ProxyConnection and return proxy response
  15874. // as the response of the request
  15875. if (proxy_res.status != StatusCode::OK_200) {
  15876. error = Error::ProxyConnection;
  15877. output_error_log(error, nullptr);
  15878. res = std::move(proxy_res);
  15879. // Thread-safe to close everything because we are assuming there are
  15880. // no requests in flight
  15881. shutdown_ssl(socket, true);
  15882. shutdown_socket(socket);
  15883. close_socket(socket);
  15884. return false;
  15885. }
  15886. return true;
  15887. }
  15888. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15889. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15890. if (is_proxy_enabled_for_host(host_)) { return true; }
  15891. if (!initialize_ssl(socket, error)) {
  15892. shutdown_socket(socket);
  15893. close_socket(socket);
  15894. return false;
  15895. }
  15896. return true;
  15897. }
  15898. // SSL HTTP client implementation
  15899. inline SSLClient::SSLClient(const std::string &host)
  15900. : SSLClient(host, 443, std::string(), std::string()) {}
  15901. inline SSLClient::SSLClient(const std::string &host, int port)
  15902. : SSLClient(host, port, std::string(), std::string()) {}
  15903. inline void SSLClient::init_ctx() {
  15904. ctx_ = tls::create_client_context();
  15905. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15906. }
  15907. inline void SSLClient::reset_ctx_on_error() {
  15908. last_backend_error_ = tls::get_error();
  15909. tls::free_context(ctx_);
  15910. ctx_ = nullptr;
  15911. }
  15912. inline SSLClient::SSLClient(const std::string &host, int port,
  15913. const std::string &client_cert_path,
  15914. const std::string &client_key_path,
  15915. const std::string &private_key_password)
  15916. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15917. init_ctx();
  15918. if (!ctx_) { return; }
  15919. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15920. const char *password =
  15921. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15922. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15923. client_key_path.c_str(), password)) {
  15924. reset_ctx_on_error();
  15925. }
  15926. }
  15927. }
  15928. inline SSLClient::SSLClient(const std::string &host, int port,
  15929. const PemMemory &pem)
  15930. : ClientImpl(host, port) {
  15931. init_ctx();
  15932. if (!ctx_) { return; }
  15933. if (pem.cert_pem && pem.key_pem) {
  15934. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15935. pem.private_key_password)) {
  15936. reset_ctx_on_error();
  15937. }
  15938. }
  15939. }
  15940. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15941. if (ca_cert_store && ctx_) {
  15942. // set_ca_store takes ownership of ca_cert_store
  15943. tls::set_ca_store(ctx_, ca_cert_store);
  15944. ca_cert_store_set_ = true;
  15945. } else if (ca_cert_store) {
  15946. tls::free_ca_store(ca_cert_store);
  15947. }
  15948. }
  15949. inline void
  15950. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15951. if (!ctx_) { return; }
  15952. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15953. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  15954. #endif
  15955. tls::set_verify_callback(ctx_, verifier);
  15956. }
  15957. inline void SSLClient::set_session_verifier(
  15958. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15959. session_verifier_ = std::move(verifier);
  15960. }
  15961. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15962. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15963. enable_windows_cert_verification_ = enabled;
  15964. }
  15965. #endif
  15966. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15967. std::size_t size) {
  15968. if (ctx_ && ca_cert && size > 0) {
  15969. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15970. tls::load_ca_pem(ctx_, ca_cert, size);
  15971. }
  15972. }
  15973. inline bool SSLClient::load_certs() {
  15974. auto ret = true;
  15975. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15976. // one client is shared across concurrent requests here.
  15977. std::call_once(initialize_cert_, [&]() {
  15978. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15979. ret = detail::load_client_ca_config(
  15980. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15981. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15982. last_backend_error_);
  15983. });
  15984. return ret;
  15985. }
  15986. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15987. // Load CA certificates if server verification is enabled
  15988. if (server_certificate_verification_) {
  15989. if (!load_certs()) {
  15990. error = Error::SSLLoadingCerts;
  15991. output_error_log(error, nullptr);
  15992. return false;
  15993. }
  15994. }
  15995. detail::ClientTlsSessionOptions options;
  15996. options.server_hostname_verification = server_hostname_verification_;
  15997. options.session_verifier = session_verifier_;
  15998. options.ctx_mutex = &ctx_mutex_;
  15999. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16000. // Skip Schannel when a custom CA cert is specified, as the Windows
  16001. // certificate store would not know about user-provided CA certificates.
  16002. // Also skip when system CA trust is explicitly disabled.
  16003. options.windows_cert_verification =
  16004. enable_windows_cert_verification_ &&
  16005. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16006. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16007. // Only a verifier set through set_server_certificate_verifier() is seen
  16008. // here, not one installed with tls::set_verify_callback() directly.
  16009. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  16010. #endif
  16011. tls::session_t session = nullptr;
  16012. // Use scope_exit to ensure session is freed on error paths
  16013. bool success = false;
  16014. auto session_guard = detail::scope_exit([&] {
  16015. if (!success) { tls::free_session(session); }
  16016. });
  16017. detail::ClientTlsSessionError tls_error;
  16018. if (!detail::setup_client_tls_session(
  16019. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16020. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16021. options)) {
  16022. error = tls_error.error;
  16023. last_ssl_error_ = tls_error.ssl_error;
  16024. last_backend_error_ = tls_error.backend_error;
  16025. output_error_log(error, nullptr);
  16026. return false;
  16027. }
  16028. success = true;
  16029. socket.ssl = session;
  16030. return true;
  16031. }
  16032. inline void Client::set_digest_auth(const std::string &username,
  16033. const std::string &password) {
  16034. cli_->set_digest_auth(username, password);
  16035. }
  16036. inline void Client::set_proxy_digest_auth(const std::string &username,
  16037. const std::string &password) {
  16038. cli_->set_proxy_digest_auth(username, password);
  16039. }
  16040. inline void Client::enable_server_certificate_verification(bool enabled) {
  16041. cli_->enable_server_certificate_verification(enabled);
  16042. }
  16043. inline void Client::enable_server_hostname_verification(bool enabled) {
  16044. cli_->enable_server_hostname_verification(enabled);
  16045. }
  16046. inline void Client::enable_system_ca(bool enabled) {
  16047. cli_->enable_system_ca(enabled);
  16048. }
  16049. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16050. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16051. if (is_ssl_) {
  16052. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16053. enabled);
  16054. }
  16055. }
  16056. #endif
  16057. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16058. const std::string &ca_cert_dir_path) {
  16059. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16060. }
  16061. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16062. if (is_ssl_) {
  16063. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16064. } else if (ca_cert_store) {
  16065. tls::free_ca_store(ca_cert_store);
  16066. }
  16067. }
  16068. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16069. if (is_ssl_) {
  16070. // Use the PEM-based path so the CA data is retained for redirect transfer
  16071. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16072. }
  16073. }
  16074. inline void
  16075. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16076. if (is_ssl_) {
  16077. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16078. std::move(verifier));
  16079. }
  16080. }
  16081. inline void Client::set_session_verifier(
  16082. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16083. if (is_ssl_) {
  16084. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16085. }
  16086. }
  16087. inline tls::ctx_t Client::tls_context() const {
  16088. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16089. return nullptr;
  16090. }
  16091. #endif // CPPHTTPLIB_SSL_ENABLED
  16092. /*
  16093. * Group 7: TLS abstraction layer - Common API
  16094. */
  16095. #ifdef CPPHTTPLIB_SSL_ENABLED
  16096. namespace tls {
  16097. // Helper for PeerCert construction
  16098. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16099. return PeerCert(get_peer_cert(session));
  16100. }
  16101. namespace impl {
  16102. inline VerifyCallback &get_verify_callback() {
  16103. static thread_local VerifyCallback callback;
  16104. return callback;
  16105. }
  16106. inline VerifyCallback &get_mbedtls_verify_callback() {
  16107. static thread_local VerifyCallback callback;
  16108. return callback;
  16109. }
  16110. // Check if a string is an IPv4 address
  16111. inline bool is_ipv4_address(const std::string &str) {
  16112. int dots = 0;
  16113. for (char c : str) {
  16114. if (c == '.') {
  16115. dots++;
  16116. } else if (!detail::is_ascii_digit(c)) {
  16117. return false;
  16118. }
  16119. }
  16120. return dots == 3;
  16121. }
  16122. // Parse IPv4 address string to bytes
  16123. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16124. const char *p = str.c_str();
  16125. for (int i = 0; i < 4; i++) {
  16126. if (i > 0) {
  16127. if (*p != '.') { return false; }
  16128. p++;
  16129. }
  16130. int val = 0;
  16131. int digits = 0;
  16132. while (detail::is_ascii_digit(*p)) {
  16133. val = val * 10 + (*p - '0');
  16134. if (val > 255) { return false; }
  16135. p++;
  16136. digits++;
  16137. }
  16138. if (digits == 0) { return false; }
  16139. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16140. if (digits > 1 && *(p - digits) == '0') { return false; }
  16141. out[i] = static_cast<unsigned char>(val);
  16142. }
  16143. return *p == '\0';
  16144. }
  16145. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16146. // `out` must have room for at least 16 bytes. Returns the address length
  16147. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16148. // literal. Used to match a host against iPAddress SANs the same way the
  16149. // OpenSSL backend does via X509_check_ip.
  16150. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16151. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16152. struct in6_addr addr6 = {};
  16153. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16154. memcpy(out, &addr6, 16);
  16155. return 16;
  16156. }
  16157. return 0;
  16158. }
  16159. #ifdef _WIN32
  16160. // Enumerate Windows system certificates and call callback with DER data
  16161. template <typename Callback>
  16162. inline bool enumerate_windows_system_certs(Callback cb) {
  16163. bool loaded = false;
  16164. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16165. for (auto store_name : store_names) {
  16166. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16167. if (hStore) {
  16168. PCCERT_CONTEXT pContext = nullptr;
  16169. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16170. nullptr) {
  16171. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16172. loaded = true;
  16173. }
  16174. }
  16175. CertCloseStore(hStore, 0);
  16176. }
  16177. }
  16178. return loaded;
  16179. }
  16180. #endif
  16181. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16182. // Enumerate macOS Keychain certificates and call callback with DER data
  16183. template <typename Callback>
  16184. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16185. bool loaded = false;
  16186. const SecTrustSettingsDomain domains[] = {
  16187. kSecTrustSettingsDomainSystem,
  16188. kSecTrustSettingsDomainAdmin,
  16189. kSecTrustSettingsDomainUser,
  16190. };
  16191. for (auto domain : domains) {
  16192. CFArrayRef certs = nullptr;
  16193. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16194. if (status != errSecSuccess || !certs) {
  16195. if (certs) CFRelease(certs);
  16196. continue;
  16197. }
  16198. CFIndex count = CFArrayGetCount(certs);
  16199. for (CFIndex i = 0; i < count; i++) {
  16200. SecCertificateRef cert =
  16201. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16202. CFDataRef data = SecCertificateCopyData(cert);
  16203. if (data) {
  16204. if (cb(CFDataGetBytePtr(data),
  16205. static_cast<size_t>(CFDataGetLength(data)))) {
  16206. loaded = true;
  16207. }
  16208. CFRelease(data);
  16209. }
  16210. }
  16211. CFRelease(certs);
  16212. }
  16213. return loaded;
  16214. }
  16215. #endif
  16216. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16217. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16218. // Common CA certificate file paths on Linux/Unix
  16219. inline const char **system_ca_paths() {
  16220. static const char *paths[] = {
  16221. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16222. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16223. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16224. "/etc/pki/tls/cacert.pem", // OpenELEC
  16225. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16226. nullptr};
  16227. return paths;
  16228. }
  16229. // Common CA certificate directory paths on Linux/Unix
  16230. inline const char **system_ca_dirs() {
  16231. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16232. "/etc/pki/tls/certs", // RHEL/CentOS
  16233. "/usr/share/ca-certificates", // Other
  16234. nullptr};
  16235. return dirs;
  16236. }
  16237. #endif
  16238. } // namespace impl
  16239. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16240. const char *ca_dir) {
  16241. if (!ctx) { return false; }
  16242. bool success = true;
  16243. if (ca_file && *ca_file) {
  16244. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16245. }
  16246. if (ca_dir && *ca_dir) {
  16247. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16248. }
  16249. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16250. // Set CA list for client certificate request (CertificateRequest message)
  16251. if (ca_file && *ca_file) {
  16252. auto list = SSL_load_client_CA_file(ca_file);
  16253. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16254. }
  16255. #endif
  16256. return success;
  16257. }
  16258. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16259. const char *password) {
  16260. return set_client_cert_pem(ctx, cert, key, password);
  16261. }
  16262. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16263. const char *key_path, const char *password) {
  16264. return set_client_cert_file(ctx, cert_path, key_path, password);
  16265. }
  16266. // PeerCert implementation
  16267. inline PeerCert::PeerCert() = default;
  16268. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16269. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16270. other.cert_ = nullptr;
  16271. }
  16272. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16273. if (this != &other) {
  16274. if (cert_) { free_cert(cert_); }
  16275. cert_ = other.cert_;
  16276. other.cert_ = nullptr;
  16277. }
  16278. return *this;
  16279. }
  16280. inline PeerCert::~PeerCert() {
  16281. if (cert_) { free_cert(cert_); }
  16282. }
  16283. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16284. inline std::string PeerCert::subject_cn() const {
  16285. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16286. }
  16287. inline std::string PeerCert::issuer_name() const {
  16288. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16289. }
  16290. inline bool PeerCert::check_hostname(const char *hostname) const {
  16291. return cert_ ? verify_hostname(cert_, hostname) : false;
  16292. }
  16293. inline std::vector<SanEntry> PeerCert::sans() const {
  16294. std::vector<SanEntry> result;
  16295. if (cert_) { get_cert_sans(cert_, result); }
  16296. return result;
  16297. }
  16298. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16299. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16300. }
  16301. inline std::string PeerCert::serial() const {
  16302. return cert_ ? get_cert_serial(cert_) : std::string();
  16303. }
  16304. // VerifyContext method implementations
  16305. inline std::string VerifyContext::subject_cn() const {
  16306. return cert ? get_cert_subject_cn(cert) : std::string();
  16307. }
  16308. inline std::string VerifyContext::issuer_name() const {
  16309. return cert ? get_cert_issuer_name(cert) : std::string();
  16310. }
  16311. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16312. return cert ? verify_hostname(cert, hostname) : false;
  16313. }
  16314. inline std::vector<SanEntry> VerifyContext::sans() const {
  16315. std::vector<SanEntry> result;
  16316. if (cert) { get_cert_sans(cert, result); }
  16317. return result;
  16318. }
  16319. inline bool VerifyContext::validity(time_t &not_before,
  16320. time_t &not_after) const {
  16321. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16322. }
  16323. inline std::string VerifyContext::serial() const {
  16324. return cert ? get_cert_serial(cert) : std::string();
  16325. }
  16326. // TlsError static method implementation
  16327. inline std::string TlsError::verify_error_to_string(long error_code) {
  16328. return verify_error_string(error_code);
  16329. }
  16330. } // namespace tls
  16331. // Request::peer_cert() implementation
  16332. inline tls::PeerCert Request::peer_cert() const {
  16333. return tls::get_peer_cert_from_session(ssl);
  16334. }
  16335. // Request::sni() implementation
  16336. inline std::string Request::sni() const {
  16337. if (!ssl) { return std::string(); }
  16338. const char *s = tls::get_sni(ssl);
  16339. return s ? std::string(s) : std::string();
  16340. }
  16341. #endif // CPPHTTPLIB_SSL_ENABLED
  16342. /*
  16343. * Group 8: TLS abstraction layer - OpenSSL backend
  16344. */
  16345. /*
  16346. * OpenSSL Backend Implementation
  16347. */
  16348. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16349. namespace tls {
  16350. namespace impl {
  16351. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16352. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16353. switch (ssl_error) {
  16354. case SSL_ERROR_NONE: return ErrorCode::Success;
  16355. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16356. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16357. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16358. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16359. case SSL_ERROR_SSL:
  16360. default: return ErrorCode::Fatal;
  16361. }
  16362. }
  16363. // Helper: Create client CA list from PEM string
  16364. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16365. // Caller takes ownership of returned list
  16366. inline STACK_OF(X509_NAME) *
  16367. create_client_ca_list_from_pem(const char *ca_pem) {
  16368. if (!ca_pem) { return nullptr; }
  16369. auto ca_list = sk_X509_NAME_new_null();
  16370. if (!ca_list) { return nullptr; }
  16371. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16372. if (!bio) {
  16373. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16374. return nullptr;
  16375. }
  16376. X509 *cert = nullptr;
  16377. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16378. nullptr) {
  16379. const X509_NAME *name = X509_get_subject_name(cert);
  16380. if (name) {
  16381. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16382. }
  16383. X509_free(cert);
  16384. }
  16385. BIO_free(bio);
  16386. return ca_list;
  16387. }
  16388. // OpenSSL verify callback wrapper
  16389. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16390. auto &callback = get_verify_callback();
  16391. if (!callback) { return preverify_ok; }
  16392. // Get SSL object from X509_STORE_CTX
  16393. auto ssl = static_cast<SSL *>(
  16394. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16395. if (!ssl) { return preverify_ok; }
  16396. // Get current certificate and depth
  16397. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16398. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16399. int error = X509_STORE_CTX_get_error(ctx);
  16400. // Build context
  16401. VerifyContext verify_ctx;
  16402. verify_ctx.session = static_cast<session_t>(ssl);
  16403. verify_ctx.cert = static_cast<cert_t>(cert);
  16404. verify_ctx.depth = depth;
  16405. verify_ctx.preverify_ok = (preverify_ok != 0);
  16406. verify_ctx.error_code = error;
  16407. verify_ctx.error_string =
  16408. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16409. return callback(verify_ctx) ? 1 : 0;
  16410. }
  16411. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16412. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16413. // that must be released with release_store_objects
  16414. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16415. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16416. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16417. #endif
  16418. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16419. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16420. return X509_STORE_get1_objects(store);
  16421. #else
  16422. return X509_STORE_get0_objects(store);
  16423. #endif
  16424. }
  16425. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16426. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16427. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16428. #else
  16429. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16430. #endif
  16431. }
  16432. } // namespace impl
  16433. inline ctx_t create_client_context() {
  16434. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16435. if (ctx) {
  16436. // Disable auto-retry to properly handle non-blocking I/O
  16437. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16438. // Set minimum TLS version
  16439. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16440. }
  16441. return static_cast<ctx_t>(ctx);
  16442. }
  16443. inline void free_context(ctx_t ctx) {
  16444. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16445. }
  16446. inline bool set_min_version(ctx_t ctx, Version version) {
  16447. if (!ctx) return false;
  16448. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16449. static_cast<int>(version)) == 1;
  16450. }
  16451. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16452. if (!ctx || !pem || len == 0) return false;
  16453. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16454. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16455. if (!store) return false;
  16456. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16457. if (!bio) return false;
  16458. bool ok = true;
  16459. X509 *cert = nullptr;
  16460. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16461. nullptr) {
  16462. if (X509_STORE_add_cert(store, cert) != 1) {
  16463. // Ignore duplicate errors
  16464. auto err = ERR_peek_last_error();
  16465. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16466. ok = false;
  16467. }
  16468. }
  16469. X509_free(cert);
  16470. if (!ok) break;
  16471. }
  16472. BIO_free(bio);
  16473. // Clear any "no more certificates" errors
  16474. ERR_clear_error();
  16475. return ok;
  16476. }
  16477. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16478. if (!ctx || !file_path) return false;
  16479. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16480. nullptr) == 1;
  16481. }
  16482. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16483. if (!ctx || !dir_path) return false;
  16484. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16485. dir_path) == 1;
  16486. }
  16487. inline bool load_system_certs(ctx_t ctx) {
  16488. if (!ctx) return false;
  16489. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16490. #ifdef _WIN32
  16491. // Windows: Load from system certificate store (ROOT and CA)
  16492. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16493. if (!store) return false;
  16494. bool loaded_any = false;
  16495. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16496. for (auto store_name : store_names) {
  16497. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16498. if (!hStore) continue;
  16499. PCCERT_CONTEXT pContext = nullptr;
  16500. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16501. nullptr) {
  16502. const unsigned char *data = pContext->pbCertEncoded;
  16503. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16504. if (x509) {
  16505. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16506. X509_free(x509);
  16507. }
  16508. }
  16509. CertCloseStore(hStore, 0);
  16510. }
  16511. return loaded_any;
  16512. #elif defined(__APPLE__)
  16513. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16514. // macOS: Load from Keychain
  16515. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16516. if (!store) return false;
  16517. bool loaded_any = false;
  16518. const SecTrustSettingsDomain domains[] = {
  16519. kSecTrustSettingsDomainSystem,
  16520. kSecTrustSettingsDomainAdmin,
  16521. kSecTrustSettingsDomainUser,
  16522. };
  16523. for (auto domain : domains) {
  16524. CFArrayRef certs = nullptr;
  16525. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16526. !certs) {
  16527. if (certs) CFRelease(certs);
  16528. continue;
  16529. }
  16530. auto count = CFArrayGetCount(certs);
  16531. for (CFIndex i = 0; i < count; i++) {
  16532. auto cert = reinterpret_cast<SecCertificateRef>(
  16533. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16534. CFDataRef der = SecCertificateCopyData(cert);
  16535. if (der) {
  16536. const unsigned char *data = CFDataGetBytePtr(der);
  16537. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16538. if (x509) {
  16539. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16540. X509_free(x509);
  16541. }
  16542. CFRelease(der);
  16543. }
  16544. }
  16545. CFRelease(certs);
  16546. }
  16547. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16548. #else
  16549. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16550. #endif
  16551. #else
  16552. // Other Unix: use default verify paths
  16553. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16554. #endif
  16555. }
  16556. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16557. const char *password) {
  16558. if (!ctx || !cert || !key) return false;
  16559. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16560. // Load certificate
  16561. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16562. if (!cert_bio) return false;
  16563. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16564. BIO_free(cert_bio);
  16565. if (!x509) return false;
  16566. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16567. X509_free(x509);
  16568. if (!cert_ok) return false;
  16569. // Load private key
  16570. auto key_bio = BIO_new_mem_buf(key, -1);
  16571. if (!key_bio) return false;
  16572. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16573. password ? const_cast<char *>(password)
  16574. : nullptr);
  16575. BIO_free(key_bio);
  16576. if (!pkey) return false;
  16577. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16578. EVP_PKEY_free(pkey);
  16579. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16580. }
  16581. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16582. const char *key_path, const char *password) {
  16583. if (!ctx || !cert_path || !key_path) return false;
  16584. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16585. if (password && password[0] != '\0') {
  16586. SSL_CTX_set_default_passwd_cb_userdata(
  16587. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16588. }
  16589. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16590. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16591. }
  16592. inline ctx_t create_server_context() {
  16593. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16594. if (ctx) {
  16595. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16596. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16597. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16598. }
  16599. return static_cast<ctx_t>(ctx);
  16600. }
  16601. inline void set_verify_client(ctx_t ctx, bool require) {
  16602. if (!ctx) return;
  16603. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16604. require
  16605. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16606. : SSL_VERIFY_NONE,
  16607. nullptr);
  16608. }
  16609. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16610. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16611. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16612. SSL *ssl = SSL_new(ssl_ctx);
  16613. if (!ssl) return nullptr;
  16614. // Disable auto-retry for proper non-blocking I/O handling
  16615. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16616. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16617. if (!bio) {
  16618. SSL_free(ssl);
  16619. return nullptr;
  16620. }
  16621. SSL_set_bio(ssl, bio, bio);
  16622. return static_cast<session_t>(ssl);
  16623. }
  16624. inline void free_session(session_t session) {
  16625. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16626. }
  16627. inline bool set_sni(session_t session, const char *hostname,
  16628. bool /*verify_hostname*/) {
  16629. if (!session || !hostname) return false;
  16630. auto ssl = static_cast<SSL *>(session);
  16631. // Set SNI (Server Name Indication) only - does not enable verification.
  16632. // OpenSSL never binds identity checking to SNI (that happens post-
  16633. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16634. #if defined(OPENSSL_IS_BORINGSSL)
  16635. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16636. #else
  16637. // Direct call instead of macro to suppress -Wold-style-cast warning
  16638. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16639. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16640. #endif
  16641. }
  16642. inline TlsError connect(session_t session) {
  16643. if (!session) { return TlsError(); }
  16644. auto ssl = static_cast<SSL *>(session);
  16645. auto ret = SSL_connect(ssl);
  16646. TlsError err;
  16647. if (ret == 1) {
  16648. err.code = ErrorCode::Success;
  16649. } else {
  16650. auto ssl_err = SSL_get_error(ssl, ret);
  16651. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16652. err.backend_code = ERR_get_error();
  16653. }
  16654. return err;
  16655. }
  16656. inline TlsError accept(session_t session) {
  16657. if (!session) { return TlsError(); }
  16658. auto ssl = static_cast<SSL *>(session);
  16659. auto ret = SSL_accept(ssl);
  16660. TlsError err;
  16661. if (ret == 1) {
  16662. err.code = ErrorCode::Success;
  16663. } else {
  16664. auto ssl_err = SSL_get_error(ssl, ret);
  16665. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16666. err.backend_code = ERR_get_error();
  16667. }
  16668. return err;
  16669. }
  16670. inline bool connect_nonblocking(session_t session, socket_t sock,
  16671. time_t timeout_sec, time_t timeout_usec,
  16672. TlsError *err) {
  16673. if (!session) {
  16674. if (err) { err->code = ErrorCode::Fatal; }
  16675. return false;
  16676. }
  16677. auto ssl = static_cast<SSL *>(session);
  16678. auto bio = SSL_get_rbio(ssl);
  16679. // Set non-blocking mode for handshake
  16680. detail::set_nonblocking(sock, true);
  16681. if (bio) { BIO_set_nbio(bio, 1); }
  16682. auto cleanup = detail::scope_exit([&]() {
  16683. // Restore blocking mode after handshake
  16684. if (bio) { BIO_set_nbio(bio, 0); }
  16685. detail::set_nonblocking(sock, false);
  16686. });
  16687. auto res = 0;
  16688. while ((res = SSL_connect(ssl)) != 1) {
  16689. auto ssl_err = SSL_get_error(ssl, res);
  16690. switch (ssl_err) {
  16691. case SSL_ERROR_WANT_READ:
  16692. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16693. continue;
  16694. }
  16695. break;
  16696. case SSL_ERROR_WANT_WRITE:
  16697. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16698. continue;
  16699. }
  16700. break;
  16701. default: break;
  16702. }
  16703. if (err) {
  16704. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16705. err->backend_code = ERR_get_error();
  16706. }
  16707. return false;
  16708. }
  16709. if (err) { err->code = ErrorCode::Success; }
  16710. return true;
  16711. }
  16712. inline bool accept_nonblocking(session_t session, socket_t sock,
  16713. time_t timeout_sec, time_t timeout_usec,
  16714. TlsError *err) {
  16715. if (!session) {
  16716. if (err) { err->code = ErrorCode::Fatal; }
  16717. return false;
  16718. }
  16719. auto ssl = static_cast<SSL *>(session);
  16720. auto bio = SSL_get_rbio(ssl);
  16721. // Set non-blocking mode for handshake
  16722. detail::set_nonblocking(sock, true);
  16723. if (bio) { BIO_set_nbio(bio, 1); }
  16724. auto cleanup = detail::scope_exit([&]() {
  16725. // Restore blocking mode after handshake
  16726. if (bio) { BIO_set_nbio(bio, 0); }
  16727. detail::set_nonblocking(sock, false);
  16728. });
  16729. auto res = 0;
  16730. while ((res = SSL_accept(ssl)) != 1) {
  16731. auto ssl_err = SSL_get_error(ssl, res);
  16732. switch (ssl_err) {
  16733. case SSL_ERROR_WANT_READ:
  16734. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16735. continue;
  16736. }
  16737. break;
  16738. case SSL_ERROR_WANT_WRITE:
  16739. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16740. continue;
  16741. }
  16742. break;
  16743. default: break;
  16744. }
  16745. if (err) {
  16746. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16747. err->backend_code = ERR_get_error();
  16748. }
  16749. return false;
  16750. }
  16751. if (err) { err->code = ErrorCode::Success; }
  16752. return true;
  16753. }
  16754. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16755. if (!session || !buf) {
  16756. err.code = ErrorCode::Fatal;
  16757. return -1;
  16758. }
  16759. auto ssl = static_cast<SSL *>(session);
  16760. constexpr auto max_len =
  16761. static_cast<size_t>((std::numeric_limits<int>::max)());
  16762. if (len > max_len) { len = max_len; }
  16763. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16764. if (ret > 0) {
  16765. err.code = ErrorCode::Success;
  16766. return ret;
  16767. }
  16768. auto ssl_err = SSL_get_error(ssl, ret);
  16769. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16770. if (err.code == ErrorCode::PeerClosed) {
  16771. return 0;
  16772. } // Gracefully handle the peer closed state.
  16773. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16774. return -1;
  16775. }
  16776. inline ssize_t write(session_t session, const void *buf, size_t len,
  16777. TlsError &err) {
  16778. if (!session || !buf) {
  16779. err.code = ErrorCode::Fatal;
  16780. return -1;
  16781. }
  16782. auto ssl = static_cast<SSL *>(session);
  16783. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16784. if (ret > 0) {
  16785. err.code = ErrorCode::Success;
  16786. return ret;
  16787. }
  16788. auto ssl_err = SSL_get_error(ssl, ret);
  16789. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16790. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16791. return -1;
  16792. }
  16793. inline int pending(const_session_t session) {
  16794. if (!session) return 0;
  16795. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16796. }
  16797. inline void shutdown(session_t session, bool graceful) {
  16798. if (!session) return;
  16799. auto ssl = static_cast<SSL *>(session);
  16800. if (graceful) {
  16801. // Send close_notify without waiting for the peer's. The connection is
  16802. // closed right after this, so a unidirectional shutdown is enough, and an
  16803. // idle peer that never answers would otherwise hold this thread until the
  16804. // read timeout. The other backends do not wait either.
  16805. SSL_shutdown(ssl);
  16806. }
  16807. }
  16808. inline bool is_peer_closed(session_t session, socket_t sock) {
  16809. if (!session) return true;
  16810. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16811. detail::set_nonblocking(sock, true);
  16812. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16813. auto ssl = static_cast<SSL *>(session);
  16814. char buf;
  16815. auto ret = SSL_peek(ssl, &buf, 1);
  16816. if (ret > 0) return false;
  16817. auto err = SSL_get_error(ssl, ret);
  16818. return err == SSL_ERROR_ZERO_RETURN;
  16819. }
  16820. inline cert_t get_peer_cert(const_session_t session) {
  16821. if (!session) return nullptr;
  16822. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16823. static_cast<SSL *>(const_cast<void *>(session))));
  16824. }
  16825. inline size_t get_peer_certs(const_session_t session,
  16826. std::vector<cert_t> &certs) {
  16827. certs.clear();
  16828. if (!session) { return 0; }
  16829. auto ssl = static_cast<const SSL *>(session);
  16830. // On the server side, the chain leaves out the peer's own certificate
  16831. if (SSL_is_server(ssl)) {
  16832. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16833. }
  16834. auto sk = SSL_get_peer_cert_chain(ssl);
  16835. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16836. auto x509 = sk_X509_value(sk, i);
  16837. X509_up_ref(x509);
  16838. certs.push_back(static_cast<cert_t>(x509));
  16839. }
  16840. return certs.size();
  16841. }
  16842. inline void free_cert(cert_t cert) {
  16843. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16844. }
  16845. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16846. if (!cert || !hostname) return false;
  16847. auto x509 = static_cast<X509 *>(cert);
  16848. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16849. if (detail::is_ip_address(hostname)) {
  16850. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16851. }
  16852. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16853. }
  16854. inline uint64_t hostname_mismatch_code() {
  16855. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16856. }
  16857. inline long get_verify_result(const_session_t session) {
  16858. if (!session) return X509_V_ERR_UNSPECIFIED;
  16859. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16860. }
  16861. inline std::string get_cert_subject_cn(cert_t cert) {
  16862. if (!cert) return "";
  16863. auto x509 = static_cast<X509 *>(cert);
  16864. auto subject_name = X509_get_subject_name(x509);
  16865. if (!subject_name) return "";
  16866. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16867. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16868. if (idx < 0) return "";
  16869. auto entry = X509_NAME_get_entry(subject_name, idx);
  16870. if (!entry) return "";
  16871. auto data = X509_NAME_ENTRY_get_data(entry);
  16872. if (!data) return "";
  16873. return std::string(
  16874. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16875. static_cast<size_t>(ASN1_STRING_length(data)));
  16876. }
  16877. inline std::string get_cert_issuer_name(cert_t cert) {
  16878. if (!cert) return "";
  16879. auto x509 = static_cast<X509 *>(cert);
  16880. auto issuer_name = X509_get_issuer_name(x509);
  16881. if (!issuer_name) return "";
  16882. char buf[256];
  16883. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16884. return std::string(buf);
  16885. }
  16886. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16887. sans.clear();
  16888. if (!cert) return false;
  16889. auto x509 = static_cast<X509 *>(cert);
  16890. auto names = static_cast<GENERAL_NAMES *>(
  16891. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16892. if (!names) return true; // No SANs is valid
  16893. auto count = sk_GENERAL_NAME_num(names);
  16894. for (decltype(count) i = 0; i < count; i++) {
  16895. auto gen = sk_GENERAL_NAME_value(names, i);
  16896. if (!gen) continue;
  16897. SanEntry entry;
  16898. switch (gen->type) {
  16899. case GEN_DNS:
  16900. entry.type = SanType::DNS;
  16901. if (gen->d.dNSName) {
  16902. entry.value = std::string(
  16903. reinterpret_cast<const char *>(
  16904. ASN1_STRING_get0_data(gen->d.dNSName)),
  16905. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16906. }
  16907. break;
  16908. case GEN_IPADD:
  16909. entry.type = SanType::IP;
  16910. if (gen->d.iPAddress) {
  16911. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16912. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16913. if (len == 4) {
  16914. // IPv4
  16915. char buf[INET_ADDRSTRLEN];
  16916. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16917. entry.value = buf;
  16918. } else if (len == 16) {
  16919. // IPv6
  16920. char buf[INET6_ADDRSTRLEN];
  16921. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16922. entry.value = buf;
  16923. }
  16924. }
  16925. break;
  16926. case GEN_EMAIL:
  16927. entry.type = SanType::EMAIL;
  16928. if (gen->d.rfc822Name) {
  16929. entry.value = std::string(
  16930. reinterpret_cast<const char *>(
  16931. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16932. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16933. }
  16934. break;
  16935. case GEN_URI:
  16936. entry.type = SanType::URI;
  16937. if (gen->d.uniformResourceIdentifier) {
  16938. entry.value = std::string(
  16939. reinterpret_cast<const char *>(
  16940. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16941. static_cast<size_t>(
  16942. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16943. }
  16944. break;
  16945. default: entry.type = SanType::OTHER; break;
  16946. }
  16947. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16948. }
  16949. GENERAL_NAMES_free(names);
  16950. return true;
  16951. }
  16952. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16953. time_t &not_after) {
  16954. if (!cert) return false;
  16955. auto x509 = static_cast<X509 *>(cert);
  16956. auto nb = X509_get0_notBefore(x509);
  16957. auto na = X509_get0_notAfter(x509);
  16958. if (!nb || !na) return false;
  16959. ASN1_TIME *epoch = ASN1_TIME_new();
  16960. if (!epoch) return false;
  16961. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16962. if (!ASN1_TIME_set(epoch, 0)) return false;
  16963. int pday, psec;
  16964. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16965. not_before = 86400 * (time_t)pday + psec;
  16966. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16967. not_after = 86400 * (time_t)pday + psec;
  16968. return true;
  16969. }
  16970. inline std::string get_cert_serial(cert_t cert) {
  16971. if (!cert) return "";
  16972. auto x509 = static_cast<X509 *>(cert);
  16973. auto serial = X509_get_serialNumber(x509);
  16974. if (!serial) return "";
  16975. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16976. if (!bn) return "";
  16977. auto hex = BN_bn2hex(bn);
  16978. BN_free(bn);
  16979. if (!hex) return "";
  16980. std::string result(hex);
  16981. OPENSSL_free(hex);
  16982. return result;
  16983. }
  16984. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16985. if (!cert) return false;
  16986. auto x509 = static_cast<X509 *>(cert);
  16987. auto len = i2d_X509(x509, nullptr);
  16988. if (len < 0) return false;
  16989. der.resize(static_cast<size_t>(len));
  16990. auto p = der.data();
  16991. i2d_X509(x509, &p);
  16992. return true;
  16993. }
  16994. inline const char *get_sni(const_session_t session) {
  16995. if (!session) return nullptr;
  16996. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16997. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16998. }
  16999. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17000. inline uint64_t get_error() { return ERR_get_error(); }
  17001. inline std::string error_string(uint64_t code) {
  17002. char buf[256];
  17003. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17004. return std::string(buf);
  17005. }
  17006. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17007. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17008. if (!mem) { return nullptr; }
  17009. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17010. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17011. if (!inf) { return nullptr; }
  17012. auto store = X509_STORE_new();
  17013. if (store) {
  17014. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17015. auto itmp = sk_X509_INFO_value(inf, i);
  17016. if (!itmp) { continue; }
  17017. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17018. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17019. }
  17020. }
  17021. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17022. return static_cast<ca_store_t>(store);
  17023. }
  17024. inline void free_ca_store(ca_store_t store) {
  17025. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17026. }
  17027. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17028. if (!ctx || !store) { return false; }
  17029. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17030. auto x509_store = static_cast<X509_STORE *>(store);
  17031. // Check if same store is already set
  17032. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17033. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17034. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17035. return true;
  17036. }
  17037. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17038. certs.clear();
  17039. if (!ctx) { return 0; }
  17040. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17041. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17042. if (!store) { return 0; }
  17043. auto objs = impl::get_store_objects(store);
  17044. if (!objs) { return 0; }
  17045. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17046. auto count = sk_X509_OBJECT_num(objs);
  17047. for (decltype(count) i = 0; i < count; i++) {
  17048. auto obj = sk_X509_OBJECT_value(objs, i);
  17049. if (!obj) { continue; }
  17050. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17051. auto x509 = X509_OBJECT_get0_X509(obj);
  17052. if (x509) {
  17053. // Increment reference count so caller can free it
  17054. X509_up_ref(x509);
  17055. certs.push_back(static_cast<cert_t>(x509));
  17056. }
  17057. }
  17058. }
  17059. return certs.size();
  17060. }
  17061. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17062. std::vector<std::string> names;
  17063. if (!ctx) { return names; }
  17064. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17065. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17066. if (!store) { return names; }
  17067. auto objs = impl::get_store_objects(store);
  17068. if (!objs) { return names; }
  17069. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17070. auto count = sk_X509_OBJECT_num(objs);
  17071. for (decltype(count) i = 0; i < count; i++) {
  17072. auto obj = sk_X509_OBJECT_value(objs, i);
  17073. if (!obj) { continue; }
  17074. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17075. auto x509 = X509_OBJECT_get0_X509(obj);
  17076. if (x509) {
  17077. auto subject = X509_get_subject_name(x509);
  17078. if (subject) {
  17079. char buf[512];
  17080. X509_NAME_oneline(subject, buf, sizeof(buf));
  17081. names.push_back(buf);
  17082. }
  17083. }
  17084. }
  17085. }
  17086. return names;
  17087. }
  17088. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17089. const char *key_pem, const char *password) {
  17090. if (!ctx || !cert_pem || !key_pem) { return false; }
  17091. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17092. // Load certificate from PEM
  17093. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17094. if (!cert_bio) { return false; }
  17095. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17096. BIO_free(cert_bio);
  17097. if (!cert) { return false; }
  17098. // Load private key from PEM
  17099. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17100. if (!key_bio) {
  17101. X509_free(cert);
  17102. return false;
  17103. }
  17104. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17105. password ? const_cast<char *>(password)
  17106. : nullptr);
  17107. BIO_free(key_bio);
  17108. if (!key) {
  17109. X509_free(cert);
  17110. return false;
  17111. }
  17112. // Update certificate and key
  17113. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17114. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17115. X509_free(cert);
  17116. EVP_PKEY_free(key);
  17117. return ret;
  17118. }
  17119. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17120. if (!ctx || !ca_pem) { return false; }
  17121. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17122. // Create new X509_STORE from PEM
  17123. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17124. if (!store) { return false; }
  17125. // SSL_CTX_set_cert_store takes ownership
  17126. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17127. // Set client CA list for client certificate request
  17128. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17129. if (ca_list) {
  17130. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17131. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17132. }
  17133. return true;
  17134. }
  17135. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17136. if (!ctx) { return false; }
  17137. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17138. impl::get_verify_callback() = std::move(callback);
  17139. if (impl::get_verify_callback()) {
  17140. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17141. } else {
  17142. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17143. }
  17144. return true;
  17145. }
  17146. inline long get_verify_error(const_session_t session) {
  17147. if (!session) { return -1; }
  17148. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17149. return SSL_get_verify_result(ssl);
  17150. }
  17151. inline std::string verify_error_string(long error_code) {
  17152. if (error_code == X509_V_OK) { return ""; }
  17153. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17154. return str ? str : "unknown error";
  17155. }
  17156. } // namespace tls
  17157. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17158. /*
  17159. * Group 9: TLS abstraction layer - Mbed TLS backend
  17160. */
  17161. /*
  17162. * Mbed TLS Backend Implementation
  17163. */
  17164. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17165. namespace tls {
  17166. namespace impl {
  17167. // Mbed TLS session wrapper
  17168. struct MbedTlsSession {
  17169. mbedtls_ssl_context ssl;
  17170. socket_t sock = INVALID_SOCKET;
  17171. std::string hostname; // For client: set via set_sni
  17172. std::string sni_hostname; // For server: received from client via SNI callback
  17173. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17174. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17175. // (e.g. a response that arrived while this side was still in its post-write
  17176. // check), the byte is pushed back here and served by the next read().
  17177. unsigned char peeked_byte = 0;
  17178. bool has_peeked_byte = false;
  17179. // Set by set_sni() when the caller disabled hostname verification, so the
  17180. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17181. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17182. // OpenSSL and wolfSSL keep them independent).
  17183. bool suppress_hostname_mismatch = false;
  17184. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  17185. // decide which verify callback to install when hostname verification is
  17186. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  17187. // wired for this context, or a self-contained one otherwise, so a session
  17188. // that never opted into a callback never consults the process-wide
  17189. // set_verify_callback() slot (which some other, unrelated client may have
  17190. // populated).
  17191. bool has_verify_callback = false;
  17192. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17193. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17194. MbedTlsSession(const MbedTlsSession &) = delete;
  17195. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17196. };
  17197. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17198. // queue)
  17199. inline int &mbedtls_last_error() {
  17200. static thread_local int err = 0;
  17201. return err;
  17202. }
  17203. // Helper to map Mbed TLS error to ErrorCode
  17204. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17205. uint32_t verify_flags) {
  17206. if (ret == 0) { return ErrorCode::Success; }
  17207. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17208. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17209. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17210. return ErrorCode::PeerClosed;
  17211. }
  17212. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17213. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17214. out_errno = errno;
  17215. return ErrorCode::SyscallError;
  17216. }
  17217. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17218. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17219. // the handshake's chain verification (see set_sni()); a mismatch there
  17220. // is reported the same way as any other verify_flags bit. Report it as
  17221. // HostnameMismatch, matching the other backends and the post-handshake
  17222. // identity check below, but only when naming is the sole problem -
  17223. // if the chain itself is also untrusted/expired/etc., that takes
  17224. // priority over the naming detail.
  17225. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17226. return ErrorCode::HostnameMismatch;
  17227. }
  17228. return ErrorCode::CertVerifyFailed;
  17229. }
  17230. return ErrorCode::Fatal;
  17231. }
  17232. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17233. // return value, including the verify-flags-dependent HostnameMismatch
  17234. // mapping; shared by connect() and connect_nonblocking() so the
  17235. // backend_code policy for that mapping only lives in one place.
  17236. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17237. int ret) {
  17238. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17239. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17240. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17241. ? static_cast<uint64_t>(verify_flags)
  17242. : static_cast<uint64_t>(-ret);
  17243. }
  17244. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17245. // non-fatal notification delivered between records, not an error and not
  17246. // application data, so I/O calls that see it should just be retried. Kept in
  17247. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17248. // splitting the closing brace across an #if.
  17249. inline bool mbedtls_is_session_ticket(int ret) {
  17250. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17251. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17252. #else
  17253. (void)ret;
  17254. return false;
  17255. #endif
  17256. }
  17257. // BIO-like send callback for Mbed TLS
  17258. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17259. size_t len) {
  17260. auto sock = *static_cast<socket_t *>(ctx);
  17261. #ifdef _WIN32
  17262. auto ret =
  17263. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17264. if (ret == SOCKET_ERROR) {
  17265. int err = WSAGetLastError();
  17266. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17267. return MBEDTLS_ERR_NET_SEND_FAILED;
  17268. }
  17269. #else
  17270. auto ret = send(sock, buf, len, 0);
  17271. if (ret < 0) {
  17272. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17273. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17274. }
  17275. return MBEDTLS_ERR_NET_SEND_FAILED;
  17276. }
  17277. #endif
  17278. return static_cast<int>(ret);
  17279. }
  17280. // BIO-like recv callback for Mbed TLS
  17281. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17282. auto sock = *static_cast<socket_t *>(ctx);
  17283. #ifdef _WIN32
  17284. auto ret =
  17285. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17286. if (ret == SOCKET_ERROR) {
  17287. int err = WSAGetLastError();
  17288. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17289. return MBEDTLS_ERR_NET_RECV_FAILED;
  17290. }
  17291. #else
  17292. auto ret = recv(sock, buf, len, 0);
  17293. if (ret < 0) {
  17294. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17295. return MBEDTLS_ERR_SSL_WANT_READ;
  17296. }
  17297. return MBEDTLS_ERR_NET_RECV_FAILED;
  17298. }
  17299. #endif
  17300. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17301. return static_cast<int>(ret);
  17302. }
  17303. // MbedTlsContext constructor/destructor implementations
  17304. inline MbedTlsContext::MbedTlsContext() {
  17305. mbedtls_ssl_config_init(&conf);
  17306. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17307. mbedtls_entropy_init(&entropy);
  17308. mbedtls_ctr_drbg_init(&ctr_drbg);
  17309. #endif
  17310. mbedtls_x509_crt_init(&ca_chain);
  17311. mbedtls_x509_crt_init(&own_cert);
  17312. mbedtls_pk_init(&own_key);
  17313. }
  17314. inline MbedTlsContext::~MbedTlsContext() {
  17315. mbedtls_pk_free(&own_key);
  17316. mbedtls_x509_crt_free(&own_cert);
  17317. mbedtls_x509_crt_free(&ca_chain);
  17318. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17319. mbedtls_ctr_drbg_free(&ctr_drbg);
  17320. mbedtls_entropy_free(&entropy);
  17321. #endif
  17322. mbedtls_ssl_config_free(&conf);
  17323. }
  17324. // Thread-local storage for SNI captured during handshake
  17325. // This is needed because the SNI callback doesn't have a way to pass
  17326. // session-specific data before the session is fully set up
  17327. inline std::string &mbedpending_sni() {
  17328. static thread_local std::string sni;
  17329. return sni;
  17330. }
  17331. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17332. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17333. const unsigned char *name, size_t name_len) {
  17334. (void)p_ctx;
  17335. (void)ssl;
  17336. // Store SNI name in thread-local storage
  17337. // It will be retrieved and stored in the session after handshake
  17338. if (name && name_len > 0) {
  17339. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17340. } else {
  17341. mbedpending_sni().clear();
  17342. }
  17343. return 0; // Accept any SNI
  17344. }
  17345. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17346. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17347. }
  17348. // Verify callback used when hostname verification is disabled for a session
  17349. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17350. // has_verify_callback is false). Deliberately does not consult
  17351. // get_verify_callback(): that slot is process-wide, so reading it here would
  17352. // pick up whatever another, unrelated client last installed there.
  17353. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17354. mbedtls_x509_crt *, int,
  17355. uint32_t *flags) {
  17356. (void)data;
  17357. mbedtls_clear_cn_mismatch(flags);
  17358. return 0;
  17359. }
  17360. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17361. int cert_depth, uint32_t *flags);
  17362. // MbedTLS verify callback wrapper
  17363. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17364. int cert_depth, uint32_t *flags) {
  17365. // data points to the MbedTlsSession
  17366. auto *session = static_cast<MbedTlsSession *>(data);
  17367. // set_sni() disabled hostname verification for this session: drop the
  17368. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17369. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17370. // SNI. The final pass/fail decision still comes from the remaining flags
  17371. // (or, below, from the user's own verify callback).
  17372. if (session && session->suppress_hostname_mismatch) {
  17373. mbedtls_clear_cn_mismatch(flags);
  17374. }
  17375. auto &callback = get_verify_callback();
  17376. if (!callback) { return 0; } // Continue with default verification
  17377. // Build context
  17378. VerifyContext verify_ctx;
  17379. verify_ctx.session = static_cast<session_t>(session);
  17380. verify_ctx.cert = static_cast<cert_t>(crt);
  17381. verify_ctx.depth = cert_depth;
  17382. verify_ctx.preverify_ok = (*flags == 0);
  17383. verify_ctx.error_code = static_cast<long>(*flags);
  17384. // Convert Mbed TLS flags to error string
  17385. static thread_local char error_buf[256];
  17386. if (*flags != 0) {
  17387. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17388. verify_ctx.error_string = error_buf;
  17389. } else {
  17390. verify_ctx.error_string = nullptr;
  17391. }
  17392. bool accepted = callback(verify_ctx);
  17393. if (accepted) {
  17394. *flags = 0; // Clear all error flags
  17395. return 0;
  17396. }
  17397. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17398. }
  17399. } // namespace impl
  17400. inline ctx_t create_client_context() {
  17401. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17402. if (!ctx) { return nullptr; }
  17403. ctx->is_server = false;
  17404. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17405. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17406. if (!detail::ensure_mbedtls_psa_crypto()) {
  17407. delete ctx;
  17408. return nullptr;
  17409. }
  17410. int ret;
  17411. #else
  17412. // Seed the random number generator
  17413. const char *pers = "httplib_client";
  17414. int ret = mbedtls_ctr_drbg_seed(
  17415. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17416. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17417. if (ret != 0) {
  17418. impl::mbedtls_last_error() = ret;
  17419. delete ctx;
  17420. return nullptr;
  17421. }
  17422. #endif
  17423. // Set up SSL config for client
  17424. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17425. MBEDTLS_SSL_TRANSPORT_STREAM,
  17426. MBEDTLS_SSL_PRESET_DEFAULT);
  17427. if (ret != 0) {
  17428. impl::mbedtls_last_error() = ret;
  17429. delete ctx;
  17430. return nullptr;
  17431. }
  17432. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17433. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17434. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17435. #endif
  17436. // Default: verify peer certificate
  17437. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17438. // Set minimum TLS version to 1.2
  17439. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17440. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17441. #else
  17442. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17443. MBEDTLS_SSL_MINOR_VERSION_3);
  17444. #endif
  17445. return static_cast<ctx_t>(ctx);
  17446. }
  17447. inline ctx_t create_server_context() {
  17448. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17449. if (!ctx) { return nullptr; }
  17450. ctx->is_server = true;
  17451. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17452. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17453. if (!detail::ensure_mbedtls_psa_crypto()) {
  17454. delete ctx;
  17455. return nullptr;
  17456. }
  17457. int ret;
  17458. #else
  17459. // Seed the random number generator
  17460. const char *pers = "httplib_server";
  17461. int ret = mbedtls_ctr_drbg_seed(
  17462. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17463. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17464. if (ret != 0) {
  17465. impl::mbedtls_last_error() = ret;
  17466. delete ctx;
  17467. return nullptr;
  17468. }
  17469. #endif
  17470. // Set up SSL config for server
  17471. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17472. MBEDTLS_SSL_TRANSPORT_STREAM,
  17473. MBEDTLS_SSL_PRESET_DEFAULT);
  17474. if (ret != 0) {
  17475. impl::mbedtls_last_error() = ret;
  17476. delete ctx;
  17477. return nullptr;
  17478. }
  17479. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17480. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17481. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17482. #endif
  17483. // Default: don't verify client
  17484. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17485. // Set minimum TLS version to 1.2
  17486. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17487. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17488. #else
  17489. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17490. MBEDTLS_SSL_MINOR_VERSION_3);
  17491. #endif
  17492. // Set SNI callback to capture client's SNI hostname
  17493. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17494. return static_cast<ctx_t>(ctx);
  17495. }
  17496. inline void free_context(ctx_t ctx) {
  17497. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17498. }
  17499. inline bool set_min_version(ctx_t ctx, Version version) {
  17500. if (!ctx) { return false; }
  17501. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17502. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17503. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17504. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17505. if (version >= Version::TLS1_3) {
  17506. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17507. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17508. #endif
  17509. }
  17510. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17511. #else
  17512. // Mbed TLS 2.x uses major/minor version numbers
  17513. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17514. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17515. if (version >= Version::TLS1_3) {
  17516. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17517. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17518. #else
  17519. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17520. #endif
  17521. }
  17522. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17523. #endif
  17524. return true;
  17525. }
  17526. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17527. if (!ctx || !pem) { return false; }
  17528. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17529. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17530. // Add null terminator if not present
  17531. std::string pem_str(pem, len);
  17532. int ret = mbedtls_x509_crt_parse(
  17533. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17534. pem_str.size() + 1);
  17535. if (ret != 0) {
  17536. impl::mbedtls_last_error() = ret;
  17537. return false;
  17538. }
  17539. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17540. return true;
  17541. }
  17542. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17543. if (!ctx || !file_path) { return false; }
  17544. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17545. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17546. if (ret != 0) {
  17547. impl::mbedtls_last_error() = ret;
  17548. return false;
  17549. }
  17550. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17551. return true;
  17552. }
  17553. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17554. if (!ctx || !dir_path) { return false; }
  17555. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17556. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17557. if (ret < 0) { // Returns number of certs on success, negative on error
  17558. impl::mbedtls_last_error() = ret;
  17559. return false;
  17560. }
  17561. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17562. return true;
  17563. }
  17564. inline bool load_system_certs(ctx_t ctx) {
  17565. if (!ctx) { return false; }
  17566. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17567. bool loaded = false;
  17568. #ifdef _WIN32
  17569. loaded = impl::enumerate_windows_system_certs(
  17570. [&](const unsigned char *data, size_t len) {
  17571. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17572. });
  17573. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17574. loaded = impl::enumerate_macos_keychain_certs(
  17575. [&](const unsigned char *data, size_t len) {
  17576. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17577. });
  17578. #else
  17579. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17580. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17581. loaded = true;
  17582. break;
  17583. }
  17584. }
  17585. if (!loaded) {
  17586. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17587. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17588. loaded = true;
  17589. break;
  17590. }
  17591. }
  17592. }
  17593. #endif
  17594. if (loaded) {
  17595. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17596. }
  17597. return loaded;
  17598. }
  17599. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17600. const char *password) {
  17601. if (!ctx || !cert || !key) { return false; }
  17602. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17603. // Parse certificate
  17604. std::string cert_str(cert);
  17605. int ret = mbedtls_x509_crt_parse(
  17606. &mctx->own_cert,
  17607. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17608. cert_str.size() + 1);
  17609. if (ret != 0) {
  17610. impl::mbedtls_last_error() = ret;
  17611. return false;
  17612. }
  17613. // Parse private key
  17614. std::string key_str(key);
  17615. const unsigned char *pwd =
  17616. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17617. size_t pwd_len = password ? strlen(password) : 0;
  17618. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17619. ret = mbedtls_pk_parse_key(
  17620. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17621. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17622. &mctx->ctr_drbg);
  17623. #else
  17624. ret = mbedtls_pk_parse_key(
  17625. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17626. key_str.size() + 1, pwd, pwd_len);
  17627. #endif
  17628. if (ret != 0) {
  17629. impl::mbedtls_last_error() = ret;
  17630. return false;
  17631. }
  17632. // Verify that the certificate and private key match.
  17633. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17634. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17635. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17636. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17637. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17638. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17639. #else
  17640. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17641. #endif
  17642. if (ret != 0) {
  17643. impl::mbedtls_last_error() = ret;
  17644. return false;
  17645. }
  17646. #endif
  17647. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17648. if (ret != 0) {
  17649. impl::mbedtls_last_error() = ret;
  17650. return false;
  17651. }
  17652. return true;
  17653. }
  17654. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17655. const char *key_path, const char *password) {
  17656. if (!ctx || !cert_path || !key_path) { return false; }
  17657. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17658. // Parse certificate file
  17659. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17660. if (ret != 0) {
  17661. impl::mbedtls_last_error() = ret;
  17662. return false;
  17663. }
  17664. // Parse private key file
  17665. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17666. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17667. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17668. #else
  17669. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17670. #endif
  17671. if (ret != 0) {
  17672. impl::mbedtls_last_error() = ret;
  17673. return false;
  17674. }
  17675. // Verify that the certificate and private key match.
  17676. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17677. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17678. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17679. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17680. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17681. #else
  17682. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17683. #endif
  17684. if (ret != 0) {
  17685. impl::mbedtls_last_error() = ret;
  17686. return false;
  17687. }
  17688. #endif
  17689. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17690. if (ret != 0) {
  17691. impl::mbedtls_last_error() = ret;
  17692. return false;
  17693. }
  17694. return true;
  17695. }
  17696. inline void set_verify_client(ctx_t ctx, bool require) {
  17697. if (!ctx) { return; }
  17698. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17699. mctx->verify_client = require;
  17700. if (require) {
  17701. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17702. } else {
  17703. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17704. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17705. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17706. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17707. : MBEDTLS_SSL_VERIFY_NONE);
  17708. }
  17709. }
  17710. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17711. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17712. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17713. auto session = new (std::nothrow) impl::MbedTlsSession();
  17714. if (!session) { return nullptr; }
  17715. session->sock = sock;
  17716. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17717. if (ret != 0) {
  17718. impl::mbedtls_last_error() = ret;
  17719. delete session;
  17720. return nullptr;
  17721. }
  17722. // Explicitly opt out of in-handshake hostname verification by default;
  17723. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17724. // fails outright when no hostname was set. set_sni() installs the real
  17725. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17726. // caller verifies the certificate identity post-handshake via
  17727. // verify_hostname().
  17728. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17729. // Set BIO callbacks
  17730. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17731. impl::mbedtls_net_recv_cb, nullptr);
  17732. // Set per-session verify callback with session pointer if callback is
  17733. // registered
  17734. session->has_verify_callback = mctx->has_verify_callback;
  17735. if (mctx->has_verify_callback) {
  17736. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17737. session);
  17738. }
  17739. return static_cast<session_t>(session);
  17740. }
  17741. inline void free_session(session_t session) {
  17742. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17743. }
  17744. inline bool set_sni(session_t session, const char *hostname,
  17745. bool verify_hostname) {
  17746. if (!session || !hostname) { return false; }
  17747. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17748. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17749. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17750. // independently, so a disabled hostname check is handled below by masking
  17751. // the resulting mismatch flag instead of skipping this call.
  17752. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17753. if (ret != 0) {
  17754. impl::mbedtls_last_error() = ret;
  17755. return false;
  17756. }
  17757. msession->hostname = hostname;
  17758. if (!verify_hostname) {
  17759. msession->suppress_hostname_mismatch = true;
  17760. // If a user verify callback is already wired for this session,
  17761. // mbedtls_verify_callback() masks the mismatch flag itself before
  17762. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17763. // here would be redundant. Otherwise install the self-contained masking
  17764. // callback, which never touches the process-wide callback slot.
  17765. if (!msession->has_verify_callback) {
  17766. mbedtls_ssl_set_verify(&msession->ssl,
  17767. impl::mbedtls_mask_hostname_mismatch_callback,
  17768. msession);
  17769. }
  17770. }
  17771. return true;
  17772. }
  17773. inline TlsError connect(session_t session) {
  17774. TlsError err;
  17775. if (!session) {
  17776. err.code = ErrorCode::Fatal;
  17777. return err;
  17778. }
  17779. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17780. int ret;
  17781. do {
  17782. ret = mbedtls_ssl_handshake(&msession->ssl);
  17783. } while (impl::mbedtls_is_session_ticket(ret));
  17784. if (ret == 0) {
  17785. err.code = ErrorCode::Success;
  17786. } else {
  17787. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17788. impl::mbedtls_last_error() = ret;
  17789. }
  17790. return err;
  17791. }
  17792. inline TlsError accept(session_t session) {
  17793. // Same as connect for Mbed TLS - handshake works for both client and server
  17794. auto result = connect(session);
  17795. // After successful handshake, capture SNI from thread-local storage
  17796. if (result.code == ErrorCode::Success && session) {
  17797. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17798. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17799. impl::mbedpending_sni().clear();
  17800. }
  17801. return result;
  17802. }
  17803. inline bool connect_nonblocking(session_t session, socket_t sock,
  17804. time_t timeout_sec, time_t timeout_usec,
  17805. TlsError *err) {
  17806. if (!session) {
  17807. if (err) { err->code = ErrorCode::Fatal; }
  17808. return false;
  17809. }
  17810. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17811. // Set socket to non-blocking mode
  17812. detail::set_nonblocking(sock, true);
  17813. auto cleanup =
  17814. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17815. int ret;
  17816. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17817. // Non-fatal TLS 1.3 ticket; retry immediately.
  17818. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17819. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17820. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17821. continue;
  17822. }
  17823. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17824. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17825. continue;
  17826. }
  17827. }
  17828. // TlsError or timeout
  17829. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17830. impl::mbedtls_last_error() = ret;
  17831. return false;
  17832. }
  17833. if (err) { err->code = ErrorCode::Success; }
  17834. return true;
  17835. }
  17836. inline bool accept_nonblocking(session_t session, socket_t sock,
  17837. time_t timeout_sec, time_t timeout_usec,
  17838. TlsError *err) {
  17839. // Same implementation as connect for Mbed TLS
  17840. bool result =
  17841. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17842. // After successful handshake, capture SNI from thread-local storage
  17843. if (result && session) {
  17844. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17845. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17846. impl::mbedpending_sni().clear();
  17847. }
  17848. return result;
  17849. }
  17850. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17851. if (!session || !buf) {
  17852. err.code = ErrorCode::Fatal;
  17853. return -1;
  17854. }
  17855. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17856. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17857. if (msession->has_peeked_byte) {
  17858. if (len == 0) { return 0; }
  17859. auto p = static_cast<unsigned char *>(buf);
  17860. p[0] = msession->peeked_byte;
  17861. msession->has_peeked_byte = false;
  17862. size_t n = 1;
  17863. // Top up with any already-decrypted bytes without risking a block.
  17864. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17865. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17866. if (extra > 0) { n += static_cast<size_t>(extra); }
  17867. }
  17868. err.code = ErrorCode::Success;
  17869. return static_cast<ssize_t>(n);
  17870. }
  17871. int ret;
  17872. do {
  17873. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17874. len);
  17875. } while (impl::mbedtls_is_session_ticket(ret));
  17876. if (ret > 0) {
  17877. err.code = ErrorCode::Success;
  17878. return static_cast<ssize_t>(ret);
  17879. }
  17880. if (ret == 0) {
  17881. err.code = ErrorCode::PeerClosed;
  17882. return 0;
  17883. }
  17884. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17885. err.backend_code = static_cast<uint64_t>(-ret);
  17886. impl::mbedtls_last_error() = ret;
  17887. // mbedTLS signals a clean close_notify via a negative error code rather
  17888. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17889. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17890. return -1;
  17891. }
  17892. inline ssize_t write(session_t session, const void *buf, size_t len,
  17893. TlsError &err) {
  17894. if (!session || !buf) {
  17895. err.code = ErrorCode::Fatal;
  17896. return -1;
  17897. }
  17898. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17899. int ret;
  17900. do {
  17901. ret = mbedtls_ssl_write(&msession->ssl,
  17902. static_cast<const unsigned char *>(buf), len);
  17903. } while (impl::mbedtls_is_session_ticket(ret));
  17904. if (ret > 0) {
  17905. err.code = ErrorCode::Success;
  17906. return static_cast<ssize_t>(ret);
  17907. }
  17908. if (ret == 0) {
  17909. err.code = ErrorCode::PeerClosed;
  17910. return 0;
  17911. }
  17912. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17913. err.backend_code = static_cast<uint64_t>(-ret);
  17914. impl::mbedtls_last_error() = ret;
  17915. return -1;
  17916. }
  17917. inline int pending(const_session_t session) {
  17918. if (!session) { return 0; }
  17919. auto msession =
  17920. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17921. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17922. (msession->has_peeked_byte ? 1 : 0);
  17923. }
  17924. inline void shutdown(session_t session, bool graceful) {
  17925. if (!session) { return; }
  17926. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17927. if (graceful) {
  17928. // Try to send close_notify, but don't block forever
  17929. int ret;
  17930. int attempts = 0;
  17931. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17932. attempts < 3) {
  17933. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17934. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17935. break;
  17936. }
  17937. attempts++;
  17938. }
  17939. }
  17940. }
  17941. inline bool is_peer_closed(session_t session, socket_t sock) {
  17942. if (!session || sock == INVALID_SOCKET) { return true; }
  17943. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17944. // Check if there's already decrypted or pushed-back data available.
  17945. // If so, the connection is definitely alive.
  17946. if (msession->has_peeked_byte ||
  17947. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17948. return false;
  17949. }
  17950. // Set socket to non-blocking to avoid blocking on read
  17951. detail::set_nonblocking(sock, true);
  17952. auto cleanup =
  17953. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17954. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17955. // on application data — e.g. a response that already arrived — push the
  17956. // byte back so the next read() delivers it instead of losing it.
  17957. unsigned char buf;
  17958. int ret;
  17959. do {
  17960. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17961. } while (impl::mbedtls_is_session_ticket(ret));
  17962. // If we got data or WANT_READ (would block), connection is alive
  17963. if (ret > 0) {
  17964. msession->peeked_byte = buf;
  17965. msession->has_peeked_byte = true;
  17966. return false;
  17967. }
  17968. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17969. // If we get a peer close notify or a connection reset, the peer is closed
  17970. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17971. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17972. }
  17973. inline cert_t get_peer_cert(const_session_t session) {
  17974. if (!session) { return nullptr; }
  17975. auto msession =
  17976. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17977. // Mbed TLS returns a pointer to the internal peer cert chain.
  17978. // WARNING: This pointer is only valid while the session is active.
  17979. // Do not use the certificate after calling free_session().
  17980. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17981. return const_cast<mbedtls_x509_crt *>(cert);
  17982. }
  17983. inline size_t get_peer_certs(const_session_t session,
  17984. std::vector<cert_t> &certs) {
  17985. certs.clear();
  17986. // Mbed TLS parses the whole received chain into a list headed by the peer
  17987. // certificate, owned by the session like get_peer_cert()'s result
  17988. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  17989. crt && crt->raw.len > 0; crt = crt->next) {
  17990. certs.push_back(static_cast<cert_t>(crt));
  17991. }
  17992. return certs.size();
  17993. }
  17994. inline void free_cert(cert_t cert) {
  17995. // Mbed TLS: peer certificate is owned by the SSL context.
  17996. // No-op here, but callers should still call this for cross-backend
  17997. // portability.
  17998. (void)cert;
  17999. }
  18000. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18001. if (!cert || !hostname) { return false; }
  18002. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18003. std::string host_str(hostname);
  18004. // Check if hostname is an IP address (IPv4 or IPv6)
  18005. unsigned char ip_bytes[16];
  18006. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18007. auto is_ip = ip_len > 0;
  18008. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18009. // in buf.tag and the raw value in buf.p / buf.len.
  18010. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18011. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18012. const unsigned char *p = san->buf.p;
  18013. size_t len = san->buf.len;
  18014. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18015. if (is_ip) {
  18016. // For an IP host, only a matching iPAddress SAN of the same family
  18017. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18018. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18019. memcmp(p, ip_bytes, ip_len) == 0) {
  18020. return true;
  18021. }
  18022. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18023. std::string san_name(reinterpret_cast<const char *>(p), len);
  18024. if (detail::match_hostname(san_name, host_str)) { return true; }
  18025. }
  18026. san = san->next;
  18027. }
  18028. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18029. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18030. // the OpenSSL backend's X509_check_ip behaves the same way).
  18031. if (!is_ip) {
  18032. char cn[256];
  18033. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18034. if (ret > 0) {
  18035. std::string cn_str(cn);
  18036. // Look for "CN=" in the DN string
  18037. size_t cn_pos = cn_str.find("CN=");
  18038. if (cn_pos != std::string::npos) {
  18039. size_t start = cn_pos + 3;
  18040. size_t end = cn_str.find(',', start);
  18041. std::string cn_value =
  18042. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18043. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18044. }
  18045. }
  18046. }
  18047. return false;
  18048. }
  18049. inline uint64_t hostname_mismatch_code() {
  18050. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18051. }
  18052. inline long get_verify_result(const_session_t session) {
  18053. if (!session) { return -1; }
  18054. auto msession =
  18055. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18056. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18057. // Return 0 (X509_V_OK equivalent) if verification passed
  18058. return flags == 0 ? 0 : static_cast<long>(flags);
  18059. }
  18060. inline std::string get_cert_subject_cn(cert_t cert) {
  18061. if (!cert) return "";
  18062. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18063. // Find the CN in the subject
  18064. const mbedtls_x509_name *name = &x509->subject;
  18065. while (name != nullptr) {
  18066. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18067. return std::string(reinterpret_cast<const char *>(name->val.p),
  18068. name->val.len);
  18069. }
  18070. name = name->next;
  18071. }
  18072. return "";
  18073. }
  18074. inline std::string get_cert_issuer_name(cert_t cert) {
  18075. if (!cert) return "";
  18076. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18077. // Build a human-readable issuer name string
  18078. char buf[512];
  18079. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18080. if (ret < 0) return "";
  18081. return std::string(buf);
  18082. }
  18083. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18084. sans.clear();
  18085. if (!cert) return false;
  18086. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18087. // Parse the Subject Alternative Name extension
  18088. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18089. while (cur != nullptr) {
  18090. if (cur->buf.len > 0) {
  18091. const unsigned char *p = cur->buf.p;
  18092. size_t value_len = cur->buf.len;
  18093. SanEntry entry;
  18094. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18095. case MBEDTLS_X509_SAN_DNS_NAME:
  18096. entry.type = SanType::DNS;
  18097. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18098. break;
  18099. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18100. entry.type = SanType::IP;
  18101. if (value_len == 4) {
  18102. // IPv4
  18103. char buf[16];
  18104. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18105. entry.value = buf;
  18106. } else if (value_len == 16) {
  18107. // IPv6
  18108. char buf[64];
  18109. snprintf(buf, sizeof(buf),
  18110. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18111. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18112. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18113. p[10], p[11], p[12], p[13], p[14], p[15]);
  18114. entry.value = buf;
  18115. }
  18116. break;
  18117. case MBEDTLS_X509_SAN_RFC822_NAME:
  18118. entry.type = SanType::EMAIL;
  18119. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18120. break;
  18121. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18122. entry.type = SanType::URI;
  18123. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18124. break;
  18125. default: entry.type = SanType::OTHER; break;
  18126. }
  18127. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18128. }
  18129. cur = cur->next;
  18130. }
  18131. return true;
  18132. }
  18133. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18134. time_t &not_after) {
  18135. if (!cert) return false;
  18136. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18137. // Convert mbedtls_x509_time to time_t
  18138. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18139. struct tm tm_time = {};
  18140. tm_time.tm_year = t.year - 1900;
  18141. tm_time.tm_mon = t.mon - 1;
  18142. tm_time.tm_mday = t.day;
  18143. tm_time.tm_hour = t.hour;
  18144. tm_time.tm_min = t.min;
  18145. tm_time.tm_sec = t.sec;
  18146. #ifdef _WIN32
  18147. return _mkgmtime(&tm_time);
  18148. #else
  18149. return timegm(&tm_time);
  18150. #endif
  18151. };
  18152. not_before = to_time_t(x509->valid_from);
  18153. not_after = to_time_t(x509->valid_to);
  18154. return true;
  18155. }
  18156. inline std::string get_cert_serial(cert_t cert) {
  18157. if (!cert) return "";
  18158. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18159. // Convert serial number to hex string
  18160. std::string result;
  18161. result.reserve(x509->serial.len * 2);
  18162. for (size_t i = 0; i < x509->serial.len; i++) {
  18163. char hex[3];
  18164. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18165. result += hex;
  18166. }
  18167. return result;
  18168. }
  18169. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18170. if (!cert) return false;
  18171. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18172. if (!crt->raw.p || crt->raw.len == 0) return false;
  18173. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18174. return true;
  18175. }
  18176. inline const char *get_sni(const_session_t session) {
  18177. if (!session) return nullptr;
  18178. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18179. // For server: return SNI received from client during handshake
  18180. if (!msession->sni_hostname.empty()) {
  18181. return msession->sni_hostname.c_str();
  18182. }
  18183. // For client: return the hostname set via set_sni
  18184. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18185. return nullptr;
  18186. }
  18187. inline uint64_t peek_error() {
  18188. // Mbed TLS doesn't have an error queue, return the last error
  18189. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18190. }
  18191. inline uint64_t get_error() {
  18192. // Mbed TLS doesn't have an error queue, return and clear the last error
  18193. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18194. impl::mbedtls_last_error() = 0;
  18195. return err;
  18196. }
  18197. inline std::string error_string(uint64_t code) {
  18198. char buf[256];
  18199. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18200. return std::string(buf);
  18201. }
  18202. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18203. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18204. if (!ca_chain) { return nullptr; }
  18205. mbedtls_x509_crt_init(ca_chain);
  18206. // mbedtls_x509_crt_parse expects null-terminated PEM
  18207. int ret = mbedtls_x509_crt_parse(ca_chain,
  18208. reinterpret_cast<const unsigned char *>(pem),
  18209. len + 1); // +1 for null terminator
  18210. if (ret != 0) {
  18211. // Try without +1 in case PEM is already null-terminated
  18212. ret = mbedtls_x509_crt_parse(
  18213. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18214. if (ret != 0) {
  18215. mbedtls_x509_crt_free(ca_chain);
  18216. delete ca_chain;
  18217. return nullptr;
  18218. }
  18219. }
  18220. return static_cast<ca_store_t>(ca_chain);
  18221. }
  18222. inline void free_ca_store(ca_store_t store) {
  18223. if (store) {
  18224. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18225. mbedtls_x509_crt_free(ca_chain);
  18226. delete ca_chain;
  18227. }
  18228. }
  18229. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18230. if (!ctx || !store) { return false; }
  18231. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18232. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18233. // Free existing CA chain
  18234. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18235. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18236. // Copy the CA chain (deep copy)
  18237. // Parse from the raw data of the source cert
  18238. mbedtls_x509_crt *src = ca_chain;
  18239. while (src != nullptr) {
  18240. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18241. src->raw.len);
  18242. if (ret != 0) {
  18243. free_ca_store(store);
  18244. return false;
  18245. }
  18246. src = src->next;
  18247. }
  18248. // This function takes ownership of the store; the chain was deep-copied
  18249. // above, so release the source
  18250. free_ca_store(store);
  18251. // Update the SSL config to use the new CA chain
  18252. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18253. return true;
  18254. }
  18255. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18256. certs.clear();
  18257. if (!ctx) { return 0; }
  18258. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18259. // Iterate through the CA chain
  18260. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18261. while (cert != nullptr && cert->raw.len > 0) {
  18262. // Create a copy of the certificate for the caller
  18263. auto *copy = new mbedtls_x509_crt;
  18264. mbedtls_x509_crt_init(copy);
  18265. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18266. if (ret == 0) {
  18267. certs.push_back(static_cast<cert_t>(copy));
  18268. } else {
  18269. mbedtls_x509_crt_free(copy);
  18270. delete copy;
  18271. }
  18272. cert = cert->next;
  18273. }
  18274. return certs.size();
  18275. }
  18276. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18277. std::vector<std::string> names;
  18278. if (!ctx) { return names; }
  18279. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18280. // Iterate through the CA chain
  18281. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18282. while (cert != nullptr && cert->raw.len > 0) {
  18283. char buf[512];
  18284. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18285. if (ret > 0) { names.push_back(buf); }
  18286. cert = cert->next;
  18287. }
  18288. return names;
  18289. }
  18290. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18291. const char *key_pem, const char *password) {
  18292. if (!ctx || !cert_pem || !key_pem) { return false; }
  18293. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18294. // Free existing certificate and key
  18295. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18296. mbedtls_pk_free(&mbed_ctx->own_key);
  18297. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18298. mbedtls_pk_init(&mbed_ctx->own_key);
  18299. // Parse certificate PEM
  18300. int ret = mbedtls_x509_crt_parse(
  18301. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18302. strlen(cert_pem) + 1);
  18303. if (ret != 0) {
  18304. impl::mbedtls_last_error() = ret;
  18305. return false;
  18306. }
  18307. // Parse private key PEM
  18308. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18309. ret = mbedtls_pk_parse_key(
  18310. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18311. strlen(key_pem) + 1,
  18312. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18313. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18314. &mbed_ctx->ctr_drbg);
  18315. #else
  18316. ret = mbedtls_pk_parse_key(
  18317. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18318. strlen(key_pem) + 1,
  18319. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18320. password ? strlen(password) : 0);
  18321. #endif
  18322. if (ret != 0) {
  18323. impl::mbedtls_last_error() = ret;
  18324. return false;
  18325. }
  18326. // Configure SSL to use the new certificate and key
  18327. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18328. &mbed_ctx->own_key);
  18329. if (ret != 0) {
  18330. impl::mbedtls_last_error() = ret;
  18331. return false;
  18332. }
  18333. return true;
  18334. }
  18335. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18336. if (!ctx || !ca_pem) { return false; }
  18337. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18338. // Free existing CA chain
  18339. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18340. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18341. // Parse CA PEM
  18342. int ret = mbedtls_x509_crt_parse(
  18343. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18344. strlen(ca_pem) + 1);
  18345. if (ret != 0) {
  18346. impl::mbedtls_last_error() = ret;
  18347. return false;
  18348. }
  18349. // Update SSL config to use new CA chain
  18350. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18351. return true;
  18352. }
  18353. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18354. if (!ctx) { return false; }
  18355. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18356. impl::get_verify_callback() = std::move(callback);
  18357. mbed_ctx->has_verify_callback =
  18358. static_cast<bool>(impl::get_verify_callback());
  18359. if (mbed_ctx->has_verify_callback) {
  18360. // Set OPTIONAL mode to ensure callback is called even when verification
  18361. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18362. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18363. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18364. nullptr);
  18365. } else {
  18366. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18367. }
  18368. return true;
  18369. }
  18370. inline long get_verify_error(const_session_t session) {
  18371. if (!session) { return -1; }
  18372. auto *msession =
  18373. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18374. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18375. }
  18376. inline std::string verify_error_string(long error_code) {
  18377. if (error_code == 0) { return ""; }
  18378. char buf[256];
  18379. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18380. static_cast<uint32_t>(error_code));
  18381. // Remove trailing newline if present
  18382. std::string result(buf);
  18383. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18384. result.pop_back();
  18385. }
  18386. return result;
  18387. }
  18388. } // namespace tls
  18389. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18390. /*
  18391. * Group 10: TLS abstraction layer - wolfSSL backend
  18392. */
  18393. /*
  18394. * wolfSSL Backend Implementation
  18395. */
  18396. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18397. namespace tls {
  18398. namespace impl {
  18399. // wolfSSL session wrapper
  18400. struct WolfSSLSession {
  18401. WOLFSSL *ssl = nullptr;
  18402. socket_t sock = INVALID_SOCKET;
  18403. std::string hostname; // For client: set via set_sni
  18404. std::string sni_hostname; // For server: received from client via SNI callback
  18405. WolfSSLSession() = default;
  18406. ~WolfSSLSession() {
  18407. if (ssl) { wolfSSL_free(ssl); }
  18408. }
  18409. WolfSSLSession(const WolfSSLSession &) = delete;
  18410. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18411. };
  18412. // Thread-local error code accessor for wolfSSL
  18413. inline uint64_t &wolfssl_last_error() {
  18414. static thread_local uint64_t err = 0;
  18415. return err;
  18416. }
  18417. // Helper to map wolfSSL error to ErrorCode.
  18418. // ssl_error is the value from wolfSSL_get_error().
  18419. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18420. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18421. int &out_errno) {
  18422. switch (ssl_error) {
  18423. case SSL_ERROR_NONE: return ErrorCode::Success;
  18424. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18425. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18426. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18427. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18428. default:
  18429. if (ssl) {
  18430. // wolfSSL stores the low-level error code as a negative value.
  18431. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18432. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18433. if (low_err == DOMAIN_NAME_MISMATCH) {
  18434. return ErrorCode::HostnameMismatch;
  18435. }
  18436. // Check verify result to distinguish cert verification from generic SSL
  18437. // errors.
  18438. long vr = wolfSSL_get_verify_result(ssl);
  18439. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18440. }
  18441. return ErrorCode::Fatal;
  18442. }
  18443. }
  18444. // WolfSSLContext constructor/destructor implementations
  18445. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18446. inline WolfSSLContext::~WolfSSLContext() {
  18447. if (ctx) { wolfSSL_CTX_free(ctx); }
  18448. }
  18449. // Thread-local storage for SNI captured during handshake
  18450. inline std::string &wolfssl_pending_sni() {
  18451. static thread_local std::string sni;
  18452. return sni;
  18453. }
  18454. // SNI callback for wolfSSL server to capture client's SNI hostname
  18455. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18456. (void)ret;
  18457. (void)exArg;
  18458. void *name_data = nullptr;
  18459. unsigned short name_len =
  18460. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18461. if (name_data && name_len > 0) {
  18462. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18463. name_len);
  18464. } else {
  18465. wolfssl_pending_sni().clear();
  18466. }
  18467. return 0; // Continue regardless
  18468. }
  18469. // wolfSSL verify callback wrapper
  18470. inline int wolfssl_verify_callback(int preverify_ok,
  18471. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18472. auto &callback = get_verify_callback();
  18473. if (!callback) { return preverify_ok; }
  18474. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18475. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18476. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18477. // Get the WOLFSSL object from the X509_STORE_CTX
  18478. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18479. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18480. VerifyContext verify_ctx;
  18481. verify_ctx.session = static_cast<session_t>(ssl);
  18482. verify_ctx.cert = static_cast<cert_t>(cert);
  18483. verify_ctx.depth = depth;
  18484. verify_ctx.preverify_ok = (preverify_ok != 0);
  18485. verify_ctx.error_code = static_cast<long>(err);
  18486. if (err != 0) {
  18487. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18488. } else {
  18489. verify_ctx.error_string = nullptr;
  18490. }
  18491. bool accepted = callback(verify_ctx);
  18492. return accepted ? 1 : 0;
  18493. }
  18494. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18495. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18496. wolfSSL_CTX_set_default_passwd_cb(
  18497. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18498. auto *pwd = static_cast<const char *>(userdata);
  18499. if (!pwd) return 0;
  18500. auto len = static_cast<int>(strlen(pwd));
  18501. if (len > size) len = size;
  18502. memcpy(buf, pwd, static_cast<size_t>(len));
  18503. return len;
  18504. });
  18505. }
  18506. } // namespace impl
  18507. inline ctx_t create_client_context() {
  18508. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18509. if (!ctx) { return nullptr; }
  18510. ctx->is_server = false;
  18511. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18512. if (!method) {
  18513. delete ctx;
  18514. return nullptr;
  18515. }
  18516. ctx->ctx = wolfSSL_CTX_new(method);
  18517. if (!ctx->ctx) {
  18518. delete ctx;
  18519. return nullptr;
  18520. }
  18521. // Default: verify peer certificate
  18522. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18523. return static_cast<ctx_t>(ctx);
  18524. }
  18525. inline ctx_t create_server_context() {
  18526. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18527. if (!ctx) { return nullptr; }
  18528. ctx->is_server = true;
  18529. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18530. if (!method) {
  18531. delete ctx;
  18532. return nullptr;
  18533. }
  18534. ctx->ctx = wolfSSL_CTX_new(method);
  18535. if (!ctx->ctx) {
  18536. delete ctx;
  18537. return nullptr;
  18538. }
  18539. // Default: don't verify client
  18540. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18541. // Enable SNI on server
  18542. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18543. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18544. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18545. return static_cast<ctx_t>(ctx);
  18546. }
  18547. inline void free_context(ctx_t ctx) {
  18548. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18549. }
  18550. inline bool set_min_version(ctx_t ctx, Version version) {
  18551. if (!ctx) { return false; }
  18552. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18553. int min_ver = WOLFSSL_TLSV1_2;
  18554. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18555. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18556. }
  18557. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18558. if (!ctx || !pem) { return false; }
  18559. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18560. int ret = wolfSSL_CTX_load_verify_buffer(
  18561. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18562. static_cast<long>(len), SSL_FILETYPE_PEM);
  18563. if (ret != SSL_SUCCESS) {
  18564. impl::wolfssl_last_error() =
  18565. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18566. return false;
  18567. }
  18568. wctx->ca_pem_data_.append(pem, len);
  18569. return true;
  18570. }
  18571. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18572. if (!ctx || !file_path) { return false; }
  18573. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18574. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18575. if (ret != SSL_SUCCESS) {
  18576. impl::wolfssl_last_error() =
  18577. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18578. return false;
  18579. }
  18580. return true;
  18581. }
  18582. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18583. if (!ctx || !dir_path) { return false; }
  18584. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18585. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18586. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18587. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18588. // immediately. Return true even on failure since the CA file may have
  18589. // already been loaded, matching OpenSSL's lenient behavior.
  18590. (void)ret;
  18591. return true;
  18592. }
  18593. inline bool load_system_certs(ctx_t ctx) {
  18594. if (!ctx) { return false; }
  18595. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18596. bool loaded = false;
  18597. #ifdef _WIN32
  18598. loaded = impl::enumerate_windows_system_certs(
  18599. [&](const unsigned char *data, size_t len) {
  18600. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18601. static_cast<long>(len),
  18602. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18603. });
  18604. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18605. loaded = impl::enumerate_macos_keychain_certs(
  18606. [&](const unsigned char *data, size_t len) {
  18607. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18608. static_cast<long>(len),
  18609. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18610. });
  18611. #else
  18612. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18613. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18614. SSL_SUCCESS) {
  18615. loaded = true;
  18616. break;
  18617. }
  18618. }
  18619. if (!loaded) {
  18620. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18621. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18622. SSL_SUCCESS) {
  18623. loaded = true;
  18624. break;
  18625. }
  18626. }
  18627. }
  18628. #endif
  18629. return loaded;
  18630. }
  18631. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18632. const char *password) {
  18633. if (!ctx || !cert || !key) { return false; }
  18634. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18635. // Load certificate
  18636. int ret = wolfSSL_CTX_use_certificate_buffer(
  18637. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18638. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18639. if (ret != SSL_SUCCESS) {
  18640. impl::wolfssl_last_error() =
  18641. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18642. return false;
  18643. }
  18644. // Set password callback if password is provided
  18645. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18646. // Load private key
  18647. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18648. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18649. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18650. if (ret != SSL_SUCCESS) {
  18651. impl::wolfssl_last_error() =
  18652. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18653. return false;
  18654. }
  18655. // Verify that the certificate and private key match
  18656. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18657. }
  18658. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18659. const char *key_path, const char *password) {
  18660. if (!ctx || !cert_path || !key_path) { return false; }
  18661. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18662. // Load certificate file
  18663. int ret =
  18664. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18665. if (ret != SSL_SUCCESS) {
  18666. impl::wolfssl_last_error() =
  18667. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18668. return false;
  18669. }
  18670. // Set password callback if password is provided
  18671. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18672. // Load private key file
  18673. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18674. if (ret != SSL_SUCCESS) {
  18675. impl::wolfssl_last_error() =
  18676. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18677. return false;
  18678. }
  18679. // Verify that the certificate and private key match
  18680. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18681. }
  18682. inline void set_verify_client(ctx_t ctx, bool require) {
  18683. if (!ctx) { return; }
  18684. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18685. wctx->verify_client = require;
  18686. if (require) {
  18687. wolfSSL_CTX_set_verify(
  18688. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18689. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18690. } else {
  18691. if (wctx->has_verify_callback) {
  18692. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18693. impl::wolfssl_verify_callback);
  18694. } else {
  18695. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18696. }
  18697. }
  18698. }
  18699. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18700. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18701. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18702. auto session = new (std::nothrow) impl::WolfSSLSession();
  18703. if (!session) { return nullptr; }
  18704. session->sock = sock;
  18705. session->ssl = wolfSSL_new(wctx->ctx);
  18706. if (!session->ssl) {
  18707. impl::wolfssl_last_error() =
  18708. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18709. delete session;
  18710. return nullptr;
  18711. }
  18712. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18713. return static_cast<session_t>(session);
  18714. }
  18715. inline void free_session(session_t session) {
  18716. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18717. }
  18718. inline bool set_sni(session_t session, const char *hostname,
  18719. bool verify_hostname) {
  18720. if (!session || !hostname) { return false; }
  18721. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18722. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18723. static_cast<word16>(strlen(hostname)));
  18724. if (ret != WOLFSSL_SUCCESS) {
  18725. impl::wolfssl_last_error() =
  18726. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18727. return false;
  18728. }
  18729. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18730. // separately from the SNI extension sent above; skip it when hostname
  18731. // verification is disabled so only the chain is checked, matching OpenSSL.
  18732. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18733. wsession->hostname = hostname;
  18734. return true;
  18735. }
  18736. inline TlsError connect(session_t session) {
  18737. TlsError err;
  18738. if (!session) {
  18739. err.code = ErrorCode::Fatal;
  18740. return err;
  18741. }
  18742. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18743. int ret = wolfSSL_connect(wsession->ssl);
  18744. if (ret == SSL_SUCCESS) {
  18745. err.code = ErrorCode::Success;
  18746. } else {
  18747. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18748. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18749. err.backend_code = static_cast<uint64_t>(ssl_error);
  18750. impl::wolfssl_last_error() = err.backend_code;
  18751. }
  18752. return err;
  18753. }
  18754. inline TlsError accept(session_t session) {
  18755. TlsError err;
  18756. if (!session) {
  18757. err.code = ErrorCode::Fatal;
  18758. return err;
  18759. }
  18760. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18761. int ret = wolfSSL_accept(wsession->ssl);
  18762. if (ret == SSL_SUCCESS) {
  18763. err.code = ErrorCode::Success;
  18764. // Capture SNI from thread-local storage after successful handshake
  18765. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18766. impl::wolfssl_pending_sni().clear();
  18767. } else {
  18768. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18769. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18770. err.backend_code = static_cast<uint64_t>(ssl_error);
  18771. impl::wolfssl_last_error() = err.backend_code;
  18772. }
  18773. return err;
  18774. }
  18775. inline bool connect_nonblocking(session_t session, socket_t sock,
  18776. time_t timeout_sec, time_t timeout_usec,
  18777. TlsError *err) {
  18778. if (!session) {
  18779. if (err) { err->code = ErrorCode::Fatal; }
  18780. return false;
  18781. }
  18782. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18783. // Set socket to non-blocking mode
  18784. detail::set_nonblocking(sock, true);
  18785. auto cleanup =
  18786. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18787. int ret;
  18788. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18789. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18790. if (ssl_error == SSL_ERROR_WANT_READ) {
  18791. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18792. continue;
  18793. }
  18794. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18795. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18796. continue;
  18797. }
  18798. }
  18799. // Error or timeout
  18800. if (err) {
  18801. err->code =
  18802. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18803. err->backend_code = static_cast<uint64_t>(ssl_error);
  18804. }
  18805. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18806. return false;
  18807. }
  18808. if (err) { err->code = ErrorCode::Success; }
  18809. return true;
  18810. }
  18811. inline bool accept_nonblocking(session_t session, socket_t sock,
  18812. time_t timeout_sec, time_t timeout_usec,
  18813. TlsError *err) {
  18814. if (!session) {
  18815. if (err) { err->code = ErrorCode::Fatal; }
  18816. return false;
  18817. }
  18818. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18819. // Set socket to non-blocking mode
  18820. detail::set_nonblocking(sock, true);
  18821. auto cleanup =
  18822. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18823. int ret;
  18824. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18825. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18826. if (ssl_error == SSL_ERROR_WANT_READ) {
  18827. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18828. continue;
  18829. }
  18830. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18831. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18832. continue;
  18833. }
  18834. }
  18835. // Error or timeout
  18836. if (err) {
  18837. err->code =
  18838. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18839. err->backend_code = static_cast<uint64_t>(ssl_error);
  18840. }
  18841. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18842. return false;
  18843. }
  18844. if (err) { err->code = ErrorCode::Success; }
  18845. // Capture SNI from thread-local storage after successful handshake
  18846. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18847. impl::wolfssl_pending_sni().clear();
  18848. return true;
  18849. }
  18850. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18851. if (!session || !buf) {
  18852. err.code = ErrorCode::Fatal;
  18853. return -1;
  18854. }
  18855. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18856. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18857. if (ret > 0) {
  18858. err.code = ErrorCode::Success;
  18859. return static_cast<ssize_t>(ret);
  18860. }
  18861. if (ret == 0) {
  18862. err.code = ErrorCode::PeerClosed;
  18863. return 0;
  18864. }
  18865. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18866. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18867. err.backend_code = static_cast<uint64_t>(ssl_error);
  18868. impl::wolfssl_last_error() = err.backend_code;
  18869. return -1;
  18870. }
  18871. inline ssize_t write(session_t session, const void *buf, size_t len,
  18872. TlsError &err) {
  18873. if (!session || !buf) {
  18874. err.code = ErrorCode::Fatal;
  18875. return -1;
  18876. }
  18877. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18878. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18879. if (ret > 0) {
  18880. err.code = ErrorCode::Success;
  18881. return static_cast<ssize_t>(ret);
  18882. }
  18883. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18884. // Treat this as an error (return -1) so callers don't spin in a
  18885. // write loop adding zero to the offset.
  18886. if (ret == 0) {
  18887. err.code = ErrorCode::PeerClosed;
  18888. return -1;
  18889. }
  18890. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18891. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18892. err.backend_code = static_cast<uint64_t>(ssl_error);
  18893. impl::wolfssl_last_error() = err.backend_code;
  18894. return -1;
  18895. }
  18896. inline int pending(const_session_t session) {
  18897. if (!session) { return 0; }
  18898. auto wsession =
  18899. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18900. return wolfSSL_pending(wsession->ssl);
  18901. }
  18902. inline void shutdown(session_t session, bool graceful) {
  18903. if (!session) { return; }
  18904. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18905. if (graceful) {
  18906. int ret;
  18907. int attempts = 0;
  18908. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18909. attempts < 3) {
  18910. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18911. if (ssl_error != SSL_ERROR_WANT_READ &&
  18912. ssl_error != SSL_ERROR_WANT_WRITE) {
  18913. break;
  18914. }
  18915. attempts++;
  18916. }
  18917. } else {
  18918. wolfSSL_shutdown(wsession->ssl);
  18919. }
  18920. }
  18921. inline bool is_peer_closed(session_t session, socket_t sock) {
  18922. if (!session || sock == INVALID_SOCKET) { return true; }
  18923. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18924. // Check if there's already decrypted data available
  18925. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18926. // Set socket to non-blocking to avoid blocking on read
  18927. detail::set_nonblocking(sock, true);
  18928. auto cleanup =
  18929. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18930. // Peek 1 byte to check connection status without consuming data
  18931. unsigned char buf;
  18932. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18933. // If we got data or WANT_READ (would block), connection is alive
  18934. if (ret > 0) { return false; }
  18935. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18936. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18937. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18938. ret == 0;
  18939. }
  18940. inline cert_t get_peer_cert(const_session_t session) {
  18941. if (!session) { return nullptr; }
  18942. auto wsession =
  18943. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18944. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18945. return static_cast<cert_t>(cert);
  18946. }
  18947. inline size_t get_peer_certs(const_session_t session,
  18948. std::vector<cert_t> &certs) {
  18949. certs.clear();
  18950. if (!session) { return 0; }
  18951. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  18952. #ifdef SESSION_CERTS
  18953. auto wsession =
  18954. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18955. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  18956. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  18957. for (int i = 0; i < count; i++) {
  18958. auto x509 = wolfSSL_get_chain_X509(chain, i);
  18959. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18960. }
  18961. #endif
  18962. return certs.size();
  18963. }
  18964. inline void free_cert(cert_t cert) {
  18965. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18966. }
  18967. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18968. if (!cert || !hostname) { return false; }
  18969. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18970. std::string host_str(hostname);
  18971. // Check if hostname is an IP address (IPv4 or IPv6)
  18972. unsigned char ip_bytes[16];
  18973. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18974. auto is_ip = ip_len > 0;
  18975. // Check Subject Alternative Names
  18976. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18977. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18978. if (san_names) {
  18979. int san_count = wolfSSL_sk_num(san_names);
  18980. for (int i = 0; i < san_count; i++) {
  18981. auto *names =
  18982. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18983. if (!names) continue;
  18984. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18985. // DNS name
  18986. unsigned char *dns_name = nullptr;
  18987. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18988. if (dns_name && dns_len > 0) {
  18989. std::string san_name(reinterpret_cast<char *>(dns_name),
  18990. static_cast<size_t>(dns_len));
  18991. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18992. if (detail::match_hostname(san_name, host_str)) {
  18993. wolfSSL_sk_free(san_names);
  18994. return true;
  18995. }
  18996. }
  18997. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18998. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18999. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19000. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19001. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19002. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19003. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19004. wolfSSL_sk_free(san_names);
  19005. return true;
  19006. }
  19007. }
  19008. }
  19009. wolfSSL_sk_free(san_names);
  19010. }
  19011. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19012. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19013. // the OpenSSL backend's X509_check_ip behaves the same way).
  19014. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19015. if (subject) {
  19016. char cn[256] = {};
  19017. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19018. sizeof(cn));
  19019. if (cn_len > 0) {
  19020. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19021. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19022. }
  19023. }
  19024. return false;
  19025. }
  19026. inline uint64_t hostname_mismatch_code() {
  19027. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19028. }
  19029. inline long get_verify_result(const_session_t session) {
  19030. if (!session) { return -1; }
  19031. auto wsession =
  19032. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19033. long result = wolfSSL_get_verify_result(wsession->ssl);
  19034. return result;
  19035. }
  19036. inline std::string get_cert_subject_cn(cert_t cert) {
  19037. if (!cert) return "";
  19038. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19039. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19040. if (!subject) return "";
  19041. char cn[256] = {};
  19042. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19043. sizeof(cn));
  19044. if (cn_len <= 0) return "";
  19045. return std::string(cn, static_cast<size_t>(cn_len));
  19046. }
  19047. inline std::string get_cert_issuer_name(cert_t cert) {
  19048. if (!cert) return "";
  19049. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19050. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19051. if (!issuer) return "";
  19052. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19053. if (!name_str) return "";
  19054. std::string result(name_str);
  19055. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19056. return result;
  19057. }
  19058. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19059. sans.clear();
  19060. if (!cert) return false;
  19061. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19062. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19063. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19064. if (!san_names) return true; // No SANs is not an error
  19065. int count = wolfSSL_sk_num(san_names);
  19066. for (int i = 0; i < count; i++) {
  19067. auto *name =
  19068. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19069. if (!name) continue;
  19070. SanEntry entry;
  19071. switch (name->type) {
  19072. case WOLFSSL_GEN_DNS: {
  19073. entry.type = SanType::DNS;
  19074. unsigned char *dns_name = nullptr;
  19075. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19076. if (dns_name && dns_len > 0) {
  19077. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19078. static_cast<size_t>(dns_len));
  19079. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19080. }
  19081. break;
  19082. }
  19083. case WOLFSSL_GEN_IPADD: {
  19084. entry.type = SanType::IP;
  19085. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19086. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19087. if (ip_data && ip_len == 4) {
  19088. char buf[16];
  19089. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19090. ip_data[2], ip_data[3]);
  19091. entry.value = buf;
  19092. } else if (ip_data && ip_len == 16) {
  19093. char buf[64];
  19094. snprintf(buf, sizeof(buf),
  19095. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19096. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19097. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19098. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19099. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19100. ip_data[14], ip_data[15]);
  19101. entry.value = buf;
  19102. }
  19103. break;
  19104. }
  19105. case WOLFSSL_GEN_EMAIL:
  19106. entry.type = SanType::EMAIL;
  19107. {
  19108. unsigned char *email = nullptr;
  19109. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19110. if (email && email_len > 0) {
  19111. entry.value = std::string(reinterpret_cast<char *>(email),
  19112. static_cast<size_t>(email_len));
  19113. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19114. }
  19115. }
  19116. break;
  19117. case WOLFSSL_GEN_URI:
  19118. entry.type = SanType::URI;
  19119. {
  19120. unsigned char *uri = nullptr;
  19121. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19122. &uri, name->d.uniformResourceIdentifier);
  19123. if (uri && uri_len > 0) {
  19124. entry.value = std::string(reinterpret_cast<char *>(uri),
  19125. static_cast<size_t>(uri_len));
  19126. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19127. }
  19128. }
  19129. break;
  19130. default: entry.type = SanType::OTHER; break;
  19131. }
  19132. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19133. }
  19134. wolfSSL_sk_free(san_names);
  19135. return true;
  19136. }
  19137. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19138. time_t &not_after) {
  19139. if (!cert) return false;
  19140. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19141. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19142. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19143. if (!nb || !na) return false;
  19144. // wolfSSL_ASN1_TIME_to_tm is available
  19145. struct tm tm_nb = {}, tm_na = {};
  19146. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19147. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19148. #ifdef _WIN32
  19149. not_before = _mkgmtime(&tm_nb);
  19150. not_after = _mkgmtime(&tm_na);
  19151. #else
  19152. not_before = timegm(&tm_nb);
  19153. not_after = timegm(&tm_na);
  19154. #endif
  19155. return true;
  19156. }
  19157. inline std::string get_cert_serial(cert_t cert) {
  19158. if (!cert) return "";
  19159. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19160. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19161. if (!serial_asn1) return "";
  19162. // Get the serial number data
  19163. int len = serial_asn1->length;
  19164. unsigned char *data = serial_asn1->data;
  19165. if (!data || len <= 0) return "";
  19166. std::string result;
  19167. result.reserve(static_cast<size_t>(len) * 2);
  19168. for (int i = 0; i < len; i++) {
  19169. char hex[3];
  19170. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19171. result += hex;
  19172. }
  19173. return result;
  19174. }
  19175. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19176. if (!cert) return false;
  19177. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19178. int der_len = 0;
  19179. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19180. if (!der_data || der_len <= 0) return false;
  19181. der.assign(der_data, der_data + der_len);
  19182. return true;
  19183. }
  19184. inline const char *get_sni(const_session_t session) {
  19185. if (!session) return nullptr;
  19186. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19187. // For server: return SNI received from client during handshake
  19188. if (!wsession->sni_hostname.empty()) {
  19189. return wsession->sni_hostname.c_str();
  19190. }
  19191. // For client: return the hostname set via set_sni
  19192. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19193. return nullptr;
  19194. }
  19195. inline uint64_t peek_error() {
  19196. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19197. }
  19198. inline uint64_t get_error() {
  19199. uint64_t err = impl::wolfssl_last_error();
  19200. impl::wolfssl_last_error() = 0;
  19201. return err;
  19202. }
  19203. inline std::string error_string(uint64_t code) {
  19204. char buf[256];
  19205. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19206. return std::string(buf);
  19207. }
  19208. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19209. if (!pem || len == 0) { return nullptr; }
  19210. // Validate by attempting to load into a temporary ctx
  19211. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19212. if (!tmp_ctx) { return nullptr; }
  19213. int ret = wolfSSL_CTX_load_verify_buffer(
  19214. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19215. static_cast<long>(len), SSL_FILETYPE_PEM);
  19216. wolfSSL_CTX_free(tmp_ctx);
  19217. if (ret != SSL_SUCCESS) { return nullptr; }
  19218. return static_cast<ca_store_t>(
  19219. new impl::WolfSSLCAStore{std::string(pem, len)});
  19220. }
  19221. inline void free_ca_store(ca_store_t store) {
  19222. delete static_cast<impl::WolfSSLCAStore *>(store);
  19223. }
  19224. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19225. if (!ctx || !store) { return false; }
  19226. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19227. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19228. int ret = wolfSSL_CTX_load_verify_buffer(
  19229. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19230. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19231. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19232. // This function takes ownership of the store; the PEM data was copied into
  19233. // the context, so release the source
  19234. free_ca_store(store);
  19235. return ret == SSL_SUCCESS;
  19236. }
  19237. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19238. certs.clear();
  19239. if (!ctx) { return 0; }
  19240. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19241. if (wctx->ca_pem_data_.empty()) { return 0; }
  19242. const std::string &pem = wctx->ca_pem_data_;
  19243. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19244. const std::string end_marker = "-----END CERTIFICATE-----";
  19245. size_t pos = 0;
  19246. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19247. size_t end_pos = pem.find(end_marker, pos);
  19248. if (end_pos == std::string::npos) { break; }
  19249. end_pos += end_marker.size();
  19250. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19251. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19252. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19253. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19254. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19255. pos = end_pos;
  19256. }
  19257. return certs.size();
  19258. }
  19259. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19260. std::vector<std::string> names;
  19261. if (!ctx) { return names; }
  19262. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19263. if (wctx->ca_pem_data_.empty()) { return names; }
  19264. const std::string &pem = wctx->ca_pem_data_;
  19265. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19266. const std::string end_marker = "-----END CERTIFICATE-----";
  19267. size_t pos = 0;
  19268. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19269. size_t end_pos = pem.find(end_marker, pos);
  19270. if (end_pos == std::string::npos) { break; }
  19271. end_pos += end_marker.size();
  19272. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19273. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19274. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19275. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19276. if (x509) {
  19277. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19278. if (subject) {
  19279. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19280. if (name_str) {
  19281. names.push_back(name_str);
  19282. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19283. }
  19284. }
  19285. wolfSSL_X509_free(x509);
  19286. }
  19287. pos = end_pos;
  19288. }
  19289. return names;
  19290. }
  19291. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19292. const char *key_pem, const char *password) {
  19293. if (!ctx || !cert_pem || !key_pem) { return false; }
  19294. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19295. // Load new certificate
  19296. int ret = wolfSSL_CTX_use_certificate_buffer(
  19297. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19298. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19299. if (ret != SSL_SUCCESS) {
  19300. impl::wolfssl_last_error() =
  19301. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19302. return false;
  19303. }
  19304. // Set password if provided
  19305. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19306. // Load new private key
  19307. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19308. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19309. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19310. if (ret != SSL_SUCCESS) {
  19311. impl::wolfssl_last_error() =
  19312. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19313. return false;
  19314. }
  19315. return true;
  19316. }
  19317. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19318. if (!ctx || !ca_pem) { return false; }
  19319. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19320. int ret = wolfSSL_CTX_load_verify_buffer(
  19321. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19322. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19323. if (ret != SSL_SUCCESS) {
  19324. impl::wolfssl_last_error() =
  19325. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19326. return false;
  19327. }
  19328. return true;
  19329. }
  19330. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19331. if (!ctx) { return false; }
  19332. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19333. impl::get_verify_callback() = std::move(callback);
  19334. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19335. if (wctx->has_verify_callback) {
  19336. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19337. impl::wolfssl_verify_callback);
  19338. } else {
  19339. wolfSSL_CTX_set_verify(
  19340. wctx->ctx,
  19341. wctx->verify_client
  19342. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19343. : SSL_VERIFY_NONE,
  19344. nullptr);
  19345. }
  19346. return true;
  19347. }
  19348. inline long get_verify_error(const_session_t session) {
  19349. if (!session) { return -1; }
  19350. auto *wsession =
  19351. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19352. return wolfSSL_get_verify_result(wsession->ssl);
  19353. }
  19354. inline std::string verify_error_string(long error_code) {
  19355. if (error_code == 0) { return ""; }
  19356. const char *str =
  19357. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19358. return str ? std::string(str) : std::string();
  19359. }
  19360. } // namespace tls
  19361. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19362. // WebSocket implementation
  19363. namespace ws {
  19364. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19365. bool fin) {
  19366. std::lock_guard<std::mutex> lock(write_mutex_);
  19367. if (closed_) { return false; }
  19368. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19369. }
  19370. inline ReadResult WebSocket::read(std::string &msg) {
  19371. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19372. while (!closed_) {
  19373. Opcode opcode;
  19374. std::string payload;
  19375. bool fin;
  19376. impl::FrameRead r =
  19377. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19378. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19379. // A timeout landed on a frame boundary: the connection is untouched and
  19380. // still usable, so hand control back without closing it. That is only
  19381. // useful to a caller who asked for the timeout; the compile-time default
  19382. // is a backstop against a peer gone quiet, and elapsing it closes the
  19383. // connection so a plain `while (ws.read(msg))` loop ends.
  19384. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19385. if (r != impl::FrameRead::Ok) {
  19386. closed_ = true;
  19387. return Fail;
  19388. }
  19389. switch (opcode) {
  19390. case Opcode::Ping: {
  19391. std::lock_guard<std::mutex> lock(write_mutex_);
  19392. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19393. payload.size(), true, !is_server_);
  19394. continue;
  19395. }
  19396. case Opcode::Pong: {
  19397. std::lock_guard<std::mutex> lock(ping_mutex_);
  19398. unacked_pings_ = 0;
  19399. continue;
  19400. }
  19401. case Opcode::Close: {
  19402. if (!closed_.exchange(true)) {
  19403. // Echo close frame back
  19404. std::lock_guard<std::mutex> lock(write_mutex_);
  19405. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19406. payload.size(), true, !is_server_);
  19407. }
  19408. return Fail;
  19409. }
  19410. case Opcode::Text:
  19411. case Opcode::Binary: {
  19412. auto result = opcode == Opcode::Text ? Text : Binary;
  19413. msg = std::move(payload);
  19414. // Handle fragmentation
  19415. if (!fin) {
  19416. while (true) {
  19417. Opcode cont_opcode;
  19418. std::string cont_payload;
  19419. bool cont_fin;
  19420. // A timeout is not reportable here: half of a fragmented message is
  19421. // already in `msg` and read() has no way to resume it, so it is a
  19422. // failure like any other. Timeouts are only ever seen on a message
  19423. // boundary.
  19424. if (impl::read_websocket_frame(
  19425. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19426. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19427. impl::FrameRead::Ok) {
  19428. closed_ = true;
  19429. return Fail;
  19430. }
  19431. if (cont_opcode == Opcode::Ping) {
  19432. std::lock_guard<std::mutex> lock(write_mutex_);
  19433. detail::write_websocket_frame(
  19434. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19435. true, !is_server_);
  19436. continue;
  19437. }
  19438. if (cont_opcode == Opcode::Pong) {
  19439. std::lock_guard<std::mutex> lock(ping_mutex_);
  19440. unacked_pings_ = 0;
  19441. continue;
  19442. }
  19443. if (cont_opcode == Opcode::Close) {
  19444. if (!closed_.exchange(true)) {
  19445. std::lock_guard<std::mutex> lock(write_mutex_);
  19446. detail::write_websocket_frame(
  19447. strm_, Opcode::Close, cont_payload.data(),
  19448. cont_payload.size(), true, !is_server_);
  19449. }
  19450. return Fail;
  19451. }
  19452. // RFC 6455: continuation frames must use opcode 0x0
  19453. if (cont_opcode != Opcode::Continuation) {
  19454. closed_ = true;
  19455. return Fail;
  19456. }
  19457. msg += cont_payload;
  19458. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19459. closed_ = true;
  19460. return Fail;
  19461. }
  19462. if (cont_fin) { break; }
  19463. }
  19464. }
  19465. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19466. if (result == Text && !impl::is_valid_utf8(msg)) {
  19467. // close() takes the read lock to wait for the peer's Close reply, so
  19468. // it must not run while this thread still holds it.
  19469. read_lock.unlock();
  19470. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19471. return Fail;
  19472. }
  19473. return result;
  19474. }
  19475. default: closed_ = true; return Fail;
  19476. }
  19477. }
  19478. return Fail;
  19479. }
  19480. inline bool WebSocket::send(const std::string &data) {
  19481. return send_frame(Opcode::Text, data.data(), data.size());
  19482. }
  19483. inline bool WebSocket::send(const char *data, size_t len) {
  19484. return send_frame(Opcode::Binary, data, len);
  19485. }
  19486. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19487. if (closed_.exchange(true)) { return; }
  19488. ping_cv_.notify_all();
  19489. std::string payload;
  19490. auto code = static_cast<uint16_t>(status);
  19491. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19492. payload.push_back(static_cast<char>(code & 0xFF));
  19493. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19494. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19495. payload += reason.substr(0, 123);
  19496. {
  19497. std::lock_guard<std::mutex> lock(write_mutex_);
  19498. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19499. payload.size(), true, !is_server_);
  19500. }
  19501. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19502. // Close response before closing the TCP connection.
  19503. //
  19504. // Wait only when no other thread is parsing frames. When one is, it is the
  19505. // thread positioned to see the peer's reply, and reading here would take
  19506. // bytes out of the message it is assembling. Bailing out also leaves the
  19507. // stream, including its read timeout, entirely to that thread.
  19508. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19509. if (!read_lock.owns_lock()) { return; }
  19510. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19511. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19512. Opcode op;
  19513. std::string resp;
  19514. bool fin;
  19515. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19516. impl::FrameRead::Ok) {
  19517. if (op == Opcode::Close) { break; }
  19518. }
  19519. }
  19520. inline WebSocket::~WebSocket() {
  19521. {
  19522. std::lock_guard<std::mutex> lock(ping_mutex_);
  19523. closed_ = true;
  19524. }
  19525. ping_cv_.notify_all();
  19526. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19527. }
  19528. inline void WebSocket::start_heartbeat() {
  19529. if (ping_interval_sec_ == 0) { return; }
  19530. ping_thread_ = std::thread([this]() {
  19531. std::unique_lock<std::mutex> lock(ping_mutex_);
  19532. // The predicate keeps a spurious wakeup from sending a ping early
  19533. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19534. [this]() { return closed_.load(); })) {
  19535. // If the peer has failed to respond to the previous pings, give up.
  19536. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19537. // opt-in liveness check controlled by max_missed_pongs_.
  19538. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19539. lock.unlock();
  19540. close(CloseStatus::GoingAway, "pong timeout");
  19541. // Wake a read() blocked on the unresponsive peer. Only the read side
  19542. // is shut down: a TLS backend answers the EOF with an alert, and
  19543. // writing it to a socket closed for writing raises SIGPIPE.
  19544. #ifdef _WIN32
  19545. shutdown(strm_.socket(), SD_RECEIVE);
  19546. #else
  19547. shutdown(strm_.socket(), SHUT_RD);
  19548. #endif
  19549. return;
  19550. }
  19551. lock.unlock();
  19552. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19553. lock.lock();
  19554. closed_ = true;
  19555. break;
  19556. }
  19557. lock.lock();
  19558. unacked_pings_++;
  19559. }
  19560. });
  19561. }
  19562. inline const Request &WebSocket::request() const { return req_; }
  19563. inline bool WebSocket::is_open() const { return !closed_; }
  19564. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19565. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19566. // poll(), where 0 would instead mean "return immediately", so hand it the
  19567. // negative poll uses for an unbounded wait.
  19568. if (sec == 0 && usec == 0) { sec = -1; }
  19569. strm_.set_read_timeout(sec, usec);
  19570. read_timeout_set_ = true;
  19571. }
  19572. // WebSocketClient implementation
  19573. inline WebSocketClient::WebSocketClient(
  19574. const std::string &scheme_host_port_path, const Headers &headers)
  19575. : headers_(headers) {
  19576. detail::UrlComponents uc;
  19577. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19578. !uc.host.empty() && !uc.path.empty()) {
  19579. auto &scheme = uc.scheme;
  19580. #ifdef CPPHTTPLIB_SSL_ENABLED
  19581. if (scheme != "ws" && scheme != "wss") {
  19582. #else
  19583. if (scheme != "ws") {
  19584. #endif
  19585. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19586. std::string msg = "'" + scheme + "' scheme is not supported.";
  19587. throw std::invalid_argument(msg);
  19588. #endif
  19589. return;
  19590. }
  19591. auto is_ssl = scheme == "wss";
  19592. host_ = std::move(uc.host);
  19593. port_ = is_ssl ? 443 : 80;
  19594. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19595. path_ = std::move(uc.path);
  19596. if (!uc.query.empty()) { path_ += uc.query; }
  19597. #ifdef CPPHTTPLIB_SSL_ENABLED
  19598. is_ssl_ = is_ssl;
  19599. if (is_ssl_) {
  19600. // The context lives as long as the client so that CA configuration
  19601. // survives reconnects; sessions are created per connection.
  19602. tls_ctx_ = tls::create_client_context();
  19603. if (!tls_ctx_) { return; }
  19604. }
  19605. #else
  19606. if (is_ssl) { return; }
  19607. #endif
  19608. is_valid_ = true;
  19609. }
  19610. }
  19611. #ifdef CPPHTTPLIB_SSL_ENABLED
  19612. inline WebSocketClient::WebSocketClient(
  19613. const std::string &scheme_host_port_path, const PemMemory &pem,
  19614. const Headers &headers)
  19615. : WebSocketClient(scheme_host_port_path, headers) {
  19616. // For ws:// URLs the client certificate is silently ignored, consistent
  19617. // with the TLS-only setters such as set_ca_cert_path().
  19618. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19619. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19620. pem.private_key_password)) {
  19621. tls::free_context(tls_ctx_);
  19622. tls_ctx_ = nullptr;
  19623. is_valid_ = false;
  19624. }
  19625. }
  19626. }
  19627. #endif
  19628. inline WebSocketClient::~WebSocketClient() {
  19629. shutdown_and_close();
  19630. #ifdef CPPHTTPLIB_SSL_ENABLED
  19631. if (tls_ctx_) {
  19632. tls::free_context(tls_ctx_);
  19633. tls_ctx_ = nullptr;
  19634. }
  19635. #endif
  19636. }
  19637. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19638. inline void WebSocketClient::shutdown_and_close() {
  19639. // Send the close frame while the TLS session is still alive: ws_ holds an
  19640. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19641. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19642. if (ws_ && ws_->is_open()) { ws_->close(); }
  19643. ws_.reset();
  19644. #ifdef CPPHTTPLIB_SSL_ENABLED
  19645. if (is_ssl_) {
  19646. if (tls_session_) {
  19647. tls::shutdown(tls_session_, true);
  19648. tls::free_session(tls_session_);
  19649. tls_session_ = nullptr;
  19650. }
  19651. }
  19652. #endif
  19653. if (sock_ != INVALID_SOCKET) {
  19654. detail::shutdown_socket(sock_);
  19655. detail::close_socket(sock_);
  19656. sock_ = INVALID_SOCKET;
  19657. }
  19658. }
  19659. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19660. Error &error, int &ssl_error,
  19661. uint64_t &ssl_backend_error) {
  19662. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19663. // The streams wait with poll(), where 0 instead means "return immediately",
  19664. // so they are given the negative poll uses for an unbounded wait.
  19665. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19666. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19667. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19668. // The handshake belongs to establishing the connection, so an unset read
  19669. // timeout leaves it bounded by the connection timeout instead of forever.
  19670. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19671. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19672. #ifdef CPPHTTPLIB_SSL_ENABLED
  19673. if (is_ssl_) {
  19674. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19675. // is not safe to call concurrently on one client to begin with, since
  19676. // nothing else here is guarded either.
  19677. if (server_certificate_verification_ && !certs_loaded_) {
  19678. uint64_t backend_error = 0;
  19679. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19680. ca_cert_dir_path_, custom_ca_loaded_,
  19681. system_ca_mode_, backend_error);
  19682. certs_loaded_ = true;
  19683. }
  19684. detail::ClientTlsSessionOptions options;
  19685. options.server_hostname_verification = server_hostname_verification_;
  19686. detail::ClientTlsSessionError tls_error;
  19687. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19688. server_certificate_verification_,
  19689. hs_sec, hs_usec, &tls_error,
  19690. options)) {
  19691. error = tls_error.error;
  19692. ssl_error = tls_error.ssl_error;
  19693. ssl_backend_error = tls_error.backend_error;
  19694. return false;
  19695. }
  19696. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19697. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19698. write_timeout_usec_));
  19699. return true;
  19700. }
  19701. #else
  19702. (void)error;
  19703. (void)ssl_error;
  19704. (void)ssl_backend_error;
  19705. (void)hs_sec;
  19706. (void)hs_usec;
  19707. #endif
  19708. strm = std::unique_ptr<Stream>(
  19709. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19710. write_timeout_sec_, write_timeout_usec_));
  19711. return true;
  19712. }
  19713. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19714. #ifdef CPPHTTPLIB_SSL_ENABLED
  19715. auto is_ssl = is_ssl_;
  19716. #else
  19717. auto is_ssl = false;
  19718. #endif
  19719. if (!req.has_header("Host")) {
  19720. req.headers.emplace("Host", detail::make_default_host_header_value(
  19721. host_, port_, is_ssl, address_family_));
  19722. }
  19723. detail::add_default_user_agent_header(req);
  19724. }
  19725. inline Result WebSocketClient::connect() {
  19726. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19727. shutdown_and_close();
  19728. // Check is custom IP or hostname specified for host_
  19729. std::string connect_host;
  19730. std::string ip;
  19731. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19732. auto error = Error::Success;
  19733. sock_ = detail::create_client_socket(
  19734. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19735. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19736. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19737. write_timeout_usec_, interface_, error);
  19738. if (sock_ == INVALID_SOCKET) {
  19739. if (error == Error::Success) { error = Error::Connection; }
  19740. return Result{error, -1, Headers{}};
  19741. }
  19742. std::unique_ptr<Stream> strm;
  19743. auto stream_error = Error::SSLConnection;
  19744. int ssl_error = 0;
  19745. uint64_t ssl_backend_error = 0;
  19746. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19747. shutdown_and_close();
  19748. #ifdef CPPHTTPLIB_SSL_ENABLED
  19749. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19750. #else
  19751. return Result{stream_error, -1, Headers{}};
  19752. #endif
  19753. }
  19754. Request req;
  19755. req.method = "GET";
  19756. req.path = path_;
  19757. req.headers = headers_;
  19758. prepare_default_headers(req);
  19759. detail::WebSocketUpgradeResponse upgrade;
  19760. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19761. shutdown_and_close();
  19762. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19763. }
  19764. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19765. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19766. websocket_ping_interval_sec_,
  19767. websocket_max_missed_pongs_));
  19768. // The stream was created with the timeout already; tell the WebSocket
  19769. // whether it came from the caller, so read() knows to report it as Timeout.
  19770. ws_->read_timeout_set_ = read_timeout_set_;
  19771. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19772. }
  19773. inline ReadResult WebSocketClient::read(std::string &msg) {
  19774. if (!ws_) { return Fail; }
  19775. return ws_->read(msg);
  19776. }
  19777. inline bool WebSocketClient::send(const std::string &data) {
  19778. if (!ws_) { return false; }
  19779. return ws_->send(data);
  19780. }
  19781. inline bool WebSocketClient::send(const char *data, size_t len) {
  19782. if (!ws_) { return false; }
  19783. return ws_->send(data, len);
  19784. }
  19785. inline void WebSocketClient::close(CloseStatus status,
  19786. const std::string &reason) {
  19787. if (ws_) { ws_->close(status, reason); }
  19788. }
  19789. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19790. inline const std::string &WebSocketClient::subprotocol() const {
  19791. return subprotocol_;
  19792. }
  19793. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19794. read_timeout_sec_ = sec;
  19795. read_timeout_usec_ = usec;
  19796. read_timeout_set_ = true;
  19797. // The members above only seed the next connect(); read() consults the
  19798. // stream, so an already-open connection has to be told directly.
  19799. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19800. }
  19801. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19802. write_timeout_sec_ = sec;
  19803. write_timeout_usec_ = usec;
  19804. }
  19805. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19806. websocket_ping_interval_sec_ = sec;
  19807. }
  19808. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19809. websocket_max_missed_pongs_ = count;
  19810. }
  19811. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19812. inline void WebSocketClient::set_address_family(int family) {
  19813. address_family_ = family;
  19814. }
  19815. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19816. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19817. socket_options_ = std::move(socket_options);
  19818. }
  19819. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19820. connection_timeout_sec_ = sec;
  19821. connection_timeout_usec_ = usec;
  19822. }
  19823. inline void WebSocketClient::set_interface(const std::string &intf) {
  19824. interface_ = intf;
  19825. }
  19826. inline void WebSocketClient::set_hostname_addr_map(
  19827. std::map<std::string, std::string> addr_map) {
  19828. addr_map_ = std::move(addr_map);
  19829. }
  19830. #ifdef CPPHTTPLIB_SSL_ENABLED
  19831. inline void
  19832. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19833. const std::string &ca_cert_dir_path) {
  19834. ca_cert_file_path_ = ca_cert_file_path;
  19835. ca_cert_dir_path_ = ca_cert_dir_path;
  19836. }
  19837. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19838. if (store && tls_ctx_) {
  19839. // set_ca_store takes ownership of store
  19840. tls::set_ca_store(tls_ctx_, store);
  19841. custom_ca_loaded_ = true;
  19842. } else if (store) {
  19843. tls::free_ca_store(store);
  19844. }
  19845. }
  19846. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19847. std::size_t size) {
  19848. if (tls_ctx_ && ca_cert && size > 0) {
  19849. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19850. custom_ca_loaded_ = true;
  19851. }
  19852. }
  19853. inline void
  19854. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19855. server_certificate_verification_ = enabled;
  19856. }
  19857. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19858. server_hostname_verification_ = enabled;
  19859. }
  19860. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19861. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19862. }
  19863. #endif // CPPHTTPLIB_SSL_ENABLED
  19864. } // namespace ws
  19865. // ----------------------------------------------------------------------------
  19866. } // namespace httplib
  19867. #endif // CPPHTTPLIB_HTTPLIB_H