httplib.h 796 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296
  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 stays at
  968. // end() instead of running off the container.
  969. if (idx_ >= size_) { return *this; }
  970. ++idx_;
  971. if (key_idx_ != npos()) {
  972. while (idx_ < size_ && !matches(idx_)) {
  973. ++idx_;
  974. }
  975. }
  976. return *this;
  977. }
  978. iterator_t operator++(int) {
  979. auto tmp = *this;
  980. ++*this;
  981. return tmp;
  982. }
  983. iterator_t &operator--() {
  984. if (idx_ == 0) { return *this; }
  985. --idx_;
  986. if (key_idx_ != npos()) {
  987. while (idx_ > 0 && !matches(idx_)) {
  988. --idx_;
  989. }
  990. }
  991. return *this;
  992. }
  993. iterator_t operator--(int) {
  994. auto tmp = *this;
  995. --*this;
  996. return tmp;
  997. }
  998. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  999. return idx_ == rhs.idx_;
  1000. }
  1001. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1002. return idx_ != rhs.idx_;
  1003. }
  1004. private:
  1005. friend class insertion_ordered_multimap;
  1006. template <typename> friend class iterator_t;
  1007. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1008. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1009. bool matches(size_type i) const {
  1010. return keys_equal(data_[i].first, data_[key_idx_].first);
  1011. }
  1012. V *data_;
  1013. size_type idx_;
  1014. size_type size_;
  1015. size_type key_idx_;
  1016. };
  1017. public:
  1018. using iterator = iterator_t<value_type>;
  1019. using const_iterator = iterator_t<const value_type>;
  1020. insertion_ordered_multimap() = default;
  1021. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1022. : entries_(il) {}
  1023. template <typename InputIt>
  1024. insertion_ordered_multimap(InputIt first, InputIt last)
  1025. : entries_(first, last) {}
  1026. iterator begin() { return make_iter(0, npos()); }
  1027. iterator end() { return make_iter(entries_.size(), npos()); }
  1028. const_iterator begin() const { return make_citer(0, npos()); }
  1029. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1030. const_iterator cbegin() const { return begin(); }
  1031. const_iterator cend() const { return end(); }
  1032. bool empty() const { return entries_.empty(); }
  1033. size_type size() const { return entries_.size(); }
  1034. void clear() { entries_.clear(); }
  1035. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1036. iterator insert(const value_type &val) {
  1037. entries_.push_back(val);
  1038. return make_iter(entries_.size() - 1, npos());
  1039. }
  1040. iterator insert(value_type &&val) {
  1041. entries_.push_back(std::move(val));
  1042. return make_iter(entries_.size() - 1, npos());
  1043. }
  1044. template <typename... Args> iterator emplace(Args &&...args) {
  1045. entries_.emplace_back(std::forward<Args>(args)...);
  1046. return make_iter(entries_.size() - 1, npos());
  1047. }
  1048. // For entries that have to lead the message, such as the Host header field
  1049. // (RFC 9110 5.3 recommends sending control data first).
  1050. template <typename... Args> iterator emplace_front(Args &&...args) {
  1051. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1052. return make_iter(0, npos());
  1053. }
  1054. iterator find(const std::string &key) {
  1055. auto i = index_of(key);
  1056. return i == npos() ? end() : make_iter(i, i);
  1057. }
  1058. const_iterator find(const std::string &key) const {
  1059. auto i = index_of(key);
  1060. return i == npos() ? end() : make_citer(i, i);
  1061. }
  1062. size_type count(const std::string &key) const {
  1063. size_type n = 0;
  1064. for (const auto &entry : entries_) {
  1065. if (keys_equal(entry.first, key)) { n++; }
  1066. }
  1067. return n;
  1068. }
  1069. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1070. auto i = index_of(key);
  1071. return i == npos() ? std::make_pair(end(), end())
  1072. : std::make_pair(make_iter(i, i), end());
  1073. }
  1074. std::pair<const_iterator, const_iterator>
  1075. equal_range(const std::string &key) const {
  1076. auto i = index_of(key);
  1077. return i == npos() ? std::make_pair(end(), end())
  1078. : std::make_pair(make_citer(i, i), end());
  1079. }
  1080. size_type erase(const std::string &key) {
  1081. auto before = entries_.size();
  1082. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1083. [&](const value_type &entry) {
  1084. return keys_equal(entry.first, key);
  1085. }),
  1086. entries_.end());
  1087. return before - entries_.size();
  1088. }
  1089. iterator erase(const_iterator pos) {
  1090. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1091. return make_iter(pos.idx_, npos());
  1092. }
  1093. // Erases what iterating [first, last) would actually visit, so erasing an
  1094. // equal_range() removes only the entries with that key, not everything
  1095. // positioned between them.
  1096. iterator erase(const_iterator first, const_iterator last) {
  1097. auto from = first.idx_;
  1098. auto to = last.idx_;
  1099. if (from >= to) { return make_iter(from, npos()); }
  1100. auto begin_it = entries_.begin();
  1101. auto from_it = begin_it + static_cast<difference_type>(from);
  1102. auto to_it = begin_it + static_cast<difference_type>(to);
  1103. if (first.key_idx_ == npos()) {
  1104. entries_.erase(from_it, to_it);
  1105. } else {
  1106. auto key = entries_[first.key_idx_].first;
  1107. auto keep = from_it;
  1108. for (auto it = from_it; it != to_it; ++it) {
  1109. if (!keys_equal(it->first, key)) {
  1110. if (keep != it) { *keep = std::move(*it); }
  1111. ++keep;
  1112. }
  1113. }
  1114. if (keep != to_it) {
  1115. keep = std::move(to_it, entries_.end(), keep);
  1116. } else {
  1117. keep = entries_.end();
  1118. }
  1119. entries_.erase(keep, entries_.end());
  1120. }
  1121. return make_iter(from, npos());
  1122. }
  1123. friend bool operator==(const insertion_ordered_multimap &lhs,
  1124. const insertion_ordered_multimap &rhs) {
  1125. return lhs.entries_ == rhs.entries_;
  1126. }
  1127. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1128. const insertion_ordered_multimap &rhs) {
  1129. return !(lhs == rhs);
  1130. }
  1131. private:
  1132. size_type index_of(const std::string &key) const {
  1133. for (size_type i = 0; i < entries_.size(); i++) {
  1134. if (keys_equal(entries_[i].first, key)) { return i; }
  1135. }
  1136. return npos();
  1137. }
  1138. iterator make_iter(size_type idx, size_type key_idx) {
  1139. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1140. }
  1141. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1142. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1143. }
  1144. std::vector<value_type> entries_;
  1145. };
  1146. } // namespace detail
  1147. using Headers =
  1148. detail::insertion_ordered_multimap<std::string,
  1149. detail::case_ignore::equal_to>;
  1150. // Query parameter names are case-sensitive, unlike header field names.
  1151. using Params =
  1152. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1153. using Match = std::smatch;
  1154. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1155. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1156. /*
  1157. * detail: type-erased storage used by UserData.
  1158. * ABI-stable regardless of C++ standard — always uses this custom
  1159. * implementation instead of std::any.
  1160. */
  1161. namespace detail {
  1162. using any_type_id = const void *;
  1163. template <typename T> any_type_id any_typeid() noexcept {
  1164. static const char id = 0;
  1165. return &id;
  1166. }
  1167. struct any_storage {
  1168. virtual ~any_storage() = default;
  1169. virtual std::unique_ptr<any_storage> clone() const = 0;
  1170. virtual any_type_id type_id() const noexcept = 0;
  1171. };
  1172. template <typename T> struct any_value final : any_storage {
  1173. T value;
  1174. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1175. std::unique_ptr<any_storage> clone() const override {
  1176. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1177. }
  1178. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1179. };
  1180. } // namespace detail
  1181. class UserData {
  1182. public:
  1183. UserData() = default;
  1184. UserData(UserData &&) noexcept = default;
  1185. UserData &operator=(UserData &&) noexcept = default;
  1186. UserData(const UserData &o) {
  1187. for (const auto &e : o.entries_) {
  1188. if (e.second) { entries_[e.first] = e.second->clone(); }
  1189. }
  1190. }
  1191. UserData &operator=(const UserData &o) {
  1192. if (this != &o) {
  1193. entries_.clear();
  1194. for (const auto &e : o.entries_) {
  1195. if (e.second) { entries_[e.first] = e.second->clone(); }
  1196. }
  1197. }
  1198. return *this;
  1199. }
  1200. template <typename T> void set(const std::string &key, T &&value) {
  1201. using D = typename std::decay<T>::type;
  1202. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1203. }
  1204. template <typename T> T *get(const std::string &key) noexcept {
  1205. auto it = entries_.find(key);
  1206. if (it == entries_.end() || !it->second) { return nullptr; }
  1207. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1208. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1209. }
  1210. template <typename T> const T *get(const std::string &key) const noexcept {
  1211. auto it = entries_.find(key);
  1212. if (it == entries_.end() || !it->second) { return nullptr; }
  1213. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1214. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1215. }
  1216. bool has(const std::string &key) const noexcept {
  1217. return entries_.find(key) != entries_.end();
  1218. }
  1219. void erase(const std::string &key) { entries_.erase(key); }
  1220. void clear() noexcept { entries_.clear(); }
  1221. private:
  1222. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1223. entries_;
  1224. };
  1225. struct Response;
  1226. using ResponseHandler = std::function<bool(const Response &response)>;
  1227. struct FormData {
  1228. std::string name;
  1229. std::string content;
  1230. std::string filename;
  1231. std::string content_type;
  1232. Headers headers;
  1233. };
  1234. struct FormField {
  1235. std::string name;
  1236. std::string content;
  1237. Headers headers;
  1238. };
  1239. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1240. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1241. // should see the parts as they were sent. A std::multimap sorts by field name
  1242. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1243. // than the case-insensitive predicate Headers uses.
  1244. using FormFields =
  1245. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1246. using FormFiles =
  1247. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1248. struct MultipartFormData {
  1249. FormFields fields; // Text fields from multipart
  1250. FormFiles files; // Files from multipart
  1251. // Text field access
  1252. std::string get_field(const std::string &key, size_t id = 0) const;
  1253. std::vector<std::string> get_fields(const std::string &key) const;
  1254. bool has_field(const std::string &key) const;
  1255. size_t get_field_count(const std::string &key) const;
  1256. // File access
  1257. FormData get_file(const std::string &key, size_t id = 0) const;
  1258. std::vector<FormData> get_files(const std::string &key) const;
  1259. bool has_file(const std::string &key) const;
  1260. size_t get_file_count(const std::string &key) const;
  1261. };
  1262. struct UploadFormData {
  1263. std::string name;
  1264. std::string content;
  1265. std::string filename;
  1266. std::string content_type;
  1267. };
  1268. using UploadFormDataItems = std::vector<UploadFormData>;
  1269. class DataSink {
  1270. public:
  1271. DataSink() : os(&sb_), sb_(*this) {}
  1272. DataSink(const DataSink &) = delete;
  1273. DataSink &operator=(const DataSink &) = delete;
  1274. DataSink(DataSink &&) = delete;
  1275. DataSink &operator=(DataSink &&) = delete;
  1276. std::function<bool(const char *data, size_t data_len)> write;
  1277. // Only `write` is mandatory. The rest are defaulted so that a provider
  1278. // calling one on a writer that does not set it gets sensible behaviour
  1279. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1280. // `this` is safe: DataSink is neither copyable nor movable.
  1281. std::function<bool()> is_writable = []() { return true; };
  1282. std::function<void()> done = []() {};
  1283. std::function<void(const Headers &trailer)> done_with_trailer =
  1284. [this](const Headers & /*trailer*/) { done(); };
  1285. std::ostream os;
  1286. private:
  1287. class data_sink_streambuf final : public std::streambuf {
  1288. public:
  1289. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1290. protected:
  1291. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1292. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1293. return 0;
  1294. }
  1295. private:
  1296. DataSink &sink_;
  1297. };
  1298. data_sink_streambuf sb_;
  1299. };
  1300. using ContentProvider =
  1301. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1302. using ContentProviderWithoutLength =
  1303. std::function<bool(size_t offset, DataSink &sink)>;
  1304. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1305. struct FormDataProvider {
  1306. std::string name;
  1307. ContentProviderWithoutLength provider;
  1308. std::string filename;
  1309. std::string content_type;
  1310. };
  1311. using FormDataProviderItems = std::vector<FormDataProvider>;
  1312. inline FormDataProvider
  1313. make_file_provider(const std::string &name, const std::string &filepath,
  1314. const std::string &filename = std::string(),
  1315. const std::string &content_type = std::string()) {
  1316. FormDataProvider fdp;
  1317. fdp.name = name;
  1318. fdp.filename = filename.empty() ? filepath : filename;
  1319. fdp.content_type = content_type;
  1320. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1321. std::ifstream f(filepath, std::ios::binary);
  1322. if (!f) { return false; }
  1323. if (offset > 0) {
  1324. f.seekg(static_cast<std::streamoff>(offset));
  1325. if (!f.good()) {
  1326. sink.done();
  1327. return true;
  1328. }
  1329. }
  1330. char buf[8192];
  1331. f.read(buf, sizeof(buf));
  1332. auto n = static_cast<size_t>(f.gcount());
  1333. if (n > 0) { return sink.write(buf, n); }
  1334. sink.done(); // EOF
  1335. return true;
  1336. };
  1337. return fdp;
  1338. }
  1339. inline std::pair<size_t, ContentProvider>
  1340. make_file_body(const std::string &filepath) {
  1341. size_t size = 0;
  1342. {
  1343. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1344. if (!f) { return {0, ContentProvider{}}; }
  1345. size = static_cast<size_t>(f.tellg());
  1346. }
  1347. ContentProvider provider = [filepath](size_t offset, size_t length,
  1348. DataSink &sink) -> bool {
  1349. std::ifstream f(filepath, std::ios::binary);
  1350. if (!f) { return false; }
  1351. f.seekg(static_cast<std::streamoff>(offset));
  1352. if (!f.good()) { return false; }
  1353. char buf[8192];
  1354. while (length > 0) {
  1355. auto to_read = (std::min)(sizeof(buf), length);
  1356. f.read(buf, static_cast<std::streamsize>(to_read));
  1357. auto n = static_cast<size_t>(f.gcount());
  1358. // The file is shorter than the size make_file_body() measured, which the
  1359. // caller has already committed to as Content-Length. The body cannot be
  1360. // completed, so fail as every other error here does.
  1361. if (n == 0) { return false; }
  1362. if (!sink.write(buf, n)) { return false; }
  1363. length -= n;
  1364. }
  1365. return true;
  1366. };
  1367. return {size, std::move(provider)};
  1368. }
  1369. using ContentReceiverWithProgress = std::function<bool(
  1370. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1371. using ContentReceiver =
  1372. std::function<bool(const char *data, size_t data_length)>;
  1373. using FormDataHeader = std::function<bool(const FormData &file)>;
  1374. class ContentReader {
  1375. public:
  1376. using Reader = std::function<bool(ContentReceiver receiver)>;
  1377. using FormDataReader =
  1378. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1379. ContentReader(Reader reader, FormDataReader multipart_reader)
  1380. : reader_(std::move(reader)),
  1381. formdata_reader_(std::move(multipart_reader)) {}
  1382. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1383. return formdata_reader_(std::move(header), std::move(receiver));
  1384. }
  1385. bool operator()(ContentReceiver receiver) const {
  1386. return reader_(std::move(receiver));
  1387. }
  1388. Reader reader_;
  1389. FormDataReader formdata_reader_;
  1390. };
  1391. using Range = std::pair<ssize_t, ssize_t>;
  1392. using Ranges = std::vector<Range>;
  1393. #ifdef CPPHTTPLIB_SSL_ENABLED
  1394. // TLS abstraction layer - public type definitions and API
  1395. namespace tls {
  1396. // Opaque handles (defined as void* for abstraction)
  1397. using ctx_t = void *;
  1398. using session_t = void *;
  1399. using const_session_t = const void *; // For read-only session access
  1400. using cert_t = void *;
  1401. using ca_store_t = void *;
  1402. // TLS versions
  1403. enum class Version {
  1404. TLS1_2 = 0x0303,
  1405. TLS1_3 = 0x0304,
  1406. };
  1407. // Subject Alternative Names (SAN) entry types
  1408. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1409. // SAN entry structure
  1410. struct SanEntry {
  1411. SanType type;
  1412. std::string value;
  1413. };
  1414. // Verification context for certificate verification callback
  1415. struct VerifyContext {
  1416. session_t session; // TLS session handle
  1417. cert_t cert; // Current certificate being verified
  1418. int depth; // Certificate chain depth (0 = leaf)
  1419. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1420. long error_code; // Backend-specific error code (0 = no error)
  1421. const char *error_string; // Human-readable error description
  1422. // Certificate introspection methods
  1423. std::string subject_cn() const;
  1424. std::string issuer_name() const;
  1425. bool check_hostname(const char *hostname) const;
  1426. std::vector<SanEntry> sans() const;
  1427. bool validity(time_t &not_before, time_t &not_after) const;
  1428. std::string serial() const;
  1429. };
  1430. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1431. // TlsError codes for TLS operations (backend-independent)
  1432. enum class ErrorCode : int {
  1433. Success = 0,
  1434. WantRead, // Non-blocking: need to wait for read
  1435. WantWrite, // Non-blocking: need to wait for write
  1436. PeerClosed, // Peer closed the connection
  1437. Fatal, // Unrecoverable error
  1438. SyscallError, // System call error (check sys_errno)
  1439. CertVerifyFailed, // Certificate verification failed
  1440. HostnameMismatch, // Hostname verification failed
  1441. };
  1442. // TLS error information
  1443. struct TlsError {
  1444. ErrorCode code = ErrorCode::Fatal;
  1445. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1446. int sys_errno = 0; // errno when SyscallError
  1447. // Convert verification error code to human-readable string
  1448. static std::string verify_error_to_string(long error_code);
  1449. };
  1450. // RAII wrapper for peer certificate
  1451. class PeerCert {
  1452. public:
  1453. PeerCert();
  1454. PeerCert(PeerCert &&other) noexcept;
  1455. PeerCert &operator=(PeerCert &&other) noexcept;
  1456. ~PeerCert();
  1457. PeerCert(const PeerCert &) = delete;
  1458. PeerCert &operator=(const PeerCert &) = delete;
  1459. explicit operator bool() const;
  1460. std::string subject_cn() const;
  1461. std::string issuer_name() const;
  1462. bool check_hostname(const char *hostname) const;
  1463. std::vector<SanEntry> sans() const;
  1464. bool validity(time_t &not_before, time_t &not_after) const;
  1465. std::string serial() const;
  1466. private:
  1467. explicit PeerCert(cert_t cert);
  1468. cert_t cert_ = nullptr;
  1469. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1470. };
  1471. // Callback for TLS context setup (used by SSLServer constructor)
  1472. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1473. } // namespace tls
  1474. #endif
  1475. struct Request {
  1476. std::string method;
  1477. std::string path;
  1478. std::string matched_route;
  1479. Params params;
  1480. Headers headers;
  1481. Headers trailers;
  1482. std::string body;
  1483. std::string remote_addr;
  1484. int remote_port = -1;
  1485. std::string local_addr;
  1486. int local_port = -1;
  1487. // for server
  1488. std::string version;
  1489. std::string target;
  1490. MultipartFormData form;
  1491. Ranges ranges;
  1492. Match matches;
  1493. std::unordered_map<std::string, std::string> path_params;
  1494. std::function<bool()> is_connection_closed = []() { return true; };
  1495. // for client
  1496. std::vector<std::string> accept_content_types;
  1497. ResponseHandler response_handler;
  1498. ContentReceiverWithProgress content_receiver;
  1499. DownloadProgress download_progress;
  1500. UploadProgress upload_progress;
  1501. bool has_header(const std::string &key) const;
  1502. std::string get_header_value(const std::string &key, const char *def = "",
  1503. size_t id = 0) const;
  1504. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1505. size_t id = 0) const;
  1506. size_t get_header_value_count(const std::string &key) const;
  1507. void set_header(const std::string &key, const std::string &val);
  1508. bool has_trailer(const std::string &key) const;
  1509. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1510. size_t get_trailer_value_count(const std::string &key) const;
  1511. bool has_param(const std::string &key) const;
  1512. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1513. std::vector<std::string> get_param_values(const std::string &key) const;
  1514. size_t get_param_value_count(const std::string &key) const;
  1515. bool is_multipart_form_data() const;
  1516. // private members...
  1517. bool body_consumed_ = false;
  1518. bool expect_100_continue_pending_ = false;
  1519. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1520. size_t content_length_ = 0;
  1521. ContentProvider content_provider_;
  1522. bool is_chunked_content_provider_ = false;
  1523. size_t authorization_count_ = 0;
  1524. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1525. (std::chrono::steady_clock::time_point::min)();
  1526. #ifdef CPPHTTPLIB_SSL_ENABLED
  1527. tls::const_session_t ssl = nullptr;
  1528. tls::PeerCert peer_cert() const;
  1529. std::string sni() const;
  1530. #endif
  1531. };
  1532. namespace detail {
  1533. // Declared up here, away from the rest of the compression helpers, because
  1534. // `Response` stores one.
  1535. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1536. } // namespace detail
  1537. struct Response {
  1538. std::string version;
  1539. int status = -1;
  1540. std::string reason;
  1541. Headers headers;
  1542. Headers trailers;
  1543. std::string body;
  1544. std::string location; // Redirect location
  1545. // User-defined context — set by pre-routing/pre-request handlers and read
  1546. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1547. UserData user_data;
  1548. bool has_header(const std::string &key) const;
  1549. std::string get_header_value(const std::string &key, const char *def = "",
  1550. size_t id = 0) const;
  1551. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1552. size_t id = 0) const;
  1553. size_t get_header_value_count(const std::string &key) const;
  1554. void set_header(const std::string &key, const std::string &val);
  1555. bool has_trailer(const std::string &key) const;
  1556. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1557. size_t get_trailer_value_count(const std::string &key) const;
  1558. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1559. void set_content(const char *s, size_t n, const std::string &content_type);
  1560. void set_content(const std::string &s, const std::string &content_type);
  1561. void set_content(std::string &&s, const std::string &content_type);
  1562. void set_content_provider(
  1563. size_t length, const std::string &content_type, ContentProvider provider,
  1564. ContentProviderResourceReleaser resource_releaser = nullptr);
  1565. void set_content_provider(
  1566. const std::string &content_type, ContentProviderWithoutLength provider,
  1567. ContentProviderResourceReleaser resource_releaser = nullptr);
  1568. void set_chunked_content_provider(
  1569. const std::string &content_type, ContentProviderWithoutLength provider,
  1570. ContentProviderResourceReleaser resource_releaser = nullptr);
  1571. void set_file_content(const std::string &path,
  1572. const std::string &content_type);
  1573. void set_file_content(const std::string &path);
  1574. Response() = default;
  1575. Response(const Response &) = default;
  1576. Response &operator=(const Response &) = default;
  1577. Response(Response &&) = default;
  1578. Response &operator=(Response &&) = default;
  1579. ~Response() {
  1580. if (content_provider_resource_releaser_) {
  1581. content_provider_resource_releaser_(content_provider_success_);
  1582. }
  1583. }
  1584. // private members...
  1585. size_t content_length_ = 0;
  1586. ContentProvider content_provider_;
  1587. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1588. bool is_chunked_content_provider_ = false;
  1589. bool is_file_content_provider_ = false;
  1590. bool content_provider_success_ = false;
  1591. std::string file_content_path_;
  1592. std::string file_content_content_type_;
  1593. // Content coding chosen for the response body, decided once so that the
  1594. // headers and the body cannot disagree: where the file is opened for a
  1595. // file-backed content provider (keeping the ETag honest), and in
  1596. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1597. // for every other kind of response.
  1598. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1599. };
  1600. enum class Error {
  1601. Success = 0,
  1602. Unknown,
  1603. Connection,
  1604. BindIPAddress,
  1605. Read,
  1606. Write,
  1607. ExceedRedirectCount,
  1608. Canceled,
  1609. SSLConnection,
  1610. SSLLoadingCerts,
  1611. SSLServerVerification,
  1612. SSLServerHostnameVerification,
  1613. UnsupportedMultipartBoundaryChars,
  1614. Compression,
  1615. ConnectionTimeout,
  1616. ProxyConnection,
  1617. ConnectionClosed,
  1618. Timeout,
  1619. ResourceExhaustion,
  1620. TooManyFormDataFiles,
  1621. ExceedMaxPayloadSize,
  1622. ExceedUriMaxLength,
  1623. ExceedMaxSocketDescriptorCount,
  1624. InvalidRequestLine,
  1625. InvalidHTTPMethod,
  1626. InvalidHTTPVersion,
  1627. InvalidHeaders,
  1628. MultipartParsing,
  1629. OpenFile,
  1630. Listen,
  1631. GetSockName,
  1632. UnsupportedAddressFamily,
  1633. HTTPParsing,
  1634. InvalidRangeHeader,
  1635. UnsupportedContentEncoding,
  1636. WebSocketHandshake,
  1637. UserCallbackException,
  1638. // For internal use only
  1639. SSLPeerCouldBeClosed_,
  1640. };
  1641. std::string to_string(Error error);
  1642. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1643. class Stream {
  1644. public:
  1645. virtual ~Stream() = default;
  1646. virtual bool is_readable() const = 0;
  1647. virtual bool wait_readable() const = 0;
  1648. virtual bool wait_writable() const = 0;
  1649. virtual bool is_peer_alive() const { return wait_writable(); }
  1650. virtual ssize_t read(char *ptr, size_t size) = 0;
  1651. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1652. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1653. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1654. virtual socket_t socket() const = 0;
  1655. virtual time_t duration() const = 0;
  1656. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1657. (void)sec;
  1658. (void)usec;
  1659. }
  1660. // Bytes already pulled off the socket and sitting in this stream's own
  1661. // buffer. Exposing them lets a line reader scan for a terminator in one
  1662. // pass instead of asking for a byte at a time. A stream that does no
  1663. // buffering of its own reports none, and readers fall back to read().
  1664. virtual const char *buffered_data(size_t &size) const {
  1665. size = 0;
  1666. return nullptr;
  1667. }
  1668. // Discards `size` bytes previously returned by buffered_data().
  1669. virtual void consume_buffered(size_t size) { (void)size; }
  1670. ssize_t write(const char *ptr);
  1671. ssize_t write(const std::string &s);
  1672. Error get_error() const { return error_; }
  1673. protected:
  1674. Error error_ = Error::Success;
  1675. };
  1676. class TaskQueue {
  1677. public:
  1678. TaskQueue() = default;
  1679. virtual ~TaskQueue() = default;
  1680. virtual bool enqueue(std::function<void()> fn) = 0;
  1681. virtual void shutdown() = 0;
  1682. virtual void on_idle() {}
  1683. };
  1684. class ThreadPool final : public TaskQueue {
  1685. public:
  1686. explicit ThreadPool(
  1687. size_t n, size_t max_n = 0, size_t mqr = 0,
  1688. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1689. ThreadPool(const ThreadPool &) = delete;
  1690. ~ThreadPool() override = default;
  1691. bool enqueue(std::function<void()> fn) override;
  1692. void shutdown() override;
  1693. private:
  1694. void worker(bool is_dynamic);
  1695. void move_to_finished(std::thread::id id);
  1696. void cleanup_finished_threads();
  1697. size_t base_thread_count_;
  1698. size_t max_thread_count_;
  1699. size_t max_queued_requests_;
  1700. time_t idle_timeout_sec_;
  1701. size_t idle_thread_count_;
  1702. bool shutdown_;
  1703. std::list<std::function<void()>> jobs_;
  1704. std::vector<std::thread> threads_; // base threads
  1705. std::list<std::thread> dynamic_threads_; // dynamic threads
  1706. std::vector<std::thread>
  1707. finished_threads_; // exited dynamic threads awaiting join
  1708. std::condition_variable cond_;
  1709. std::mutex mutex_;
  1710. };
  1711. using Logger = std::function<void(const Request &, const Response &)>;
  1712. // Forward declaration for Error type
  1713. enum class Error;
  1714. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1715. using SocketOptions = std::function<void(socket_t sock)>;
  1716. void default_socket_options(socket_t sock);
  1717. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1718. const char *status_message(int status);
  1719. std::string to_string(Error error);
  1720. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1721. std::string get_bearer_token_auth(const Request &req);
  1722. namespace detail {
  1723. class MatcherBase {
  1724. public:
  1725. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1726. virtual ~MatcherBase() = default;
  1727. const std::string &pattern() const { return pattern_; }
  1728. // Match request path and populate its matches and
  1729. virtual bool match(Request &request) const = 0;
  1730. private:
  1731. std::string pattern_;
  1732. };
  1733. /**
  1734. * Captures parameters in request path and stores them in Request::path_params
  1735. *
  1736. * Capture name is a substring of a pattern from : to /.
  1737. * The rest of the pattern is matched against the request path directly
  1738. * Parameters are captured starting from the next character after
  1739. * the end of the last matched static pattern fragment until the next /.
  1740. *
  1741. * Example pattern:
  1742. * "/path/fragments/:capture/more/fragments/:second_capture"
  1743. * Static fragments:
  1744. * "/path/fragments/", "more/fragments/"
  1745. *
  1746. * Given the following request path:
  1747. * "/path/fragments/:1/more/fragments/:2"
  1748. * the resulting capture will be
  1749. * {{"capture", "1"}, {"second_capture", "2"}}
  1750. */
  1751. class PathParamsMatcher final : public MatcherBase {
  1752. public:
  1753. PathParamsMatcher(const std::string &pattern);
  1754. bool match(Request &request) const override;
  1755. private:
  1756. // Treat segment separators as the end of path parameter capture
  1757. // Does not need to handle query parameters as they are parsed before path
  1758. // matching
  1759. static constexpr char separator = '/';
  1760. // Contains static path fragments to match against, excluding the '/' after
  1761. // path params
  1762. // Fragments are separated by path params
  1763. std::vector<std::string> static_fragments_;
  1764. // Stores the names of the path parameters to be used as keys in the
  1765. // Request::path_params map
  1766. std::vector<std::string> param_names_;
  1767. };
  1768. /**
  1769. * Performs std::regex_match on request path
  1770. * and stores the result in Request::matches
  1771. *
  1772. * Note that regex match is performed directly on the whole request.
  1773. * This means that wildcard patterns may match multiple path segments with /:
  1774. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1775. */
  1776. class RegexMatcher final : public MatcherBase {
  1777. public:
  1778. RegexMatcher(const std::string &pattern)
  1779. : MatcherBase(pattern), regex_(pattern) {}
  1780. bool match(Request &request) const override;
  1781. private:
  1782. std::regex regex_;
  1783. };
  1784. int close_socket(socket_t sock) noexcept;
  1785. bool is_accept_resource_error();
  1786. bool is_accept_transient_error();
  1787. ssize_t write_headers(Stream &strm, const Headers &headers);
  1788. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1789. time_t usec);
  1790. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1791. const std::string &boundary);
  1792. ContentProvider
  1793. make_multipart_content_provider(const UploadFormDataItems &items,
  1794. const std::string &boundary);
  1795. } // namespace detail
  1796. bool is_valid_multipart_boundary(const std::string &boundary);
  1797. // Serializer for multipart/form-data request bodies. The boundary is owned
  1798. // by the writer so that per-part framing and the final terminator always
  1799. // agree. Field names and filenames are escaped following the WHATWG HTML
  1800. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1801. // in content types.
  1802. class MultipartFormDataWriter {
  1803. public:
  1804. MultipartFormDataWriter();
  1805. // precondition: is_valid_multipart_boundary(boundary)
  1806. explicit MultipartFormDataWriter(std::string boundary);
  1807. const std::string &boundary() const;
  1808. std::string content_type() const;
  1809. // In-memory items -> whole body (known length)
  1810. std::string serialize(const UploadFormDataItems &items) const;
  1811. size_t content_length(const UploadFormDataItems &items) const;
  1812. // Per-part framing for streaming via a content provider
  1813. std::string item_begin(const UploadFormData &item) const;
  1814. static std::string item_end();
  1815. std::string finish() const;
  1816. private:
  1817. std::string boundary_;
  1818. };
  1819. class Server {
  1820. public:
  1821. using Handler = std::function<void(const Request &, Response &)>;
  1822. using ExceptionHandler =
  1823. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1824. enum class HandlerResponse {
  1825. Handled,
  1826. Unhandled,
  1827. };
  1828. using HandlerWithResponse =
  1829. std::function<HandlerResponse(const Request &, Response &)>;
  1830. using HandlerWithContentReader = std::function<void(
  1831. const Request &, Response &, const ContentReader &content_reader)>;
  1832. using Expect100ContinueHandler =
  1833. std::function<int(const Request &, Response &)>;
  1834. using StartHandler = std::function<void()>;
  1835. using WebSocketHandler =
  1836. std::function<void(const Request &, ws::WebSocket &)>;
  1837. using SubProtocolSelector =
  1838. std::function<std::string(const std::vector<std::string> &protocols)>;
  1839. Server();
  1840. virtual ~Server();
  1841. virtual bool is_valid() const;
  1842. Server &Get(const std::string &pattern, Handler handler);
  1843. Server &Post(const std::string &pattern, Handler handler);
  1844. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1845. Server &Put(const std::string &pattern, Handler handler);
  1846. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1847. Server &Patch(const std::string &pattern, Handler handler);
  1848. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1849. Server &Delete(const std::string &pattern, Handler handler);
  1850. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1851. Server &Options(const std::string &pattern, Handler handler);
  1852. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1853. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1854. // server accept it; an unregistered method is still rejected with 400.
  1855. // `method` must be a valid HTTP method token and must not be one of the
  1856. // built-in methods, which have their own registration functions above. A
  1857. // rejected registration makes is_valid() return false, so listen() fails.
  1858. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1859. Handler handler);
  1860. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1861. HandlerWithContentReader handler);
  1862. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1863. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1864. SubProtocolSelector sub_protocol_selector);
  1865. bool set_base_dir(const std::string &dir,
  1866. const std::string &mount_point = std::string());
  1867. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1868. Headers headers = Headers());
  1869. bool remove_mount_point(const std::string &mount_point);
  1870. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1871. const std::string &mime);
  1872. Server &set_default_file_mimetype(const std::string &mime);
  1873. Server &set_file_request_handler(Handler handler);
  1874. template <class ErrorHandlerFunc>
  1875. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1876. return set_error_handler_core(
  1877. std::forward<ErrorHandlerFunc>(handler),
  1878. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1879. }
  1880. Server &set_exception_handler(ExceptionHandler handler);
  1881. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1882. Server &set_post_routing_handler(Handler handler);
  1883. Server &set_pre_request_handler(HandlerWithResponse handler);
  1884. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1885. Server &set_start_handler(StartHandler handler);
  1886. Server &set_logger(Logger logger);
  1887. Server &set_pre_compression_logger(Logger logger);
  1888. Server &set_error_logger(ErrorLogger error_logger);
  1889. Server &set_address_family(int family);
  1890. Server &set_tcp_nodelay(bool on);
  1891. Server &set_ipv6_v6only(bool on);
  1892. Server &set_socket_options(SocketOptions socket_options);
  1893. Server &set_default_headers(Headers headers);
  1894. Server &
  1895. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1896. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1897. Server &set_keep_alive_max_count(size_t count);
  1898. Server &set_keep_alive_timeout(time_t sec);
  1899. template <class Rep, class Period>
  1900. Server &
  1901. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1902. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1903. template <class Rep, class Period>
  1904. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1905. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1906. template <class Rep, class Period>
  1907. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1908. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1909. template <class Rep, class Period>
  1910. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1911. Server &set_payload_max_length(size_t length);
  1912. Server &set_static_file_compression(bool on);
  1913. Server &set_static_file_compression_min_length(size_t length);
  1914. Server &set_static_file_compression_max_length(size_t length);
  1915. Server &set_websocket_ping_interval(time_t sec);
  1916. template <class Rep, class Period>
  1917. Server &set_websocket_ping_interval(
  1918. const std::chrono::duration<Rep, Period> &duration);
  1919. Server &set_websocket_max_missed_pongs(int count);
  1920. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1921. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1922. bool listen_after_bind();
  1923. bool listen(const std::string &host, int port, int socket_flags = 0);
  1924. bool is_running() const;
  1925. void wait_until_ready() const;
  1926. void stop() noexcept;
  1927. void decommission();
  1928. std::function<TaskQueue *(void)> new_task_queue;
  1929. protected:
  1930. bool process_request(Stream &strm, const std::string &remote_addr,
  1931. int remote_port, const std::string &local_addr,
  1932. int local_port, bool close_connection,
  1933. bool &connection_closed,
  1934. const std::function<void(Request &)> &setup_request,
  1935. bool *websocket_upgraded = nullptr);
  1936. // Runs the per-connection serving loop and stops an exception thrown by a
  1937. // user callback from escaping the worker thread.
  1938. //
  1939. // process_request() wraps only routing() in a try/catch. Content providers,
  1940. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1941. // handlers all run outside it, and the task queue calls the job without a
  1942. // catch, so an exception from any of those would terminate the process.
  1943. //
  1944. // No 500 is possible here: by the time a content provider runs, the status
  1945. // line and headers are already on the wire. Report it through the error
  1946. // logger and drop the connection, which is what the peer observes either
  1947. // way. Other connections are unaffected.
  1948. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1949. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1950. return serve();
  1951. #else
  1952. try {
  1953. return serve();
  1954. } catch (...) {
  1955. // The error logger is a user callback too, so it must not be able to
  1956. // throw the guard back open.
  1957. try {
  1958. output_error_log(Error::UserCallbackException, nullptr);
  1959. } catch (...) {}
  1960. return false;
  1961. }
  1962. #endif
  1963. }
  1964. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1965. std::vector<std::string> trusted_proxies_;
  1966. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1967. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1968. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1969. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1970. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1971. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1972. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1973. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1974. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1975. bool static_file_compression_ = false;
  1976. size_t static_file_compression_min_length_ =
  1977. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1978. size_t static_file_compression_max_length_ =
  1979. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1980. time_t websocket_ping_interval_sec_ =
  1981. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1982. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1983. private:
  1984. using Handlers =
  1985. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1986. using HandlersForContentReader =
  1987. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1988. HandlerWithContentReader>>;
  1989. // Both handler tables for one custom method live in a single entry, so that
  1990. // routing() needs only one map lookup per request to reach either of them.
  1991. struct CustomHandlerEntry {
  1992. Handlers handlers;
  1993. HandlersForContentReader handlers_for_content_reader;
  1994. };
  1995. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1996. static std::unique_ptr<detail::MatcherBase>
  1997. make_matcher(const std::string &pattern);
  1998. static const std::set<std::string> &builtin_methods();
  1999. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2000. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2001. template <typename H>
  2002. Server &add_handler(
  2003. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2004. const std::string &pattern, H handler) {
  2005. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2006. return *this;
  2007. }
  2008. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2009. Server &set_error_handler_core(Handler handler, std::false_type);
  2010. socket_t create_server_socket(const std::string &host, int port,
  2011. int socket_flags,
  2012. SocketOptions socket_options) const;
  2013. int bind_internal(const std::string &host, int port, int socket_flags);
  2014. bool listen_internal();
  2015. bool routing(Request &req, Response &res, Stream &strm);
  2016. bool handle_file_request(Request &req, Response &res);
  2017. bool check_if_not_modified(const Request &req, Response &res,
  2018. const std::string &etag, time_t mtime) const;
  2019. bool check_if_range(Request &req, const std::string &etag,
  2020. time_t mtime) const;
  2021. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2022. Stream &strm);
  2023. bool dispatch_request_for_content_reader(
  2024. Request &req, Response &res, ContentReader content_reader,
  2025. const HandlersForContentReader &handlers) const;
  2026. bool parse_request_line(const char *s, Request &req) const;
  2027. detail::EncodingType static_file_encoding(const Request &req,
  2028. const Response &res,
  2029. const std::string &content_type,
  2030. size_t length) const;
  2031. bool apply_static_file_compression(const Request &req, Response &res) const;
  2032. void apply_ranges(const Request &req, Response &res,
  2033. std::string &content_type, std::string &boundary) const;
  2034. bool write_response(Stream &strm, bool close_connection, Request &req,
  2035. Response &res);
  2036. bool write_response_with_content(Stream &strm, bool close_connection,
  2037. const Request &req, Response &res);
  2038. bool write_response_core(Stream &strm, bool close_connection,
  2039. const Request &req, Response &res,
  2040. bool need_apply_ranges);
  2041. bool write_content_with_provider(Stream &strm, const Request &req,
  2042. Response &res, const std::string &boundary,
  2043. const std::string &content_type);
  2044. bool read_content(Stream &strm, Request &req, Response &res);
  2045. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2046. Response &res,
  2047. ContentReceiver receiver,
  2048. FormDataHeader multipart_header,
  2049. ContentReceiver multipart_receiver);
  2050. bool read_content_core(Stream &strm, Request &req, Response &res,
  2051. ContentReceiver receiver,
  2052. FormDataHeader multipart_header,
  2053. ContentReceiver multipart_receiver) const;
  2054. virtual bool process_and_close_socket(socket_t sock);
  2055. void output_log(const Request &req, const Response &res) const;
  2056. void output_pre_compression_log(const Request &req,
  2057. const Response &res) const;
  2058. void output_error_log(const Error &err, const Request *req) const;
  2059. std::atomic<bool> is_running_{false};
  2060. std::atomic<bool> is_decommissioned{false};
  2061. // Set when CustomRoute() refuses a registration. Written before listen(),
  2062. // read by is_valid() on the same thread, so it needs no synchronization.
  2063. bool has_invalid_registration_ = false;
  2064. struct MountPointEntry {
  2065. std::string mount_point;
  2066. std::string base_dir;
  2067. std::string resolved_base_dir;
  2068. Headers headers;
  2069. };
  2070. std::vector<MountPointEntry> base_dirs_;
  2071. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2072. std::string default_file_mimetype_ = "application/octet-stream";
  2073. Handler file_request_handler_;
  2074. Handlers get_handlers_;
  2075. Handlers post_handlers_;
  2076. HandlersForContentReader post_handlers_for_content_reader_;
  2077. Handlers put_handlers_;
  2078. HandlersForContentReader put_handlers_for_content_reader_;
  2079. Handlers patch_handlers_;
  2080. HandlersForContentReader patch_handlers_for_content_reader_;
  2081. Handlers delete_handlers_;
  2082. HandlersForContentReader delete_handlers_for_content_reader_;
  2083. Handlers options_handlers_;
  2084. CustomHandlers custom_handlers_;
  2085. struct WebSocketHandlerEntry {
  2086. std::unique_ptr<detail::MatcherBase> matcher;
  2087. WebSocketHandler handler;
  2088. SubProtocolSelector sub_protocol_selector;
  2089. };
  2090. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2091. WebSocketHandlers websocket_handlers_;
  2092. HandlerWithResponse error_handler_;
  2093. ExceptionHandler exception_handler_;
  2094. HandlerWithResponse pre_routing_handler_;
  2095. Handler post_routing_handler_;
  2096. HandlerWithResponse pre_request_handler_;
  2097. Expect100ContinueHandler expect_100_continue_handler_;
  2098. StartHandler start_handler_;
  2099. mutable std::mutex logger_mutex_;
  2100. Logger logger_;
  2101. Logger pre_compression_logger_;
  2102. ErrorLogger error_logger_;
  2103. int address_family_ = AF_UNSPEC;
  2104. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2105. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2106. SocketOptions socket_options_ = default_socket_options;
  2107. Headers default_headers_;
  2108. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2109. detail::write_headers;
  2110. };
  2111. class Result {
  2112. public:
  2113. Result() = default;
  2114. Result(std::unique_ptr<Response> &&res, Error err,
  2115. Headers &&request_headers = Headers{})
  2116. : res_(std::move(res)), err_(err),
  2117. request_headers_(std::move(request_headers)) {}
  2118. // Response
  2119. operator bool() const { return res_ != nullptr; }
  2120. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2121. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2122. const Response &value() const { return *res_; }
  2123. Response &value() { return *res_; }
  2124. const Response &operator*() const { return *res_; }
  2125. Response &operator*() { return *res_; }
  2126. const Response *operator->() const { return res_.get(); }
  2127. Response *operator->() { return res_.get(); }
  2128. // Error
  2129. Error error() const { return err_; }
  2130. // Request Headers
  2131. bool has_request_header(const std::string &key) const;
  2132. std::string get_request_header_value(const std::string &key,
  2133. const char *def = "",
  2134. size_t id = 0) const;
  2135. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2136. size_t id = 0) const;
  2137. size_t get_request_header_value_count(const std::string &key) const;
  2138. private:
  2139. std::unique_ptr<Response> res_;
  2140. Error err_ = Error::Unknown;
  2141. Headers request_headers_;
  2142. #ifdef CPPHTTPLIB_SSL_ENABLED
  2143. public:
  2144. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2145. int ssl_error)
  2146. : res_(std::move(res)), err_(err),
  2147. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2148. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2149. int ssl_error, uint64_t ssl_backend_error)
  2150. : res_(std::move(res)), err_(err),
  2151. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2152. ssl_backend_error_(ssl_backend_error) {}
  2153. int ssl_error() const { return ssl_error_; }
  2154. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2155. private:
  2156. int ssl_error_ = 0;
  2157. uint64_t ssl_backend_error_ = 0;
  2158. #endif
  2159. };
  2160. struct ClientConnection {
  2161. socket_t sock = INVALID_SOCKET;
  2162. bool is_open() const { return sock != INVALID_SOCKET; }
  2163. ClientConnection() = default;
  2164. ~ClientConnection();
  2165. ClientConnection(const ClientConnection &) = delete;
  2166. ClientConnection &operator=(const ClientConnection &) = delete;
  2167. ClientConnection(ClientConnection &&other) noexcept
  2168. : sock(other.sock)
  2169. #ifdef CPPHTTPLIB_SSL_ENABLED
  2170. ,
  2171. session(other.session)
  2172. #endif
  2173. {
  2174. other.sock = INVALID_SOCKET;
  2175. #ifdef CPPHTTPLIB_SSL_ENABLED
  2176. other.session = nullptr;
  2177. #endif
  2178. }
  2179. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2180. if (this != &other) {
  2181. sock = other.sock;
  2182. other.sock = INVALID_SOCKET;
  2183. #ifdef CPPHTTPLIB_SSL_ENABLED
  2184. session = other.session;
  2185. other.session = nullptr;
  2186. #endif
  2187. }
  2188. return *this;
  2189. }
  2190. #ifdef CPPHTTPLIB_SSL_ENABLED
  2191. tls::session_t session = nullptr;
  2192. #endif
  2193. };
  2194. namespace detail {
  2195. struct ChunkedDecoder;
  2196. struct BodyReader {
  2197. Stream *stream = nullptr;
  2198. bool has_content_length = false;
  2199. size_t content_length = 0;
  2200. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2201. size_t bytes_read = 0;
  2202. bool chunked = false;
  2203. bool eof = false;
  2204. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2205. Error last_error = Error::Success;
  2206. ssize_t read(char *buf, size_t len);
  2207. bool has_error() const { return last_error != Error::Success; }
  2208. };
  2209. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2210. size_t len) {
  2211. (void)stream;
  2212. return br.read(buf, len);
  2213. }
  2214. class decompressor;
  2215. enum class NoProxyKind {
  2216. Wildcard, // "*"
  2217. HostnameSuffix, // "example.com" or ".example.com"
  2218. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2219. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2220. };
  2221. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2222. // Lets one CIDR matcher cover both families.
  2223. using IPBytes = std::array<uint8_t, 16>;
  2224. struct NoProxyEntry {
  2225. NoProxyKind kind = NoProxyKind::Wildcard;
  2226. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2227. IPBytes net{};
  2228. int prefix_bits = 0;
  2229. };
  2230. struct NormalizedTarget {
  2231. std::string hostname; // lowercase; brackets and trailing dot removed
  2232. bool is_ipv4 = false;
  2233. bool is_ipv6 = false;
  2234. IPBytes ip{};
  2235. };
  2236. } // namespace detail
  2237. class ClientImpl {
  2238. public:
  2239. explicit ClientImpl(const std::string &host);
  2240. explicit ClientImpl(const std::string &host, int port);
  2241. explicit ClientImpl(const std::string &host, int port,
  2242. const std::string &client_cert_path,
  2243. const std::string &client_key_path);
  2244. virtual ~ClientImpl();
  2245. virtual bool is_valid() const;
  2246. struct StreamHandle {
  2247. std::unique_ptr<Response> response;
  2248. Error error = Error::Success;
  2249. StreamHandle() = default;
  2250. StreamHandle(const StreamHandle &) = delete;
  2251. StreamHandle &operator=(const StreamHandle &) = delete;
  2252. StreamHandle(StreamHandle &&) = default;
  2253. StreamHandle &operator=(StreamHandle &&) = default;
  2254. ~StreamHandle() = default;
  2255. bool is_valid() const {
  2256. return response != nullptr && error == Error::Success;
  2257. }
  2258. ssize_t read(char *buf, size_t len);
  2259. void parse_trailers_if_needed();
  2260. Error get_read_error() const { return body_reader_.last_error; }
  2261. bool has_read_error() const { return body_reader_.has_error(); }
  2262. bool trailers_parsed_ = false;
  2263. private:
  2264. friend class ClientImpl;
  2265. ssize_t read_with_decompression(char *buf, size_t len);
  2266. std::unique_ptr<ClientConnection> connection_;
  2267. std::unique_ptr<Stream> socket_stream_;
  2268. Stream *stream_ = nullptr;
  2269. detail::BodyReader body_reader_;
  2270. std::unique_ptr<detail::decompressor> decompressor_;
  2271. std::string decompress_buffer_;
  2272. size_t decompress_offset_ = 0;
  2273. size_t decompressed_bytes_read_ = 0;
  2274. };
  2275. // clang-format off
  2276. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2277. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2278. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2279. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2280. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2281. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2282. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2283. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2284. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2285. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2286. Result Head(const std::string &path);
  2287. Result Head(const std::string &path, const Headers &headers);
  2288. Result Post(const std::string &path);
  2289. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2290. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2291. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2293. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2294. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2295. Result Post(const std::string &path, const Params &params);
  2296. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2297. Result Post(const std::string &path, const Headers &headers);
  2298. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2299. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2302. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2303. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2304. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2305. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2306. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2307. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2309. Result Put(const std::string &path);
  2310. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2311. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2312. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2314. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2315. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2316. Result Put(const std::string &path, const Params &params);
  2317. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2318. Result Put(const std::string &path, const Headers &headers);
  2319. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2320. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2321. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2323. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2324. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2325. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2326. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2327. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2328. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2330. Result Patch(const std::string &path);
  2331. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2332. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2333. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2335. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2337. Result Patch(const std::string &path, const Params &params);
  2338. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2339. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2344. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2346. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2347. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2348. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2349. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2351. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2352. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2353. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2354. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2355. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2356. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2357. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2358. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2359. Result Options(const std::string &path);
  2360. Result Options(const std::string &path, const Headers &headers);
  2361. // clang-format on
  2362. // Streaming API: Open a stream for reading response body incrementally
  2363. // Socket ownership is transferred to StreamHandle for true streaming
  2364. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2365. StreamHandle open_stream(const std::string &method, const std::string &path,
  2366. const Params &params = {},
  2367. const Headers &headers = {},
  2368. const std::string &body = {},
  2369. const std::string &content_type = {});
  2370. bool send(Request &req, Response &res, Error &error);
  2371. Result send(const Request &req);
  2372. void stop();
  2373. std::string host() const;
  2374. int port() const;
  2375. size_t is_socket_open() const;
  2376. socket_t socket() const;
  2377. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2378. void set_default_headers(Headers headers);
  2379. void
  2380. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2381. void set_address_family(int family);
  2382. void set_tcp_nodelay(bool on);
  2383. void set_ipv6_v6only(bool on);
  2384. void set_socket_options(SocketOptions socket_options);
  2385. void set_connection_timeout(time_t sec, time_t usec = 0);
  2386. template <class Rep, class Period>
  2387. void
  2388. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2389. void set_read_timeout(time_t sec, time_t usec = 0);
  2390. template <class Rep, class Period>
  2391. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2392. void set_write_timeout(time_t sec, time_t usec = 0);
  2393. template <class Rep, class Period>
  2394. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2395. void set_max_timeout(time_t msec);
  2396. template <class Rep, class Period>
  2397. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2398. void set_basic_auth(const std::string &username, const std::string &password);
  2399. void set_bearer_token_auth(const std::string &token);
  2400. void set_keep_alive(bool on);
  2401. void set_follow_location(bool on);
  2402. void set_path_encode(bool on);
  2403. void set_compress(bool on);
  2404. void set_decompress(bool on);
  2405. void set_payload_max_length(size_t length);
  2406. void set_interface(const std::string &intf);
  2407. void set_proxy(const std::string &host, int port);
  2408. void set_proxy_basic_auth(const std::string &username,
  2409. const std::string &password);
  2410. void set_proxy_bearer_token_auth(const std::string &token);
  2411. void set_no_proxy(const std::vector<std::string> &patterns);
  2412. void set_logger(Logger logger);
  2413. void set_error_logger(ErrorLogger error_logger);
  2414. protected:
  2415. struct Socket {
  2416. socket_t sock = INVALID_SOCKET;
  2417. // For Mbed TLS compatibility: start_time for request timeout tracking
  2418. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2419. bool is_open() const { return sock != INVALID_SOCKET; }
  2420. #ifdef CPPHTTPLIB_SSL_ENABLED
  2421. tls::session_t ssl = nullptr;
  2422. #endif
  2423. };
  2424. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2425. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2426. virtual bool setup_proxy_connection(
  2427. Socket &socket,
  2428. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2429. Response &res, bool &success, Error &error);
  2430. bool is_proxy_enabled_for_host(const std::string &host) const;
  2431. // All of:
  2432. // shutdown_ssl
  2433. // shutdown_socket
  2434. // close_socket
  2435. // disconnect
  2436. // should ONLY be called when socket_mutex_ is locked, and only when
  2437. // no other thread is using the socket.
  2438. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2439. void shutdown_socket(Socket &socket) const;
  2440. void close_socket(Socket &socket);
  2441. void disconnect(bool gracefully);
  2442. bool process_request(Stream &strm, Request &req, Response &res,
  2443. bool close_connection, Error &error);
  2444. bool write_content_with_provider(Stream &strm, const Request &req,
  2445. Error &error) const;
  2446. void copy_settings(const ClientImpl &rhs);
  2447. void output_log(const Request &req, const Response &res) const;
  2448. void output_error_log(const Error &err, const Request *req) const;
  2449. // Socket endpoint information
  2450. const std::string host_;
  2451. const int port_;
  2452. // Current open socket
  2453. Socket socket_;
  2454. mutable std::mutex socket_mutex_;
  2455. std::recursive_mutex request_mutex_;
  2456. // These are all protected under socket_mutex
  2457. size_t socket_requests_in_flight_ = 0;
  2458. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2459. bool socket_should_be_closed_when_request_is_done_ = false;
  2460. // Hostname to connection target map. The value is an IP literal or another
  2461. // hostname; only the connection target changes, never the identity.
  2462. std::map<std::string, std::string> addr_map_;
  2463. // Default headers
  2464. Headers default_headers_;
  2465. // Header writer
  2466. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2467. detail::write_headers;
  2468. // Settings
  2469. std::string client_cert_path_;
  2470. std::string client_key_path_;
  2471. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2472. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2473. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2474. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2475. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2476. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2477. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2478. std::string basic_auth_username_;
  2479. std::string basic_auth_password_;
  2480. std::string bearer_token_auth_token_;
  2481. bool keep_alive_ = false;
  2482. bool follow_location_ = false;
  2483. bool path_encode_ = true;
  2484. int address_family_ = AF_UNSPEC;
  2485. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2486. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2487. SocketOptions socket_options_ = nullptr;
  2488. bool compress_ = false;
  2489. bool decompress_ = true;
  2490. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2491. bool has_payload_max_length_ = false;
  2492. std::string interface_;
  2493. std::string proxy_host_;
  2494. int proxy_port_ = -1;
  2495. std::string proxy_basic_auth_username_;
  2496. std::string proxy_basic_auth_password_;
  2497. std::string proxy_bearer_token_auth_token_;
  2498. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2499. mutable detail::NormalizedTarget host_normalized_;
  2500. mutable bool host_normalized_valid_ = false;
  2501. mutable std::mutex logger_mutex_;
  2502. Logger logger_;
  2503. ErrorLogger error_logger_;
  2504. private:
  2505. bool send_(Request &req, Response &res, Error &error);
  2506. Result send_(Request &&req);
  2507. socket_t create_client_socket(Error &error) const;
  2508. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2509. bool skip_100_continue = true) const;
  2510. bool write_request(Stream &strm, Request &req, bool close_connection,
  2511. Error &error, bool skip_body, bool &rejected_locally);
  2512. bool write_request_body(Stream &strm, Request &req, Error &error);
  2513. void prepare_default_headers(Request &r, bool for_stream,
  2514. const std::string &ct);
  2515. bool redirect(Request &req, Response &res, Error &error);
  2516. bool create_redirect_client(const std::string &scheme,
  2517. const std::string &host, int port, Request &req,
  2518. Response &res, const std::string &path,
  2519. const std::string &location, Error &error);
  2520. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2521. bool handle_request(Stream &strm, Request &req, Response &res,
  2522. bool close_connection, Error &error);
  2523. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2524. Request &req, const char *body, size_t content_length,
  2525. ContentProvider content_provider,
  2526. ContentProviderWithoutLength content_provider_without_length,
  2527. const std::string &content_type, ContentReceiver content_receiver,
  2528. Error &error);
  2529. Result send_with_content_provider_and_receiver(
  2530. const std::string &method, const std::string &path,
  2531. const Headers &headers, const char *body, size_t content_length,
  2532. ContentProvider content_provider,
  2533. ContentProviderWithoutLength content_provider_without_length,
  2534. const std::string &content_type, ContentReceiver content_receiver,
  2535. UploadProgress progress);
  2536. ContentProviderWithoutLength get_multipart_content_provider(
  2537. const std::string &boundary, const UploadFormDataItems &items,
  2538. const FormDataProviderItems &provider_items) const;
  2539. virtual bool
  2540. process_socket(const Socket &socket,
  2541. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2542. std::function<bool(Stream &strm)> callback);
  2543. virtual bool is_ssl() const;
  2544. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2545. #ifdef CPPHTTPLIB_SSL_ENABLED
  2546. public:
  2547. void set_digest_auth(const std::string &username,
  2548. const std::string &password);
  2549. void set_proxy_digest_auth(const std::string &username,
  2550. const std::string &password);
  2551. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2552. const std::string &ca_cert_dir_path = std::string());
  2553. void enable_server_certificate_verification(bool enabled);
  2554. void enable_server_hostname_verification(bool enabled);
  2555. void enable_system_ca(bool enabled);
  2556. protected:
  2557. std::string digest_auth_username_;
  2558. std::string digest_auth_password_;
  2559. std::string proxy_digest_auth_username_;
  2560. std::string proxy_digest_auth_password_;
  2561. std::string ca_cert_file_path_;
  2562. std::string ca_cert_dir_path_;
  2563. bool server_certificate_verification_ = true;
  2564. bool server_hostname_verification_ = true;
  2565. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2566. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2567. int last_ssl_error_ = 0;
  2568. uint64_t last_backend_error_ = 0;
  2569. #endif
  2570. };
  2571. class Client {
  2572. public:
  2573. // Universal interface
  2574. explicit Client(const std::string &scheme_host_port);
  2575. explicit Client(const std::string &scheme_host_port,
  2576. const std::string &client_cert_path,
  2577. const std::string &client_key_path);
  2578. // HTTP only interface
  2579. explicit Client(const std::string &host, int port);
  2580. explicit Client(const std::string &host, int port,
  2581. const std::string &client_cert_path,
  2582. const std::string &client_key_path);
  2583. Client(Client &&) = default;
  2584. Client &operator=(Client &&) = default;
  2585. ~Client();
  2586. bool is_valid() const;
  2587. // clang-format off
  2588. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2589. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2590. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2591. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2592. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2593. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2594. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2595. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2596. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2597. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2598. Result Head(const std::string &path);
  2599. Result Head(const std::string &path, const Headers &headers);
  2600. Result Post(const std::string &path);
  2601. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2602. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2603. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2605. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2606. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2607. Result Post(const std::string &path, const Params &params);
  2608. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2609. Result Post(const std::string &path, const Headers &headers);
  2610. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2611. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2614. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2615. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2616. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2617. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2618. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2619. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2620. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2621. Result Put(const std::string &path);
  2622. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2623. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2624. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2626. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2627. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2628. Result Put(const std::string &path, const Params &params);
  2629. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2630. Result Put(const std::string &path, const Headers &headers);
  2631. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2632. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2633. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2635. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2636. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2637. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2638. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2639. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2640. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2641. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2642. Result Patch(const std::string &path);
  2643. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2644. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2645. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2647. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2648. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2649. Result Patch(const std::string &path, const Params &params);
  2650. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2651. Result Patch(const std::string &path, const Headers &headers);
  2652. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2653. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2654. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, 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, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2656. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2657. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2658. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2659. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2660. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2661. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2662. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2663. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2664. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2665. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2666. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2667. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2668. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2669. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2670. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2671. Result Options(const std::string &path);
  2672. Result Options(const std::string &path, const Headers &headers);
  2673. // clang-format on
  2674. // Streaming API: Open a stream for reading response body incrementally
  2675. // Socket ownership is transferred to StreamHandle for true streaming
  2676. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2677. ClientImpl::StreamHandle open_stream(const std::string &method,
  2678. const std::string &path,
  2679. const Params &params = {},
  2680. const Headers &headers = {},
  2681. const std::string &body = {},
  2682. const std::string &content_type = {});
  2683. bool send(Request &req, Response &res, Error &error);
  2684. Result send(const Request &req);
  2685. void stop();
  2686. std::string host() const;
  2687. int port() const;
  2688. size_t is_socket_open() const;
  2689. socket_t socket() const;
  2690. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2691. void set_default_headers(Headers headers);
  2692. void
  2693. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2694. void set_address_family(int family);
  2695. void set_tcp_nodelay(bool on);
  2696. void set_socket_options(SocketOptions socket_options);
  2697. void set_connection_timeout(time_t sec, time_t usec = 0);
  2698. template <class Rep, class Period>
  2699. void
  2700. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2701. void set_read_timeout(time_t sec, time_t usec = 0);
  2702. template <class Rep, class Period>
  2703. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2704. void set_write_timeout(time_t sec, time_t usec = 0);
  2705. template <class Rep, class Period>
  2706. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2707. void set_max_timeout(time_t msec);
  2708. template <class Rep, class Period>
  2709. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2710. void set_basic_auth(const std::string &username, const std::string &password);
  2711. void set_bearer_token_auth(const std::string &token);
  2712. void set_keep_alive(bool on);
  2713. void set_follow_location(bool on);
  2714. void set_path_encode(bool on);
  2715. void set_compress(bool on);
  2716. void set_decompress(bool on);
  2717. void set_payload_max_length(size_t length);
  2718. void set_interface(const std::string &intf);
  2719. void set_proxy(const std::string &host, int port);
  2720. void set_proxy_basic_auth(const std::string &username,
  2721. const std::string &password);
  2722. void set_proxy_bearer_token_auth(const std::string &token);
  2723. void set_no_proxy(const std::vector<std::string> &patterns);
  2724. void set_logger(Logger logger);
  2725. void set_error_logger(ErrorLogger error_logger);
  2726. private:
  2727. std::unique_ptr<ClientImpl> cli_;
  2728. #ifdef CPPHTTPLIB_SSL_ENABLED
  2729. public:
  2730. void set_digest_auth(const std::string &username,
  2731. const std::string &password);
  2732. void set_proxy_digest_auth(const std::string &username,
  2733. const std::string &password);
  2734. void enable_server_certificate_verification(bool enabled);
  2735. void enable_server_hostname_verification(bool enabled);
  2736. void enable_system_ca(bool enabled);
  2737. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2738. const std::string &ca_cert_dir_path = std::string());
  2739. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2740. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2741. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2742. void set_session_verifier(
  2743. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2744. tls::ctx_t tls_context() const;
  2745. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2746. void enable_windows_certificate_verification(bool enabled);
  2747. #endif
  2748. private:
  2749. bool is_ssl_ = false;
  2750. #endif
  2751. };
  2752. #ifdef CPPHTTPLIB_SSL_ENABLED
  2753. class SSLServer : public Server {
  2754. public:
  2755. SSLServer(const char *cert_path, const char *private_key_path,
  2756. const char *client_ca_cert_file_path = nullptr,
  2757. const char *client_ca_cert_dir_path = nullptr,
  2758. const char *private_key_password = nullptr);
  2759. struct PemMemory {
  2760. const char *cert_pem;
  2761. size_t cert_pem_len;
  2762. const char *key_pem;
  2763. size_t key_pem_len;
  2764. const char *client_ca_pem;
  2765. size_t client_ca_pem_len;
  2766. const char *private_key_password;
  2767. };
  2768. explicit SSLServer(const PemMemory &pem);
  2769. // The callback receives the ctx_t handle which can be cast to the
  2770. // appropriate backend type (SSL_CTX* for OpenSSL,
  2771. // tls::impl::MbedTlsContext* for Mbed TLS)
  2772. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2773. ~SSLServer() override;
  2774. bool is_valid() const override;
  2775. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2776. const char *client_ca_pem = nullptr,
  2777. const char *password = nullptr);
  2778. tls::ctx_t tls_context() const { return ctx_; }
  2779. int ssl_last_error() const { return last_ssl_error_; }
  2780. private:
  2781. bool process_and_close_socket(socket_t sock) override;
  2782. tls::ctx_t ctx_ = nullptr;
  2783. std::mutex ctx_mutex_;
  2784. int last_ssl_error_ = 0;
  2785. };
  2786. class SSLClient final : public ClientImpl {
  2787. public:
  2788. explicit SSLClient(const std::string &host);
  2789. explicit SSLClient(const std::string &host, int port);
  2790. explicit SSLClient(const std::string &host, int port,
  2791. const std::string &client_cert_path,
  2792. const std::string &client_key_path,
  2793. const std::string &private_key_password = std::string());
  2794. struct PemMemory {
  2795. const char *cert_pem;
  2796. size_t cert_pem_len;
  2797. const char *key_pem;
  2798. size_t key_pem_len;
  2799. const char *private_key_password;
  2800. };
  2801. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2802. ~SSLClient() override;
  2803. bool is_valid() const override;
  2804. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2805. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2806. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2807. // Post-handshake session verifier (backend-independent)
  2808. void set_session_verifier(
  2809. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2810. tls::ctx_t tls_context() const { return ctx_; }
  2811. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2812. void enable_windows_certificate_verification(bool enabled);
  2813. #endif
  2814. private:
  2815. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2816. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2817. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2818. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2819. bool
  2820. process_socket(const Socket &socket,
  2821. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2822. std::function<bool(Stream &strm)> callback) override;
  2823. bool is_ssl() const override;
  2824. bool setup_proxy_connection(
  2825. Socket &socket,
  2826. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2827. Response &res, bool &success, Error &error) override;
  2828. bool connect_with_proxy(
  2829. Socket &sock,
  2830. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2831. Response &res, bool &success, Error &error);
  2832. bool initialize_ssl(Socket &socket, Error &error);
  2833. void init_ctx();
  2834. void reset_ctx_on_error();
  2835. bool load_certs();
  2836. tls::ctx_t ctx_ = nullptr;
  2837. std::mutex ctx_mutex_;
  2838. std::once_flag initialize_cert_;
  2839. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2840. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2841. // Used to keep custom CA configuration exclusive with system CA loading.
  2842. bool ca_cert_store_set_ = false;
  2843. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2844. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2845. bool enable_windows_cert_verification_ = true;
  2846. // Like ca_cert_store_set_, tracks what ctx_ cannot report back: whether
  2847. // set_server_certificate_verifier() installed a verifier.
  2848. bool server_certificate_verifier_set_ = false;
  2849. #endif
  2850. friend class ClientImpl;
  2851. };
  2852. #endif // CPPHTTPLIB_SSL_ENABLED
  2853. namespace detail {
  2854. template <typename T, typename U>
  2855. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2856. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2857. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2858. duration - std::chrono::seconds(sec))
  2859. .count();
  2860. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2861. }
  2862. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2863. return N - 1;
  2864. }
  2865. inline bool is_numeric(const std::string &str) {
  2866. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2867. }
  2868. // std::ranges::next(first, n, last) for C++11
  2869. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2870. for (; n > 0 && first != last; --n) {
  2871. ++first;
  2872. }
  2873. return first;
  2874. }
  2875. inline size_t get_header_value_u64(const Headers &headers,
  2876. const std::string &key, size_t def,
  2877. size_t id, bool &is_invalid_value) {
  2878. is_invalid_value = false;
  2879. auto rng = headers.equal_range(key);
  2880. auto it = bounded_next(rng.first, id, rng.second);
  2881. if (it != rng.second) {
  2882. if (is_numeric(it->second)) {
  2883. // Parse at size_t width so an out-of-range Content-Length is reported
  2884. // rather than silently saturated/truncated (a value above 2^32 would
  2885. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2886. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2887. size_t val = 0;
  2888. const auto &s = it->second;
  2889. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2890. if (r.ec == std::errc::result_out_of_range) {
  2891. is_invalid_value = true;
  2892. return (std::numeric_limits<size_t>::max)();
  2893. }
  2894. return val;
  2895. } else {
  2896. is_invalid_value = true;
  2897. }
  2898. }
  2899. return def;
  2900. }
  2901. inline size_t get_header_value_u64(const Headers &headers,
  2902. const std::string &key, size_t def,
  2903. size_t id) {
  2904. auto dummy = false;
  2905. return get_header_value_u64(headers, key, def, id, dummy);
  2906. }
  2907. } // namespace detail
  2908. template <class Rep, class Period>
  2909. inline Server &
  2910. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2911. detail::duration_to_sec_and_usec(
  2912. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2913. return *this;
  2914. }
  2915. template <class Rep, class Period>
  2916. inline Server &
  2917. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2918. detail::duration_to_sec_and_usec(
  2919. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2920. return *this;
  2921. }
  2922. template <class Rep, class Period>
  2923. inline Server &
  2924. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2925. detail::duration_to_sec_and_usec(
  2926. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2927. return *this;
  2928. }
  2929. template <class Rep, class Period>
  2930. inline void ClientImpl::set_connection_timeout(
  2931. const std::chrono::duration<Rep, Period> &duration) {
  2932. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2933. set_connection_timeout(sec, usec);
  2934. });
  2935. }
  2936. template <class Rep, class Period>
  2937. inline void ClientImpl::set_read_timeout(
  2938. const std::chrono::duration<Rep, Period> &duration) {
  2939. detail::duration_to_sec_and_usec(
  2940. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2941. }
  2942. template <class Rep, class Period>
  2943. inline void ClientImpl::set_write_timeout(
  2944. const std::chrono::duration<Rep, Period> &duration) {
  2945. detail::duration_to_sec_and_usec(
  2946. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2947. }
  2948. template <class Rep, class Period>
  2949. inline void ClientImpl::set_max_timeout(
  2950. const std::chrono::duration<Rep, Period> &duration) {
  2951. auto msec =
  2952. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2953. set_max_timeout(msec);
  2954. }
  2955. template <class Rep, class Period>
  2956. inline void Client::set_connection_timeout(
  2957. const std::chrono::duration<Rep, Period> &duration) {
  2958. cli_->set_connection_timeout(duration);
  2959. }
  2960. template <class Rep, class Period>
  2961. inline void
  2962. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2963. cli_->set_read_timeout(duration);
  2964. }
  2965. template <class Rep, class Period>
  2966. inline void
  2967. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2968. cli_->set_write_timeout(duration);
  2969. }
  2970. inline void Client::set_max_timeout(time_t msec) {
  2971. cli_->set_max_timeout(msec);
  2972. }
  2973. template <class Rep, class Period>
  2974. inline void
  2975. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2976. cli_->set_max_timeout(duration);
  2977. }
  2978. /*
  2979. * Forward declarations and types that will be part of the .h file if split into
  2980. * .h + .cc.
  2981. */
  2982. std::string hosted_at(const std::string &hostname);
  2983. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2984. // JavaScript-style URL encoding/decoding functions
  2985. std::string encode_uri_component(const std::string &value);
  2986. std::string encode_uri(const std::string &value);
  2987. std::string decode_uri_component(const std::string &value);
  2988. std::string decode_uri(const std::string &value);
  2989. // RFC 3986 compliant URL component encoding/decoding functions
  2990. std::string encode_path_component(const std::string &component);
  2991. std::string decode_path_component(const std::string &component);
  2992. std::string encode_query_component(const std::string &component,
  2993. bool space_as_plus = true);
  2994. std::string decode_query_component(const std::string &component,
  2995. bool plus_as_space = true);
  2996. std::string sanitize_filename(const std::string &filename);
  2997. std::string append_query_params(const std::string &path, const Params &params);
  2998. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2999. std::pair<std::string, std::string>
  3000. make_basic_authentication_header(const std::string &username,
  3001. const std::string &password,
  3002. bool is_proxy = false);
  3003. namespace detail {
  3004. #if defined(_WIN32)
  3005. inline std::wstring u8string_to_wstring(const char *s) {
  3006. if (!s) { return std::wstring(); }
  3007. auto len = static_cast<int>(strlen(s));
  3008. if (!len) { return std::wstring(); }
  3009. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3010. if (!wlen) { return std::wstring(); }
  3011. std::wstring ws;
  3012. ws.resize(wlen);
  3013. wlen = ::MultiByteToWideChar(
  3014. CP_UTF8, 0, s, len,
  3015. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3016. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3017. return ws;
  3018. }
  3019. #endif
  3020. struct FileStat {
  3021. FileStat(const std::string &path);
  3022. bool is_file() const;
  3023. bool is_dir() const;
  3024. time_t mtime() const;
  3025. size_t size() const;
  3026. private:
  3027. #if defined(_WIN32)
  3028. struct _stat st_;
  3029. #else
  3030. struct stat st_;
  3031. #endif
  3032. int ret_ = -1;
  3033. };
  3034. std::string make_host_and_port_string(const std::string &host, int port,
  3035. bool is_ssl);
  3036. template <typename T>
  3037. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3038. Error &error);
  3039. std::string trim_copy(const std::string &s);
  3040. void divide(
  3041. const char *data, std::size_t size, char d,
  3042. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3043. fn);
  3044. void divide(
  3045. const std::string &str, char d,
  3046. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3047. fn);
  3048. void split(const char *b, const char *e, char d,
  3049. std::function<void(const char *, const char *)> fn);
  3050. void split(const char *b, const char *e, char d, size_t m,
  3051. std::function<void(const char *, const char *)> fn);
  3052. bool split_find(const char *b, const char *e, char d,
  3053. std::function<bool(const char *, const char *)> fn);
  3054. bool has_header_token(const Headers &headers, const std::string &key,
  3055. const std::string &token);
  3056. std::string websocket_accept_key(const std::string &client_key);
  3057. bool is_websocket_upgrade(const Request &req);
  3058. bool process_client_socket(
  3059. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3060. time_t write_timeout_sec, time_t write_timeout_usec,
  3061. time_t max_timeout_msec,
  3062. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3063. std::function<bool(Stream &)> callback);
  3064. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3065. int port, int address_family, bool tcp_nodelay,
  3066. bool ipv6_v6only, SocketOptions socket_options,
  3067. time_t connection_timeout_sec,
  3068. time_t connection_timeout_usec,
  3069. time_t read_timeout_sec, time_t read_timeout_usec,
  3070. time_t write_timeout_sec,
  3071. time_t write_timeout_usec,
  3072. const std::string &intf, Error &error);
  3073. const char *get_header_value(const Headers &headers, const std::string &key,
  3074. const char *def, size_t id);
  3075. std::string get_combined_header_value(const Headers &headers,
  3076. const std::string &key);
  3077. std::string params_to_query_str(const Params &params);
  3078. void parse_query_text(const char *data, std::size_t size, Params &params);
  3079. void parse_query_text(const std::string &s, Params &params);
  3080. bool parse_multipart_boundary(const std::string &content_type,
  3081. std::string &boundary);
  3082. bool parse_range_header(const std::string &s, Ranges &ranges);
  3083. bool parse_accept_header(const std::string &s,
  3084. std::vector<std::string> &content_types);
  3085. void parse_disposition_params(const std::string &s, Params &params);
  3086. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3087. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3088. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3089. EncodingType encoding_type(const Request &req, const Response &res,
  3090. const std::string &content_type);
  3091. EncodingType encoding_type(const Request &req, const Response &res);
  3092. class BufferStream final : public Stream {
  3093. public:
  3094. BufferStream() = default;
  3095. ~BufferStream() override = default;
  3096. bool is_readable() const override;
  3097. bool wait_readable() const override;
  3098. bool wait_writable() const override;
  3099. ssize_t read(char *ptr, size_t size) override;
  3100. ssize_t write(const char *ptr, size_t size) override;
  3101. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3102. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3103. socket_t socket() const override;
  3104. time_t duration() const override;
  3105. const std::string &get_buffer() const;
  3106. private:
  3107. std::string buffer;
  3108. size_t position = 0;
  3109. };
  3110. class compressor {
  3111. public:
  3112. virtual ~compressor() = default;
  3113. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3114. virtual bool compress(const char *data, size_t data_length, bool last,
  3115. Callback callback) = 0;
  3116. };
  3117. class decompressor {
  3118. public:
  3119. virtual ~decompressor() = default;
  3120. virtual bool is_valid() const = 0;
  3121. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3122. virtual bool decompress(const char *data, size_t data_length,
  3123. Callback callback) = 0;
  3124. };
  3125. class nocompressor final : public compressor {
  3126. public:
  3127. ~nocompressor() override = default;
  3128. bool compress(const char *data, size_t data_length, bool /*last*/,
  3129. Callback callback) override;
  3130. };
  3131. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3132. class gzip_compressor final : public compressor {
  3133. public:
  3134. gzip_compressor();
  3135. ~gzip_compressor() override;
  3136. bool compress(const char *data, size_t data_length, bool last,
  3137. Callback callback) override;
  3138. private:
  3139. bool is_valid_ = false;
  3140. z_stream strm_;
  3141. };
  3142. class gzip_decompressor final : public decompressor {
  3143. public:
  3144. gzip_decompressor();
  3145. ~gzip_decompressor() override;
  3146. bool is_valid() const override;
  3147. bool decompress(const char *data, size_t data_length,
  3148. Callback callback) override;
  3149. private:
  3150. bool is_valid_ = false;
  3151. z_stream strm_;
  3152. };
  3153. #endif
  3154. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3155. class brotli_compressor final : public compressor {
  3156. public:
  3157. brotli_compressor();
  3158. ~brotli_compressor();
  3159. bool compress(const char *data, size_t data_length, bool last,
  3160. Callback callback) override;
  3161. private:
  3162. BrotliEncoderState *state_ = nullptr;
  3163. };
  3164. class brotli_decompressor final : public decompressor {
  3165. public:
  3166. brotli_decompressor();
  3167. ~brotli_decompressor();
  3168. bool is_valid() const override;
  3169. bool decompress(const char *data, size_t data_length,
  3170. Callback callback) override;
  3171. private:
  3172. BrotliDecoderResult decoder_r;
  3173. BrotliDecoderState *decoder_s = nullptr;
  3174. };
  3175. #endif
  3176. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3177. class zstd_compressor : public compressor {
  3178. public:
  3179. zstd_compressor();
  3180. ~zstd_compressor();
  3181. bool compress(const char *data, size_t data_length, bool last,
  3182. Callback callback) override;
  3183. private:
  3184. ZSTD_CCtx *ctx_ = nullptr;
  3185. };
  3186. class zstd_decompressor : public decompressor {
  3187. public:
  3188. zstd_decompressor();
  3189. ~zstd_decompressor();
  3190. bool is_valid() const override;
  3191. bool decompress(const char *data, size_t data_length,
  3192. Callback callback) override;
  3193. private:
  3194. ZSTD_DCtx *ctx_ = nullptr;
  3195. };
  3196. #endif
  3197. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3198. // to store data. The call can set memory on stack for performance.
  3199. class stream_line_reader {
  3200. public:
  3201. stream_line_reader(Stream &strm, char *fixed_buffer,
  3202. size_t fixed_buffer_size);
  3203. const char *ptr() const;
  3204. size_t size() const;
  3205. bool end_with_crlf() const;
  3206. bool getline();
  3207. private:
  3208. void append(char c);
  3209. void append(const char *data, size_t size);
  3210. Stream &strm_;
  3211. char *fixed_buffer_;
  3212. const size_t fixed_buffer_size_;
  3213. size_t fixed_buffer_used_size_ = 0;
  3214. std::string growable_buffer_;
  3215. };
  3216. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3217. const Headers &src_headers);
  3218. struct ChunkedDecoder {
  3219. Stream &strm;
  3220. size_t chunk_remaining = 0;
  3221. bool finished = false;
  3222. char line_buf[64];
  3223. size_t last_chunk_total = 0;
  3224. size_t last_chunk_offset = 0;
  3225. explicit ChunkedDecoder(Stream &s);
  3226. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3227. size_t &out_chunk_total);
  3228. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3229. };
  3230. class mmap {
  3231. public:
  3232. mmap(const char *path);
  3233. ~mmap();
  3234. bool open(const char *path);
  3235. void close();
  3236. bool is_open() const;
  3237. size_t size() const;
  3238. const char *data() const;
  3239. private:
  3240. #if defined(_WIN32)
  3241. HANDLE hFile_ = NULL;
  3242. HANDLE hMapping_ = NULL;
  3243. #else
  3244. int fd_ = -1;
  3245. #endif
  3246. size_t size_ = 0;
  3247. void *addr_ = nullptr;
  3248. bool is_open_empty_file = false;
  3249. };
  3250. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3251. namespace fields {
  3252. bool is_token_char(char c);
  3253. bool is_token(const std::string &s);
  3254. bool is_field_name(const std::string &s);
  3255. bool is_vchar(char c);
  3256. bool is_obs_text(char c);
  3257. bool is_field_vchar(char c);
  3258. bool is_field_content(const std::string &s);
  3259. bool is_field_value(const std::string &s);
  3260. bool is_field_valid(const std::string &name, const std::string &value);
  3261. bool is_request_target(const std::string &s);
  3262. bool is_host(const std::string &s);
  3263. } // namespace fields
  3264. } // namespace detail
  3265. /*
  3266. * TLS Abstraction Layer Declarations
  3267. */
  3268. #ifdef CPPHTTPLIB_SSL_ENABLED
  3269. // TLS abstraction layer - backend-specific type declarations
  3270. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3271. namespace tls {
  3272. namespace impl {
  3273. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3274. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3275. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3276. struct MbedTlsContext {
  3277. mbedtls_ssl_config conf;
  3278. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3279. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3280. mbedtls_entropy_context entropy;
  3281. mbedtls_ctr_drbg_context ctr_drbg;
  3282. #endif
  3283. mbedtls_x509_crt ca_chain;
  3284. mbedtls_x509_crt own_cert;
  3285. mbedtls_pk_context own_key;
  3286. bool is_server = false;
  3287. bool verify_client = false;
  3288. bool has_verify_callback = false;
  3289. MbedTlsContext();
  3290. ~MbedTlsContext();
  3291. MbedTlsContext(const MbedTlsContext &) = delete;
  3292. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3293. };
  3294. } // namespace impl
  3295. } // namespace tls
  3296. #endif
  3297. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3298. namespace tls {
  3299. namespace impl {
  3300. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3301. // This struct is accessible via tls::impl for use in SSL context
  3302. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3303. struct WolfSSLContext {
  3304. WOLFSSL_CTX *ctx = nullptr;
  3305. bool is_server = false;
  3306. bool verify_client = false;
  3307. bool has_verify_callback = false;
  3308. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3309. WolfSSLContext();
  3310. ~WolfSSLContext();
  3311. WolfSSLContext(const WolfSSLContext &) = delete;
  3312. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3313. };
  3314. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3315. struct WolfSSLCAStore {
  3316. std::string pem_data;
  3317. };
  3318. } // namespace impl
  3319. } // namespace tls
  3320. #endif
  3321. #endif // CPPHTTPLIB_SSL_ENABLED
  3322. namespace stream {
  3323. class Result {
  3324. public:
  3325. Result();
  3326. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3327. Result(Result &&other) noexcept;
  3328. Result &operator=(Result &&other) noexcept;
  3329. Result(const Result &) = delete;
  3330. Result &operator=(const Result &) = delete;
  3331. // Response info
  3332. bool is_valid() const;
  3333. explicit operator bool() const;
  3334. int status() const;
  3335. const Headers &headers() const;
  3336. std::string get_header_value(const std::string &key,
  3337. const char *def = "") const;
  3338. bool has_header(const std::string &key) const;
  3339. Error error() const;
  3340. Error read_error() const;
  3341. bool has_read_error() const;
  3342. // Stream reading
  3343. bool next();
  3344. const char *data() const;
  3345. size_t size() const;
  3346. std::string read_all();
  3347. private:
  3348. ClientImpl::StreamHandle handle_;
  3349. std::string buffer_;
  3350. size_t current_size_ = 0;
  3351. size_t chunk_size_;
  3352. bool finished_ = false;
  3353. };
  3354. // GET
  3355. template <typename ClientType>
  3356. inline Result Get(ClientType &cli, const std::string &path,
  3357. size_t chunk_size = 8192) {
  3358. return Result{cli.open_stream("GET", path), chunk_size};
  3359. }
  3360. template <typename ClientType>
  3361. inline Result Get(ClientType &cli, const std::string &path,
  3362. const Headers &headers, size_t chunk_size = 8192) {
  3363. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3364. }
  3365. template <typename ClientType>
  3366. inline Result Get(ClientType &cli, const std::string &path,
  3367. const Params &params, size_t chunk_size = 8192) {
  3368. return Result{cli.open_stream("GET", path, params), chunk_size};
  3369. }
  3370. template <typename ClientType>
  3371. inline Result Get(ClientType &cli, const std::string &path,
  3372. const Params &params, const Headers &headers,
  3373. size_t chunk_size = 8192) {
  3374. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3375. }
  3376. // POST
  3377. template <typename ClientType>
  3378. inline Result Post(ClientType &cli, const std::string &path,
  3379. const std::string &body, const std::string &content_type,
  3380. size_t chunk_size = 8192) {
  3381. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3382. chunk_size};
  3383. }
  3384. template <typename ClientType>
  3385. inline Result Post(ClientType &cli, const std::string &path,
  3386. const Headers &headers, const std::string &body,
  3387. const std::string &content_type, size_t chunk_size = 8192) {
  3388. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3389. chunk_size};
  3390. }
  3391. template <typename ClientType>
  3392. inline Result Post(ClientType &cli, const std::string &path,
  3393. const Params &params, const std::string &body,
  3394. const std::string &content_type, size_t chunk_size = 8192) {
  3395. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3396. chunk_size};
  3397. }
  3398. template <typename ClientType>
  3399. inline Result Post(ClientType &cli, const std::string &path,
  3400. const Params &params, const Headers &headers,
  3401. const std::string &body, const std::string &content_type,
  3402. size_t chunk_size = 8192) {
  3403. return Result{
  3404. cli.open_stream("POST", path, params, headers, body, content_type),
  3405. chunk_size};
  3406. }
  3407. // PUT
  3408. template <typename ClientType>
  3409. inline Result Put(ClientType &cli, const std::string &path,
  3410. const std::string &body, const std::string &content_type,
  3411. size_t chunk_size = 8192) {
  3412. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3413. chunk_size};
  3414. }
  3415. template <typename ClientType>
  3416. inline Result Put(ClientType &cli, const std::string &path,
  3417. const Headers &headers, const std::string &body,
  3418. const std::string &content_type, size_t chunk_size = 8192) {
  3419. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3420. chunk_size};
  3421. }
  3422. template <typename ClientType>
  3423. inline Result Put(ClientType &cli, const std::string &path,
  3424. const Params &params, const std::string &body,
  3425. const std::string &content_type, size_t chunk_size = 8192) {
  3426. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3427. chunk_size};
  3428. }
  3429. template <typename ClientType>
  3430. inline Result Put(ClientType &cli, const std::string &path,
  3431. const Params &params, const Headers &headers,
  3432. const std::string &body, const std::string &content_type,
  3433. size_t chunk_size = 8192) {
  3434. return Result{
  3435. cli.open_stream("PUT", path, params, headers, body, content_type),
  3436. chunk_size};
  3437. }
  3438. // PATCH
  3439. template <typename ClientType>
  3440. inline Result Patch(ClientType &cli, const std::string &path,
  3441. const std::string &body, const std::string &content_type,
  3442. size_t chunk_size = 8192) {
  3443. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3444. chunk_size};
  3445. }
  3446. template <typename ClientType>
  3447. inline Result Patch(ClientType &cli, const std::string &path,
  3448. const Headers &headers, const std::string &body,
  3449. const std::string &content_type, size_t chunk_size = 8192) {
  3450. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3451. chunk_size};
  3452. }
  3453. template <typename ClientType>
  3454. inline Result Patch(ClientType &cli, const std::string &path,
  3455. const Params &params, const std::string &body,
  3456. const std::string &content_type, size_t chunk_size = 8192) {
  3457. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3458. chunk_size};
  3459. }
  3460. template <typename ClientType>
  3461. inline Result Patch(ClientType &cli, const std::string &path,
  3462. const Params &params, const Headers &headers,
  3463. const std::string &body, const std::string &content_type,
  3464. size_t chunk_size = 8192) {
  3465. return Result{
  3466. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3467. chunk_size};
  3468. }
  3469. // DELETE
  3470. template <typename ClientType>
  3471. inline Result Delete(ClientType &cli, const std::string &path,
  3472. size_t chunk_size = 8192) {
  3473. return Result{cli.open_stream("DELETE", path), chunk_size};
  3474. }
  3475. template <typename ClientType>
  3476. inline Result Delete(ClientType &cli, const std::string &path,
  3477. const Headers &headers, size_t chunk_size = 8192) {
  3478. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3479. }
  3480. template <typename ClientType>
  3481. inline Result Delete(ClientType &cli, const std::string &path,
  3482. const std::string &body, const std::string &content_type,
  3483. size_t chunk_size = 8192) {
  3484. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3485. chunk_size};
  3486. }
  3487. template <typename ClientType>
  3488. inline Result Delete(ClientType &cli, const std::string &path,
  3489. const Headers &headers, const std::string &body,
  3490. const std::string &content_type,
  3491. size_t chunk_size = 8192) {
  3492. return Result{
  3493. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3494. chunk_size};
  3495. }
  3496. template <typename ClientType>
  3497. inline Result Delete(ClientType &cli, const std::string &path,
  3498. const Params &params, size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Delete(ClientType &cli, const std::string &path,
  3503. const Params &params, const Headers &headers,
  3504. size_t chunk_size = 8192) {
  3505. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3506. }
  3507. template <typename ClientType>
  3508. inline Result Delete(ClientType &cli, const std::string &path,
  3509. const Params &params, const std::string &body,
  3510. const std::string &content_type,
  3511. size_t chunk_size = 8192) {
  3512. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3513. chunk_size};
  3514. }
  3515. template <typename ClientType>
  3516. inline Result Delete(ClientType &cli, const std::string &path,
  3517. const Params &params, const Headers &headers,
  3518. const std::string &body, const std::string &content_type,
  3519. size_t chunk_size = 8192) {
  3520. return Result{
  3521. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3522. chunk_size};
  3523. }
  3524. // HEAD
  3525. template <typename ClientType>
  3526. inline Result Head(ClientType &cli, const std::string &path,
  3527. size_t chunk_size = 8192) {
  3528. return Result{cli.open_stream("HEAD", path), chunk_size};
  3529. }
  3530. template <typename ClientType>
  3531. inline Result Head(ClientType &cli, const std::string &path,
  3532. const Headers &headers, size_t chunk_size = 8192) {
  3533. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Head(ClientType &cli, const std::string &path,
  3537. const Params &params, size_t chunk_size = 8192) {
  3538. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3539. }
  3540. template <typename ClientType>
  3541. inline Result Head(ClientType &cli, const std::string &path,
  3542. const Params &params, const Headers &headers,
  3543. size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3545. }
  3546. // OPTIONS
  3547. template <typename ClientType>
  3548. inline Result Options(ClientType &cli, const std::string &path,
  3549. size_t chunk_size = 8192) {
  3550. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3551. }
  3552. template <typename ClientType>
  3553. inline Result Options(ClientType &cli, const std::string &path,
  3554. const Headers &headers, size_t chunk_size = 8192) {
  3555. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3556. }
  3557. template <typename ClientType>
  3558. inline Result Options(ClientType &cli, const std::string &path,
  3559. const Params &params, size_t chunk_size = 8192) {
  3560. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3561. }
  3562. template <typename ClientType>
  3563. inline Result Options(ClientType &cli, const std::string &path,
  3564. const Params &params, const Headers &headers,
  3565. size_t chunk_size = 8192) {
  3566. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3567. }
  3568. } // namespace stream
  3569. namespace sse {
  3570. struct SSEMessage {
  3571. std::string event; // Event type (default: "message")
  3572. std::string data; // Event payload
  3573. std::string id; // Event ID for Last-Event-ID header
  3574. SSEMessage();
  3575. void clear();
  3576. };
  3577. class SSEClient {
  3578. public:
  3579. using MessageHandler = std::function<void(const SSEMessage &)>;
  3580. using ErrorHandler = std::function<void(Error)>;
  3581. using OpenHandler = std::function<void()>;
  3582. SSEClient(Client &client, const std::string &path);
  3583. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3584. ~SSEClient();
  3585. SSEClient(const SSEClient &) = delete;
  3586. SSEClient &operator=(const SSEClient &) = delete;
  3587. // Event handlers
  3588. SSEClient &on_message(MessageHandler handler);
  3589. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3590. SSEClient &on_open(OpenHandler handler);
  3591. SSEClient &on_error(ErrorHandler handler);
  3592. SSEClient &set_reconnect_interval(int ms);
  3593. SSEClient &set_max_reconnect_attempts(int n);
  3594. // Update headers (thread-safe)
  3595. SSEClient &set_headers(const Headers &headers);
  3596. // State accessors
  3597. bool is_connected() const;
  3598. const std::string &last_event_id() const;
  3599. // Blocking start - runs event loop with auto-reconnect
  3600. void start();
  3601. // Non-blocking start - runs in background thread
  3602. void start_async();
  3603. // Stop the client (thread-safe)
  3604. void stop();
  3605. private:
  3606. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3607. bool &has_data, bool &has_id);
  3608. void run_event_loop();
  3609. void dispatch_event(const SSEMessage &msg);
  3610. bool should_reconnect(int count) const;
  3611. void wait_for_reconnect();
  3612. // Client and path
  3613. Client &client_;
  3614. std::string path_;
  3615. Headers headers_;
  3616. mutable std::mutex headers_mutex_;
  3617. // Callbacks
  3618. MessageHandler on_message_;
  3619. std::map<std::string, MessageHandler> event_handlers_;
  3620. OpenHandler on_open_;
  3621. ErrorHandler on_error_;
  3622. // Configuration
  3623. int reconnect_interval_ms_ = 3000;
  3624. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3625. // State
  3626. std::atomic<bool> running_{false};
  3627. std::atomic<bool> connected_{false};
  3628. std::string last_event_id_;
  3629. // Async support
  3630. std::thread async_thread_;
  3631. };
  3632. } // namespace sse
  3633. namespace ws {
  3634. class WebSocketClient;
  3635. enum class Opcode : uint8_t {
  3636. Continuation = 0x0,
  3637. Text = 0x1,
  3638. Binary = 0x2,
  3639. Close = 0x8,
  3640. Ping = 0x9,
  3641. Pong = 0xA,
  3642. };
  3643. enum class CloseStatus : uint16_t {
  3644. Normal = 1000,
  3645. GoingAway = 1001,
  3646. ProtocolError = 1002,
  3647. UnsupportedData = 1003,
  3648. NoStatus = 1005,
  3649. Abnormal = 1006,
  3650. InvalidPayload = 1007,
  3651. PolicyViolation = 1008,
  3652. MessageTooBig = 1009,
  3653. MandatoryExtension = 1010,
  3654. InternalError = 1011,
  3655. };
  3656. // Timeout is returned only when a read timeout was set and it elapsed before
  3657. // any byte of a frame arrived: nothing was consumed and the connection is
  3658. // still open, so the caller can send on it and read again. `msg` is left
  3659. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3660. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3661. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3662. // upgrade handshake fully succeeded. On failure error() identifies the
  3663. // failing layer; status()/headers() expose the server's upgrade response
  3664. // when one was received (status() is -1 otherwise).
  3665. class Result {
  3666. public:
  3667. Result() = default;
  3668. Result(Error err, int status, Headers &&headers)
  3669. : err_(err), status_(status), headers_(std::move(headers)) {}
  3670. explicit operator bool() const { return err_ == Error::Success; }
  3671. Error error() const { return err_; }
  3672. // Upgrade response info
  3673. int status() const { return status_; }
  3674. const Headers &headers() const { return headers_; }
  3675. std::string get_header_value(const std::string &key,
  3676. const char *def = "") const {
  3677. return detail::get_header_value(headers_, key, def, 0);
  3678. }
  3679. bool has_header(const std::string &key) const {
  3680. return headers_.find(key) != headers_.end();
  3681. }
  3682. #ifdef CPPHTTPLIB_SSL_ENABLED
  3683. Result(Error err, int status, Headers &&headers, int ssl_error,
  3684. uint64_t ssl_backend_error)
  3685. : err_(err), status_(status), headers_(std::move(headers)),
  3686. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3687. int ssl_error() const { return ssl_error_; }
  3688. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3689. #endif
  3690. private:
  3691. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3692. int status_ = -1;
  3693. Headers headers_;
  3694. #ifdef CPPHTTPLIB_SSL_ENABLED
  3695. int ssl_error_ = 0;
  3696. uint64_t ssl_backend_error_ = 0;
  3697. #endif
  3698. };
  3699. class WebSocket {
  3700. public:
  3701. WebSocket(const WebSocket &) = delete;
  3702. WebSocket &operator=(const WebSocket &) = delete;
  3703. ~WebSocket();
  3704. ReadResult read(std::string &msg);
  3705. bool send(const std::string &data);
  3706. bool send(const char *data, size_t len);
  3707. void close(CloseStatus status = CloseStatus::Normal,
  3708. const std::string &reason = "");
  3709. const Request &request() const;
  3710. bool is_open() const;
  3711. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3712. // A server handler owns its connection's timeout this way; a client sets it
  3713. // through WebSocketClient. Safe to call while another thread is in read().
  3714. //
  3715. // Only a timeout set here is reported as Timeout. The compile-time default
  3716. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3717. // than a request for control, so when it elapses read() returns Fail and
  3718. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3719. void set_read_timeout(time_t sec, time_t usec = 0);
  3720. template <class Rep, class Period>
  3721. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3722. private:
  3723. friend class httplib::Server;
  3724. friend class httplib::ws::WebSocketClient;
  3725. WebSocket(
  3726. Stream &strm, const Request &req, bool is_server,
  3727. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3728. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3729. : strm_(strm), req_(req), is_server_(is_server),
  3730. ping_interval_sec_(ping_interval_sec),
  3731. max_missed_pongs_(max_missed_pongs) {
  3732. start_heartbeat();
  3733. }
  3734. WebSocket(
  3735. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3736. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3737. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3738. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3739. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3740. max_missed_pongs_(max_missed_pongs) {
  3741. start_heartbeat();
  3742. }
  3743. void start_heartbeat();
  3744. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3745. Stream &strm_;
  3746. std::unique_ptr<Stream> owned_strm_;
  3747. Request req_;
  3748. bool is_server_;
  3749. time_t ping_interval_sec_;
  3750. int max_missed_pongs_;
  3751. int unacked_pings_ = 0;
  3752. std::atomic<bool> closed_{false};
  3753. // Set once the caller has bounded read() through set_read_timeout(). Until
  3754. // then the timeout in effect is the compile-time default, and elapsing it
  3755. // is a failure that closes the connection, not a Timeout.
  3756. std::atomic<bool> read_timeout_set_{false};
  3757. std::mutex write_mutex_;
  3758. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3759. // may do so: read_websocket_frame() reads a payload until it has the whole
  3760. // declared length, so a second parser stealing bytes silently corrupts the
  3761. // message the first one is assembling.
  3762. std::mutex read_mutex_;
  3763. std::thread ping_thread_;
  3764. std::mutex ping_mutex_;
  3765. std::condition_variable ping_cv_;
  3766. };
  3767. class WebSocketClient {
  3768. public:
  3769. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3770. const Headers &headers = {});
  3771. ~WebSocketClient();
  3772. WebSocketClient(const WebSocketClient &) = delete;
  3773. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3774. bool is_valid() const;
  3775. Result connect();
  3776. ReadResult read(std::string &msg);
  3777. bool send(const std::string &data);
  3778. bool send(const char *data, size_t len);
  3779. void close(CloseStatus status = CloseStatus::Normal,
  3780. const std::string &reason = "");
  3781. bool is_open() const;
  3782. const std::string &subprotocol() const;
  3783. void set_read_timeout(time_t sec, time_t usec = 0);
  3784. template <class Rep, class Period>
  3785. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3786. void set_write_timeout(time_t sec, time_t usec = 0);
  3787. template <class Rep, class Period>
  3788. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3789. void set_websocket_ping_interval(time_t sec);
  3790. void set_websocket_max_missed_pongs(int count);
  3791. void set_tcp_nodelay(bool on);
  3792. void set_address_family(int family);
  3793. void set_ipv6_v6only(bool on);
  3794. void set_socket_options(SocketOptions socket_options);
  3795. void set_connection_timeout(time_t sec, time_t usec = 0);
  3796. template <class Rep, class Period>
  3797. void
  3798. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3799. void set_interface(const std::string &intf);
  3800. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3801. #ifdef CPPHTTPLIB_SSL_ENABLED
  3802. struct PemMemory {
  3803. const char *cert_pem;
  3804. size_t cert_pem_len;
  3805. const char *key_pem;
  3806. size_t key_pem_len;
  3807. const char *private_key_password;
  3808. };
  3809. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3810. const PemMemory &pem, const Headers &headers = {});
  3811. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3812. const std::string &ca_cert_dir_path = std::string());
  3813. void set_ca_cert_store(tls::ca_store_t store);
  3814. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3815. void enable_server_certificate_verification(bool enabled);
  3816. void enable_server_hostname_verification(bool enabled);
  3817. void enable_system_ca(bool enabled);
  3818. #endif
  3819. private:
  3820. void shutdown_and_close();
  3821. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3822. int &ssl_error, uint64_t &ssl_backend_error);
  3823. void prepare_default_headers(Request &req);
  3824. std::string host_;
  3825. int port_;
  3826. std::string path_;
  3827. Headers headers_;
  3828. std::string subprotocol_;
  3829. bool is_valid_ = false;
  3830. socket_t sock_ = INVALID_SOCKET;
  3831. std::unique_ptr<WebSocket> ws_;
  3832. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3833. time_t read_timeout_usec_ = 0;
  3834. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3835. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3836. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3837. time_t websocket_ping_interval_sec_ =
  3838. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3839. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3840. int address_family_ = AF_UNSPEC;
  3841. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3842. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3843. SocketOptions socket_options_ = nullptr;
  3844. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3845. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3846. std::string interface_;
  3847. // Hostname to connection target map. The value is an IP literal or another
  3848. // hostname; only the connection target changes, never the identity.
  3849. std::map<std::string, std::string> addr_map_;
  3850. #ifdef CPPHTTPLIB_SSL_ENABLED
  3851. bool is_ssl_ = false;
  3852. tls::ctx_t tls_ctx_ = nullptr;
  3853. tls::session_t tls_session_ = nullptr;
  3854. std::string ca_cert_file_path_;
  3855. std::string ca_cert_dir_path_;
  3856. bool custom_ca_loaded_ = false;
  3857. bool certs_loaded_ = false;
  3858. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3859. bool server_certificate_verification_ = true;
  3860. bool server_hostname_verification_ = true;
  3861. #endif
  3862. };
  3863. template <class Rep, class Period>
  3864. inline void WebSocket::set_read_timeout(
  3865. const std::chrono::duration<Rep, Period> &duration) {
  3866. detail::duration_to_sec_and_usec(
  3867. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3868. }
  3869. template <class Rep, class Period>
  3870. inline void WebSocketClient::set_read_timeout(
  3871. const std::chrono::duration<Rep, Period> &duration) {
  3872. detail::duration_to_sec_and_usec(
  3873. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3874. }
  3875. template <class Rep, class Period>
  3876. inline void WebSocketClient::set_write_timeout(
  3877. const std::chrono::duration<Rep, Period> &duration) {
  3878. detail::duration_to_sec_and_usec(
  3879. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3880. }
  3881. template <class Rep, class Period>
  3882. inline void WebSocketClient::set_connection_timeout(
  3883. const std::chrono::duration<Rep, Period> &duration) {
  3884. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3885. set_connection_timeout(sec, usec);
  3886. });
  3887. }
  3888. namespace impl {
  3889. bool is_valid_utf8(const std::string &s);
  3890. // Three states, because a failure that consumed bytes and one that consumed
  3891. // none are not the same thing: the first has left the stream in the middle of
  3892. // a frame and the connection cannot be reused, the second can just be retried.
  3893. enum class FrameRead { Ok, Fail, Timeout };
  3894. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3895. std::string &payload, bool &fin,
  3896. bool expect_masked, size_t max_len);
  3897. } // namespace impl
  3898. } // namespace ws
  3899. // ----------------------------------------------------------------------------
  3900. /*
  3901. * Implementation that will be part of the .cc file if split into .h + .cc.
  3902. */
  3903. namespace stream {
  3904. // stream::Result implementations
  3905. inline Result::Result() : chunk_size_(8192) {}
  3906. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3907. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3908. inline Result::Result(Result &&other) noexcept
  3909. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3910. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3911. finished_(other.finished_) {
  3912. other.current_size_ = 0;
  3913. other.finished_ = true;
  3914. }
  3915. inline Result &Result::operator=(Result &&other) noexcept {
  3916. if (this != &other) {
  3917. handle_ = std::move(other.handle_);
  3918. buffer_ = std::move(other.buffer_);
  3919. current_size_ = other.current_size_;
  3920. chunk_size_ = other.chunk_size_;
  3921. finished_ = other.finished_;
  3922. other.current_size_ = 0;
  3923. other.finished_ = true;
  3924. }
  3925. return *this;
  3926. }
  3927. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3928. inline Result::operator bool() const { return is_valid(); }
  3929. inline int Result::status() const {
  3930. return handle_.response ? handle_.response->status : -1;
  3931. }
  3932. inline const Headers &Result::headers() const {
  3933. static const Headers empty_headers;
  3934. return handle_.response ? handle_.response->headers : empty_headers;
  3935. }
  3936. inline std::string Result::get_header_value(const std::string &key,
  3937. const char *def) const {
  3938. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3939. }
  3940. inline bool Result::has_header(const std::string &key) const {
  3941. return handle_.response ? handle_.response->has_header(key) : false;
  3942. }
  3943. inline Error Result::error() const { return handle_.error; }
  3944. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3945. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3946. inline bool Result::next() {
  3947. if (!handle_.is_valid() || finished_) { return false; }
  3948. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3949. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3950. if (n > 0) {
  3951. current_size_ = static_cast<size_t>(n);
  3952. return true;
  3953. }
  3954. current_size_ = 0;
  3955. finished_ = true;
  3956. return false;
  3957. }
  3958. inline const char *Result::data() const { return buffer_.data(); }
  3959. inline size_t Result::size() const { return current_size_; }
  3960. inline std::string Result::read_all() {
  3961. std::string result;
  3962. while (next()) {
  3963. result.append(data(), size());
  3964. }
  3965. return result;
  3966. }
  3967. } // namespace stream
  3968. namespace sse {
  3969. // SSEMessage implementations
  3970. inline SSEMessage::SSEMessage() : event("message") {}
  3971. inline void SSEMessage::clear() {
  3972. event = "message";
  3973. data.clear();
  3974. id.clear();
  3975. }
  3976. // SSEClient implementations
  3977. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3978. : client_(client), path_(path) {}
  3979. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3980. const Headers &headers)
  3981. : client_(client), path_(path), headers_(headers) {}
  3982. inline SSEClient::~SSEClient() { stop(); }
  3983. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3984. on_message_ = std::move(handler);
  3985. return *this;
  3986. }
  3987. inline SSEClient &SSEClient::on_event(const std::string &type,
  3988. MessageHandler handler) {
  3989. event_handlers_[type] = std::move(handler);
  3990. return *this;
  3991. }
  3992. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3993. on_open_ = std::move(handler);
  3994. return *this;
  3995. }
  3996. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3997. on_error_ = std::move(handler);
  3998. return *this;
  3999. }
  4000. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4001. reconnect_interval_ms_ = ms;
  4002. return *this;
  4003. }
  4004. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4005. max_reconnect_attempts_ = n;
  4006. return *this;
  4007. }
  4008. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4009. std::lock_guard<std::mutex> lock(headers_mutex_);
  4010. headers_ = headers;
  4011. return *this;
  4012. }
  4013. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4014. inline const std::string &SSEClient::last_event_id() const {
  4015. return last_event_id_;
  4016. }
  4017. inline void SSEClient::start() {
  4018. running_.store(true);
  4019. run_event_loop();
  4020. }
  4021. inline void SSEClient::start_async() {
  4022. running_.store(true);
  4023. async_thread_ = std::thread([this]() { run_event_loop(); });
  4024. }
  4025. inline void SSEClient::stop() {
  4026. running_.store(false);
  4027. client_.stop(); // Cancel any pending operations
  4028. if (async_thread_.joinable()) { async_thread_.join(); }
  4029. }
  4030. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4031. int &retry_ms, bool &has_data,
  4032. bool &has_id) {
  4033. // Blank line signals end of event
  4034. if (line.empty()) { return true; }
  4035. // Lines starting with ':' are comments (ignored)
  4036. if (line[0] == ':') { return false; }
  4037. // Find the colon separator
  4038. auto colon_pos = line.find(':');
  4039. auto field = line.substr(0, colon_pos);
  4040. std::string value;
  4041. // Value starts after colon, skip optional single space
  4042. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4043. auto value_start = colon_pos + 1;
  4044. if (line[value_start] == ' ') { value_start++; }
  4045. value = line.substr(value_start);
  4046. }
  4047. // Handle known fields
  4048. if (field == "event") {
  4049. msg.event = value;
  4050. } else if (field == "data") {
  4051. // Multiple data lines are concatenated with newlines
  4052. if (has_data) { msg.data += "\n"; }
  4053. msg.data += value;
  4054. has_data = true;
  4055. } else if (field == "id") {
  4056. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4057. // valid (clears the last event ID)
  4058. if (detail::fields::is_field_value(value)) {
  4059. msg.id = value;
  4060. has_id = true;
  4061. }
  4062. } else if (field == "retry") {
  4063. // Parse retry interval in milliseconds
  4064. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4065. if (detail::is_numeric(value)) {
  4066. int v = 0;
  4067. auto res =
  4068. detail::from_chars(value.data(), value.data() + value.size(), v);
  4069. if (res.ec == std::errc{}) { retry_ms = v; }
  4070. }
  4071. }
  4072. // Unknown fields are ignored per SSE spec
  4073. return false;
  4074. }
  4075. inline void SSEClient::run_event_loop() {
  4076. auto reconnect_count = 0;
  4077. while (running_.load()) {
  4078. // Build headers, including Last-Event-ID if we have one
  4079. Headers request_headers;
  4080. {
  4081. std::lock_guard<std::mutex> lock(headers_mutex_);
  4082. request_headers = headers_;
  4083. }
  4084. if (!last_event_id_.empty()) {
  4085. request_headers.emplace("Last-Event-ID", last_event_id_);
  4086. }
  4087. // Open streaming connection
  4088. auto result = stream::Get(client_, path_, request_headers);
  4089. // Connection error handling
  4090. if (!result) {
  4091. connected_.store(false);
  4092. if (on_error_) { on_error_(result.error()); }
  4093. if (!should_reconnect(reconnect_count)) { break; }
  4094. wait_for_reconnect();
  4095. reconnect_count++;
  4096. continue;
  4097. }
  4098. if (result.status() != StatusCode::OK_200) {
  4099. connected_.store(false);
  4100. if (on_error_) { on_error_(Error::Connection); }
  4101. // For certain errors, don't reconnect.
  4102. // Note: 401 is intentionally absent so that handlers can refresh
  4103. // credentials via set_headers() and let the client reconnect.
  4104. if (result.status() == StatusCode::NoContent_204 ||
  4105. result.status() == StatusCode::NotFound_404 ||
  4106. result.status() == StatusCode::Forbidden_403) {
  4107. break;
  4108. }
  4109. if (!should_reconnect(reconnect_count)) { break; }
  4110. wait_for_reconnect();
  4111. reconnect_count++;
  4112. continue;
  4113. }
  4114. // Connection successful
  4115. connected_.store(true);
  4116. reconnect_count = 0;
  4117. if (on_open_) { on_open_(); }
  4118. // Event receiving loop
  4119. std::string buffer;
  4120. SSEMessage current_msg;
  4121. auto has_data = false;
  4122. auto has_id = false;
  4123. auto first_line = true;
  4124. auto after_cr = false;
  4125. while (running_.load() && result.next()) {
  4126. // What is left in the buffer has no line ending
  4127. auto search_pos = buffer.size();
  4128. buffer.append(result.data(), result.size());
  4129. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4130. // per the SSE spec
  4131. size_t line_start = 0;
  4132. size_t eol_pos;
  4133. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4134. std::string::npos) {
  4135. auto line = buffer.substr(line_start, eol_pos - line_start);
  4136. line_start = eol_pos + 1;
  4137. search_pos = line_start;
  4138. // The \n of a \r\n may arrive in a later chunk than its \r
  4139. auto is_lf_of_crlf =
  4140. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4141. after_cr = buffer[eol_pos] == '\r';
  4142. if (is_lf_of_crlf) { continue; }
  4143. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4144. if (first_line) {
  4145. first_line = false;
  4146. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4147. }
  4148. // Parse the line and check if event is complete
  4149. auto event_complete = parse_sse_line(
  4150. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4151. if (event_complete) {
  4152. // Update last_event_id for reconnection, even for an event that
  4153. // has no data. An empty id clears it.
  4154. if (has_id) { last_event_id_ = current_msg.id; }
  4155. // An event without a data field is not dispatched
  4156. if (has_data) { dispatch_event(current_msg); }
  4157. // Reset the message for the next event either way
  4158. current_msg.clear();
  4159. has_data = false;
  4160. has_id = false;
  4161. }
  4162. }
  4163. // Keep unprocessed data in buffer
  4164. buffer.erase(0, line_start);
  4165. }
  4166. // Connection ended
  4167. connected_.store(false);
  4168. if (!running_.load()) { break; }
  4169. // Check for read errors
  4170. if (result.has_read_error()) {
  4171. if (on_error_) { on_error_(result.read_error()); }
  4172. }
  4173. if (!should_reconnect(reconnect_count)) { break; }
  4174. wait_for_reconnect();
  4175. reconnect_count++;
  4176. }
  4177. connected_.store(false);
  4178. }
  4179. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4180. // Check for specific event type handler first
  4181. auto it = event_handlers_.find(msg.event);
  4182. if (it != event_handlers_.end()) {
  4183. it->second(msg);
  4184. return;
  4185. }
  4186. // Fall back to generic message handler
  4187. if (on_message_) { on_message_(msg); }
  4188. }
  4189. inline bool SSEClient::should_reconnect(int count) const {
  4190. if (!running_.load()) { return false; }
  4191. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4192. return count < max_reconnect_attempts_;
  4193. }
  4194. inline void SSEClient::wait_for_reconnect() {
  4195. // Use small increments to check running_ flag frequently.
  4196. // Always wait at least one increment, so that a zero interval (e.g.
  4197. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4198. const auto step_ms = 100;
  4199. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4200. auto waited = 0;
  4201. while (running_.load() && waited < interval_ms) {
  4202. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4203. waited += step_ms;
  4204. }
  4205. }
  4206. } // namespace sse
  4207. #ifdef CPPHTTPLIB_SSL_ENABLED
  4208. /*
  4209. * TLS abstraction layer - internal function declarations
  4210. * These are implementation details and not part of the public API.
  4211. */
  4212. namespace tls {
  4213. // Client context
  4214. ctx_t create_client_context();
  4215. void free_context(ctx_t ctx);
  4216. bool set_min_version(ctx_t ctx, Version version);
  4217. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4218. bool load_ca_file(ctx_t ctx, const char *file_path);
  4219. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4220. bool load_system_certs(ctx_t ctx);
  4221. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4222. const char *password);
  4223. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4224. const char *key_path, const char *password);
  4225. // Server context
  4226. ctx_t create_server_context();
  4227. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4228. const char *password);
  4229. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4230. const char *key_path, const char *password);
  4231. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4232. void set_verify_client(ctx_t ctx, bool require);
  4233. // Session management
  4234. session_t create_session(ctx_t ctx, socket_t sock);
  4235. void free_session(session_t session);
  4236. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4237. // Handshake (non-blocking capable)
  4238. TlsError connect(session_t session);
  4239. TlsError accept(session_t session);
  4240. // Handshake with timeout (blocking until timeout)
  4241. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4242. time_t timeout_usec, TlsError *err);
  4243. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4244. time_t timeout_usec, TlsError *err);
  4245. // I/O (non-blocking capable)
  4246. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4247. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4248. int pending(const_session_t session);
  4249. void shutdown(session_t session, bool graceful);
  4250. // Connection state
  4251. bool is_peer_closed(session_t session, socket_t sock);
  4252. // Certificate verification
  4253. cert_t get_peer_cert(const_session_t session);
  4254. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4255. // do not use them after free_session(), as with get_peer_cert().
  4256. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4257. void free_cert(cert_t cert);
  4258. bool verify_hostname(cert_t cert, const char *hostname);
  4259. uint64_t hostname_mismatch_code();
  4260. long get_verify_result(const_session_t session);
  4261. // Certificate introspection
  4262. std::string get_cert_subject_cn(cert_t cert);
  4263. std::string get_cert_issuer_name(cert_t cert);
  4264. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4265. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4266. std::string get_cert_serial(cert_t cert);
  4267. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4268. const char *get_sni(const_session_t session);
  4269. // CA store management
  4270. ca_store_t create_ca_store(const char *pem, size_t len);
  4271. void free_ca_store(ca_store_t store);
  4272. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4273. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4274. std::vector<std::string> get_ca_names(ctx_t ctx);
  4275. // Dynamic certificate update (for servers)
  4276. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4277. const char *password);
  4278. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4279. // Certificate verification callback
  4280. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4281. long get_verify_error(const_session_t session);
  4282. std::string verify_error_string(long error_code);
  4283. // TlsError information
  4284. uint64_t peek_error();
  4285. uint64_t get_error();
  4286. std::string error_string(uint64_t code);
  4287. } // namespace tls
  4288. #endif // CPPHTTPLIB_SSL_ENABLED
  4289. /*
  4290. * Group 1: detail namespace - Non-SSL utilities
  4291. */
  4292. namespace detail {
  4293. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4294. const void *optval, socklen_t optlen) {
  4295. return setsockopt(sock, level, optname,
  4296. #ifdef _WIN32
  4297. reinterpret_cast<const char *>(optval),
  4298. #else
  4299. optval,
  4300. #endif
  4301. optlen) == 0;
  4302. }
  4303. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4304. time_t sec, time_t usec) {
  4305. #ifdef _WIN32
  4306. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4307. #else
  4308. timeval timeout;
  4309. timeout.tv_sec = static_cast<long>(sec);
  4310. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4311. #endif
  4312. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4313. }
  4314. inline bool is_hex(char c, int &v) {
  4315. if (is_ascii_digit(c)) {
  4316. v = c - '0';
  4317. return true;
  4318. } else if ('A' <= c && c <= 'F') {
  4319. v = c - 'A' + 10;
  4320. return true;
  4321. } else if ('a' <= c && c <= 'f') {
  4322. v = c - 'a' + 10;
  4323. return true;
  4324. }
  4325. return false;
  4326. }
  4327. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4328. int &val) {
  4329. if (i >= s.size()) { return false; }
  4330. val = 0;
  4331. for (; cnt; i++, cnt--) {
  4332. if (!s[i]) { return false; }
  4333. auto v = 0;
  4334. if (is_hex(s[i], v)) {
  4335. val = val * 16 + v;
  4336. } else {
  4337. return false;
  4338. }
  4339. }
  4340. return true;
  4341. }
  4342. inline std::string from_i_to_hex(size_t n) {
  4343. static const auto charset = "0123456789abcdef";
  4344. std::string ret;
  4345. do {
  4346. ret = charset[n & 15] + ret;
  4347. n >>= 4;
  4348. } while (n > 0);
  4349. return ret;
  4350. }
  4351. inline std::string compute_etag(const FileStat &fs,
  4352. const std::string &suffix = std::string()) {
  4353. if (!fs.is_file()) { return std::string(); }
  4354. // If mtime cannot be determined (negative value indicates an error
  4355. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4356. // value like 0 could collide with a real file that legitimately has
  4357. // mtime == 0 (epoch) and lead to misleading validators.
  4358. auto mtime_raw = fs.mtime();
  4359. if (mtime_raw < 0) { return std::string(); }
  4360. auto mtime = static_cast<size_t>(mtime_raw);
  4361. auto size = fs.size();
  4362. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4363. from_i_to_hex(size) + suffix + "\"";
  4364. }
  4365. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4366. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4367. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4368. inline std::string file_mtime_to_http_date(time_t mtime) {
  4369. if (mtime < 0) { return std::string(); }
  4370. struct tm tm_buf;
  4371. #ifdef _WIN32
  4372. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4373. #else
  4374. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4375. #endif
  4376. char buf[64];
  4377. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4378. return std::string();
  4379. }
  4380. return std::string(buf);
  4381. }
  4382. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4383. inline time_t parse_http_date(const std::string &date_str) {
  4384. struct tm tm_buf;
  4385. // Create a classic locale object once for all parsing attempts
  4386. const std::locale classic_locale = std::locale::classic();
  4387. // Try to parse using std::get_time (C++11, cross-platform)
  4388. auto try_parse = [&](const char *fmt) -> bool {
  4389. std::istringstream ss(date_str);
  4390. ss.imbue(classic_locale);
  4391. memset(&tm_buf, 0, sizeof(tm_buf));
  4392. ss >> std::get_time(&tm_buf, fmt);
  4393. return !ss.fail();
  4394. };
  4395. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4396. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4397. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4398. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4399. // asctime format: "Sun Nov 6 08:49:37 1994"
  4400. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4401. return static_cast<time_t>(-1);
  4402. }
  4403. }
  4404. }
  4405. #ifdef _WIN32
  4406. return _mkgmtime(&tm_buf);
  4407. #elif defined _AIX
  4408. return mktime(&tm_buf);
  4409. #else
  4410. return timegm(&tm_buf);
  4411. #endif
  4412. }
  4413. inline bool is_weak_etag(const std::string &s) {
  4414. // Check if the string is a weak ETag (starts with 'W/"')
  4415. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4416. }
  4417. inline bool is_strong_etag(const std::string &s) {
  4418. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4419. // chars)
  4420. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4421. }
  4422. inline size_t to_utf8(int code, char *buff) {
  4423. if (code < 0x0080) {
  4424. buff[0] = static_cast<char>(code & 0x7F);
  4425. return 1;
  4426. } else if (code < 0x0800) {
  4427. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4428. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4429. return 2;
  4430. } else if (code < 0xD800) {
  4431. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4432. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4433. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4434. return 3;
  4435. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4436. return 0;
  4437. } else if (code < 0x10000) {
  4438. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4439. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4440. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4441. return 3;
  4442. } else if (code < 0x110000) {
  4443. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4444. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4445. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4446. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4447. return 4;
  4448. }
  4449. // NOTREACHED
  4450. return 0;
  4451. }
  4452. } // namespace detail
  4453. namespace ws {
  4454. namespace impl {
  4455. inline bool is_valid_utf8(const std::string &s) {
  4456. size_t i = 0;
  4457. auto n = s.size();
  4458. while (i < n) {
  4459. auto c = static_cast<unsigned char>(s[i]);
  4460. size_t len;
  4461. uint32_t cp;
  4462. if (c < 0x80) {
  4463. i++;
  4464. continue;
  4465. } else if ((c & 0xE0) == 0xC0) {
  4466. len = 2;
  4467. cp = c & 0x1F;
  4468. } else if ((c & 0xF0) == 0xE0) {
  4469. len = 3;
  4470. cp = c & 0x0F;
  4471. } else if ((c & 0xF8) == 0xF0) {
  4472. len = 4;
  4473. cp = c & 0x07;
  4474. } else {
  4475. return false;
  4476. }
  4477. if (i + len > n) { return false; }
  4478. for (size_t j = 1; j < len; j++) {
  4479. auto b = static_cast<unsigned char>(s[i + j]);
  4480. if ((b & 0xC0) != 0x80) { return false; }
  4481. cp = (cp << 6) | (b & 0x3F);
  4482. }
  4483. // Overlong encoding check
  4484. if (len == 2 && cp < 0x80) { return false; }
  4485. if (len == 3 && cp < 0x800) { return false; }
  4486. if (len == 4 && cp < 0x10000) { return false; }
  4487. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4488. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4489. if (cp > 0x10FFFF) { return false; }
  4490. i += len;
  4491. }
  4492. return true;
  4493. }
  4494. } // namespace impl
  4495. } // namespace ws
  4496. namespace detail {
  4497. // NOTE: This code came up with the following stackoverflow post:
  4498. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4499. inline std::string base64_encode(const std::string &in) {
  4500. static const auto lookup =
  4501. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4502. std::string out;
  4503. out.reserve(in.size());
  4504. // Unsigned: the accumulator is never masked, so with a signed int the
  4505. // `val << 8` below overflows once enough bytes are folded in (undefined
  4506. // behaviour before C++20). Only the low bits are ever emitted, so the
  4507. // wrap-around of an unsigned accumulator does not affect the output.
  4508. uint32_t val = 0;
  4509. auto valb = -6;
  4510. for (auto c : in) {
  4511. val = (val << 8) + static_cast<uint8_t>(c);
  4512. valb += 8;
  4513. while (valb >= 0) {
  4514. out.push_back(lookup[(val >> valb) & 0x3F]);
  4515. valb -= 6;
  4516. }
  4517. }
  4518. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4519. while (out.size() % 4) {
  4520. out.push_back('=');
  4521. }
  4522. return out;
  4523. }
  4524. inline std::string sha1(const std::string &input) {
  4525. // RFC 3174 SHA-1 implementation
  4526. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4527. return (x << n) | (x >> (32 - n));
  4528. };
  4529. uint32_t h0 = 0x67452301;
  4530. uint32_t h1 = 0xEFCDAB89;
  4531. uint32_t h2 = 0x98BADCFE;
  4532. uint32_t h3 = 0x10325476;
  4533. uint32_t h4 = 0xC3D2E1F0;
  4534. // Pre-processing: adding padding bits
  4535. std::string msg = input;
  4536. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4537. msg.push_back(static_cast<char>(0x80u));
  4538. while (msg.size() % 64 != 56) {
  4539. msg.push_back(0);
  4540. }
  4541. // Append original length in bits as 64-bit big-endian
  4542. for (int i = 56; i >= 0; i -= 8) {
  4543. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4544. }
  4545. // Process each 512-bit chunk
  4546. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4547. uint32_t w[80];
  4548. for (size_t i = 0; i < 16; i++) {
  4549. w[i] =
  4550. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4551. << 24) |
  4552. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4553. << 16) |
  4554. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4555. << 8) |
  4556. (static_cast<uint32_t>(
  4557. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4558. }
  4559. for (int i = 16; i < 80; i++) {
  4560. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4561. }
  4562. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4563. for (int i = 0; i < 80; i++) {
  4564. uint32_t f, k;
  4565. if (i < 20) {
  4566. f = (b & c) | ((~b) & d);
  4567. k = 0x5A827999;
  4568. } else if (i < 40) {
  4569. f = b ^ c ^ d;
  4570. k = 0x6ED9EBA1;
  4571. } else if (i < 60) {
  4572. f = (b & c) | (b & d) | (c & d);
  4573. k = 0x8F1BBCDC;
  4574. } else {
  4575. f = b ^ c ^ d;
  4576. k = 0xCA62C1D6;
  4577. }
  4578. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4579. e = d;
  4580. d = c;
  4581. c = left_rotate(b, 30);
  4582. b = a;
  4583. a = temp;
  4584. }
  4585. h0 += a;
  4586. h1 += b;
  4587. h2 += c;
  4588. h3 += d;
  4589. h4 += e;
  4590. }
  4591. // Produce the final hash as a 20-byte binary string
  4592. std::string hash(20, '\0');
  4593. for (size_t i = 0; i < 4; i++) {
  4594. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4595. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4596. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4597. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4598. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4599. }
  4600. return hash;
  4601. }
  4602. inline std::string websocket_accept_key(const std::string &client_key) {
  4603. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4604. return base64_encode(sha1(client_key + magic));
  4605. }
  4606. inline bool is_websocket_upgrade(const Request &req) {
  4607. if (req.method != "GET") { return false; }
  4608. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4609. // list of protocols and asks recipients to match each name
  4610. // case-insensitively, so look for the token rather than compare the whole
  4611. // field value.
  4612. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4613. // Check Connection: Upgrade
  4614. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4615. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4616. // RFC 6455 Section 4.2.1
  4617. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4618. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4619. return false;
  4620. }
  4621. static const std::string b64chars =
  4622. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4623. for (size_t i = 0; i < 22; i++) {
  4624. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4625. }
  4626. // Check Sec-WebSocket-Version: 13
  4627. auto version = req.get_header_value("Sec-WebSocket-Version");
  4628. if (version != "13") { return false; }
  4629. return true;
  4630. }
  4631. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4632. const char *data, size_t len, bool fin,
  4633. bool mask) {
  4634. // First byte: FIN + opcode
  4635. uint8_t header[2];
  4636. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4637. (static_cast<uint8_t>(opcode) & 0x0F));
  4638. // Second byte: MASK + payload length
  4639. if (len < 126) {
  4640. header[1] = static_cast<uint8_t>(len);
  4641. if (mask) { header[1] |= 0x80; }
  4642. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4643. } else if (len <= 0xFFFF) {
  4644. header[1] = 126;
  4645. if (mask) { header[1] |= 0x80; }
  4646. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4647. uint8_t ext[2];
  4648. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4649. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4650. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4651. } else {
  4652. header[1] = 127;
  4653. if (mask) { header[1] |= 0x80; }
  4654. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4655. uint8_t ext[8];
  4656. for (int i = 7; i >= 0; i--) {
  4657. ext[7 - i] =
  4658. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4659. }
  4660. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4661. }
  4662. if (mask) {
  4663. // Generate random mask key
  4664. thread_local std::mt19937 rng(std::random_device{}());
  4665. uint8_t mask_key[4];
  4666. auto r = rng();
  4667. std::memcpy(mask_key, &r, 4);
  4668. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4669. // Write masked payload in chunks
  4670. const size_t chunk_size = 4096;
  4671. std::vector<char> buf((std::min)(len, chunk_size));
  4672. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4673. size_t n = (std::min)(chunk_size, len - offset);
  4674. for (size_t i = 0; i < n; i++) {
  4675. buf[i] =
  4676. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4677. }
  4678. if (strm.write(buf.data(), n) < 0) { return false; }
  4679. }
  4680. } else {
  4681. if (len > 0) {
  4682. if (strm.write(data, len) < 0) { return false; }
  4683. }
  4684. }
  4685. return true;
  4686. }
  4687. } // namespace detail
  4688. namespace ws {
  4689. namespace impl {
  4690. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4691. // hands back whatever its buffer already holds -- so every multi-byte field has
  4692. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4693. // header straddles the read buffer's boundary.
  4694. //
  4695. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4696. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4697. // there is a failure like any other. (When read() fails it always records why,
  4698. // so the error belongs to this call and not to an earlier one.)
  4699. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4700. auto p = static_cast<char *>(buf);
  4701. size_t total = 0;
  4702. while (total < size) {
  4703. auto n = strm.read(p + total, size - total);
  4704. if (n <= 0) {
  4705. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4706. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4707. }
  4708. total += static_cast<size_t>(n);
  4709. }
  4710. return FrameRead::Ok;
  4711. }
  4712. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4713. std::string &payload, bool &fin,
  4714. bool expect_masked, size_t max_len) {
  4715. // Read first 2 bytes. This is the only read that may report a timeout: it
  4716. // sits on a frame boundary, where nothing has been consumed yet.
  4717. uint8_t header[2];
  4718. FrameRead first = read_exact(strm, header, 2);
  4719. if (first != FrameRead::Ok) { return first; }
  4720. fin = (header[0] & 0x80) != 0;
  4721. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4722. if (header[0] & 0x70) { return FrameRead::Fail; }
  4723. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4724. bool masked = (header[1] & 0x80) != 0;
  4725. uint64_t payload_len = header[1] & 0x7F;
  4726. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4727. // MUST have a payload length of 125 bytes or less
  4728. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4729. if (is_control) {
  4730. if (!fin) { return FrameRead::Fail; }
  4731. if (payload_len > 125) { return FrameRead::Fail; }
  4732. }
  4733. if (masked != expect_masked) { return FrameRead::Fail; }
  4734. // Extended payload length
  4735. if (payload_len == 126) {
  4736. uint8_t ext[2];
  4737. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4738. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4739. } else if (payload_len == 127) {
  4740. uint8_t ext[8];
  4741. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4742. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4743. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4744. payload_len = 0;
  4745. for (int i = 0; i < 8; i++) {
  4746. payload_len = (payload_len << 8) | ext[i];
  4747. }
  4748. }
  4749. if (payload_len > max_len) { return FrameRead::Fail; }
  4750. // Read mask key if present
  4751. uint8_t mask_key[4] = {0};
  4752. if (masked) {
  4753. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4754. return FrameRead::Fail;
  4755. }
  4756. }
  4757. // Read payload
  4758. payload.resize(static_cast<size_t>(payload_len));
  4759. if (payload_len > 0 &&
  4760. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4761. FrameRead::Ok) {
  4762. return FrameRead::Fail;
  4763. }
  4764. // Unmask if needed
  4765. if (masked) {
  4766. for (size_t i = 0; i < payload.size(); i++) {
  4767. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4768. }
  4769. }
  4770. return FrameRead::Ok;
  4771. }
  4772. } // namespace impl
  4773. } // namespace ws
  4774. namespace detail {
  4775. inline bool is_valid_path(const std::string &path) {
  4776. size_t level = 0;
  4777. size_t i = 0;
  4778. // Skip slash
  4779. while (i < path.size() && path[i] == '/') {
  4780. i++;
  4781. }
  4782. while (i < path.size()) {
  4783. // Read component
  4784. auto beg = i;
  4785. while (i < path.size() && path[i] != '/') {
  4786. if (path[i] == '\0') {
  4787. return false;
  4788. } else if (path[i] == '\\') {
  4789. return false;
  4790. }
  4791. i++;
  4792. }
  4793. auto len = i - beg;
  4794. assert(len > 0);
  4795. if (!path.compare(beg, len, ".")) {
  4796. ;
  4797. } else if (!path.compare(beg, len, "..")) {
  4798. if (level == 0) { return false; }
  4799. level--;
  4800. } else {
  4801. level++;
  4802. }
  4803. // Skip slash
  4804. while (i < path.size() && path[i] == '/') {
  4805. i++;
  4806. }
  4807. }
  4808. return true;
  4809. }
  4810. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4811. #if defined(_WIN32)
  4812. char buf[_MAX_PATH];
  4813. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4814. resolved = buf;
  4815. #elif defined(PATH_MAX)
  4816. char buf[PATH_MAX];
  4817. if (realpath(path, buf) == nullptr) { return false; }
  4818. resolved = buf;
  4819. #else
  4820. auto buf = realpath(path, nullptr);
  4821. auto guard = scope_exit([&]() { std::free(buf); });
  4822. if (buf == nullptr) { return false; }
  4823. resolved = buf;
  4824. #endif
  4825. return true;
  4826. }
  4827. inline bool is_path_within_base(const std::string &resolved_path,
  4828. const std::string &resolved_base) {
  4829. #if defined(_WIN32)
  4830. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4831. resolved_base.size()) == 0;
  4832. #else
  4833. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4834. resolved_base.size()) == 0;
  4835. #endif
  4836. }
  4837. inline FileStat::FileStat(const std::string &path) {
  4838. #if defined(_WIN32)
  4839. auto wpath = u8string_to_wstring(path.c_str());
  4840. ret_ = _wstat(wpath.c_str(), &st_);
  4841. #else
  4842. ret_ = stat(path.c_str(), &st_);
  4843. #endif
  4844. }
  4845. inline bool FileStat::is_file() const {
  4846. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4847. }
  4848. inline bool FileStat::is_dir() const {
  4849. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4850. }
  4851. inline time_t FileStat::mtime() const {
  4852. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4853. : static_cast<time_t>(-1);
  4854. }
  4855. inline size_t FileStat::size() const {
  4856. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4857. }
  4858. inline std::string encode_path(const std::string &s) {
  4859. std::string result;
  4860. result.reserve(s.size());
  4861. for (size_t i = 0; s[i]; i++) {
  4862. switch (s[i]) {
  4863. case ' ': result += "%20"; break;
  4864. case '+': result += "%2B"; break;
  4865. case '\'': result += "%27"; break;
  4866. case ',': result += "%2C"; break;
  4867. // case ':': result += "%3A"; break; // ok? probably...
  4868. case ';': result += "%3B"; break;
  4869. default:
  4870. auto c = static_cast<uint8_t>(s[i]);
  4871. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4872. // in a request-target as-is.
  4873. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4874. result += '%';
  4875. char hex[4];
  4876. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4877. assert(len == 2);
  4878. result.append(hex, static_cast<size_t>(len));
  4879. } else {
  4880. result += s[i];
  4881. }
  4882. break;
  4883. }
  4884. }
  4885. return result;
  4886. }
  4887. inline std::string file_extension(const std::string &path) {
  4888. std::smatch m;
  4889. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4890. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4891. return std::string();
  4892. }
  4893. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4894. template <typename T>
  4895. inline bool parse_header(const char *beg, const char *end, T fn);
  4896. template <typename T>
  4897. inline bool parse_header(const char *beg, const char *end, T fn) {
  4898. // Skip trailing spaces and tabs.
  4899. while (beg < end && is_space_or_tab(end[-1])) {
  4900. end--;
  4901. }
  4902. auto p = beg;
  4903. while (p < end && *p != ':') {
  4904. p++;
  4905. }
  4906. auto name = std::string(beg, p);
  4907. if (!detail::fields::is_field_name(name)) { return false; }
  4908. if (p == end) { return false; }
  4909. auto key_end = p;
  4910. if (*p++ != ':') { return false; }
  4911. while (p < end && is_space_or_tab(*p)) {
  4912. p++;
  4913. }
  4914. if (p <= end) {
  4915. auto key_len = key_end - beg;
  4916. if (!key_len) { return false; }
  4917. auto key = std::string(beg, key_end);
  4918. auto val = std::string(p, end);
  4919. if (!detail::fields::is_field_value(val)) { return false; }
  4920. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4921. // percent-decoded by the recipient. Applications that need to interpret a
  4922. // value as a URI component should call httplib::decode_uri_component()
  4923. // (or decode_path_component()) explicitly.
  4924. fn(key, val);
  4925. return true;
  4926. }
  4927. return false;
  4928. }
  4929. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4930. const Headers &src_headers) {
  4931. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4932. // transfer coding is complete when a chunk with a chunk-size of zero is
  4933. // received, possibly followed by a trailer section, and finally terminated by
  4934. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4935. //
  4936. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4937. // doesn't care for the existence of the final CRLF. In other words, it seems
  4938. // to be ok whether the final CRLF exists or not in the chunked data.
  4939. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4940. //
  4941. // According to the reference code in RFC 9112, cpp-httplib now allows
  4942. // chunked transfer coding data without the final CRLF.
  4943. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4944. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4945. "transfer-encoding",
  4946. "content-length",
  4947. "host",
  4948. "authorization",
  4949. "www-authenticate",
  4950. "proxy-authenticate",
  4951. "proxy-authorization",
  4952. "cookie",
  4953. "set-cookie",
  4954. "cache-control",
  4955. "expect",
  4956. "max-forwards",
  4957. "pragma",
  4958. "range",
  4959. "te",
  4960. "age",
  4961. "expires",
  4962. "date",
  4963. "location",
  4964. "retry-after",
  4965. "vary",
  4966. "warning",
  4967. "content-encoding",
  4968. "content-type",
  4969. "content-range",
  4970. "trailer"};
  4971. case_ignore::unordered_set<std::string> declared_trailers;
  4972. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4973. if (!trailer_header.empty()) {
  4974. // split() trims each token and skips empty ones, so the name arrives ready
  4975. // to look up.
  4976. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4977. ',', [&](const char *b, const char *e) {
  4978. // A legitimate message declares only a handful of trailers. Cap the
  4979. // set so a peer cannot grow it without bound: an oversized set only
  4980. // arises from an attempt to force many colliding names into
  4981. // quadratic lookups (case_ignore::hash is unkeyed).
  4982. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4983. return;
  4984. }
  4985. std::string key(b, e);
  4986. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4987. declared_trailers.insert(key);
  4988. }
  4989. });
  4990. }
  4991. size_t trailer_header_count = 0;
  4992. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4993. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4994. // Count every received trailer field, not only the declared ones stored in
  4995. // dest, so undeclared fields cannot keep this loop running past the limit.
  4996. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4997. constexpr auto line_terminator_len = 2;
  4998. auto line_beg = line_reader.ptr();
  4999. auto line_end =
  5000. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5001. if (!parse_header(line_beg, line_end,
  5002. [&](const std::string &key, const std::string &val) {
  5003. if (declared_trailers.find(key) !=
  5004. declared_trailers.end()) {
  5005. dest.emplace(key, val);
  5006. }
  5007. })) {
  5008. return false;
  5009. }
  5010. trailer_header_count++;
  5011. if (!line_reader.getline()) { return false; }
  5012. }
  5013. return true;
  5014. }
  5015. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5016. size_t right) {
  5017. while (b + left < e && is_space_or_tab(b[left])) {
  5018. left++;
  5019. }
  5020. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5021. right--;
  5022. }
  5023. return std::make_pair(left, right);
  5024. }
  5025. inline std::string trim_copy(const std::string &s) {
  5026. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5027. return s.substr(r.first, r.second - r.first);
  5028. }
  5029. inline std::string trim_double_quotes_copy(const std::string &s) {
  5030. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5031. return s.substr(1, s.size() - 2);
  5032. }
  5033. return s;
  5034. }
  5035. inline void
  5036. divide(const char *data, std::size_t size, char d,
  5037. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5038. fn) {
  5039. const auto it = std::find(data, data + size, d);
  5040. const auto found = static_cast<std::size_t>(it != data + size);
  5041. const auto lhs_data = data;
  5042. const auto lhs_size = static_cast<std::size_t>(it - data);
  5043. const auto rhs_data = it + found;
  5044. const auto rhs_size = size - lhs_size - found;
  5045. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5046. }
  5047. inline void
  5048. divide(const std::string &str, char d,
  5049. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5050. fn) {
  5051. divide(str.data(), str.size(), d, std::move(fn));
  5052. }
  5053. inline void split(const char *b, const char *e, char d,
  5054. std::function<void(const char *, const char *)> fn) {
  5055. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5056. }
  5057. inline void split(const char *b, const char *e, char d, size_t m,
  5058. std::function<void(const char *, const char *)> fn) {
  5059. size_t i = 0;
  5060. size_t beg = 0;
  5061. size_t count = 1;
  5062. while (e ? (b + i < e) : (b[i] != '\0')) {
  5063. if (b[i] == d && count < m) {
  5064. auto r = trim(b, e, beg, i);
  5065. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5066. beg = i + 1;
  5067. count++;
  5068. }
  5069. i++;
  5070. }
  5071. if (i) {
  5072. auto r = trim(b, e, beg, i);
  5073. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5074. }
  5075. }
  5076. // Same contract as split(), except that a delimiter inside a quoted-string is
  5077. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5078. // quoted-string, and ';' and '=' are legal characters inside one.
  5079. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5080. std::function<void(const char *, const char *)> fn) {
  5081. size_t i = 0;
  5082. size_t beg = 0;
  5083. size_t count = 1;
  5084. auto in_quotes = false;
  5085. while (e ? (b + i < e) : (b[i] != '\0')) {
  5086. if (b[i] == '"') {
  5087. in_quotes = !in_quotes;
  5088. } else if (b[i] == d && !in_quotes && count < m) {
  5089. auto r = trim(b, e, beg, i);
  5090. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5091. beg = i + 1;
  5092. count++;
  5093. }
  5094. i++;
  5095. }
  5096. if (i) {
  5097. auto r = trim(b, e, beg, i);
  5098. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5099. }
  5100. }
  5101. inline void split_unquoted(const char *b, const char *e, char d,
  5102. std::function<void(const char *, const char *)> fn) {
  5103. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5104. std::move(fn));
  5105. }
  5106. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5107. // key a token, so the first '=' is the separator even when the value is a
  5108. // quoted-string carrying more of them.
  5109. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5110. std::string &val) {
  5111. divide(
  5112. b, static_cast<std::size_t>(e - b), '=',
  5113. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5114. const auto kr = trim(kb, kb + klen, 0, klen);
  5115. key.assign(kb + kr.first, kb + kr.second);
  5116. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5117. val.assign(vb + vr.first, vb + vr.second);
  5118. });
  5119. }
  5120. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5121. std::function<bool(const char *, const char *)> fn) {
  5122. size_t i = 0;
  5123. size_t beg = 0;
  5124. size_t count = 1;
  5125. while (e ? (b + i < e) : (b[i] != '\0')) {
  5126. if (b[i] == d && count < m) {
  5127. auto r = trim(b, e, beg, i);
  5128. if (r.first < r.second) {
  5129. auto found = fn(&b[r.first], &b[r.second]);
  5130. if (found) { return true; }
  5131. }
  5132. beg = i + 1;
  5133. count++;
  5134. }
  5135. i++;
  5136. }
  5137. if (i) {
  5138. auto r = trim(b, e, beg, i);
  5139. if (r.first < r.second) {
  5140. auto found = fn(&b[r.first], &b[r.second]);
  5141. if (found) { return true; }
  5142. }
  5143. }
  5144. return false;
  5145. }
  5146. inline bool split_find(const char *b, const char *e, char d,
  5147. std::function<bool(const char *, const char *)> fn) {
  5148. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5149. std::move(fn));
  5150. }
  5151. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5152. size_t fixed_buffer_size)
  5153. : strm_(strm), fixed_buffer_(fixed_buffer),
  5154. fixed_buffer_size_(fixed_buffer_size) {}
  5155. inline const char *stream_line_reader::ptr() const {
  5156. if (growable_buffer_.empty()) {
  5157. return fixed_buffer_;
  5158. } else {
  5159. return growable_buffer_.data();
  5160. }
  5161. }
  5162. inline size_t stream_line_reader::size() const {
  5163. if (growable_buffer_.empty()) {
  5164. return fixed_buffer_used_size_;
  5165. } else {
  5166. return growable_buffer_.size();
  5167. }
  5168. }
  5169. inline bool stream_line_reader::end_with_crlf() const {
  5170. auto end = ptr() + size();
  5171. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5172. }
  5173. inline bool stream_line_reader::getline() {
  5174. fixed_buffer_used_size_ = 0;
  5175. growable_buffer_.clear();
  5176. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5177. char prev_byte = 0;
  5178. #endif
  5179. for (size_t i = 0;; i++) {
  5180. // Fast path: whatever the stream has already buffered can be scanned for
  5181. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5182. // call, a bounds check and a one-byte copy per character of the request.
  5183. size_t buffered_size = 0;
  5184. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5185. auto take = buffered_size;
  5186. auto terminated = false;
  5187. for (size_t at = 0; at < buffered_size;) {
  5188. auto nl = static_cast<const char *>(
  5189. memchr(buffered + at, '\n', buffered_size - at));
  5190. if (!nl) { break; }
  5191. auto pos = static_cast<size_t>(nl - buffered);
  5192. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5193. take = pos + 1;
  5194. terminated = true;
  5195. break;
  5196. #else
  5197. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5198. // be the last byte of an earlier chunk, hence prev_byte.
  5199. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5200. take = pos + 1;
  5201. terminated = true;
  5202. break;
  5203. }
  5204. at = pos + 1;
  5205. #endif
  5206. }
  5207. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5208. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5209. prev_byte = buffered[take - 1];
  5210. #endif
  5211. append(buffered, take);
  5212. strm_.consume_buffered(take);
  5213. i += take;
  5214. if (terminated) { return true; }
  5215. continue;
  5216. }
  5217. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5218. // Treat exceptionally long lines as an error to
  5219. // prevent infinite loops/memory exhaustion
  5220. return false;
  5221. }
  5222. char byte;
  5223. auto n = strm_.read(&byte, 1);
  5224. if (n < 0) {
  5225. return false;
  5226. } else if (n == 0) {
  5227. if (i == 0) {
  5228. return false;
  5229. } else {
  5230. break;
  5231. }
  5232. }
  5233. append(byte);
  5234. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5235. if (byte == '\n') { break; }
  5236. #else
  5237. if (prev_byte == '\r' && byte == '\n') { break; }
  5238. prev_byte = byte;
  5239. #endif
  5240. }
  5241. return true;
  5242. }
  5243. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5244. inline void stream_line_reader::append(const char *data, size_t size) {
  5245. // Once the line has outgrown the fixed buffer everything must keep going to
  5246. // the growable one, even if a later chunk would have fit. Without the
  5247. // emptiness check a short append after a long one would land in the fixed
  5248. // buffer, which ptr() and size() no longer look at, and be lost.
  5249. if (growable_buffer_.empty() &&
  5250. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5251. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5252. fixed_buffer_used_size_ += size;
  5253. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5254. } else {
  5255. // Unlike the per-character overload, this can be the very first append of
  5256. // the line, so the fixed buffer may hold nothing and carry no terminator
  5257. // yet. assign() takes an explicit length and does not need one.
  5258. if (growable_buffer_.empty()) {
  5259. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5260. }
  5261. growable_buffer_.append(data, size);
  5262. }
  5263. }
  5264. inline mmap::mmap(const char *path) { open(path); }
  5265. inline mmap::~mmap() { close(); }
  5266. inline bool mmap::open(const char *path) {
  5267. close();
  5268. #if defined(_WIN32)
  5269. auto wpath = u8string_to_wstring(path);
  5270. if (wpath.empty()) { return false; }
  5271. hFile_ =
  5272. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5273. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5274. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5275. LARGE_INTEGER size{};
  5276. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5277. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5278. // See:
  5279. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5280. if (static_cast<ULONGLONG>(size.QuadPart) >
  5281. (std::numeric_limits<decltype(size_)>::max)()) {
  5282. // `size_t` might be 32-bits, on 32-bits Windows.
  5283. return false;
  5284. }
  5285. size_ = static_cast<size_t>(size.QuadPart);
  5286. hMapping_ =
  5287. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5288. // Special treatment for an empty file...
  5289. if (hMapping_ == NULL && size_ == 0) {
  5290. close();
  5291. is_open_empty_file = true;
  5292. return true;
  5293. }
  5294. if (hMapping_ == NULL) {
  5295. close();
  5296. return false;
  5297. }
  5298. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5299. if (addr_ == nullptr) {
  5300. close();
  5301. return false;
  5302. }
  5303. #else
  5304. fd_ = ::open(path, O_RDONLY);
  5305. if (fd_ == -1) { return false; }
  5306. struct stat sb;
  5307. if (fstat(fd_, &sb) == -1) {
  5308. close();
  5309. return false;
  5310. }
  5311. size_ = static_cast<size_t>(sb.st_size);
  5312. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5313. // Special treatment for an empty file...
  5314. if (addr_ == MAP_FAILED && size_ == 0) {
  5315. close();
  5316. is_open_empty_file = true;
  5317. return false;
  5318. }
  5319. if (addr_ == MAP_FAILED) {
  5320. // Clear the sentinel before `close()`, since `is_open()` only checks
  5321. // `addr_` against nullptr and `munmap()` must not be called with it.
  5322. addr_ = nullptr;
  5323. close();
  5324. return false;
  5325. }
  5326. #endif
  5327. return true;
  5328. }
  5329. inline bool mmap::is_open() const {
  5330. return is_open_empty_file ? true : addr_ != nullptr;
  5331. }
  5332. inline size_t mmap::size() const { return size_; }
  5333. inline const char *mmap::data() const {
  5334. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5335. }
  5336. inline void mmap::close() {
  5337. #if defined(_WIN32)
  5338. if (addr_) {
  5339. ::UnmapViewOfFile(addr_);
  5340. addr_ = nullptr;
  5341. }
  5342. if (hMapping_) {
  5343. ::CloseHandle(hMapping_);
  5344. hMapping_ = NULL;
  5345. }
  5346. if (hFile_ != INVALID_HANDLE_VALUE) {
  5347. ::CloseHandle(hFile_);
  5348. hFile_ = INVALID_HANDLE_VALUE;
  5349. }
  5350. is_open_empty_file = false;
  5351. #else
  5352. if (addr_ != nullptr) {
  5353. munmap(addr_, size_);
  5354. addr_ = nullptr;
  5355. }
  5356. if (fd_ != -1) {
  5357. ::close(fd_);
  5358. fd_ = -1;
  5359. }
  5360. #endif
  5361. size_ = 0;
  5362. }
  5363. inline int close_socket(socket_t sock) noexcept {
  5364. #ifdef _WIN32
  5365. return closesocket(sock);
  5366. #else
  5367. return close(sock);
  5368. #endif
  5369. }
  5370. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5371. ssize_t res = 0;
  5372. while (true) {
  5373. res = fn();
  5374. if (res < 0 && errno == EINTR) {
  5375. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5376. continue;
  5377. }
  5378. break;
  5379. }
  5380. return res;
  5381. }
  5382. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5383. return handle_EINTR([&]() {
  5384. return recv(sock,
  5385. #ifdef _WIN32
  5386. static_cast<char *>(ptr), static_cast<int>(size),
  5387. #else
  5388. ptr, size,
  5389. #endif
  5390. flags);
  5391. });
  5392. }
  5393. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5394. int flags) {
  5395. return handle_EINTR([&]() {
  5396. return send(sock,
  5397. #ifdef _WIN32
  5398. static_cast<const char *>(ptr), static_cast<int>(size),
  5399. #else
  5400. ptr, size,
  5401. #endif
  5402. flags);
  5403. });
  5404. }
  5405. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5406. #ifdef _WIN32
  5407. return ::WSAPoll(fds, nfds, timeout);
  5408. #else
  5409. return ::poll(fds, nfds, timeout);
  5410. #endif
  5411. }
  5412. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5413. time_t usec) {
  5414. struct pollfd pfd;
  5415. pfd.fd = sock;
  5416. pfd.events = events;
  5417. pfd.revents = 0;
  5418. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5419. // "return immediately", which callers here rely on to probe a socket.
  5420. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5421. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5422. }
  5423. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5424. return select_impl(sock, POLLIN, sec, usec);
  5425. }
  5426. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5427. return select_impl(sock, POLLOUT, sec, usec);
  5428. }
  5429. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5430. time_t usec) {
  5431. struct pollfd pfd_read;
  5432. pfd_read.fd = sock;
  5433. pfd_read.events = POLLIN | POLLOUT;
  5434. pfd_read.revents = 0;
  5435. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5436. auto poll_res =
  5437. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5438. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5439. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5440. auto error = 0;
  5441. socklen_t len = sizeof(error);
  5442. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5443. reinterpret_cast<char *>(&error), &len);
  5444. auto successful = res >= 0 && !error;
  5445. return successful ? Error::Success : Error::Connection;
  5446. }
  5447. return Error::Connection;
  5448. }
  5449. inline bool is_socket_alive(socket_t sock) {
  5450. const auto val = detail::select_read(sock, 0, 0);
  5451. if (val == 0) {
  5452. return true;
  5453. } else if (val < 0 && errno == EBADF) {
  5454. return false;
  5455. }
  5456. char buf[1];
  5457. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5458. }
  5459. class SocketStream final : public Stream {
  5460. public:
  5461. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5462. time_t write_timeout_sec, time_t write_timeout_usec,
  5463. time_t max_timeout_msec = 0,
  5464. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5465. (std::chrono::steady_clock::time_point::min)());
  5466. ~SocketStream() override;
  5467. bool is_readable() const override;
  5468. bool wait_readable() const override;
  5469. bool wait_writable() const override;
  5470. bool is_peer_alive() const override;
  5471. ssize_t read(char *ptr, size_t size) override;
  5472. ssize_t write(const char *ptr, size_t size) override;
  5473. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5474. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5475. socket_t socket() const override;
  5476. time_t duration() const override;
  5477. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5478. const char *buffered_data(size_t &size) const override;
  5479. void consume_buffered(size_t size) override;
  5480. // The caller has just seen this socket become readable. Lets the next read
  5481. // skip its own readiness wait, which would otherwise ask the kernel a
  5482. // question that was answered a moment ago. Consumed by that read.
  5483. void set_readable_hint() { readable_hint_ = true; }
  5484. private:
  5485. bool ensure_readable();
  5486. socket_t sock_;
  5487. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5488. // thread while a read is in flight -- that is the point of it, for a caller
  5489. // holding one connection and wanting control back to send on it.
  5490. std::atomic<time_t> read_timeout_sec_;
  5491. std::atomic<time_t> read_timeout_usec_;
  5492. time_t write_timeout_sec_;
  5493. time_t write_timeout_usec_;
  5494. time_t max_timeout_msec_;
  5495. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5496. std::vector<char> read_buff_;
  5497. size_t read_buff_off_ = 0;
  5498. size_t read_buff_content_size_ = 0;
  5499. bool readable_hint_ = false;
  5500. static const size_t read_buff_size_ = 1024l * 4;
  5501. };
  5502. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5503. time_t keep_alive_timeout_sec) {
  5504. using namespace std::chrono;
  5505. const auto interval_usec =
  5506. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5507. // Avoid expensive `steady_clock::now()` call for the first time
  5508. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5509. const auto start = steady_clock::now() - microseconds{interval_usec};
  5510. const auto timeout = seconds{keep_alive_timeout_sec};
  5511. while (true) {
  5512. if (svr_sock == INVALID_SOCKET) {
  5513. break; // Server socket is closed
  5514. }
  5515. auto val = select_read(sock, 0, interval_usec);
  5516. if (val < 0) {
  5517. break; // Ssocket error
  5518. } else if (val == 0) {
  5519. if (steady_clock::now() - start > timeout) {
  5520. break; // Timeout
  5521. }
  5522. } else {
  5523. return true; // Ready for read
  5524. }
  5525. }
  5526. return false;
  5527. }
  5528. // `has_buffered_request` reports whether the connection's stream already holds
  5529. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5530. // 9.3.2), so reading one request can pull the start of the next one into the
  5531. // stream's buffer; that request must be served without waiting for the socket
  5532. // to become readable again, since its bytes are no longer on the socket.
  5533. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5534. template <typename P, typename T>
  5535. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5536. socket_t sock,
  5537. size_t keep_alive_max_count,
  5538. time_t keep_alive_timeout_sec,
  5539. P has_buffered_request, T callback) {
  5540. assert(keep_alive_max_count > 0);
  5541. auto ret = false;
  5542. auto count = keep_alive_max_count;
  5543. while (count > 0) {
  5544. auto socket_readable = false;
  5545. if (!has_buffered_request()) {
  5546. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5547. socket_readable = true;
  5548. }
  5549. auto close_connection = count == 1;
  5550. auto connection_closed = false;
  5551. ret = callback(socket_readable, close_connection, connection_closed);
  5552. if (!ret || connection_closed) { break; }
  5553. count--;
  5554. }
  5555. return ret;
  5556. }
  5557. template <typename T>
  5558. inline bool
  5559. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5560. size_t keep_alive_max_count,
  5561. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5562. time_t read_timeout_usec, time_t write_timeout_sec,
  5563. time_t write_timeout_usec, T callback) {
  5564. // One stream per connection: its read buffer can already hold the start of
  5565. // the next, pipelined request.
  5566. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5567. write_timeout_sec, write_timeout_usec);
  5568. return process_server_socket_core(
  5569. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5570. [&]() { return strm.is_readable(); },
  5571. [&](bool socket_readable, bool close_connection,
  5572. bool &connection_closed) {
  5573. if (socket_readable) { strm.set_readable_hint(); }
  5574. return callback(strm, close_connection, connection_closed);
  5575. });
  5576. }
  5577. inline bool process_client_socket(
  5578. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5579. time_t write_timeout_sec, time_t write_timeout_usec,
  5580. time_t max_timeout_msec,
  5581. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5582. std::function<bool(Stream &)> callback) {
  5583. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5584. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5585. start_time);
  5586. return callback(strm);
  5587. }
  5588. inline int shutdown_socket(socket_t sock) noexcept {
  5589. #ifdef _WIN32
  5590. return shutdown(sock, SD_BOTH);
  5591. #else
  5592. return shutdown(sock, SHUT_RDWR);
  5593. #endif
  5594. }
  5595. // Half-closes the write side and drains any in-flight/queued bytes before
  5596. // the final shutdown+close. Closing with unread data in the receive queue
  5597. // (or bytes arriving after the receive side is closed) makes the stack send
  5598. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5599. // response as a failed read even though it was fully written.
  5600. inline void drain_and_close_socket(socket_t sock) noexcept {
  5601. #ifdef _WIN32
  5602. shutdown(sock, SD_SEND);
  5603. #else
  5604. shutdown(sock, SHUT_WR);
  5605. #endif
  5606. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5607. size_t total = 0;
  5608. const auto deadline = std::chrono::steady_clock::now() +
  5609. std::chrono::milliseconds(100); // bound #1
  5610. while (total < size_t(1024u * 1024u)) { // bound #2
  5611. const auto remaining =
  5612. std::chrono::duration_cast<std::chrono::microseconds>(
  5613. deadline - std::chrono::steady_clock::now())
  5614. .count();
  5615. if (remaining <= 0) { break; }
  5616. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5617. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5618. if (n <= 0) { break; }
  5619. total += static_cast<size_t>(n);
  5620. }
  5621. shutdown_socket(sock);
  5622. close_socket(sock);
  5623. }
  5624. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5625. if (s.size() > 1 && s[0] == '\0') {
  5626. auto ret = s;
  5627. ret[0] = '@';
  5628. return ret;
  5629. }
  5630. return s;
  5631. }
  5632. inline std::string
  5633. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5634. if (s.size() > 1 && s[0] == '@') {
  5635. auto ret = s;
  5636. ret[0] = '\0';
  5637. return ret;
  5638. }
  5639. return s;
  5640. }
  5641. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5642. const struct addrinfo *hints,
  5643. struct addrinfo **res, time_t timeout_sec) {
  5644. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5645. if (timeout_sec <= 0) {
  5646. // No timeout specified, use standard getaddrinfo
  5647. return getaddrinfo(node, service, hints, res);
  5648. }
  5649. #ifdef _WIN32
  5650. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5651. OVERLAPPED overlapped = {};
  5652. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5653. if (!event) { return EAI_FAIL; }
  5654. overlapped.hEvent = event;
  5655. PADDRINFOEXW result_addrinfo = nullptr;
  5656. HANDLE cancel_handle = nullptr;
  5657. ADDRINFOEXW hints_ex = {};
  5658. if (hints) {
  5659. hints_ex.ai_flags = hints->ai_flags;
  5660. hints_ex.ai_family = hints->ai_family;
  5661. hints_ex.ai_socktype = hints->ai_socktype;
  5662. hints_ex.ai_protocol = hints->ai_protocol;
  5663. }
  5664. auto wnode = u8string_to_wstring(node);
  5665. auto wservice = u8string_to_wstring(service);
  5666. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5667. hints ? &hints_ex : nullptr, &result_addrinfo,
  5668. nullptr, &overlapped, nullptr, &cancel_handle);
  5669. if (ret == WSA_IO_PENDING) {
  5670. auto wait_result =
  5671. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5672. if (wait_result == WAIT_TIMEOUT) {
  5673. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5674. ::CloseHandle(event);
  5675. return EAI_AGAIN;
  5676. }
  5677. DWORD bytes_returned;
  5678. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5679. &bytes_returned, FALSE)) {
  5680. ::CloseHandle(event);
  5681. return ::WSAGetLastError();
  5682. }
  5683. }
  5684. ::CloseHandle(event);
  5685. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5686. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5687. return 0;
  5688. }
  5689. return ret;
  5690. #elif TARGET_OS_MAC && defined(__clang__)
  5691. if (!node) { return EAI_NONAME; }
  5692. // macOS implementation using CFHost API for asynchronous DNS resolution
  5693. CFStringRef hostname_ref = CFStringCreateWithCString(
  5694. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5695. if (!hostname_ref) { return EAI_MEMORY; }
  5696. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5697. CFRelease(hostname_ref);
  5698. if (!host_ref) { return EAI_MEMORY; }
  5699. // Set up context for callback
  5700. struct CFHostContext {
  5701. bool completed = false;
  5702. bool success = false;
  5703. CFArrayRef addresses = nullptr;
  5704. std::mutex mutex;
  5705. std::condition_variable cv;
  5706. } context;
  5707. CFHostClientContext client_context;
  5708. memset(&client_context, 0, sizeof(client_context));
  5709. client_context.info = &context;
  5710. // Set callback
  5711. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5712. const CFStreamError *error, void *info) {
  5713. auto ctx = static_cast<CFHostContext *>(info);
  5714. std::lock_guard<std::mutex> lock(ctx->mutex);
  5715. if (error && error->error != 0) {
  5716. ctx->success = false;
  5717. } else {
  5718. Boolean hasBeenResolved;
  5719. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5720. if (ctx->addresses && hasBeenResolved) {
  5721. CFRetain(ctx->addresses);
  5722. ctx->success = true;
  5723. } else {
  5724. ctx->success = false;
  5725. }
  5726. }
  5727. ctx->completed = true;
  5728. ctx->cv.notify_one();
  5729. };
  5730. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5731. CFRelease(host_ref);
  5732. return EAI_SYSTEM;
  5733. }
  5734. // Schedule on run loop
  5735. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5736. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5737. // Start resolution
  5738. CFStreamError stream_error;
  5739. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5740. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5741. CFRelease(host_ref);
  5742. return EAI_FAIL;
  5743. }
  5744. // Wait for completion with timeout
  5745. auto timeout_time =
  5746. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5747. bool timed_out = false;
  5748. {
  5749. std::unique_lock<std::mutex> lock(context.mutex);
  5750. while (!context.completed) {
  5751. auto now = std::chrono::steady_clock::now();
  5752. if (now >= timeout_time) {
  5753. timed_out = true;
  5754. break;
  5755. }
  5756. // Run the runloop for a short time
  5757. lock.unlock();
  5758. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5759. lock.lock();
  5760. }
  5761. }
  5762. // Clean up
  5763. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5764. CFHostSetClient(host_ref, nullptr, nullptr);
  5765. if (timed_out || !context.completed) {
  5766. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5767. CFRelease(host_ref);
  5768. return EAI_AGAIN;
  5769. }
  5770. if (!context.success || !context.addresses) {
  5771. CFRelease(host_ref);
  5772. return EAI_NODATA;
  5773. }
  5774. // Convert CFArray to addrinfo
  5775. CFIndex count = CFArrayGetCount(context.addresses);
  5776. if (count == 0) {
  5777. CFRelease(context.addresses);
  5778. CFRelease(host_ref);
  5779. return EAI_NODATA;
  5780. }
  5781. struct addrinfo *result_addrinfo = nullptr;
  5782. struct addrinfo **current = &result_addrinfo;
  5783. for (CFIndex i = 0; i < count; i++) {
  5784. CFDataRef addr_data =
  5785. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5786. if (!addr_data) continue;
  5787. const struct sockaddr *sockaddr_ptr =
  5788. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5789. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5790. // Allocate addrinfo structure
  5791. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5792. if (!*current) {
  5793. freeaddrinfo(result_addrinfo);
  5794. CFRelease(context.addresses);
  5795. CFRelease(host_ref);
  5796. return EAI_MEMORY;
  5797. }
  5798. memset(*current, 0, sizeof(struct addrinfo));
  5799. // Set up addrinfo fields
  5800. (*current)->ai_family = sockaddr_ptr->sa_family;
  5801. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5802. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5803. (*current)->ai_addrlen = sockaddr_len;
  5804. // Copy sockaddr
  5805. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5806. if (!(*current)->ai_addr) {
  5807. freeaddrinfo(result_addrinfo);
  5808. CFRelease(context.addresses);
  5809. CFRelease(host_ref);
  5810. return EAI_MEMORY;
  5811. }
  5812. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5813. // Set port if service is specified
  5814. if (service && *service) {
  5815. int port = 0;
  5816. if (parse_port(service, strlen(service), port)) {
  5817. if (sockaddr_ptr->sa_family == AF_INET) {
  5818. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5819. ->sin_port = htons(static_cast<uint16_t>(port));
  5820. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5821. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5822. ->sin6_port = htons(static_cast<uint16_t>(port));
  5823. }
  5824. }
  5825. }
  5826. current = &((*current)->ai_next);
  5827. }
  5828. CFRelease(context.addresses);
  5829. CFRelease(host_ref);
  5830. *res = result_addrinfo;
  5831. return 0;
  5832. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5833. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5834. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5835. // the resolver worker still references the stack-local gaicb. The cancel
  5836. // path therefore waits (gai_suspend with no timeout) for the worker to
  5837. // actually finish before letting the stack frame go. The trade-off is that
  5838. // a wedged DNS server can hold this thread for the system resolver timeout
  5839. // (~30s by default) past the caller's connection timeout.
  5840. struct gaicb request{};
  5841. struct gaicb *requests[1] = {&request};
  5842. struct sigevent sevp{};
  5843. struct timespec timeout{timeout_sec, 0};
  5844. request.ar_name = node;
  5845. request.ar_service = service;
  5846. request.ar_request = hints;
  5847. sevp.sigev_notify = SIGEV_NONE;
  5848. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5849. if (rc != 0) { return rc; }
  5850. auto cleanup = scope_exit([&] {
  5851. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5852. });
  5853. int wait_result = gai_suspend(requests, 1, &timeout);
  5854. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5855. int gai_result = gai_error(&request);
  5856. if (gai_result == 0) {
  5857. *res = request.ar_result;
  5858. request.ar_result = nullptr;
  5859. return 0;
  5860. }
  5861. return gai_result;
  5862. }
  5863. gai_cancel(&request);
  5864. while (gai_error(&request) == EAI_INPROGRESS) {
  5865. gai_suspend(requests, 1, nullptr);
  5866. }
  5867. return wait_result;
  5868. #else
  5869. // Fallback implementation using thread-based timeout for other Unix systems.
  5870. struct GetAddrInfoState {
  5871. ~GetAddrInfoState() {
  5872. if (info) { freeaddrinfo(info); }
  5873. }
  5874. std::mutex mutex;
  5875. std::condition_variable result_cv;
  5876. bool completed = false;
  5877. int result = EAI_SYSTEM;
  5878. std::string node;
  5879. std::string service;
  5880. struct addrinfo hints;
  5881. struct addrinfo *info = nullptr;
  5882. };
  5883. // Allocate on the heap, so the resolver thread can keep using the data.
  5884. auto state = std::make_shared<GetAddrInfoState>();
  5885. if (node) { state->node = node; }
  5886. state->service = service;
  5887. state->hints = *hints;
  5888. std::thread resolve_thread([state]() {
  5889. auto thread_result =
  5890. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5891. &state->info);
  5892. std::lock_guard<std::mutex> lock(state->mutex);
  5893. state->result = thread_result;
  5894. state->completed = true;
  5895. state->result_cv.notify_one();
  5896. });
  5897. // Wait for completion or timeout
  5898. std::unique_lock<std::mutex> lock(state->mutex);
  5899. auto finished =
  5900. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5901. [&] { return state->completed; });
  5902. if (finished) {
  5903. // Operation completed within timeout
  5904. resolve_thread.join();
  5905. *res = state->info;
  5906. state->info = nullptr; // Pass ownership to caller
  5907. return state->result;
  5908. } else {
  5909. // Timeout occurred
  5910. resolve_thread.detach(); // Let the thread finish in background
  5911. return EAI_AGAIN; // Return timeout error
  5912. }
  5913. #endif
  5914. #else
  5915. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5916. return getaddrinfo(node, service, hints, res);
  5917. #endif
  5918. }
  5919. template <typename BindOrConnect>
  5920. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5921. int address_family, int socket_flags, bool tcp_nodelay,
  5922. bool ipv6_v6only, SocketOptions socket_options,
  5923. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5924. // Get address info
  5925. const char *node = nullptr;
  5926. struct addrinfo hints;
  5927. struct addrinfo *result;
  5928. memset(&hints, 0, sizeof(struct addrinfo));
  5929. hints.ai_socktype = SOCK_STREAM;
  5930. hints.ai_protocol = IPPROTO_IP;
  5931. if (!ip.empty()) {
  5932. node = ip.c_str();
  5933. // Ask getaddrinfo to convert IP in c-string to address
  5934. hints.ai_family = AF_UNSPEC;
  5935. hints.ai_flags = AI_NUMERICHOST;
  5936. } else {
  5937. if (!host.empty()) { node = host.c_str(); }
  5938. hints.ai_family = address_family;
  5939. hints.ai_flags = socket_flags;
  5940. }
  5941. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5942. if (hints.ai_family == AF_UNIX) {
  5943. const auto addrlen = host.length();
  5944. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5945. #ifdef SOCK_CLOEXEC
  5946. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5947. hints.ai_protocol);
  5948. #else
  5949. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5950. #endif
  5951. if (sock != INVALID_SOCKET) {
  5952. sockaddr_un addr{};
  5953. addr.sun_family = AF_UNIX;
  5954. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5955. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5956. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5957. hints.ai_addrlen = static_cast<socklen_t>(
  5958. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5959. #ifndef SOCK_CLOEXEC
  5960. #ifndef _WIN32
  5961. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5962. #endif
  5963. #endif
  5964. if (socket_options) { socket_options(sock); }
  5965. #ifdef _WIN32
  5966. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5967. // remove the option.
  5968. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5969. #endif
  5970. bool dummy;
  5971. if (!bind_or_connect(sock, hints, dummy)) {
  5972. close_socket(sock);
  5973. sock = INVALID_SOCKET;
  5974. }
  5975. }
  5976. return sock;
  5977. }
  5978. #endif
  5979. auto service = std::to_string(port);
  5980. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5981. timeout_sec)) {
  5982. #if defined __linux__ && !defined __ANDROID__
  5983. res_init();
  5984. #endif
  5985. return INVALID_SOCKET;
  5986. }
  5987. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5988. for (auto rp = result; rp; rp = rp->ai_next) {
  5989. // Create a socket
  5990. #ifdef _WIN32
  5991. auto sock =
  5992. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5993. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5994. /**
  5995. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5996. * and above the socket creation fails on older Windows Systems.
  5997. *
  5998. * Let's try to create a socket the old way in this case.
  5999. *
  6000. * Reference:
  6001. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6002. *
  6003. * WSA_FLAG_NO_HANDLE_INHERIT:
  6004. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6005. * SP1, and later
  6006. *
  6007. */
  6008. if (sock == INVALID_SOCKET) {
  6009. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6010. }
  6011. #else
  6012. #ifdef SOCK_CLOEXEC
  6013. auto sock =
  6014. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6015. #else
  6016. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6017. #endif
  6018. #endif
  6019. if (sock == INVALID_SOCKET) { continue; }
  6020. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6021. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6022. close_socket(sock);
  6023. continue;
  6024. }
  6025. #endif
  6026. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6027. if (rp->ai_family == AF_INET6) {
  6028. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6029. }
  6030. if (socket_options) { socket_options(sock); }
  6031. // bind or connect
  6032. auto quit = false;
  6033. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6034. close_socket(sock);
  6035. if (quit) { break; }
  6036. }
  6037. return INVALID_SOCKET;
  6038. }
  6039. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6040. #ifdef _WIN32
  6041. auto flags = nonblocking ? 1UL : 0UL;
  6042. ioctlsocket(sock, FIONBIO, &flags);
  6043. #else
  6044. auto flags = fcntl(sock, F_GETFL, 0);
  6045. fcntl(sock, F_SETFL,
  6046. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6047. #endif
  6048. }
  6049. inline bool is_connection_error() {
  6050. #ifdef _WIN32
  6051. return WSAGetLastError() != WSAEWOULDBLOCK;
  6052. #else
  6053. return errno != EINPROGRESS;
  6054. #endif
  6055. }
  6056. // accept() failed because the process or the network stack is temporarily out
  6057. // of resources. The listening socket is still usable, so back off briefly and
  6058. // try again.
  6059. inline bool is_accept_resource_error() {
  6060. #ifdef _WIN32
  6061. auto err = WSAGetLastError();
  6062. return err == WSAEMFILE || err == WSAENOBUFS;
  6063. #else
  6064. auto err = errno;
  6065. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6066. #endif
  6067. }
  6068. // accept() failed for a reason that says nothing about the listening socket:
  6069. // the pending connection went away before it could be accepted, or the call
  6070. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6071. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6072. // connection that way.
  6073. inline bool is_accept_transient_error() {
  6074. #ifdef _WIN32
  6075. auto err = WSAGetLastError();
  6076. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6077. err == WSAECONNABORTED;
  6078. #else
  6079. auto err = errno;
  6080. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6081. err == ECONNABORTED;
  6082. #endif
  6083. }
  6084. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6085. struct addrinfo hints;
  6086. struct addrinfo *result;
  6087. memset(&hints, 0, sizeof(struct addrinfo));
  6088. hints.ai_family = AF_UNSPEC;
  6089. hints.ai_socktype = SOCK_STREAM;
  6090. hints.ai_protocol = 0;
  6091. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6092. return false;
  6093. }
  6094. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6095. auto ret = false;
  6096. for (auto rp = result; rp; rp = rp->ai_next) {
  6097. const auto &ai = *rp;
  6098. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6099. ret = true;
  6100. break;
  6101. }
  6102. }
  6103. return ret;
  6104. }
  6105. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6106. #define USE_IF2IP
  6107. #endif
  6108. #ifdef USE_IF2IP
  6109. inline std::string if2ip(int address_family, const std::string &ifn) {
  6110. struct ifaddrs *ifap;
  6111. getifaddrs(&ifap);
  6112. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6113. std::string addr_candidate;
  6114. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6115. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6116. (AF_UNSPEC == address_family ||
  6117. ifa->ifa_addr->sa_family == address_family)) {
  6118. if (ifa->ifa_addr->sa_family == AF_INET) {
  6119. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6120. char buf[INET_ADDRSTRLEN];
  6121. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6122. return std::string(buf, INET_ADDRSTRLEN);
  6123. }
  6124. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6125. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6126. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6127. char buf[INET6_ADDRSTRLEN] = {};
  6128. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6129. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6130. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6131. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6132. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6133. } else {
  6134. return std::string(buf, INET6_ADDRSTRLEN);
  6135. }
  6136. }
  6137. }
  6138. }
  6139. }
  6140. }
  6141. return addr_candidate;
  6142. }
  6143. #endif
  6144. inline socket_t create_client_socket(
  6145. const std::string &host, const std::string &ip, int port,
  6146. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6147. SocketOptions socket_options, time_t connection_timeout_sec,
  6148. time_t connection_timeout_usec, time_t read_timeout_sec,
  6149. time_t read_timeout_usec, time_t write_timeout_sec,
  6150. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6151. auto sock = create_socket(
  6152. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6153. std::move(socket_options),
  6154. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6155. if (!intf.empty()) {
  6156. #ifdef USE_IF2IP
  6157. auto ip_from_if = if2ip(address_family, intf);
  6158. if (ip_from_if.empty()) { ip_from_if = intf; }
  6159. if (!bind_ip_address(sock2, ip_from_if)) {
  6160. error = Error::BindIPAddress;
  6161. return false;
  6162. }
  6163. #endif
  6164. }
  6165. set_nonblocking(sock2, true);
  6166. auto ret =
  6167. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6168. if (ret < 0) {
  6169. if (is_connection_error()) {
  6170. error = Error::Connection;
  6171. return false;
  6172. }
  6173. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6174. connection_timeout_usec);
  6175. if (error != Error::Success) {
  6176. if (error == Error::ConnectionTimeout) { quit = true; }
  6177. return false;
  6178. }
  6179. }
  6180. set_nonblocking(sock2, false);
  6181. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6182. read_timeout_usec);
  6183. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6184. write_timeout_usec);
  6185. error = Error::Success;
  6186. return true;
  6187. },
  6188. connection_timeout_sec); // Pass DNS timeout
  6189. if (sock != INVALID_SOCKET) {
  6190. error = Error::Success;
  6191. } else {
  6192. if (error == Error::Success) { error = Error::Connection; }
  6193. }
  6194. return sock;
  6195. }
  6196. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6197. socklen_t addr_len, std::string &ip, int &port) {
  6198. if (addr.ss_family == AF_INET) {
  6199. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6200. } else if (addr.ss_family == AF_INET6) {
  6201. port =
  6202. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6203. } else {
  6204. return false;
  6205. }
  6206. std::array<char, NI_MAXHOST> ipstr{};
  6207. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6208. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6209. 0, NI_NUMERICHOST)) {
  6210. return false;
  6211. }
  6212. ip = ipstr.data();
  6213. return true;
  6214. }
  6215. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6216. struct sockaddr_storage addr;
  6217. socklen_t addr_len = sizeof(addr);
  6218. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6219. &addr_len)) {
  6220. get_ip_and_port(addr, addr_len, ip, port);
  6221. }
  6222. }
  6223. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6224. struct sockaddr_storage addr;
  6225. socklen_t addr_len = sizeof(addr);
  6226. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6227. &addr_len)) {
  6228. #ifndef _WIN32
  6229. if (addr.ss_family == AF_UNIX) {
  6230. #if defined(__linux__)
  6231. struct ucred ucred;
  6232. socklen_t len = sizeof(ucred);
  6233. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6234. port = ucred.pid;
  6235. }
  6236. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6237. pid_t pid;
  6238. socklen_t len = sizeof(pid);
  6239. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6240. port = pid;
  6241. }
  6242. #endif
  6243. return;
  6244. }
  6245. #endif
  6246. get_ip_and_port(addr, addr_len, ip, port);
  6247. }
  6248. }
  6249. // Recursive form retained so operator""_t below can compute hashes for
  6250. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6251. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6252. // instead, which is iterative and stack-safe.
  6253. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6254. unsigned int h) {
  6255. return (l == 0)
  6256. ? h
  6257. : str2tag_core(
  6258. s + 1, l - 1,
  6259. // Unsets the 6 high bits of h, therefore no overflow happens
  6260. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6261. h * 33) ^
  6262. static_cast<unsigned char>(*s));
  6263. }
  6264. inline unsigned int str2tag(const std::string &s) {
  6265. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6266. // for compile-time UDL evaluation of short string literals, but at runtime
  6267. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6268. // would blow the stack with one frame per character.
  6269. unsigned int h = 0;
  6270. for (auto c : s) {
  6271. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6272. static_cast<unsigned char>(c);
  6273. }
  6274. return h;
  6275. }
  6276. namespace udl {
  6277. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6278. return str2tag_core(s, l, 0);
  6279. }
  6280. } // namespace udl
  6281. inline std::string
  6282. find_content_type(const std::string &path,
  6283. const std::map<std::string, std::string> &user_data,
  6284. const std::string &default_content_type) {
  6285. auto ext = file_extension(path);
  6286. auto it = user_data.find(ext);
  6287. if (it != user_data.end()) { return it->second; }
  6288. using udl::operator""_t;
  6289. switch (str2tag(ext)) {
  6290. default: return default_content_type;
  6291. case "css"_t: return "text/css";
  6292. case "csv"_t: return "text/csv";
  6293. case "htm"_t:
  6294. case "html"_t: return "text/html";
  6295. case "js"_t:
  6296. case "mjs"_t: return "text/javascript";
  6297. case "txt"_t: return "text/plain";
  6298. case "vtt"_t: return "text/vtt";
  6299. case "apng"_t: return "image/apng";
  6300. case "avif"_t: return "image/avif";
  6301. case "bmp"_t: return "image/bmp";
  6302. case "gif"_t: return "image/gif";
  6303. case "png"_t: return "image/png";
  6304. case "svg"_t: return "image/svg+xml";
  6305. case "webp"_t: return "image/webp";
  6306. case "ico"_t: return "image/x-icon";
  6307. case "tif"_t: return "image/tiff";
  6308. case "tiff"_t: return "image/tiff";
  6309. case "jpg"_t:
  6310. case "jpeg"_t: return "image/jpeg";
  6311. case "mp4"_t: return "video/mp4";
  6312. case "mpeg"_t: return "video/mpeg";
  6313. case "webm"_t: return "video/webm";
  6314. case "mp3"_t: return "audio/mp3";
  6315. case "mpga"_t: return "audio/mpeg";
  6316. case "weba"_t: return "audio/webm";
  6317. case "wav"_t: return "audio/wave";
  6318. case "otf"_t: return "font/otf";
  6319. case "ttf"_t: return "font/ttf";
  6320. case "woff"_t: return "font/woff";
  6321. case "woff2"_t: return "font/woff2";
  6322. case "7z"_t: return "application/x-7z-compressed";
  6323. case "atom"_t: return "application/atom+xml";
  6324. case "pdf"_t: return "application/pdf";
  6325. case "json"_t: return "application/json";
  6326. case "rss"_t: return "application/rss+xml";
  6327. case "tar"_t: return "application/x-tar";
  6328. case "xht"_t:
  6329. case "xhtml"_t: return "application/xhtml+xml";
  6330. case "xslt"_t: return "application/xslt+xml";
  6331. case "xml"_t: return "application/xml";
  6332. case "gz"_t: return "application/gzip";
  6333. case "zip"_t: return "application/zip";
  6334. case "wasm"_t: return "application/wasm";
  6335. }
  6336. }
  6337. inline std::string
  6338. extract_media_type(const std::string &content_type,
  6339. std::map<std::string, std::string> *params = nullptr) {
  6340. // Extract type/subtype from Content-Type value (RFC 2045)
  6341. // e.g. "application/json; charset=utf-8" -> "application/json"
  6342. auto media_type = content_type;
  6343. auto semicolon_pos = media_type.find(';');
  6344. if (semicolon_pos != std::string::npos) {
  6345. auto param_str = media_type.substr(semicolon_pos + 1);
  6346. media_type = media_type.substr(0, semicolon_pos);
  6347. if (params) {
  6348. // Parse parameters: key=value pairs separated by ';'
  6349. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6350. [&](const char *b, const char *e) {
  6351. std::string key;
  6352. std::string val;
  6353. divide_param_pair(b, e, key, val);
  6354. if (!key.empty()) {
  6355. params->emplace(trim_copy(key),
  6356. trim_double_quotes_copy(val));
  6357. }
  6358. });
  6359. }
  6360. }
  6361. // Trim whitespace from media type
  6362. return trim_copy(media_type);
  6363. }
  6364. inline bool can_compress_content_type(const std::string &content_type) {
  6365. using udl::operator""_t;
  6366. auto mime_type = extract_media_type(content_type);
  6367. auto tag = str2tag(mime_type);
  6368. switch (tag) {
  6369. case "image/svg+xml"_t:
  6370. case "application/javascript"_t:
  6371. case "application/x-javascript"_t:
  6372. case "application/json"_t:
  6373. case "application/ld+json"_t:
  6374. case "application/xml"_t:
  6375. case "application/xhtml+xml"_t:
  6376. case "application/rss+xml"_t:
  6377. case "application/atom+xml"_t:
  6378. case "application/xslt+xml"_t:
  6379. case "application/protobuf"_t: return true;
  6380. case "text/event-stream"_t: return false;
  6381. default: return !mime_type.rfind("text/", 0);
  6382. }
  6383. }
  6384. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6385. double &quality) {
  6386. quality = 1.0;
  6387. token.clear();
  6388. // Split on first ';': left = token name, right = parameters
  6389. const char *params_b = nullptr;
  6390. std::size_t params_len = 0;
  6391. divide(
  6392. b, static_cast<std::size_t>(e - b), ';',
  6393. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6394. auto r = trim(lb, lb + llen, 0, llen);
  6395. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6396. params_b = rb;
  6397. params_len = rlen;
  6398. });
  6399. if (token.empty()) { return false; }
  6400. if (params_len == 0) { return true; }
  6401. // Scan parameters for q= (stops on first match)
  6402. bool invalid = false;
  6403. split_find(params_b, params_b + params_len, ';',
  6404. (std::numeric_limits<size_t>::max)(),
  6405. [&](const char *pb, const char *pe) -> bool {
  6406. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6407. auto len = static_cast<size_t>(pe - pb);
  6408. if (len < 2) { return false; }
  6409. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6410. return false;
  6411. }
  6412. // Trim the value portion
  6413. auto r = trim(pb, pe, 2, len);
  6414. if (r.first >= r.second) {
  6415. invalid = true;
  6416. return true;
  6417. }
  6418. double v = 0.0;
  6419. auto res = from_chars(pb + r.first, pb + r.second, v);
  6420. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6421. v < 0.0 || v > 1.0) {
  6422. invalid = true;
  6423. return true;
  6424. }
  6425. quality = v;
  6426. return true;
  6427. });
  6428. return !invalid;
  6429. }
  6430. inline EncodingType encoding_type(const Request &req,
  6431. const std::string &content_type) {
  6432. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6433. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6434. if (s.empty()) { return EncodingType::None; }
  6435. // Single-pass: iterate tokens and track the best supported encoding.
  6436. // Server preference breaks ties (br > gzip > zstd).
  6437. EncodingType best = EncodingType::None;
  6438. double best_q = 0.0; // q=0 means "not acceptable"
  6439. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6440. auto priority = [](EncodingType t) -> int {
  6441. switch (t) {
  6442. case EncodingType::Brotli: return 0;
  6443. case EncodingType::Gzip: return 1;
  6444. case EncodingType::Zstd: return 2;
  6445. default: return 3;
  6446. }
  6447. };
  6448. std::string name;
  6449. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6450. double quality = 1.0;
  6451. if (!parse_quality(b, e, name, quality)) { return; }
  6452. if (quality <= 0.0) { return; }
  6453. EncodingType type = EncodingType::None;
  6454. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6455. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6456. #endif
  6457. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6458. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6459. type = EncodingType::Gzip;
  6460. }
  6461. #endif
  6462. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6463. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6464. type = EncodingType::Zstd;
  6465. }
  6466. #endif
  6467. if (type == EncodingType::None) { return; }
  6468. // Higher q-value wins; for equal q, server preference breaks ties
  6469. if (quality > best_q ||
  6470. (quality == best_q && priority(type) < priority(best))) {
  6471. best_q = quality;
  6472. best = type;
  6473. }
  6474. });
  6475. return best;
  6476. }
  6477. // `content_type` is taken separately because a file-backed response has not
  6478. // been given one yet when its coding has to be decided.
  6479. inline EncodingType encoding_type(const Request &req, const Response &res,
  6480. const std::string &content_type) {
  6481. // The response already names a content coding of its own: a handler serving
  6482. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6483. // point whose headers name the coding its files are stored in. Applying one
  6484. // on top of that would double-encode the body and append a second
  6485. // `Content-Encoding` field line.
  6486. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6487. return encoding_type(req, content_type);
  6488. }
  6489. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6490. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6491. }
  6492. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6493. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6494. if (type == EncodingType::Gzip) {
  6495. return detail::make_unique<gzip_compressor>();
  6496. }
  6497. #endif
  6498. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6499. if (type == EncodingType::Brotli) {
  6500. return detail::make_unique<brotli_compressor>();
  6501. }
  6502. #endif
  6503. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6504. if (type == EncodingType::Zstd) {
  6505. return detail::make_unique<zstd_compressor>();
  6506. }
  6507. #endif
  6508. (void)type;
  6509. return nullptr;
  6510. }
  6511. inline const char *encoding_name(EncodingType type) {
  6512. switch (type) {
  6513. case EncodingType::Gzip: return "gzip";
  6514. case EncodingType::Brotli: return "br";
  6515. case EncodingType::Zstd: return "zstd";
  6516. default: return "";
  6517. }
  6518. }
  6519. inline bool nocompressor::compress(const char *data, size_t data_length,
  6520. bool /*last*/, Callback callback) {
  6521. if (!data_length) { return true; }
  6522. return callback(data, data_length);
  6523. }
  6524. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6525. inline gzip_compressor::gzip_compressor() {
  6526. std::memset(&strm_, 0, sizeof(strm_));
  6527. strm_.zalloc = Z_NULL;
  6528. strm_.zfree = Z_NULL;
  6529. strm_.opaque = Z_NULL;
  6530. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6531. Z_DEFAULT_STRATEGY) == Z_OK;
  6532. }
  6533. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6534. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6535. bool last, Callback callback) {
  6536. assert(is_valid_);
  6537. do {
  6538. constexpr size_t max_avail_in =
  6539. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6540. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6541. (std::min)(data_length, max_avail_in));
  6542. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6543. data_length -= strm_.avail_in;
  6544. data += strm_.avail_in;
  6545. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6546. auto ret = Z_OK;
  6547. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6548. do {
  6549. strm_.avail_out = static_cast<uInt>(buff.size());
  6550. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6551. ret = deflate(&strm_, flush);
  6552. if (ret == Z_STREAM_ERROR) { return false; }
  6553. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6554. return false;
  6555. }
  6556. } while (strm_.avail_out == 0);
  6557. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6558. (flush == Z_NO_FLUSH && ret == Z_OK));
  6559. assert(strm_.avail_in == 0);
  6560. } while (data_length > 0);
  6561. return true;
  6562. }
  6563. inline gzip_decompressor::gzip_decompressor() {
  6564. std::memset(&strm_, 0, sizeof(strm_));
  6565. strm_.zalloc = Z_NULL;
  6566. strm_.zfree = Z_NULL;
  6567. strm_.opaque = Z_NULL;
  6568. // 15 is the value of wbits, which should be at the maximum possible value
  6569. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6570. // that the stream type should be automatically detected either gzip or
  6571. // deflate.
  6572. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6573. }
  6574. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6575. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6576. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6577. Callback callback) {
  6578. assert(is_valid_);
  6579. auto ret = Z_OK;
  6580. do {
  6581. constexpr size_t max_avail_in =
  6582. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6583. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6584. (std::min)(data_length, max_avail_in));
  6585. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6586. data_length -= strm_.avail_in;
  6587. data += strm_.avail_in;
  6588. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6589. while (strm_.avail_in > 0 && ret == Z_OK) {
  6590. strm_.avail_out = static_cast<uInt>(buff.size());
  6591. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6592. ret = inflate(&strm_, Z_NO_FLUSH);
  6593. assert(ret != Z_STREAM_ERROR);
  6594. switch (ret) {
  6595. case Z_NEED_DICT:
  6596. case Z_DATA_ERROR:
  6597. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6598. }
  6599. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6600. return false;
  6601. }
  6602. }
  6603. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6604. } while (data_length > 0);
  6605. return true;
  6606. }
  6607. #endif
  6608. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6609. inline brotli_compressor::brotli_compressor() {
  6610. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6611. }
  6612. inline brotli_compressor::~brotli_compressor() {
  6613. BrotliEncoderDestroyInstance(state_);
  6614. }
  6615. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6616. bool last, Callback callback) {
  6617. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6618. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6619. auto available_in = data_length;
  6620. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6621. for (;;) {
  6622. if (last) {
  6623. if (BrotliEncoderIsFinished(state_)) { break; }
  6624. } else {
  6625. if (!available_in) { break; }
  6626. }
  6627. auto available_out = buff.size();
  6628. auto next_out = buff.data();
  6629. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6630. &available_out, &next_out, nullptr)) {
  6631. return false;
  6632. }
  6633. auto output_bytes = buff.size() - available_out;
  6634. if (output_bytes) {
  6635. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6636. }
  6637. }
  6638. return true;
  6639. }
  6640. inline brotli_decompressor::brotli_decompressor() {
  6641. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6642. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6643. : BROTLI_DECODER_RESULT_ERROR;
  6644. }
  6645. inline brotli_decompressor::~brotli_decompressor() {
  6646. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6647. }
  6648. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6649. inline bool brotli_decompressor::decompress(const char *data,
  6650. size_t data_length,
  6651. Callback callback) {
  6652. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6653. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6654. return 0;
  6655. }
  6656. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6657. size_t avail_in = data_length;
  6658. size_t total_out;
  6659. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6660. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6661. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6662. char *next_out = buff.data();
  6663. size_t avail_out = buff.size();
  6664. decoder_r = BrotliDecoderDecompressStream(
  6665. decoder_s, &avail_in, &next_in, &avail_out,
  6666. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6667. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6668. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6669. }
  6670. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6671. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6672. }
  6673. #endif
  6674. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6675. inline zstd_compressor::zstd_compressor() {
  6676. ctx_ = ZSTD_createCCtx();
  6677. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6678. }
  6679. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6680. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6681. bool last, Callback callback) {
  6682. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6683. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6684. ZSTD_inBuffer input = {data, data_length, 0};
  6685. bool finished;
  6686. do {
  6687. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6688. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6689. if (ZSTD_isError(remaining)) { return false; }
  6690. if (!callback(buff.data(), output.pos)) { return false; }
  6691. finished = last ? (remaining == 0) : (input.pos == input.size);
  6692. } while (!finished);
  6693. return true;
  6694. }
  6695. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6696. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6697. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6698. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6699. Callback callback) {
  6700. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6701. ZSTD_inBuffer input = {data, data_length, 0};
  6702. while (input.pos < input.size) {
  6703. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6704. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6705. if (ZSTD_isError(remaining)) { return false; }
  6706. if (!callback(buff.data(), output.pos)) { return false; }
  6707. }
  6708. return true;
  6709. }
  6710. #endif
  6711. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6712. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6713. // unknown coding, and its payload would be handed back still compressed.
  6714. inline bool is_zlib_encoding(const std::string &encoding) {
  6715. return case_ignore::equal(encoding, "gzip") ||
  6716. case_ignore::equal(encoding, "deflate");
  6717. }
  6718. inline bool is_brotli_encoding(const std::string &encoding) {
  6719. return case_ignore::equal(encoding, "br");
  6720. }
  6721. inline bool is_zstd_encoding(const std::string &encoding) {
  6722. return case_ignore::equal(encoding, "zstd");
  6723. }
  6724. // Returns true if the content coding is one cpp-httplib is able to decompress
  6725. // when the corresponding support is compiled in.
  6726. inline bool is_known_content_encoding(const std::string &encoding) {
  6727. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6728. is_zstd_encoding(encoding);
  6729. }
  6730. inline std::unique_ptr<decompressor>
  6731. create_decompressor(const std::string &encoding) {
  6732. std::unique_ptr<decompressor> decompressor;
  6733. if (is_zlib_encoding(encoding)) {
  6734. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6735. decompressor = detail::make_unique<gzip_decompressor>();
  6736. #endif
  6737. } else if (is_brotli_encoding(encoding)) {
  6738. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6739. decompressor = detail::make_unique<brotli_decompressor>();
  6740. #endif
  6741. } else if (is_zstd_encoding(encoding)) {
  6742. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6743. decompressor = detail::make_unique<zstd_decompressor>();
  6744. #endif
  6745. }
  6746. return decompressor;
  6747. }
  6748. // Returns the best available compressor and its Content-Encoding name.
  6749. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6750. inline std::pair<std::unique_ptr<compressor>, const char *>
  6751. create_compressor() {
  6752. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6753. return {detail::make_unique<brotli_compressor>(), "br"};
  6754. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6755. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6756. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6757. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6758. #else
  6759. return {nullptr, nullptr};
  6760. #endif
  6761. }
  6762. inline bool is_prohibited_header_name(const std::string &name) {
  6763. using udl::operator""_t;
  6764. switch (str2tag(name)) {
  6765. case "REMOTE_ADDR"_t:
  6766. case "REMOTE_PORT"_t:
  6767. case "LOCAL_ADDR"_t:
  6768. case "LOCAL_PORT"_t: return true;
  6769. default: return false;
  6770. }
  6771. }
  6772. inline bool has_header(const Headers &headers, const std::string &key) {
  6773. if (is_prohibited_header_name(key)) { return false; }
  6774. return headers.find(key) != headers.end();
  6775. }
  6776. inline const char *get_header_value(const Headers &headers,
  6777. const std::string &key, const char *def,
  6778. size_t id) {
  6779. if (is_prohibited_header_name(key)) {
  6780. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6781. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6782. throw std::invalid_argument(msg);
  6783. #else
  6784. return "";
  6785. #endif
  6786. }
  6787. auto rng = headers.equal_range(key);
  6788. auto it = bounded_next(rng.first, id, rng.second);
  6789. if (it != rng.second) { return it->second.c_str(); }
  6790. return def;
  6791. }
  6792. inline size_t get_header_value_count(const Headers &headers,
  6793. const std::string &key) {
  6794. return headers.count(key);
  6795. }
  6796. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6797. // list may be sent as several field lines, and the combined field value is
  6798. // those values joined by commas in the order they were received. Callers that
  6799. // parse such a list must work on the combined value; reading only the first
  6800. // occurrence silently drops whatever the later field lines carry.
  6801. inline std::string get_combined_header_value(const Headers &headers,
  6802. const std::string &key) {
  6803. std::string combined;
  6804. auto rng = headers.equal_range(key);
  6805. for (auto it = rng.first; it != rng.second; ++it) {
  6806. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6807. // elements, so an empty field line must not contribute a bare comma to the
  6808. // combined value.
  6809. if (it->second.empty()) { continue; }
  6810. if (!combined.empty()) { combined += ", "; }
  6811. combined += it->second;
  6812. }
  6813. return combined;
  6814. }
  6815. inline bool has_header_token(const Headers &headers, const std::string &key,
  6816. const std::string &token) {
  6817. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6818. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6819. // several lines. Match complete tokens rather than searching the raw value,
  6820. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6821. auto rng = headers.equal_range(key);
  6822. for (auto it = rng.first; it != rng.second; ++it) {
  6823. const auto &value = it->second;
  6824. if (split_find(value.data(), value.data() + value.size(), ',',
  6825. [&](const char *b, const char *e) {
  6826. return case_ignore::equal(std::string(b, e), token);
  6827. })) {
  6828. return true;
  6829. }
  6830. }
  6831. return false;
  6832. }
  6833. template <typename Map>
  6834. inline typename Map::mapped_type
  6835. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6836. auto rng = m.equal_range(key);
  6837. auto it = bounded_next(rng.first, id, rng.second);
  6838. if (it != rng.second) { return it->second; }
  6839. return typename Map::mapped_type();
  6840. }
  6841. inline void set_header(Headers &headers, const std::string &key,
  6842. const std::string &val) {
  6843. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6844. }
  6845. inline bool read_headers(Stream &strm, Headers &headers) {
  6846. const auto bufsiz = 2048;
  6847. char buf[bufsiz];
  6848. stream_line_reader line_reader(strm, buf, bufsiz);
  6849. size_t header_count = 0;
  6850. for (;;) {
  6851. if (!line_reader.getline()) { return false; }
  6852. // Check if the line ends with CRLF.
  6853. auto line_terminator_len = 2;
  6854. if (line_reader.end_with_crlf()) {
  6855. // Blank line indicates end of headers.
  6856. if (line_reader.size() == 2) { break; }
  6857. } else {
  6858. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6859. // Blank line indicates end of headers.
  6860. if (line_reader.size() == 1) { break; }
  6861. line_terminator_len = 1;
  6862. #else
  6863. continue; // Skip invalid line.
  6864. #endif
  6865. }
  6866. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6867. // Check header count limit
  6868. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6869. // Exclude line terminator
  6870. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6871. if (!parse_header(line_reader.ptr(), end,
  6872. [&](const std::string &key, const std::string &val) {
  6873. headers.emplace(key, val);
  6874. })) {
  6875. return false;
  6876. }
  6877. header_count++;
  6878. }
  6879. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6880. // headers that have different values to prevent request smuggling.
  6881. auto cl_range = headers.equal_range("Content-Length");
  6882. if (cl_range.first != cl_range.second) {
  6883. const auto &first_val = cl_range.first->second;
  6884. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6885. if (it->second != first_val) { return false; }
  6886. }
  6887. }
  6888. return true;
  6889. }
  6890. inline bool parse_status_line(const char *line, std::string &version,
  6891. int &status, std::string &reason) {
  6892. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6893. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6894. #else
  6895. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6896. #endif
  6897. std::cmatch m;
  6898. if (!std::regex_match(line, m, re)) { return false; }
  6899. version = std::string(m[1]);
  6900. status = std::stoi(std::string(m[2]));
  6901. reason = std::string(m[3]);
  6902. return true;
  6903. }
  6904. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6905. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6906. struct WebSocketUpgradeResponse {
  6907. Error error = Error::Success;
  6908. int status = -1;
  6909. Headers headers;
  6910. std::string selected_subprotocol;
  6911. };
  6912. inline bool
  6913. read_websocket_upgrade_response(Stream &strm,
  6914. const std::string &expected_accept,
  6915. const std::string &offered_subprotocols,
  6916. WebSocketUpgradeResponse &upgrade) {
  6917. // Read status line
  6918. const auto bufsiz = 2048;
  6919. char buf[bufsiz];
  6920. stream_line_reader line_reader(strm, buf, bufsiz);
  6921. if (!line_reader.getline()) {
  6922. upgrade.error = Error::Read;
  6923. return false;
  6924. }
  6925. std::string version;
  6926. std::string reason;
  6927. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6928. upgrade.error = Error::WebSocketHandshake;
  6929. return false;
  6930. }
  6931. // Read the headers even for a rejection so the caller can see why the
  6932. // server refused the upgrade. A non-101 response may carry a body; it is
  6933. // deliberately left unread since the caller closes the socket right away.
  6934. if (!read_headers(strm, upgrade.headers)) {
  6935. upgrade.error = Error::Read;
  6936. return false;
  6937. }
  6938. const auto &headers = upgrade.headers;
  6939. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6940. upgrade.error = Error::WebSocketHandshake;
  6941. return false;
  6942. }
  6943. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6944. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6945. upgrade.error = Error::WebSocketHandshake;
  6946. return false;
  6947. }
  6948. // Verify Connection: Upgrade
  6949. if (!has_header_token(headers, "Connection", "upgrade")) {
  6950. upgrade.error = Error::WebSocketHandshake;
  6951. return false;
  6952. }
  6953. // Verify Sec-WebSocket-Accept header value
  6954. auto it = headers.find("Sec-WebSocket-Accept");
  6955. if (it == headers.end() || it->second != expected_accept) {
  6956. upgrade.error = Error::WebSocketHandshake;
  6957. return false;
  6958. }
  6959. // Extract negotiated subprotocol
  6960. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6961. if (proto_it != headers.end()) {
  6962. upgrade.selected_subprotocol = proto_it->second;
  6963. }
  6964. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  6965. if (!upgrade.selected_subprotocol.empty()) {
  6966. auto was_offered = false;
  6967. split(offered_subprotocols.data(),
  6968. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  6969. [&](const char *b, const char *e) {
  6970. if (std::string(b, e) == upgrade.selected_subprotocol) {
  6971. was_offered = true;
  6972. }
  6973. });
  6974. if (!was_offered) {
  6975. upgrade.error = Error::WebSocketHandshake;
  6976. return false;
  6977. }
  6978. }
  6979. return true;
  6980. }
  6981. enum class ReadContentResult {
  6982. Success, // Successfully read the content
  6983. PayloadTooLarge, // The content exceeds the specified payload limit
  6984. Error // An error occurred while reading the content
  6985. };
  6986. inline ReadContentResult read_content_with_length(
  6987. Stream &strm, size_t len, DownloadProgress progress,
  6988. ContentReceiverWithProgress out,
  6989. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6990. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6991. detail::BodyReader br;
  6992. br.stream = &strm;
  6993. br.has_content_length = true;
  6994. br.content_length = len;
  6995. br.payload_max_length = payload_max_length;
  6996. br.chunked = false;
  6997. br.bytes_read = 0;
  6998. br.last_error = Error::Success;
  6999. size_t r = 0;
  7000. while (r < len) {
  7001. auto read_len = static_cast<size_t>(len - r);
  7002. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7003. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7004. if (n <= 0) {
  7005. // Check if it was a payload size error
  7006. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7007. return ReadContentResult::PayloadTooLarge;
  7008. }
  7009. return ReadContentResult::Error;
  7010. }
  7011. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7012. return ReadContentResult::Error;
  7013. }
  7014. r += static_cast<size_t>(n);
  7015. if (progress) {
  7016. if (!progress(r, len)) { return ReadContentResult::Error; }
  7017. }
  7018. }
  7019. return ReadContentResult::Success;
  7020. }
  7021. inline ReadContentResult
  7022. read_content_without_length(Stream &strm, size_t payload_max_length,
  7023. ContentReceiverWithProgress out) {
  7024. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7025. size_t r = 0;
  7026. for (;;) {
  7027. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7028. if (n == 0) { return ReadContentResult::Success; }
  7029. if (n < 0) { return ReadContentResult::Error; }
  7030. // Check if adding this data would exceed the payload limit
  7031. if (payload_max_length > 0 &&
  7032. (r > payload_max_length ||
  7033. payload_max_length - r < static_cast<size_t>(n))) {
  7034. return ReadContentResult::PayloadTooLarge;
  7035. }
  7036. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7037. return ReadContentResult::Error;
  7038. }
  7039. r += static_cast<size_t>(n);
  7040. }
  7041. return ReadContentResult::Success;
  7042. }
  7043. template <typename T>
  7044. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7045. size_t payload_max_length,
  7046. ContentReceiverWithProgress out) {
  7047. detail::ChunkedDecoder dec(strm);
  7048. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7049. size_t total_len = 0;
  7050. for (;;) {
  7051. size_t chunk_offset = 0;
  7052. size_t chunk_total = 0;
  7053. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7054. if (n < 0) { return ReadContentResult::Error; }
  7055. if (n == 0) {
  7056. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7057. return ReadContentResult::Error;
  7058. }
  7059. return ReadContentResult::Success;
  7060. }
  7061. if (payload_max_length > 0 &&
  7062. (total_len > payload_max_length ||
  7063. payload_max_length - total_len < static_cast<size_t>(n))) {
  7064. return ReadContentResult::PayloadTooLarge;
  7065. }
  7066. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7067. return ReadContentResult::Error;
  7068. }
  7069. total_len += static_cast<size_t>(n);
  7070. }
  7071. }
  7072. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7073. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7074. // is the final transfer coding. A single field value may list several
  7075. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7076. // several Transfer-Encoding lines, which combine into one comma-separated
  7077. // list in the order the lines were received. Headers preserves that order,
  7078. // so the final coding is the last token of the last line. Match it
  7079. // case-insensitively rather than comparing the whole value against
  7080. // "chunked".
  7081. //
  7082. // Security: reading a chunked message as unframed leaves its body in the
  7083. // socket, where a keep-alive connection parses it as a smuggled request.
  7084. // Server::process_request() answers 400 and closes when the final coding is
  7085. // not chunked, so a request whose framing cannot be determined never
  7086. // reaches the "no body" path.
  7087. auto rng = headers.equal_range("Transfer-Encoding");
  7088. if (rng.first == rng.second) { return false; }
  7089. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7090. // combined list ending in nothing rather than inheriting the line before it.
  7091. std::string last_coding;
  7092. for (auto it = rng.first; it != rng.second; ++it) {
  7093. const auto &value = it->second;
  7094. last_coding.clear();
  7095. split(value.data(), value.data() + value.size(), ',',
  7096. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7097. }
  7098. return case_ignore::equal(last_coding, "chunked");
  7099. }
  7100. inline bool has_conflicting_content_length(const Headers &headers) {
  7101. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7102. // Content-Length is framed ambiguously. The body readers here delimit it by
  7103. // the transfer coding and drop Content-Length, while an intermediary may do
  7104. // the reverse, so the two disagree on where the body ends and a reused
  7105. // connection is desynchronised (request/response smuggling). Content-Length:
  7106. // 0 is tolerated for compatibility with existing peers.
  7107. return has_header(headers, "Transfer-Encoding") &&
  7108. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7109. }
  7110. template <typename T, typename U>
  7111. bool prepare_content_receiver(T &x, int &status,
  7112. ContentReceiverWithProgress receiver,
  7113. bool decompress, size_t payload_max_length,
  7114. bool &exceed_payload_max_length, U callback) {
  7115. if (decompress) {
  7116. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7117. std::unique_ptr<decompressor> decompressor;
  7118. if (!encoding.empty()) {
  7119. // A coding we know about but were not built with is an error. An
  7120. // unrecognized coding (including "identity") is left alone and the
  7121. // payload is passed through as-is, since some servers misuse the header,
  7122. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7123. decompressor = detail::create_decompressor(encoding);
  7124. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7125. status = StatusCode::UnsupportedMediaType_415;
  7126. return false;
  7127. }
  7128. }
  7129. if (decompressor) {
  7130. if (decompressor->is_valid()) {
  7131. size_t decompressed_size = 0;
  7132. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7133. size_t off, size_t len) {
  7134. return decompressor->decompress(
  7135. buf, n, [&](const char *buf2, size_t n2) {
  7136. // Guard against zip-bomb: check
  7137. // decompressed size against limit.
  7138. if (payload_max_length > 0 &&
  7139. (decompressed_size >= payload_max_length ||
  7140. n2 > payload_max_length - decompressed_size)) {
  7141. exceed_payload_max_length = true;
  7142. return false;
  7143. }
  7144. decompressed_size += n2;
  7145. return receiver(buf2, n2, off, len);
  7146. });
  7147. };
  7148. return callback(std::move(out));
  7149. } else {
  7150. status = StatusCode::InternalServerError_500;
  7151. return false;
  7152. }
  7153. }
  7154. }
  7155. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7156. size_t len) {
  7157. return receiver(buf, n, off, len);
  7158. };
  7159. return callback(std::move(out));
  7160. }
  7161. template <typename T>
  7162. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7163. DownloadProgress progress,
  7164. ContentReceiverWithProgress receiver, bool decompress) {
  7165. bool exceed_payload_max_length = false;
  7166. return prepare_content_receiver(
  7167. x, status, std::move(receiver), decompress, payload_max_length,
  7168. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7169. auto ret = true;
  7170. // Note: exceed_payload_max_length may also be set by the decompressor
  7171. // wrapper in prepare_content_receiver when the decompressed payload
  7172. // size exceeds the limit.
  7173. if (is_chunked_transfer_encoding(x.headers)) {
  7174. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7175. if (result == ReadContentResult::Success) {
  7176. ret = true;
  7177. } else if (result == ReadContentResult::PayloadTooLarge) {
  7178. exceed_payload_max_length = true;
  7179. ret = false;
  7180. } else {
  7181. ret = false;
  7182. }
  7183. } else if (!has_header(x.headers, "Content-Length")) {
  7184. auto result =
  7185. read_content_without_length(strm, payload_max_length, out);
  7186. if (result == ReadContentResult::Success) {
  7187. ret = true;
  7188. } else if (result == ReadContentResult::PayloadTooLarge) {
  7189. exceed_payload_max_length = true;
  7190. ret = false;
  7191. } else {
  7192. ret = false;
  7193. }
  7194. } else {
  7195. auto is_invalid_value = false;
  7196. auto len = get_header_value_u64(x.headers, "Content-Length",
  7197. (std::numeric_limits<size_t>::max)(),
  7198. 0, is_invalid_value);
  7199. if (is_invalid_value) {
  7200. ret = false;
  7201. } else if (len > 0) {
  7202. auto result = read_content_with_length(
  7203. strm, len, std::move(progress), out, payload_max_length);
  7204. ret = (result == ReadContentResult::Success);
  7205. if (result == ReadContentResult::PayloadTooLarge) {
  7206. exceed_payload_max_length = true;
  7207. }
  7208. }
  7209. }
  7210. if (!ret) {
  7211. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7212. : StatusCode::BadRequest_400;
  7213. }
  7214. return ret;
  7215. });
  7216. }
  7217. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7218. const std::string &path) {
  7219. // Neither the method nor the request target may carry CR/LF, SP or other
  7220. // control octets; otherwise a value smuggled into either splits the request
  7221. // line and injects headers or a whole request.
  7222. if (!fields::is_token(method)) { return -1; }
  7223. if (!fields::is_request_target(path)) { return -1; }
  7224. std::string s = method;
  7225. s += ' ';
  7226. s += path;
  7227. s += " HTTP/1.1\r\n";
  7228. return strm.write(s.data(), s.size());
  7229. }
  7230. inline ssize_t write_response_line(Stream &strm, int status) {
  7231. std::string s = "HTTP/1.1 ";
  7232. s += std::to_string(status);
  7233. s += ' ';
  7234. s += httplib::status_message(status);
  7235. s += "\r\n";
  7236. return strm.write(s.data(), s.size());
  7237. }
  7238. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7239. ssize_t write_len = 0;
  7240. for (const auto &x : headers) {
  7241. // Skip fields with invalid names or values to prevent response splitting
  7242. // via CR/LF injection, matching set_header(). The client validates request
  7243. // headers up front in check_and_write_headers, but the server passes
  7244. // res.headers straight to this writer, and res.headers is a public field
  7245. // an application can populate directly with request-derived values.
  7246. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7247. std::string s;
  7248. s = x.first;
  7249. s += ": ";
  7250. s += x.second;
  7251. s += "\r\n";
  7252. auto len = strm.write(s.data(), s.size());
  7253. if (len < 0) { return len; }
  7254. write_len += len;
  7255. }
  7256. auto len = strm.write("\r\n");
  7257. if (len < 0) { return len; }
  7258. write_len += len;
  7259. return write_len;
  7260. }
  7261. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7262. size_t offset = 0;
  7263. while (offset < l) {
  7264. auto length = strm.write(d + offset, l - offset);
  7265. if (length < 0) { return false; }
  7266. offset += static_cast<size_t>(length);
  7267. }
  7268. return true;
  7269. }
  7270. template <typename T>
  7271. inline bool write_content_with_progress(Stream &strm,
  7272. const ContentProvider &content_provider,
  7273. size_t offset, size_t length,
  7274. T is_shutting_down,
  7275. const UploadProgress &upload_progress,
  7276. Error &error) {
  7277. size_t end_offset = offset + length;
  7278. size_t start_offset = offset;
  7279. auto ok = true;
  7280. auto finished = false;
  7281. DataSink data_sink;
  7282. data_sink.write = [&](const char *d, size_t l) -> bool {
  7283. if (ok) {
  7284. if (write_data(strm, d, l)) {
  7285. offset += l;
  7286. if (upload_progress && length > 0) {
  7287. size_t current_written = offset - start_offset;
  7288. if (!upload_progress(current_written, length)) {
  7289. ok = false;
  7290. return false;
  7291. }
  7292. }
  7293. } else {
  7294. ok = false;
  7295. }
  7296. }
  7297. return ok;
  7298. };
  7299. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7300. // The body is framed by `length`, so a provider that reports itself done
  7301. // early has truncated it. Record that and let the short-body check below
  7302. // fail the write, rather than calling the provider again forever.
  7303. data_sink.done = [&]() { finished = true; };
  7304. while (offset < end_offset && !finished && !is_shutting_down()) {
  7305. auto last_offset = offset;
  7306. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7307. error = Error::Write;
  7308. return false;
  7309. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7310. error = Error::Canceled;
  7311. return false;
  7312. } else if (!ok) {
  7313. error = Error::Write;
  7314. return false;
  7315. }
  7316. // A provider that reports success without writing anything and without
  7317. // reporting itself done gets handed the same offset and length again on
  7318. // the next pass, so it would spin here for as long as the peer stays
  7319. // connected. Treat making no progress as a short body, like done() early.
  7320. if (!finished && offset == last_offset) {
  7321. error = Error::Write;
  7322. return false;
  7323. }
  7324. }
  7325. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7326. error = Error::Write;
  7327. return false;
  7328. }
  7329. error = Error::Success;
  7330. return true;
  7331. }
  7332. template <typename T>
  7333. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7334. size_t offset, size_t length, T is_shutting_down,
  7335. Error &error) {
  7336. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7337. is_shutting_down, nullptr, error);
  7338. }
  7339. template <typename T>
  7340. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7341. size_t offset, size_t length,
  7342. const T &is_shutting_down) {
  7343. auto error = Error::Success;
  7344. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7345. error);
  7346. }
  7347. template <typename T>
  7348. inline bool
  7349. write_content_without_length(Stream &strm,
  7350. const ContentProvider &content_provider,
  7351. const T &is_shutting_down) {
  7352. size_t offset = 0;
  7353. auto data_available = true;
  7354. auto ok = true;
  7355. DataSink data_sink;
  7356. data_sink.write = [&](const char *d, size_t l) -> bool {
  7357. if (ok) {
  7358. offset += l;
  7359. if (!write_data(strm, d, l)) { ok = false; }
  7360. }
  7361. return ok;
  7362. };
  7363. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7364. data_sink.done = [&](void) { data_available = false; };
  7365. while (data_available && !is_shutting_down()) {
  7366. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7367. return false;
  7368. } else if (!content_provider(offset, 0, data_sink)) {
  7369. return false;
  7370. } else if (!ok) {
  7371. return false;
  7372. }
  7373. }
  7374. return !data_available; // true only if done() was called, false if shutting
  7375. // down
  7376. }
  7377. // Runs a known-length content provider to completion and compresses what it
  7378. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7379. // by an mmap hands the compressor a pointer straight into the mapping.
  7380. inline bool compress_content_provider(const ContentProvider &content_provider,
  7381. size_t length, compressor &cmp,
  7382. std::string &out) {
  7383. size_t offset = 0;
  7384. auto ok = true;
  7385. auto finished = false;
  7386. DataSink data_sink;
  7387. auto append = [&](const char *data, size_t data_len) {
  7388. out.append(data, data_len);
  7389. return true;
  7390. };
  7391. data_sink.write = [&](const char *d, size_t l) -> bool {
  7392. if (!ok) { return false; }
  7393. offset += l;
  7394. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7395. return ok;
  7396. };
  7397. // The body is framed by `length`, so a provider that reports itself done
  7398. // early has truncated it; the short-body check below turns that into a
  7399. // failure rather than calling the provider again forever.
  7400. data_sink.done = [&]() { finished = true; };
  7401. while (offset < length && !finished) {
  7402. auto prev_offset = offset;
  7403. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7404. return false;
  7405. }
  7406. // No Stream to block on here, so a provider that keeps returning true
  7407. // without writing would spin. Treat a pass that made no progress as a
  7408. // failure.
  7409. if (offset == prev_offset) { return false; }
  7410. }
  7411. if (offset != length) { return false; }
  7412. return cmp.compress(nullptr, 0, true, append);
  7413. }
  7414. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7415. // and the file flag, so recording them has to come after; keeping all of it
  7416. // here means a third file-serving path cannot get that order wrong.
  7417. inline void set_file_content_provider(Response &res,
  7418. const std::shared_ptr<mmap> &m,
  7419. const std::string &content_type,
  7420. EncodingType encoding) {
  7421. res.set_content_provider(
  7422. m->size(), content_type,
  7423. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7424. sink.write(m->data() + offset, length);
  7425. return true;
  7426. });
  7427. res.is_file_content_provider_ = true;
  7428. res.content_coding_ = encoding;
  7429. }
  7430. template <typename T, typename U>
  7431. inline bool
  7432. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7433. const T &is_shutting_down, U &compressor, Error &error) {
  7434. size_t offset = 0;
  7435. auto data_available = true;
  7436. auto ok = true;
  7437. DataSink data_sink;
  7438. data_sink.write = [&](const char *d, size_t l) -> bool {
  7439. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7440. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7441. // zero-length chunk is the terminator, so it must not be emitted here.
  7442. if (ok && l > 0) {
  7443. offset += l;
  7444. std::string payload;
  7445. if (compressor.compress(d, l, false,
  7446. [&](const char *data, size_t data_len) {
  7447. payload.append(data, data_len);
  7448. return true;
  7449. })) {
  7450. if (!payload.empty()) {
  7451. // Emit chunked response header and footer for each chunk
  7452. auto chunk =
  7453. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7454. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7455. }
  7456. } else {
  7457. ok = false;
  7458. }
  7459. }
  7460. return ok;
  7461. };
  7462. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7463. auto done_with_trailer = [&](const Headers *trailer) {
  7464. if (!ok) { return; }
  7465. data_available = false;
  7466. std::string payload;
  7467. if (!compressor.compress(nullptr, 0, true,
  7468. [&](const char *data, size_t data_len) {
  7469. payload.append(data, data_len);
  7470. return true;
  7471. })) {
  7472. ok = false;
  7473. return;
  7474. }
  7475. if (!payload.empty()) {
  7476. // Emit chunked response header and footer for each chunk
  7477. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7478. if (!write_data(strm, chunk.data(), chunk.size())) {
  7479. ok = false;
  7480. return;
  7481. }
  7482. }
  7483. constexpr const char done_marker[] = "0\r\n";
  7484. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7485. // Trailer
  7486. if (trailer) {
  7487. for (const auto &kv : *trailer) {
  7488. // Skip fields with invalid names or values to prevent response
  7489. // splitting via CR/LF injection, matching set_header().
  7490. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7491. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7492. if (!write_data(strm, field_line.data(), field_line.size())) {
  7493. ok = false;
  7494. }
  7495. }
  7496. }
  7497. constexpr const char crlf[] = "\r\n";
  7498. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7499. };
  7500. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7501. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7502. done_with_trailer(&trailer);
  7503. };
  7504. while (data_available && !is_shutting_down()) {
  7505. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7506. error = Error::Write;
  7507. return false;
  7508. } else if (!content_provider(offset, 0, data_sink)) {
  7509. error = Error::Canceled;
  7510. return false;
  7511. } else if (!ok) {
  7512. error = Error::Write;
  7513. return false;
  7514. }
  7515. }
  7516. if (data_available) { // exited due to is_shutting_down(), not done()
  7517. error = Error::Write;
  7518. return false;
  7519. }
  7520. error = Error::Success;
  7521. return true;
  7522. }
  7523. template <typename T, typename U>
  7524. inline bool write_content_chunked(Stream &strm,
  7525. const ContentProvider &content_provider,
  7526. const T &is_shutting_down, U &compressor) {
  7527. auto error = Error::Success;
  7528. return write_content_chunked(strm, content_provider, is_shutting_down,
  7529. compressor, error);
  7530. }
  7531. template <typename T>
  7532. inline bool redirect(T &cli, Request &req, Response &res,
  7533. const std::string &path, const std::string &location,
  7534. Error &error) {
  7535. Request new_req = req;
  7536. new_req.path = path;
  7537. new_req.redirect_count_ -= 1;
  7538. if (res.status == StatusCode::SeeOther_303 &&
  7539. (req.method != "GET" && req.method != "HEAD")) {
  7540. new_req.method = "GET";
  7541. new_req.body.clear();
  7542. new_req.headers.clear();
  7543. new_req.content_length_ = 0;
  7544. new_req.content_provider_ = nullptr;
  7545. new_req.is_chunked_content_provider_ = false;
  7546. }
  7547. Response new_res;
  7548. auto ret = cli.send(new_req, new_res, error);
  7549. if (ret) {
  7550. req = std::move(new_req);
  7551. res = std::move(new_res);
  7552. if (res.location.empty()) { res.location = location; }
  7553. }
  7554. return ret;
  7555. }
  7556. inline std::string params_to_query_str(const Params &params) {
  7557. std::string query;
  7558. for (auto it = params.begin(); it != params.end(); ++it) {
  7559. if (it != params.begin()) { query += '&'; }
  7560. query += encode_query_component(it->first);
  7561. query += '=';
  7562. query += encode_query_component(it->second);
  7563. }
  7564. return query;
  7565. }
  7566. // Splits one "key=value" span of a query string at its first '='. A span with
  7567. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7568. // "?flag" keeps its name.
  7569. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7570. std::string &val) {
  7571. divide(b, static_cast<std::size_t>(e - b), '=',
  7572. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7573. std::size_t rhs_size) {
  7574. key.assign(lhs_data, lhs_size);
  7575. val.assign(rhs_data, rhs_size);
  7576. });
  7577. }
  7578. inline void parse_query_text(const char *data, std::size_t size,
  7579. Params &params) {
  7580. std::set<std::string> cache;
  7581. split(data, data + size, '&', [&](const char *b, const char *e) {
  7582. std::string kv(b, e);
  7583. if (cache.find(kv) != cache.end()) { return; }
  7584. cache.insert(std::move(kv));
  7585. std::string key;
  7586. std::string val;
  7587. divide_query_pair(b, e, key, val);
  7588. if (!key.empty()) {
  7589. params.emplace(decode_query_component(key), decode_query_component(val));
  7590. }
  7591. });
  7592. }
  7593. inline void parse_query_text(const std::string &s, Params &params) {
  7594. parse_query_text(s.data(), s.size(), params);
  7595. }
  7596. // Normalize a query string by decoding and re-encoding each key/value pair
  7597. // while preserving the original parameter order. This avoids double-encoding
  7598. // and ensures consistent encoding. It works on the raw string rather than
  7599. // parsing into Params and re-serializing, because that round trip cannot
  7600. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7601. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7602. // duplicated pairs.
  7603. inline std::string normalize_query_string(const std::string &query) {
  7604. std::string result;
  7605. split(query.data(), query.data() + query.size(), '&',
  7606. [&](const char *b, const char *e) {
  7607. std::string key;
  7608. std::string val;
  7609. divide_query_pair(b, e, key, val);
  7610. if (!key.empty()) {
  7611. auto dec_key = decode_query_component(key);
  7612. auto dec_val = decode_query_component(val);
  7613. if (!result.empty()) { result += '&'; }
  7614. result += encode_query_component(dec_key);
  7615. if (!val.empty() || std::find(b, e, '=') != e) {
  7616. result += '=';
  7617. result += encode_query_component(dec_val);
  7618. }
  7619. }
  7620. });
  7621. return result;
  7622. }
  7623. // Build the request target that goes on the wire from a caller-supplied path.
  7624. // Shared by the buffered send path and the streaming API so that both put the
  7625. // same bytes in the request line for the same input.
  7626. inline std::string encode_request_target(const std::string &target,
  7627. bool path_encode) {
  7628. // `substr(0, npos)` yields the whole string, which is what the no-query
  7629. // case needs.
  7630. auto query_pos = target.find('?');
  7631. auto path_part = target.substr(0, query_pos);
  7632. std::string query_part;
  7633. if (query_pos != std::string::npos) {
  7634. query_part = target.substr(query_pos + 1);
  7635. }
  7636. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7637. if (!query_part.empty()) {
  7638. // When path encoding is disabled the caller has supplied an already-encoded
  7639. // target and expects the exact bytes to be sent on the wire, so skip
  7640. // normalization for the query too. Normalizing would decode-then-re-encode
  7641. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7642. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7643. if (path_encode) {
  7644. auto normalized = normalize_query_string(query_part);
  7645. if (!normalized.empty()) {
  7646. result += '?';
  7647. result += normalized;
  7648. }
  7649. } else {
  7650. result += '?';
  7651. result += query_part;
  7652. }
  7653. }
  7654. return result;
  7655. }
  7656. inline bool parse_multipart_boundary(const std::string &content_type,
  7657. std::string &boundary) {
  7658. std::map<std::string, std::string> params;
  7659. extract_media_type(content_type, &params);
  7660. auto it = params.find("boundary");
  7661. if (it == params.end()) { return false; }
  7662. boundary = it->second;
  7663. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7664. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7665. // bytes costs a nearly full comparison at nearly every position: the
  7666. // boundary's length multiplies the worst-case cost of scanning a body.
  7667. return !boundary.empty() && boundary.size() <= 70;
  7668. }
  7669. inline void parse_disposition_params(const std::string &s, Params &params) {
  7670. std::set<std::string> cache;
  7671. split_unquoted(s.data(), s.data() + s.size(), ';',
  7672. [&](const char *b, const char *e) {
  7673. std::string kv(b, e);
  7674. if (cache.find(kv) != cache.end()) { return; }
  7675. cache.insert(kv);
  7676. std::string key;
  7677. std::string val;
  7678. divide_param_pair(b, e, key, val);
  7679. if (!key.empty()) {
  7680. params.emplace(trim_double_quotes_copy(key),
  7681. trim_double_quotes_copy(val));
  7682. }
  7683. });
  7684. }
  7685. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7686. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7687. #else
  7688. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7689. #endif
  7690. auto is_valid = [](const std::string &str) {
  7691. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7692. };
  7693. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7694. const auto pos = static_cast<size_t>(6);
  7695. const auto len = static_cast<size_t>(s.size() - 6);
  7696. auto all_valid_ranges = true;
  7697. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7698. if (!all_valid_ranges) { return; }
  7699. const auto it = std::find(b, e, '-');
  7700. if (it == e) {
  7701. all_valid_ranges = false;
  7702. return;
  7703. }
  7704. const auto lhs = std::string(b, it);
  7705. const auto rhs = std::string(it + 1, e);
  7706. if (!is_valid(lhs) || !is_valid(rhs)) {
  7707. all_valid_ranges = false;
  7708. return;
  7709. }
  7710. ssize_t first = -1;
  7711. if (!lhs.empty()) {
  7712. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7713. // would turn the range into a suffix range.
  7714. auto res =
  7715. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7716. if (res.ec != std::errc{}) {
  7717. all_valid_ranges = false;
  7718. return;
  7719. }
  7720. }
  7721. ssize_t last = -1;
  7722. if (!rhs.empty()) {
  7723. // An overflowing last-byte-pos is past any content length, so keeping
  7724. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7725. ssize_t v;
  7726. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7727. if (res.ec == std::errc{}) { last = v; }
  7728. }
  7729. if ((first == -1 && last == -1) ||
  7730. (first != -1 && last != -1 && first > last)) {
  7731. all_valid_ranges = false;
  7732. return;
  7733. }
  7734. ranges.emplace_back(first, last);
  7735. });
  7736. return all_valid_ranges && !ranges.empty();
  7737. }
  7738. return false;
  7739. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7740. }
  7741. #else
  7742. } catch (...) { return false; }
  7743. #endif
  7744. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7745. inline std::string remove_quoted_strings(const std::string &s) {
  7746. std::string out;
  7747. auto in_quotes = false;
  7748. for (size_t i = 0; i < s.size(); i++) {
  7749. if (s[i] == '"') {
  7750. in_quotes = !in_quotes;
  7751. } else if (!in_quotes) {
  7752. out += s[i];
  7753. } else if (s[i] == '\\') {
  7754. i++;
  7755. }
  7756. }
  7757. return out;
  7758. }
  7759. inline bool parse_accept_header(const std::string &s,
  7760. std::vector<std::string> &content_types) {
  7761. // Parameter values are not used here, so a quoted-string is dropped rather
  7762. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7763. if (s.find('"') != std::string::npos) {
  7764. return parse_accept_header(remove_quoted_strings(s), content_types);
  7765. }
  7766. content_types.clear();
  7767. // Empty string is considered valid (no preference)
  7768. if (s.empty()) { return true; }
  7769. struct AcceptEntry {
  7770. std::string media_type;
  7771. double quality;
  7772. int order;
  7773. };
  7774. std::vector<AcceptEntry> entries;
  7775. int order = 0;
  7776. bool has_invalid_entry = false;
  7777. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7778. // has to parse and ignore empty list elements, so a leading, trailing or
  7779. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7780. // split() skips them, and the header length limit bounds how many a sender
  7781. // can send, so ignoring all of them cannot be used as a denial-of-service
  7782. // vector.
  7783. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7784. std::string entry(b, e);
  7785. entry = trim_copy(entry);
  7786. AcceptEntry accept_entry;
  7787. accept_entry.order = order++;
  7788. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7789. accept_entry.media_type, accept_entry.quality)) {
  7790. has_invalid_entry = true;
  7791. return;
  7792. }
  7793. // Remove additional parameters from media type
  7794. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7795. // Basic validation of media type format
  7796. if (accept_entry.media_type.empty()) {
  7797. has_invalid_entry = true;
  7798. return;
  7799. }
  7800. // Check for basic media type format (should contain '/' or be '*')
  7801. if (accept_entry.media_type != "*" &&
  7802. accept_entry.media_type.find('/') == std::string::npos) {
  7803. has_invalid_entry = true;
  7804. return;
  7805. }
  7806. entries.push_back(std::move(accept_entry));
  7807. });
  7808. // Return false if any invalid entry was found
  7809. if (has_invalid_entry) { return false; }
  7810. // Sort by quality (descending), then by original order (ascending)
  7811. std::sort(entries.begin(), entries.end(),
  7812. [](const AcceptEntry &a, const AcceptEntry &b) {
  7813. if (a.quality != b.quality) {
  7814. return a.quality > b.quality; // Higher quality first
  7815. }
  7816. return a.order < b.order; // Earlier order first for same quality
  7817. });
  7818. // Extract sorted media types
  7819. content_types.reserve(entries.size());
  7820. for (auto &entry : entries) {
  7821. content_types.push_back(std::move(entry.media_type));
  7822. }
  7823. return true;
  7824. }
  7825. class FormDataParser {
  7826. public:
  7827. FormDataParser() = default;
  7828. void set_boundary(std::string &&boundary) {
  7829. boundary_ = std::move(boundary);
  7830. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7831. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7832. }
  7833. bool is_valid() const { return is_valid_; }
  7834. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7835. const ContentReceiver &content_callback) {
  7836. // Once the close delimiter has been seen the rest of the body is epilogue
  7837. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7838. // spread across reads is not copied in only to be erased right away.
  7839. if (state_ == 5) { return true; }
  7840. buf_append(buf, n);
  7841. while (buf_size() > 0) {
  7842. switch (state_) {
  7843. case 0: { // Initial boundary
  7844. auto pos = buf_find(dash_boundary_crlf_);
  7845. if (pos == buf_size()) {
  7846. // Not found yet: keep only a possible partial boundary at the tail so
  7847. // that a body which never contains the boundary cannot grow the
  7848. // buffer (and get rescanned from the start) without bound.
  7849. auto keep = dash_boundary_crlf_.size() - 1;
  7850. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7851. return true;
  7852. }
  7853. buf_erase(pos + dash_boundary_crlf_.size());
  7854. state_ = 1;
  7855. break;
  7856. }
  7857. case 1: { // New entry
  7858. clear_file_info();
  7859. state_ = 2;
  7860. break;
  7861. }
  7862. case 2: { // Headers
  7863. auto pos = buf_find(crlf_);
  7864. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7865. while (pos < buf_size()) {
  7866. // Empty line
  7867. if (pos == 0) {
  7868. if (!header_callback(file_)) {
  7869. is_valid_ = false;
  7870. return false;
  7871. }
  7872. buf_erase(crlf_.size());
  7873. state_ = 3;
  7874. break;
  7875. }
  7876. // Check header count limit
  7877. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7878. is_valid_ = false;
  7879. return false;
  7880. }
  7881. header_count_++;
  7882. const auto header = buf_head(pos);
  7883. if (!parse_header(header.data(), header.data() + header.size(),
  7884. [&](const std::string &, const std::string &) {})) {
  7885. is_valid_ = false;
  7886. return false;
  7887. }
  7888. // Parse and emplace space trimmed headers into a map
  7889. if (!parse_header(
  7890. header.data(), header.data() + header.size(),
  7891. [&](const std::string &key, const std::string &val) {
  7892. file_.headers.emplace(key, val);
  7893. })) {
  7894. is_valid_ = false;
  7895. return false;
  7896. }
  7897. constexpr const char header_content_type[] = "Content-Type:";
  7898. if (start_with_case_ignore(header, header_content_type)) {
  7899. file_.content_type =
  7900. trim_copy(header.substr(str_len(header_content_type)));
  7901. } else {
  7902. std::string disposition_params;
  7903. if (parse_content_disposition(header, disposition_params)) {
  7904. Params params;
  7905. parse_disposition_params(disposition_params, params);
  7906. auto it = params.find("name");
  7907. if (it != params.end()) {
  7908. file_.name = it->second;
  7909. } else {
  7910. is_valid_ = false;
  7911. return false;
  7912. }
  7913. it = params.find("filename");
  7914. if (it != params.end()) { file_.filename = it->second; }
  7915. it = params.find("filename*");
  7916. if (it != params.end()) {
  7917. // RFC 5987: only UTF-8 encoding is allowed
  7918. const auto &val = it->second;
  7919. constexpr const char utf8_prefix[] = "UTF-8''";
  7920. constexpr size_t prefix_len = str_len(utf8_prefix);
  7921. if (val.size() > prefix_len &&
  7922. start_with_case_ignore(val, utf8_prefix)) {
  7923. file_.filename = decode_path_component(
  7924. val.substr(prefix_len)); // override...
  7925. } else {
  7926. is_valid_ = false;
  7927. return false;
  7928. }
  7929. }
  7930. }
  7931. }
  7932. buf_erase(pos + crlf_.size());
  7933. pos = buf_find(crlf_);
  7934. }
  7935. if (state_ != 3) { return true; }
  7936. break;
  7937. }
  7938. case 3: { // Body
  7939. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7940. auto pos = buf_find(crlf_dash_boundary_);
  7941. if (pos < buf_size()) {
  7942. if (!content_callback(buf_data(), pos)) {
  7943. is_valid_ = false;
  7944. return false;
  7945. }
  7946. buf_erase(pos + crlf_dash_boundary_.size());
  7947. state_ = 4;
  7948. } else {
  7949. auto len = buf_size() - crlf_dash_boundary_.size();
  7950. if (len > 0) {
  7951. if (!content_callback(buf_data(), len)) {
  7952. is_valid_ = false;
  7953. return false;
  7954. }
  7955. buf_erase(len);
  7956. }
  7957. return true;
  7958. }
  7959. break;
  7960. }
  7961. case 4: { // Boundary
  7962. if (crlf_.size() > buf_size()) { return true; }
  7963. if (buf_start_with(crlf_)) {
  7964. buf_erase(crlf_.size());
  7965. state_ = 1;
  7966. } else if (buf_start_with(dash_)) {
  7967. buf_erase(dash_.size());
  7968. is_valid_ = true;
  7969. state_ = 5;
  7970. } else {
  7971. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7972. // accepted after a boundary; RFC 2046 allows transport-padding in
  7973. // between, but this parser has never supported it. Either way the
  7974. // body is already destined to be rejected, so fail now instead of
  7975. // buffering the rest of it. Both are two bytes, so the check above
  7976. // already guarantees enough buffered data to decide.
  7977. is_valid_ = false;
  7978. return false;
  7979. }
  7980. break;
  7981. }
  7982. case 5: { // Epilogue
  7983. buf_erase(buf_size());
  7984. break;
  7985. }
  7986. }
  7987. }
  7988. return true;
  7989. }
  7990. private:
  7991. void clear_file_info() {
  7992. file_.name.clear();
  7993. file_.filename.clear();
  7994. file_.content_type.clear();
  7995. file_.headers.clear();
  7996. header_count_ = 0;
  7997. }
  7998. bool start_with_case_ignore(const std::string &a, const char *b,
  7999. size_t offset = 0) const {
  8000. const auto b_len = strlen(b);
  8001. if (a.size() < offset + b_len) { return false; }
  8002. for (size_t i = 0; i < b_len; i++) {
  8003. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8004. return false;
  8005. }
  8006. }
  8007. return true;
  8008. }
  8009. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8010. // Returns true if header matches, with the params portion in `params_out`.
  8011. bool parse_content_disposition(const std::string &header,
  8012. std::string &params_out) const {
  8013. constexpr const char prefix[] = "Content-Disposition:";
  8014. constexpr size_t prefix_len = str_len(prefix);
  8015. if (!start_with_case_ignore(header, prefix)) { return false; }
  8016. // Skip whitespace after "Content-Disposition:"
  8017. auto pos = prefix_len;
  8018. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8019. pos++;
  8020. }
  8021. // Match "form-data;" (case-insensitive)
  8022. constexpr const char form_data[] = "form-data;";
  8023. constexpr size_t form_data_len = str_len(form_data);
  8024. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8025. pos += form_data_len;
  8026. // Skip whitespace after "form-data;"
  8027. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8028. pos++;
  8029. }
  8030. params_out = header.substr(pos);
  8031. return true;
  8032. }
  8033. const std::string dash_ = "--";
  8034. const std::string crlf_ = "\r\n";
  8035. std::string boundary_;
  8036. std::string dash_boundary_crlf_;
  8037. std::string crlf_dash_boundary_;
  8038. size_t state_ = 0;
  8039. bool is_valid_ = false;
  8040. FormData file_;
  8041. size_t header_count_ = 0;
  8042. // Buffer
  8043. bool start_with(const std::string &a, size_t spos, size_t epos,
  8044. const std::string &b) const {
  8045. if (epos - spos < b.size()) { return false; }
  8046. for (size_t i = 0; i < b.size(); i++) {
  8047. if (a[i + spos] != b[i]) { return false; }
  8048. }
  8049. return true;
  8050. }
  8051. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8052. const char *buf_data() const { return &buf_[buf_spos_]; }
  8053. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8054. bool buf_start_with(const std::string &s) const {
  8055. return start_with(buf_, buf_spos_, buf_epos_, s);
  8056. }
  8057. size_t buf_find(const std::string &s) const {
  8058. auto c = s.front();
  8059. size_t off = buf_spos_;
  8060. while (off < buf_epos_) {
  8061. auto pos = off;
  8062. while (true) {
  8063. if (pos == buf_epos_) { return buf_size(); }
  8064. if (buf_[pos] == c) { break; }
  8065. pos++;
  8066. }
  8067. auto remaining_size = buf_epos_ - pos;
  8068. if (s.size() > remaining_size) { return buf_size(); }
  8069. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8070. off = pos + 1;
  8071. }
  8072. return buf_size();
  8073. }
  8074. void buf_append(const char *data, size_t n) {
  8075. auto remaining_size = buf_size();
  8076. if (remaining_size > 0 && buf_spos_ > 0) {
  8077. for (size_t i = 0; i < remaining_size; i++) {
  8078. buf_[i] = buf_[buf_spos_ + i];
  8079. }
  8080. }
  8081. buf_spos_ = 0;
  8082. buf_epos_ = remaining_size;
  8083. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8084. for (size_t i = 0; i < n; i++) {
  8085. buf_[buf_epos_ + i] = data[i];
  8086. }
  8087. buf_epos_ += n;
  8088. }
  8089. void buf_erase(size_t size) { buf_spos_ += size; }
  8090. std::string buf_;
  8091. size_t buf_spos_ = 0;
  8092. size_t buf_epos_ = 0;
  8093. };
  8094. inline std::string random_string(size_t length) {
  8095. constexpr const char data[] =
  8096. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8097. thread_local auto engine([]() {
  8098. // std::random_device might actually be deterministic on some
  8099. // platforms, but due to lack of support in the c++ standard library,
  8100. // doing better requires either some ugly hacks or breaking portability.
  8101. std::random_device seed_gen;
  8102. // Request 128 bits of entropy for initialization
  8103. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8104. return std::mt19937(seed_sequence);
  8105. }());
  8106. std::string result;
  8107. for (size_t i = 0; i < length; i++) {
  8108. result += data[engine() % (sizeof(data) - 1)];
  8109. }
  8110. return result;
  8111. }
  8112. inline std::string make_multipart_data_boundary() {
  8113. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8114. }
  8115. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8116. auto valid = true;
  8117. for (size_t i = 0; i < boundary.size(); i++) {
  8118. auto c = boundary[i];
  8119. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8120. valid = false;
  8121. break;
  8122. }
  8123. }
  8124. return valid;
  8125. }
  8126. // Escape a multipart field name/filename following the WHATWG HTML standard
  8127. // ("escape a multipart form-data name"), which is what browsers send:
  8128. // '"' -> %22, CR -> %0D, LF -> %0A
  8129. // With escape_quote = false, only CR and LF are escaped; this is for header
  8130. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8131. inline std::string escape_multipart_field(const std::string &s,
  8132. bool escape_quote = true) {
  8133. std::string result;
  8134. result.reserve(s.size());
  8135. for (auto c : s) {
  8136. switch (c) {
  8137. case '"':
  8138. if (escape_quote) {
  8139. result += "%22";
  8140. } else {
  8141. result += c;
  8142. }
  8143. break;
  8144. case '\r': result += "%0D"; break;
  8145. case '\n': result += "%0A"; break;
  8146. default: result += c; break;
  8147. }
  8148. }
  8149. return result;
  8150. }
  8151. template <typename T>
  8152. inline std::string
  8153. serialize_multipart_formdata_item_begin(const T &item,
  8154. const std::string &boundary) {
  8155. std::string body = "--" + boundary + "\r\n";
  8156. body += "Content-Disposition: form-data; name=\"" +
  8157. escape_multipart_field(item.name) + "\"";
  8158. if (!item.filename.empty()) {
  8159. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8160. }
  8161. body += "\r\n";
  8162. if (!item.content_type.empty()) {
  8163. body +=
  8164. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8165. "\r\n";
  8166. }
  8167. body += "\r\n";
  8168. return body;
  8169. }
  8170. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8171. inline std::string
  8172. serialize_multipart_formdata_finish(const std::string &boundary) {
  8173. return "--" + boundary + "--\r\n";
  8174. }
  8175. inline std::string
  8176. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8177. return "multipart/form-data; boundary=" + boundary;
  8178. }
  8179. inline std::string
  8180. serialize_multipart_formdata(const UploadFormDataItems &items,
  8181. const std::string &boundary, bool finish = true) {
  8182. std::string body;
  8183. for (const auto &item : items) {
  8184. body += serialize_multipart_formdata_item_begin(item, boundary);
  8185. body += item.content + serialize_multipart_formdata_item_end();
  8186. }
  8187. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8188. return body;
  8189. }
  8190. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8191. const std::string &boundary) {
  8192. size_t total = 0;
  8193. for (const auto &item : items) {
  8194. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8195. total += item.content.size();
  8196. total += serialize_multipart_formdata_item_end().size();
  8197. }
  8198. total += serialize_multipart_formdata_finish(boundary).size();
  8199. return total;
  8200. }
  8201. struct MultipartSegment {
  8202. const char *data;
  8203. size_t size;
  8204. };
  8205. // NOTE: items must outlive the returned ContentProvider
  8206. // (safe for synchronous use inside Post/Put/Patch)
  8207. inline ContentProvider
  8208. make_multipart_content_provider(const UploadFormDataItems &items,
  8209. const std::string &boundary) {
  8210. // Own the per-item header strings and the finish string
  8211. std::vector<std::string> owned;
  8212. owned.reserve(items.size() + 1);
  8213. for (const auto &item : items)
  8214. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8215. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8216. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8217. std::vector<MultipartSegment> segs;
  8218. segs.reserve(items.size() * 3 + 1);
  8219. static const char crlf[] = "\r\n";
  8220. for (size_t i = 0; i < items.size(); i++) {
  8221. segs.push_back({owned[i].data(), owned[i].size()});
  8222. segs.push_back({items[i].content.data(), items[i].content.size()});
  8223. segs.push_back({crlf, 2});
  8224. }
  8225. segs.push_back({owned.back().data(), owned.back().size()});
  8226. struct MultipartState {
  8227. std::vector<std::string> owned;
  8228. std::vector<MultipartSegment> segs;
  8229. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8230. };
  8231. auto state = std::make_shared<MultipartState>();
  8232. state->owned = std::move(owned);
  8233. // `segs` holds raw pointers into owned strings; std::string move preserves
  8234. // the data pointer, so these pointers remain valid after the move above.
  8235. state->segs = std::move(segs);
  8236. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8237. // Buffer multiple small segments into fewer, larger writes to avoid
  8238. // excessive TCP packets when there are many form data items (#2410)
  8239. auto &buf = state->buf;
  8240. auto buf_size = buf.size();
  8241. size_t buf_len = 0;
  8242. size_t remaining = length;
  8243. // Find the first segment containing 'offset'
  8244. size_t pos = 0;
  8245. size_t seg_idx = 0;
  8246. for (; seg_idx < state->segs.size(); seg_idx++) {
  8247. const auto &seg = state->segs[seg_idx];
  8248. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8249. pos += seg.size;
  8250. }
  8251. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8252. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8253. const auto &seg = state->segs[seg_idx];
  8254. size_t available = seg.size - seg_offset;
  8255. size_t to_copy = (std::min)(available, remaining);
  8256. const char *src = seg.data + seg_offset;
  8257. seg_offset = 0; // only the first segment has a non-zero offset
  8258. while (to_copy > 0) {
  8259. size_t space = buf_size - buf_len;
  8260. size_t chunk = (std::min)(to_copy, space);
  8261. std::memcpy(buf.data() + buf_len, src, chunk);
  8262. buf_len += chunk;
  8263. src += chunk;
  8264. to_copy -= chunk;
  8265. remaining -= chunk;
  8266. if (buf_len == buf_size) {
  8267. if (!sink.write(buf.data(), buf_len)) { return false; }
  8268. buf_len = 0;
  8269. }
  8270. }
  8271. }
  8272. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8273. return true;
  8274. };
  8275. }
  8276. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8277. if (ranges.size() <= 1) return;
  8278. // Sort ranges by start position
  8279. std::sort(ranges.begin(), ranges.end(),
  8280. [](const Range &a, const Range &b) { return a.first < b.first; });
  8281. Ranges coalesced;
  8282. coalesced.reserve(ranges.size());
  8283. for (auto &r : ranges) {
  8284. auto first_pos = r.first;
  8285. auto last_pos = r.second;
  8286. // Handle special cases like in range_error
  8287. if (first_pos == -1 && last_pos == -1) {
  8288. first_pos = 0;
  8289. last_pos = static_cast<ssize_t>(content_length);
  8290. }
  8291. if (first_pos == -1) {
  8292. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8293. last_pos = static_cast<ssize_t>(content_length) - 1;
  8294. }
  8295. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8296. last_pos = static_cast<ssize_t>(content_length) - 1;
  8297. }
  8298. // Skip invalid ranges
  8299. if (!(0 <= first_pos && first_pos <= last_pos &&
  8300. last_pos < static_cast<ssize_t>(content_length))) {
  8301. continue;
  8302. }
  8303. // Coalesce with previous range if overlapping or adjacent (but not
  8304. // identical)
  8305. if (!coalesced.empty()) {
  8306. auto &prev = coalesced.back();
  8307. // Check if current range overlaps or is adjacent to previous range
  8308. // but don't coalesce identical ranges (allow duplicates)
  8309. if (first_pos <= prev.second + 1 &&
  8310. !(first_pos == prev.first && last_pos == prev.second)) {
  8311. // Extend the previous range
  8312. prev.second = (std::max)(prev.second, last_pos);
  8313. continue;
  8314. }
  8315. }
  8316. // Add new range
  8317. coalesced.emplace_back(first_pos, last_pos);
  8318. }
  8319. ranges = std::move(coalesced);
  8320. }
  8321. inline bool range_error(Request &req, Response &res) {
  8322. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8323. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8324. req.ranges.clear();
  8325. if (res.status == StatusCode::PartialContent_206) {
  8326. res.status = StatusCode::OK_200;
  8327. }
  8328. return false;
  8329. }
  8330. ssize_t content_len = static_cast<ssize_t>(
  8331. res.content_length_ ? res.content_length_ : res.body.size());
  8332. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8333. size_t overwrapping_count = 0;
  8334. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8335. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8336. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8337. // Too many ranges
  8338. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8339. for (auto &r : req.ranges) {
  8340. auto &first_pos = r.first;
  8341. auto &last_pos = r.second;
  8342. if (first_pos == -1 && last_pos == -1) {
  8343. first_pos = 0;
  8344. last_pos = content_len;
  8345. }
  8346. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8347. // selects the entire representation.
  8348. if (first_pos == -1) {
  8349. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8350. last_pos = content_len - 1;
  8351. }
  8352. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8353. // A client can limit the number of bytes requested without knowing the
  8354. // size of the selected representation. If the last-pos value is absent,
  8355. // or if the value is greater than or equal to the current length of the
  8356. // representation data, the byte range is interpreted as the remainder of
  8357. // the representation (i.e., the server replaces the value of last-pos
  8358. // with a value that is one less than the current length of the selected
  8359. // representation).
  8360. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8361. if (last_pos == -1 || last_pos >= content_len) {
  8362. last_pos = content_len - 1;
  8363. }
  8364. // Range must be within content length
  8365. if (!(0 <= first_pos && first_pos <= last_pos &&
  8366. last_pos <= content_len - 1)) {
  8367. return true;
  8368. }
  8369. // Request must not have more than two overlapping ranges
  8370. for (const auto &processed_range : processed_ranges) {
  8371. if (!(last_pos < processed_range.first ||
  8372. first_pos > processed_range.second)) {
  8373. overwrapping_count++;
  8374. if (overwrapping_count > 2) { return true; }
  8375. break; // Only count once per range
  8376. }
  8377. }
  8378. processed_ranges.emplace_back(first_pos, last_pos);
  8379. }
  8380. // After validation, coalesce overlapping ranges as per RFC 9110
  8381. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8382. }
  8383. return false;
  8384. }
  8385. inline std::pair<size_t, size_t>
  8386. get_range_offset_and_length(Range r, size_t content_length) {
  8387. assert(r.first != -1 && r.second != -1);
  8388. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8389. assert(r.first <= r.second &&
  8390. r.second < static_cast<ssize_t>(content_length));
  8391. (void)(content_length);
  8392. return std::make_pair(static_cast<size_t>(r.first),
  8393. static_cast<size_t>(r.second - r.first) + 1);
  8394. }
  8395. inline std::string make_content_range_header_field(
  8396. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8397. auto st = offset_and_length.first;
  8398. auto ed = st + offset_and_length.second - 1;
  8399. std::string field = "bytes ";
  8400. field += std::to_string(st);
  8401. field += '-';
  8402. field += std::to_string(ed);
  8403. field += '/';
  8404. field += std::to_string(content_length);
  8405. return field;
  8406. }
  8407. template <typename SToken, typename CToken, typename Content>
  8408. bool process_multipart_ranges_data(const Request &req,
  8409. const std::string &boundary,
  8410. const std::string &content_type,
  8411. size_t content_length, SToken stoken,
  8412. CToken ctoken, Content content) {
  8413. for (size_t i = 0; i < req.ranges.size(); i++) {
  8414. ctoken("--");
  8415. stoken(boundary);
  8416. ctoken("\r\n");
  8417. if (!content_type.empty()) {
  8418. ctoken("Content-Type: ");
  8419. stoken(content_type);
  8420. ctoken("\r\n");
  8421. }
  8422. auto offset_and_length =
  8423. get_range_offset_and_length(req.ranges[i], content_length);
  8424. ctoken("Content-Range: ");
  8425. stoken(make_content_range_header_field(offset_and_length, content_length));
  8426. ctoken("\r\n");
  8427. ctoken("\r\n");
  8428. if (!content(offset_and_length.first, offset_and_length.second)) {
  8429. return false;
  8430. }
  8431. ctoken("\r\n");
  8432. }
  8433. ctoken("--");
  8434. stoken(boundary);
  8435. ctoken("--");
  8436. return true;
  8437. }
  8438. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8439. const std::string &boundary,
  8440. const std::string &content_type,
  8441. size_t content_length,
  8442. std::string &data) {
  8443. process_multipart_ranges_data(
  8444. req, boundary, content_type, content_length,
  8445. [&](const std::string &token) { data += token; },
  8446. [&](const std::string &token) { data += token; },
  8447. [&](size_t offset, size_t length) {
  8448. assert(offset + length <= content_length);
  8449. data += res.body.substr(offset, length);
  8450. return true;
  8451. });
  8452. }
  8453. inline size_t get_multipart_ranges_data_length(const Request &req,
  8454. const std::string &boundary,
  8455. const std::string &content_type,
  8456. size_t content_length) {
  8457. size_t data_length = 0;
  8458. process_multipart_ranges_data(
  8459. req, boundary, content_type, content_length,
  8460. [&](const std::string &token) { data_length += token.size(); },
  8461. [&](const std::string &token) { data_length += token.size(); },
  8462. [&](size_t /*offset*/, size_t length) {
  8463. data_length += length;
  8464. return true;
  8465. });
  8466. return data_length;
  8467. }
  8468. template <typename T>
  8469. inline bool
  8470. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8471. const std::string &boundary,
  8472. const std::string &content_type,
  8473. size_t content_length, const T &is_shutting_down) {
  8474. return process_multipart_ranges_data(
  8475. req, boundary, content_type, content_length,
  8476. [&](const std::string &token) { strm.write(token); },
  8477. [&](const std::string &token) { strm.write(token); },
  8478. [&](size_t offset, size_t length) {
  8479. return write_content(strm, res.content_provider_, offset, length,
  8480. is_shutting_down);
  8481. });
  8482. }
  8483. inline bool has_framed_body(const Request &req) {
  8484. return is_chunked_transfer_encoding(req.headers) ||
  8485. req.get_header_value_u64("Content-Length") > 0;
  8486. }
  8487. inline bool is_connection_persistent(const Request &req) {
  8488. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8489. if (req.version == "HTTP/1.0" &&
  8490. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8491. return false;
  8492. }
  8493. return true;
  8494. }
  8495. inline bool expect_content(const Request &req) {
  8496. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8497. req.method == "DELETE") {
  8498. return true;
  8499. }
  8500. return has_framed_body(req);
  8501. }
  8502. #ifdef _WIN32
  8503. class WSInit {
  8504. public:
  8505. WSInit() {
  8506. WSADATA wsaData;
  8507. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8508. }
  8509. ~WSInit() {
  8510. if (is_valid_) WSACleanup();
  8511. }
  8512. bool is_valid_ = false;
  8513. };
  8514. static WSInit wsinit_;
  8515. #endif
  8516. // RFC 9110 Section 11.6.1 defines a challenge list as
  8517. // WWW-Authenticate = #challenge
  8518. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8519. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8520. // so a server may offer several schemes, each with its own comma-separated
  8521. // auth-param list, in either order and either as separate field lines or
  8522. // packed into one. Splitting on every comma would break apart a challenge's
  8523. // own param list; splitting only on the first space would miss a Digest
  8524. // challenge that isn't first. Split on commas that aren't inside a
  8525. // quoted-string instead, then track which scheme each resulting segment
  8526. // belongs to: a segment whose text before "=" contains whitespace (or that
  8527. // has no "=" at all) starts a new challenge named by its leading token.
  8528. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8529. std::vector<std::string> segments;
  8530. size_t start = 0;
  8531. auto in_quotes = false;
  8532. for (size_t i = 0; i < s.size(); i++) {
  8533. auto c = s[i];
  8534. if (in_quotes) {
  8535. if (c == '\\' && i + 1 < s.size()) {
  8536. i++;
  8537. } else if (c == '"') {
  8538. in_quotes = false;
  8539. }
  8540. } else if (c == '"') {
  8541. in_quotes = true;
  8542. } else if (c == ',') {
  8543. segments.push_back(s.substr(start, i - start));
  8544. start = i + 1;
  8545. }
  8546. }
  8547. segments.push_back(s.substr(start));
  8548. return segments;
  8549. }
  8550. inline std::string unescape_quoted_pairs(const std::string &s) {
  8551. std::string out;
  8552. out.reserve(s.size());
  8553. for (size_t i = 0; i < s.size(); i++) {
  8554. if (s[i] == '\\' && i + 1 < s.size()) {
  8555. out += s[++i];
  8556. } else {
  8557. out += s[i];
  8558. }
  8559. }
  8560. return out;
  8561. }
  8562. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8563. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8564. // quoted-pair, so the recipient recovers the original value.
  8565. inline std::string escape_quoted_pairs(const std::string &s) {
  8566. std::string out;
  8567. out.reserve(s.size());
  8568. for (auto c : s) {
  8569. if (c == '\\' || c == '"') { out += '\\'; }
  8570. out += c;
  8571. }
  8572. return out;
  8573. }
  8574. inline bool parse_www_authenticate(const Response &res,
  8575. std::map<std::string, std::string> &auth,
  8576. bool is_proxy) {
  8577. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8578. auto combined = get_combined_header_value(res.headers, auth_key);
  8579. if (combined.empty()) { return false; }
  8580. auto found_digest = false;
  8581. auto in_digest_challenge = false;
  8582. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8583. auto segment = trim_copy(raw_segment);
  8584. if (segment.empty()) { continue; }
  8585. auto eq_pos = segment.find('=');
  8586. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8587. // for the first segment of a challenge, "<scheme> <key>") must be
  8588. // trimmed before its boundaries are inspected.
  8589. auto key_part = trim_copy(
  8590. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8591. auto space_pos = key_part.find_last_of(" \t");
  8592. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8593. // "<scheme>[ <key>]" starts a new challenge.
  8594. auto scheme_end =
  8595. space_pos == std::string::npos ? key_part.size() : space_pos;
  8596. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8597. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8598. // from one challenge is never paired with another's algorithm.
  8599. in_digest_challenge =
  8600. !found_digest &&
  8601. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8602. if (in_digest_challenge) { found_digest = true; }
  8603. if (space_pos == std::string::npos) {
  8604. // Bare scheme (or a token68), no auth-param on this segment.
  8605. continue;
  8606. }
  8607. key_part = key_part.substr(space_pos + 1);
  8608. }
  8609. if (!in_digest_challenge) { continue; }
  8610. auto val = trim_copy(segment.substr(eq_pos + 1));
  8611. auto unquoted = trim_double_quotes_copy(val);
  8612. if (unquoted.size() != val.size()) {
  8613. unquoted = unescape_quoted_pairs(unquoted);
  8614. }
  8615. auth[std::move(key_part)] = std::move(unquoted);
  8616. }
  8617. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8618. // make_digest_authentication_header() dereferences both unconditionally, so
  8619. // a challenge missing either can't produce a usable Authorization header.
  8620. // Treat it the same as no Digest challenge at all.
  8621. return found_digest && auth.find("realm") != auth.end() &&
  8622. auth.find("nonce") != auth.end();
  8623. }
  8624. class ContentProviderAdapter {
  8625. public:
  8626. explicit ContentProviderAdapter(
  8627. ContentProviderWithoutLength &&content_provider)
  8628. : content_provider_(std::move(content_provider)) {}
  8629. bool operator()(size_t offset, size_t, DataSink &sink) {
  8630. return content_provider_(offset, sink);
  8631. }
  8632. private:
  8633. ContentProviderWithoutLength content_provider_;
  8634. };
  8635. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8636. namespace fields {
  8637. inline bool is_token_char(char c) {
  8638. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8639. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8640. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8641. }
  8642. inline bool is_token(const std::string &s) {
  8643. if (s.empty()) { return false; }
  8644. for (auto c : s) {
  8645. if (!is_token_char(c)) { return false; }
  8646. }
  8647. return true;
  8648. }
  8649. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8650. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8651. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8652. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8653. inline bool is_field_content(const std::string &s) {
  8654. if (s.empty()) { return true; }
  8655. if (s.size() == 1) {
  8656. return is_field_vchar(s[0]);
  8657. } else if (s.size() == 2) {
  8658. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8659. } else {
  8660. size_t i = 0;
  8661. if (!is_field_vchar(s[i])) { return false; }
  8662. i++;
  8663. while (i < s.size() - 1) {
  8664. auto c = s[i++];
  8665. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8666. } else {
  8667. return false;
  8668. }
  8669. }
  8670. return is_field_vchar(s[i]);
  8671. }
  8672. }
  8673. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8674. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8675. return is_field_name(name) && is_field_value(value);
  8676. }
  8677. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8678. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8679. inline bool is_request_target(const std::string &s) {
  8680. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8681. }
  8682. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8683. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8684. inline bool is_host(const std::string &s) {
  8685. return std::all_of(s.begin(), s.end(), [](char c) {
  8686. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8687. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8688. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8689. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8690. });
  8691. }
  8692. } // namespace fields
  8693. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8694. WebSocketUpgradeResponse &upgrade) {
  8695. // Generate random Sec-WebSocket-Key
  8696. thread_local std::mt19937 rng(std::random_device{}());
  8697. std::string key_bytes(16, '\0');
  8698. for (size_t i = 0; i < 16; i += 4) {
  8699. auto r = rng();
  8700. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8701. }
  8702. auto client_key = base64_encode(key_bytes);
  8703. req.headers.erase("Upgrade");
  8704. req.headers.erase("Connection");
  8705. req.headers.erase("Sec-WebSocket-Key");
  8706. req.headers.erase("Sec-WebSocket-Version");
  8707. req.headers.emplace("Upgrade", "websocket");
  8708. req.headers.emplace("Connection", "Upgrade");
  8709. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8710. req.headers.emplace("Sec-WebSocket-Version", "13");
  8711. // Build the request in memory first, like ClientImpl::write_request does.
  8712. // Writing straight to the socket would leak a request line onto the wire
  8713. // before check_and_write_headers gets a chance to reject an invalid header,
  8714. // and would emit one small write per header.
  8715. BufferStream bstrm;
  8716. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8717. upgrade.error = Error::Write;
  8718. return false;
  8719. }
  8720. auto error = Error::Success;
  8721. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8722. upgrade.error = error;
  8723. return false;
  8724. }
  8725. const auto &data = bstrm.get_buffer();
  8726. if (!write_data(strm, data.data(), data.size())) {
  8727. upgrade.error = Error::Write;
  8728. return false;
  8729. }
  8730. // Verify 101 response and Sec-WebSocket-Accept header
  8731. auto expected_accept = websocket_accept_key(client_key);
  8732. auto offered_subprotocols =
  8733. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8734. return read_websocket_upgrade_response(strm, expected_accept,
  8735. offered_subprotocols, upgrade);
  8736. }
  8737. inline bool is_ip_address(const std::string &host) {
  8738. struct in_addr addr4;
  8739. struct in6_addr addr6;
  8740. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8741. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8742. }
  8743. // Resolve where a client should connect for `host`, honoring a user-supplied
  8744. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8745. // supplying the Host header and SNI; only the connection target changes.
  8746. //
  8747. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8748. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8749. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8750. // absent or empty mapping leaves `host` as the connection target; without the
  8751. // empty check the value would reach getaddrinfo as a null node and silently
  8752. // resolve to loopback.
  8753. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8754. const std::string &host, std::string &connect_host,
  8755. std::string &ip) {
  8756. connect_host = host;
  8757. ip.clear();
  8758. auto it = addr_map.find(host);
  8759. if (it == addr_map.end() || it->second.empty()) { return; }
  8760. if (is_ip_address(it->second)) {
  8761. ip = it->second;
  8762. } else {
  8763. connect_host = it->second;
  8764. }
  8765. }
  8766. } // namespace detail
  8767. /*
  8768. * Group 2: detail namespace - SSL common utilities
  8769. */
  8770. #ifdef CPPHTTPLIB_SSL_ENABLED
  8771. namespace detail {
  8772. class SSLSocketStream final : public Stream {
  8773. public:
  8774. SSLSocketStream(
  8775. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8776. time_t read_timeout_usec, time_t write_timeout_sec,
  8777. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8778. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8779. (std::chrono::steady_clock::time_point::min)());
  8780. ~SSLSocketStream() override;
  8781. bool is_readable() const override;
  8782. bool wait_readable() const override;
  8783. bool wait_writable() const override;
  8784. bool is_peer_alive() const override;
  8785. ssize_t read(char *ptr, size_t size) override;
  8786. ssize_t write(const char *ptr, size_t size) override;
  8787. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8788. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8789. socket_t socket() const override;
  8790. time_t duration() const override;
  8791. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8792. // See SocketStream::set_readable_hint().
  8793. void set_readable_hint() { readable_hint_ = true; }
  8794. private:
  8795. bool ensure_readable();
  8796. socket_t sock_;
  8797. tls::session_t session_;
  8798. time_t read_timeout_sec_;
  8799. time_t read_timeout_usec_;
  8800. time_t write_timeout_sec_;
  8801. time_t write_timeout_usec_;
  8802. time_t max_timeout_msec_;
  8803. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8804. bool readable_hint_ = false;
  8805. };
  8806. // A TLS stream for WebSocket connections, where the receive path and the
  8807. // send path (application send() plus the heartbeat ping thread) run on
  8808. // different threads. A single TLS session must never be entered
  8809. // concurrently, so every call into the session is serialized by one mutex.
  8810. //
  8811. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8812. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8813. // call under the lock, then waits for readiness with select() outside the
  8814. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8815. // blocked waiting for data never stalls a concurrent sender.
  8816. //
  8817. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8818. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8819. class WebSocketSSLStream final : public Stream {
  8820. public:
  8821. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8822. time_t read_timeout_sec, time_t read_timeout_usec,
  8823. time_t write_timeout_sec, time_t write_timeout_usec);
  8824. ~WebSocketSSLStream() override;
  8825. bool is_readable() const override;
  8826. bool wait_readable() const override;
  8827. bool wait_writable() const override;
  8828. ssize_t read(char *ptr, size_t size) override;
  8829. ssize_t write(const char *ptr, size_t size) override;
  8830. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8831. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8832. socket_t socket() const override;
  8833. time_t duration() const override;
  8834. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8835. private:
  8836. mutable std::mutex session_mutex_;
  8837. socket_t sock_;
  8838. tls::session_t session_;
  8839. // WebSocket::close() shortens the read timeout from the closing thread
  8840. // while the receive thread is inside wait_readable(), so these two are read
  8841. // and written concurrently. The write timeouts are never mutated.
  8842. std::atomic<time_t> read_timeout_sec_;
  8843. std::atomic<time_t> read_timeout_usec_;
  8844. time_t write_timeout_sec_;
  8845. time_t write_timeout_usec_;
  8846. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8847. };
  8848. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8849. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8850. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8851. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8852. unsigned int hash_length = 0;
  8853. unsigned char hash[EVP_MAX_MD_SIZE];
  8854. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8855. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8856. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8857. std::stringstream ss;
  8858. for (auto i = 0u; i < hash_length; ++i) {
  8859. ss << std::hex << std::setw(2) << std::setfill('0')
  8860. << static_cast<unsigned int>(hash[i]);
  8861. }
  8862. return ss.str();
  8863. }
  8864. inline std::string MD5(const std::string &s) {
  8865. return message_digest(s, EVP_md5());
  8866. }
  8867. inline std::string SHA_256(const std::string &s) {
  8868. return message_digest(s, EVP_sha256());
  8869. }
  8870. inline std::string SHA_512(const std::string &s) {
  8871. return message_digest(s, EVP_sha512());
  8872. }
  8873. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8874. namespace {
  8875. template <size_t N>
  8876. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8877. std::stringstream ss;
  8878. for (size_t i = 0; i < N; ++i) {
  8879. ss << std::hex << std::setw(2) << std::setfill('0')
  8880. << static_cast<unsigned int>(hash[i]);
  8881. }
  8882. return ss.str();
  8883. }
  8884. } // namespace
  8885. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8886. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8887. // initialized once. PSA state is process-global; do not free it.
  8888. inline bool ensure_mbedtls_psa_crypto() {
  8889. static std::once_flag once;
  8890. static bool ok = false;
  8891. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8892. return ok;
  8893. }
  8894. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8895. unsigned char *out, size_t out_size) {
  8896. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8897. size_t olen = 0;
  8898. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8899. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8900. olen == out_size;
  8901. }
  8902. #endif
  8903. inline std::string MD5(const std::string &s) {
  8904. unsigned char hash[16];
  8905. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8906. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8907. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8908. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8909. hash);
  8910. #else
  8911. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8912. hash);
  8913. #endif
  8914. return hash_to_hex(hash);
  8915. }
  8916. inline std::string SHA_256(const std::string &s) {
  8917. unsigned char hash[32];
  8918. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8919. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8920. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8921. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8922. hash, 0);
  8923. #else
  8924. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8925. s.size(), hash, 0);
  8926. #endif
  8927. return hash_to_hex(hash);
  8928. }
  8929. inline std::string SHA_512(const std::string &s) {
  8930. unsigned char hash[64];
  8931. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8932. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8933. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8934. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8935. hash, 0);
  8936. #else
  8937. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8938. s.size(), hash, 0);
  8939. #endif
  8940. return hash_to_hex(hash);
  8941. }
  8942. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8943. namespace {
  8944. template <size_t N>
  8945. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8946. std::stringstream ss;
  8947. for (size_t i = 0; i < N; ++i) {
  8948. ss << std::hex << std::setw(2) << std::setfill('0')
  8949. << static_cast<unsigned int>(hash[i]);
  8950. }
  8951. return ss.str();
  8952. }
  8953. } // namespace
  8954. inline std::string MD5(const std::string &s) {
  8955. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8956. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8957. static_cast<word32>(s.size()), hash);
  8958. return hash_to_hex(hash);
  8959. }
  8960. inline std::string SHA_256(const std::string &s) {
  8961. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8962. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8963. static_cast<word32>(s.size()), hash);
  8964. return hash_to_hex(hash);
  8965. }
  8966. inline std::string SHA_512(const std::string &s) {
  8967. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8968. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8969. static_cast<word32>(s.size()), hash);
  8970. return hash_to_hex(hash);
  8971. }
  8972. #endif
  8973. template <typename T>
  8974. inline bool process_server_socket_ssl(
  8975. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8976. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8977. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8978. time_t write_timeout_usec, T callback) {
  8979. // See process_server_socket(). The TLS library keeps already decrypted bytes
  8980. // of a pipelined request, which keep_alive() cannot see on the socket.
  8981. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8982. write_timeout_sec, write_timeout_usec);
  8983. return process_server_socket_core(
  8984. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8985. [&]() { return strm.is_readable(); },
  8986. [&](bool socket_readable, bool close_connection,
  8987. bool &connection_closed) {
  8988. if (socket_readable) { strm.set_readable_hint(); }
  8989. return callback(strm, close_connection, connection_closed);
  8990. });
  8991. }
  8992. template <typename T>
  8993. inline bool process_client_socket_ssl(
  8994. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8995. time_t read_timeout_usec, time_t write_timeout_sec,
  8996. time_t write_timeout_usec, time_t max_timeout_msec,
  8997. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8998. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8999. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9000. start_time);
  9001. return callback(strm);
  9002. }
  9003. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9004. const Request &req, const std::map<std::string, std::string> &auth,
  9005. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9006. const std::string &password, bool is_proxy = false) {
  9007. std::string nc;
  9008. {
  9009. std::stringstream ss;
  9010. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9011. nc = ss.str();
  9012. }
  9013. std::string qop;
  9014. if (auth.find("qop") != auth.end()) {
  9015. qop = auth.at("qop");
  9016. if (qop.find("auth-int") != std::string::npos) {
  9017. qop = "auth-int";
  9018. } else if (qop.find("auth") != std::string::npos) {
  9019. qop = "auth";
  9020. } else {
  9021. qop.clear();
  9022. }
  9023. }
  9024. std::string algo = "MD5";
  9025. if (auth.find("algorithm") != auth.end()) {
  9026. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9027. // not a token would otherwise be emitted verbatim and could carry commas
  9028. // or quotes that inject further auth-params into the header below.
  9029. const auto &a = auth.at("algorithm");
  9030. if (fields::is_token(a)) { algo = a; }
  9031. }
  9032. std::string response;
  9033. {
  9034. auto H = algo == "SHA-256" ? detail::SHA_256
  9035. : algo == "SHA-512" ? detail::SHA_512
  9036. : detail::MD5;
  9037. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9038. auto A2 = req.method + ":" + req.path;
  9039. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9040. if (qop.empty()) {
  9041. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9042. } else {
  9043. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9044. ":" + qop + ":" + H(A2));
  9045. }
  9046. }
  9047. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9048. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9049. // close the string early. realm, nonce and opaque come straight from the
  9050. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9051. // without this a crafted challenge injects extra auth-params into the header.
  9052. auto field =
  9053. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9054. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9055. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9056. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9057. "\", algorithm=" + algo +
  9058. (qop.empty() ? ", response=\""
  9059. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9060. "\", response=\"") +
  9061. response + "\"" +
  9062. (opaque.empty()
  9063. ? ""
  9064. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9065. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9066. return std::make_pair(key, field);
  9067. }
  9068. inline bool match_hostname(const std::string &pattern,
  9069. const std::string &hostname) {
  9070. // Exact match (case-insensitive)
  9071. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  9072. // Split both pattern and hostname into components by '.'
  9073. std::vector<std::string> pattern_components;
  9074. if (!pattern.empty()) {
  9075. split(pattern.data(), pattern.data() + pattern.size(), '.',
  9076. [&](const char *b, const char *e) {
  9077. pattern_components.emplace_back(b, e);
  9078. });
  9079. }
  9080. std::vector<std::string> host_components;
  9081. if (!hostname.empty()) {
  9082. split(hostname.data(), hostname.data() + hostname.size(), '.',
  9083. [&](const char *b, const char *e) {
  9084. host_components.emplace_back(b, e);
  9085. });
  9086. }
  9087. // Component count must match
  9088. if (host_components.size() != pattern_components.size()) { return false; }
  9089. // Compare each component with wildcard support
  9090. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9091. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9092. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9093. auto itr = pattern_components.begin();
  9094. for (const auto &h : host_components) {
  9095. auto &p = *itr;
  9096. auto is_leftmost = itr == pattern_components.begin();
  9097. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9098. bool partial_match = false;
  9099. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9100. const auto prefix_length = p.size() - 1;
  9101. if (prefix_length == 0) {
  9102. partial_match = true;
  9103. } else if (h.size() >= prefix_length) {
  9104. partial_match =
  9105. std::equal(p.begin(),
  9106. p.begin() + static_cast<std::string::difference_type>(
  9107. prefix_length),
  9108. h.begin(), [](const char ca, const char cb) {
  9109. return detail::case_ignore::to_lower(ca) ==
  9110. detail::case_ignore::to_lower(cb);
  9111. });
  9112. }
  9113. }
  9114. if (!partial_match) { return false; }
  9115. }
  9116. ++itr;
  9117. }
  9118. return true;
  9119. }
  9120. #ifdef _WIN32
  9121. // Verify certificate using Windows CertGetCertificateChain API.
  9122. // This provides real-time certificate validation with Windows Update
  9123. // integration, independent of the TLS backend.
  9124. inline bool verify_cert_with_windows_schannel(
  9125. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9126. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9127. if (der_cert.empty()) { return false; }
  9128. out_error = 0;
  9129. // Create Windows certificate context from DER data
  9130. auto cert_context = CertCreateCertificateContext(
  9131. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9132. static_cast<DWORD>(der_cert.size()));
  9133. if (!cert_context) {
  9134. out_error = GetLastError();
  9135. return false;
  9136. }
  9137. auto cert_guard =
  9138. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9139. // Give CryptoAPI the certificates the server sent. Without them it follows
  9140. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9141. std::vector<tls::cert_t> peer_certs;
  9142. tls::get_peer_certs(session, peer_certs);
  9143. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9144. auto store_guard = scope_exit([&] {
  9145. for (auto cert : peer_certs) {
  9146. tls::free_cert(cert);
  9147. }
  9148. if (store) { CertCloseStore(store, 0); }
  9149. });
  9150. for (auto cert : peer_certs) {
  9151. std::vector<unsigned char> der;
  9152. if (store && tls::get_cert_der(cert, der)) {
  9153. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9154. static_cast<DWORD>(der.size()),
  9155. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9156. }
  9157. }
  9158. // Setup chain parameters
  9159. CERT_CHAIN_PARA chain_para = {};
  9160. chain_para.cbSize = sizeof(chain_para);
  9161. // Require the server authentication usage along the chain, which also
  9162. // rejects roots that Windows trusts only for other purposes.
  9163. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9164. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9165. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9166. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9167. // Build certificate chain with revocation checking
  9168. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9169. auto chain_result = CertGetCertificateChain(
  9170. nullptr, cert_context, nullptr, store, &chain_para,
  9171. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9172. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9173. nullptr, &chain_context);
  9174. if (!chain_result || !chain_context) {
  9175. out_error = GetLastError();
  9176. return false;
  9177. }
  9178. auto chain_guard =
  9179. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9180. // Verify SSL policy
  9181. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9182. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9183. #ifdef AUTHTYPE_SERVER
  9184. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9185. #endif
  9186. std::wstring whost;
  9187. if (verify_hostname) {
  9188. whost = u8string_to_wstring(hostname.c_str());
  9189. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9190. }
  9191. CERT_CHAIN_POLICY_PARA policy_para = {};
  9192. policy_para.cbSize = sizeof(policy_para);
  9193. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9194. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9195. #else
  9196. policy_para.dwFlags = 0;
  9197. #endif
  9198. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9199. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9200. policy_status.cbSize = sizeof(policy_status);
  9201. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9202. &policy_para, &policy_status)) {
  9203. out_error = GetLastError();
  9204. return false;
  9205. }
  9206. if (policy_status.dwError != 0) {
  9207. out_error = policy_status.dwError;
  9208. return false;
  9209. }
  9210. return true;
  9211. }
  9212. #endif // _WIN32
  9213. // Loads CA file/dir configuration and applies the system CA policy to a
  9214. // client TLS context. PEM data and native stores are applied to the context
  9215. // directly at set time; has_custom_store reflects them for the Auto policy
  9216. // decision.
  9217. inline bool load_client_ca_config(tls::ctx_t ctx,
  9218. const std::string &ca_cert_file_path,
  9219. const std::string &ca_cert_dir_path,
  9220. bool has_custom_store, SystemCAMode mode,
  9221. uint64_t &backend_error) {
  9222. auto ret = true;
  9223. if (!ca_cert_file_path.empty()) {
  9224. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9225. backend_error = tls::get_error();
  9226. ret = false;
  9227. }
  9228. } else if (!ca_cert_dir_path.empty()) {
  9229. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9230. backend_error = tls::get_error();
  9231. ret = false;
  9232. }
  9233. }
  9234. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9235. !ca_cert_dir_path.empty() || has_custom_store;
  9236. if (mode == SystemCAMode::Enabled ||
  9237. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9238. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9239. }
  9240. return ret;
  9241. }
  9242. // The parts of session setup that only SSLClient needs, plus the handful
  9243. // WebSocketClient also exposes; everything else takes the defaults, which is
  9244. // what keeps the two clients on one implementation.
  9245. struct ClientTlsSessionOptions {
  9246. // Both SSLClient and WebSocketClient expose this independently of
  9247. // certificate verification.
  9248. bool server_hostname_verification = true;
  9249. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9250. // When non-null, guards session creation against concurrent use of the
  9251. // context. A WebSocketClient is not safe to use from several threads to
  9252. // begin with, so it passes nothing.
  9253. std::mutex *ctx_mutex = nullptr;
  9254. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9255. // The caller decides whether Schannel has anything to say about this
  9256. // connection; see SSLClient::initialize_ssl().
  9257. bool windows_cert_verification = false;
  9258. // A server certificate verifier works on the backend's chain verification,
  9259. // so the backend keeps deciding and Schannel only adds its own check.
  9260. bool server_certificate_verifier_set = false;
  9261. #endif
  9262. };
  9263. // Filled in on failure for callers that report error details.
  9264. struct ClientTlsSessionError {
  9265. Error error = Error::Success;
  9266. int ssl_error = 0;
  9267. uint64_t backend_error = 0;
  9268. };
  9269. // Establishes a client TLS session on an already connected socket. On failure
  9270. // the session is left for the caller to free: SSLClient frees it right away,
  9271. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9272. inline bool setup_client_tls_session(
  9273. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9274. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9275. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9276. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9277. using namespace tls;
  9278. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9279. if (out_error) {
  9280. out_error->error = error;
  9281. out_error->ssl_error = ssl_error;
  9282. out_error->backend_error = backend_error;
  9283. }
  9284. return false;
  9285. };
  9286. if (!ctx) {
  9287. session = nullptr;
  9288. return fail(Error::SSLConnection, 0, 0);
  9289. }
  9290. // With Windows verification on and no server certificate verifier set,
  9291. // Schannel is the only chain verifier. The backend's trust store is a
  9292. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9293. // demand, so the backend's verdict is not used.
  9294. auto windows_verifies_chain = false;
  9295. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9296. windows_verifies_chain = options.windows_cert_verification &&
  9297. !options.server_certificate_verifier_set;
  9298. #endif
  9299. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9300. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9301. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9302. // Schannel verifies the chain instead, chain verification happens during
  9303. // the handshake even for IP hosts; the certificate identity is verified
  9304. // post-handshake via verify_hostname().
  9305. set_verify_client(ctx,
  9306. server_certificate_verification && !windows_verifies_chain);
  9307. #endif
  9308. {
  9309. std::unique_lock<std::mutex> guard;
  9310. if (options.ctx_mutex) {
  9311. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9312. }
  9313. session = create_session(ctx, sock);
  9314. }
  9315. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9316. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9317. // their identity is checked post-handshake below instead. On Mbed TLS and
  9318. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9319. // options.server_hostname_verification is threaded through here.
  9320. if (!is_ip_address(host)) {
  9321. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9322. return fail(Error::SSLConnection, 0, get_error());
  9323. }
  9324. }
  9325. TlsError tls_err;
  9326. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9327. &tls_err)) {
  9328. auto error = Error::SSLConnection;
  9329. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9330. error = Error::SSLServerVerification;
  9331. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9332. error = Error::SSLServerHostnameVerification;
  9333. }
  9334. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9335. }
  9336. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9337. if (options.session_verifier) {
  9338. verification_status = options.session_verifier(session);
  9339. }
  9340. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9341. return fail(Error::SSLServerVerification, 0, get_error());
  9342. }
  9343. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9344. server_certificate_verification) {
  9345. if (!windows_verifies_chain) {
  9346. auto verify_result = get_verify_result(session);
  9347. if (verify_result != 0) {
  9348. return fail(Error::SSLServerVerification, 0,
  9349. static_cast<uint64_t>(verify_result));
  9350. }
  9351. }
  9352. auto server_cert = get_peer_cert(session);
  9353. if (!server_cert) {
  9354. return fail(Error::SSLServerVerification, 0, get_error());
  9355. }
  9356. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9357. // Identity check against the peer certificate, post-handshake for all
  9358. // backends. For IP hosts this is the only identity verification, since no
  9359. // hostname is bound during the handshake.
  9360. if (options.server_hostname_verification) {
  9361. if (!verify_hostname(server_cert, host.c_str())) {
  9362. return fail(Error::SSLServerHostnameVerification, 0,
  9363. hostname_mismatch_code());
  9364. }
  9365. }
  9366. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9367. // Windows Schannel verification, which lets Windows fetch missing roots
  9368. // and intermediates on demand. It must not be skipped: unless a server
  9369. // certificate verifier is set, it is the only chain check.
  9370. if (options.windows_cert_verification) {
  9371. std::vector<unsigned char> der;
  9372. uint64_t wincrypt_error = 0;
  9373. if (!get_cert_der(server_cert, der) ||
  9374. !verify_cert_with_windows_schannel(
  9375. der, host, options.server_hostname_verification, wincrypt_error,
  9376. session)) {
  9377. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9378. }
  9379. }
  9380. #endif
  9381. }
  9382. return true;
  9383. }
  9384. } // namespace detail
  9385. #endif // CPPHTTPLIB_SSL_ENABLED
  9386. /*
  9387. * Group 3: httplib namespace - Non-SSL public API implementations
  9388. */
  9389. inline void default_socket_options(socket_t sock) {
  9390. set_socket_opt(sock, SOL_SOCKET,
  9391. #ifdef SO_REUSEPORT
  9392. SO_REUSEPORT,
  9393. #else
  9394. SO_REUSEADDR,
  9395. #endif
  9396. 1);
  9397. }
  9398. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9399. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9400. sizeof(optval));
  9401. }
  9402. inline std::string get_bearer_token_auth(const Request &req) {
  9403. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9404. // than the prefix carries no token.
  9405. constexpr const char bearer_prefix[] = "Bearer ";
  9406. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9407. auto value = req.get_header_value("Authorization");
  9408. if (value.size() >= bearer_prefix_len &&
  9409. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9410. bearer_prefix)) {
  9411. return value.substr(bearer_prefix_len);
  9412. }
  9413. return "";
  9414. }
  9415. inline const char *status_message(int status) {
  9416. switch (status) {
  9417. case StatusCode::Continue_100: return "Continue";
  9418. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9419. case StatusCode::Processing_102: return "Processing";
  9420. case StatusCode::EarlyHints_103: return "Early Hints";
  9421. case StatusCode::OK_200: return "OK";
  9422. case StatusCode::Created_201: return "Created";
  9423. case StatusCode::Accepted_202: return "Accepted";
  9424. case StatusCode::NonAuthoritativeInformation_203:
  9425. return "Non-Authoritative Information";
  9426. case StatusCode::NoContent_204: return "No Content";
  9427. case StatusCode::ResetContent_205: return "Reset Content";
  9428. case StatusCode::PartialContent_206: return "Partial Content";
  9429. case StatusCode::MultiStatus_207: return "Multi-Status";
  9430. case StatusCode::AlreadyReported_208: return "Already Reported";
  9431. case StatusCode::IMUsed_226: return "IM Used";
  9432. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9433. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9434. case StatusCode::Found_302: return "Found";
  9435. case StatusCode::SeeOther_303: return "See Other";
  9436. case StatusCode::NotModified_304: return "Not Modified";
  9437. case StatusCode::UseProxy_305: return "Use Proxy";
  9438. case StatusCode::unused_306: return "unused";
  9439. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9440. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9441. case StatusCode::BadRequest_400: return "Bad Request";
  9442. case StatusCode::Unauthorized_401: return "Unauthorized";
  9443. case StatusCode::PaymentRequired_402: return "Payment Required";
  9444. case StatusCode::Forbidden_403: return "Forbidden";
  9445. case StatusCode::NotFound_404: return "Not Found";
  9446. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9447. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9448. case StatusCode::ProxyAuthenticationRequired_407:
  9449. return "Proxy Authentication Required";
  9450. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9451. case StatusCode::Conflict_409: return "Conflict";
  9452. case StatusCode::Gone_410: return "Gone";
  9453. case StatusCode::LengthRequired_411: return "Length Required";
  9454. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9455. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9456. case StatusCode::UriTooLong_414: return "URI Too Long";
  9457. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9458. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9459. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9460. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9461. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9462. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9463. case StatusCode::Locked_423: return "Locked";
  9464. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9465. case StatusCode::TooEarly_425: return "Too Early";
  9466. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9467. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9468. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9469. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9470. return "Request Header Fields Too Large";
  9471. case StatusCode::UnavailableForLegalReasons_451:
  9472. return "Unavailable For Legal Reasons";
  9473. case StatusCode::NotImplemented_501: return "Not Implemented";
  9474. case StatusCode::BadGateway_502: return "Bad Gateway";
  9475. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9476. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9477. case StatusCode::HttpVersionNotSupported_505:
  9478. return "HTTP Version Not Supported";
  9479. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9480. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9481. case StatusCode::LoopDetected_508: return "Loop Detected";
  9482. case StatusCode::NotExtended_510: return "Not Extended";
  9483. case StatusCode::NetworkAuthenticationRequired_511:
  9484. return "Network Authentication Required";
  9485. default:
  9486. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9487. }
  9488. }
  9489. inline std::string to_string(const Error error) {
  9490. switch (error) {
  9491. case Error::Success: return "Success (no error)";
  9492. case Error::Unknown: return "Unknown";
  9493. case Error::Connection: return "Could not establish connection";
  9494. case Error::BindIPAddress: return "Failed to bind IP address";
  9495. case Error::Read: return "Failed to read connection";
  9496. case Error::Write: return "Failed to write connection";
  9497. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9498. case Error::Canceled: return "Connection handling canceled";
  9499. case Error::SSLConnection: return "SSL connection failed";
  9500. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9501. case Error::SSLServerVerification: return "SSL server verification failed";
  9502. case Error::SSLServerHostnameVerification:
  9503. return "SSL server hostname verification failed";
  9504. case Error::UnsupportedMultipartBoundaryChars:
  9505. return "Unsupported HTTP multipart boundary characters";
  9506. case Error::Compression: return "Compression failed";
  9507. case Error::ConnectionTimeout: return "Connection timed out";
  9508. case Error::ProxyConnection: return "Proxy connection failed";
  9509. case Error::ConnectionClosed: return "Connection closed by server";
  9510. case Error::Timeout: return "Read timeout";
  9511. case Error::ResourceExhaustion: return "Resource exhaustion";
  9512. case Error::TooManyFormDataFiles: return "Too many form data files";
  9513. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9514. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9515. case Error::ExceedMaxSocketDescriptorCount:
  9516. return "Exceeded maximum socket descriptor count";
  9517. case Error::InvalidRequestLine: return "Invalid request line";
  9518. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9519. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9520. case Error::InvalidHeaders: return "Invalid headers";
  9521. case Error::MultipartParsing: return "Multipart parsing failed";
  9522. case Error::OpenFile: return "Failed to open file";
  9523. case Error::Listen: return "Failed to listen on socket";
  9524. case Error::GetSockName: return "Failed to get socket name";
  9525. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9526. case Error::HTTPParsing: return "HTTP parsing failed";
  9527. case Error::InvalidRangeHeader: return "Invalid Range header";
  9528. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9529. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9530. case Error::UserCallbackException: return "User callback threw an exception";
  9531. default: break;
  9532. }
  9533. return "Invalid";
  9534. }
  9535. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9536. os << to_string(obj);
  9537. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9538. return os;
  9539. }
  9540. inline std::string hosted_at(const std::string &hostname) {
  9541. std::vector<std::string> addrs;
  9542. hosted_at(hostname, addrs);
  9543. if (addrs.empty()) { return std::string(); }
  9544. return addrs[0];
  9545. }
  9546. inline void hosted_at(const std::string &hostname,
  9547. std::vector<std::string> &addrs) {
  9548. struct addrinfo hints;
  9549. struct addrinfo *result;
  9550. memset(&hints, 0, sizeof(struct addrinfo));
  9551. hints.ai_family = AF_UNSPEC;
  9552. hints.ai_socktype = SOCK_STREAM;
  9553. hints.ai_protocol = 0;
  9554. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9555. &result, 0)) {
  9556. #if defined __linux__ && !defined __ANDROID__
  9557. res_init();
  9558. #endif
  9559. return;
  9560. }
  9561. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9562. for (auto rp = result; rp; rp = rp->ai_next) {
  9563. const auto &addr =
  9564. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9565. std::string ip;
  9566. auto dummy = -1;
  9567. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9568. dummy)) {
  9569. addrs.emplace_back(std::move(ip));
  9570. }
  9571. }
  9572. }
  9573. inline std::string encode_uri_component(const std::string &value) {
  9574. std::ostringstream escaped;
  9575. escaped.fill('0');
  9576. escaped << std::hex;
  9577. for (auto c : value) {
  9578. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9579. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9580. escaped << c;
  9581. } else {
  9582. escaped << std::uppercase;
  9583. escaped << '%' << std::setw(2)
  9584. << static_cast<int>(static_cast<unsigned char>(c));
  9585. escaped << std::nouppercase;
  9586. }
  9587. }
  9588. return escaped.str();
  9589. }
  9590. inline std::string encode_uri(const std::string &value) {
  9591. std::ostringstream escaped;
  9592. escaped.fill('0');
  9593. escaped << std::hex;
  9594. for (auto c : value) {
  9595. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9596. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9597. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9598. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9599. escaped << c;
  9600. } else {
  9601. escaped << std::uppercase;
  9602. escaped << '%' << std::setw(2)
  9603. << static_cast<int>(static_cast<unsigned char>(c));
  9604. escaped << std::nouppercase;
  9605. }
  9606. }
  9607. return escaped.str();
  9608. }
  9609. inline std::string decode_uri_component(const std::string &value) {
  9610. std::string result;
  9611. for (size_t i = 0; i < value.size(); i++) {
  9612. if (value[i] == '%' && i + 2 < value.size()) {
  9613. auto val = 0;
  9614. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9615. result += static_cast<char>(val);
  9616. i += 2;
  9617. } else {
  9618. result += value[i];
  9619. }
  9620. } else {
  9621. result += value[i];
  9622. }
  9623. }
  9624. return result;
  9625. }
  9626. inline std::string decode_uri(const std::string &value) {
  9627. std::string result;
  9628. for (size_t i = 0; i < value.size(); i++) {
  9629. if (value[i] == '%' && i + 2 < value.size()) {
  9630. auto val = 0;
  9631. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9632. auto c = static_cast<char>(val);
  9633. // Keep escapes of the reserved characters that encode_uri leaves
  9634. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9635. // delimiter is not promoted into a real one (as with JS decodeURI).
  9636. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9637. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9638. c == '#') {
  9639. result += value[i];
  9640. result += value[i + 1];
  9641. result += value[i + 2];
  9642. } else {
  9643. result += c;
  9644. }
  9645. i += 2;
  9646. } else {
  9647. result += value[i];
  9648. }
  9649. } else {
  9650. result += value[i];
  9651. }
  9652. }
  9653. return result;
  9654. }
  9655. inline std::string encode_path_component(const std::string &component) {
  9656. std::string result;
  9657. result.reserve(component.size() * 3);
  9658. for (size_t i = 0; i < component.size(); i++) {
  9659. auto c = static_cast<unsigned char>(component[i]);
  9660. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9661. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9662. c == '_' || c == '~') {
  9663. result += static_cast<char>(c);
  9664. }
  9665. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9666. // "," / ";" / "="
  9667. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9668. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9669. c == '=') {
  9670. result += static_cast<char>(c);
  9671. }
  9672. // Colon is allowed in path segments except first segment
  9673. else if (c == ':') {
  9674. result += static_cast<char>(c);
  9675. }
  9676. // @ is allowed in path
  9677. else if (c == '@') {
  9678. result += static_cast<char>(c);
  9679. } else {
  9680. result += '%';
  9681. char hex[3];
  9682. snprintf(hex, sizeof(hex), "%02X", c);
  9683. result.append(hex, 2);
  9684. }
  9685. }
  9686. return result;
  9687. }
  9688. inline std::string decode_path_component(const std::string &component) {
  9689. std::string result;
  9690. result.reserve(component.size());
  9691. for (size_t i = 0; i < component.size(); i++) {
  9692. if (component[i] == '%' && i + 1 < component.size()) {
  9693. if (component[i + 1] == 'u') {
  9694. // Unicode %uXXXX encoding
  9695. auto val = 0;
  9696. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9697. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9698. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9699. char buff[4];
  9700. size_t len = detail::to_utf8(val, buff);
  9701. if (len > 0) { result.append(buff, len); }
  9702. i += 5; // 'u0000'
  9703. } else {
  9704. result += component[i];
  9705. }
  9706. } else {
  9707. // Standard %XX encoding
  9708. auto val = 0;
  9709. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9710. // 2 digits hex codes
  9711. result += static_cast<char>(val);
  9712. i += 2; // 'XX'
  9713. } else {
  9714. result += component[i];
  9715. }
  9716. }
  9717. } else {
  9718. result += component[i];
  9719. }
  9720. }
  9721. return result;
  9722. }
  9723. inline std::string encode_query_component(const std::string &component,
  9724. bool space_as_plus) {
  9725. std::string result;
  9726. result.reserve(component.size() * 3);
  9727. for (size_t i = 0; i < component.size(); i++) {
  9728. auto c = static_cast<unsigned char>(component[i]);
  9729. // Unreserved characters per RFC 3986
  9730. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9731. c == '_' || c == '~') {
  9732. result += static_cast<char>(c);
  9733. }
  9734. // Space handling
  9735. else if (c == ' ') {
  9736. if (space_as_plus) {
  9737. result += '+';
  9738. } else {
  9739. result += "%20";
  9740. }
  9741. }
  9742. // Plus sign handling
  9743. else if (c == '+') {
  9744. if (space_as_plus) {
  9745. result += "%2B";
  9746. } else {
  9747. result += static_cast<char>(c);
  9748. }
  9749. }
  9750. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9751. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9752. c == '*' || c == ',' || c == ';') {
  9753. result += static_cast<char>(c);
  9754. }
  9755. // Colon and @ are allowed in query
  9756. else if (c == ':' || c == '@') {
  9757. result += static_cast<char>(c);
  9758. }
  9759. // Forward slash is allowed in query values
  9760. else if (c == '/') {
  9761. result += static_cast<char>(c);
  9762. }
  9763. // Question mark is allowed in query values (after first ?)
  9764. else if (c == '?') {
  9765. result += static_cast<char>(c);
  9766. } else {
  9767. result += '%';
  9768. char hex[3];
  9769. snprintf(hex, sizeof(hex), "%02X", c);
  9770. result.append(hex, 2);
  9771. }
  9772. }
  9773. return result;
  9774. }
  9775. inline std::string decode_query_component(const std::string &component,
  9776. bool plus_as_space) {
  9777. std::string result;
  9778. result.reserve(component.size());
  9779. for (size_t i = 0; i < component.size(); i++) {
  9780. if (component[i] == '%' && i + 2 < component.size()) {
  9781. auto val = 0;
  9782. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9783. result += static_cast<char>(val);
  9784. i += 2;
  9785. } else {
  9786. result += component[i];
  9787. }
  9788. } else if (component[i] == '+' && plus_as_space) {
  9789. result += ' '; // + becomes space in form-urlencoded
  9790. } else {
  9791. result += component[i];
  9792. }
  9793. }
  9794. return result;
  9795. }
  9796. inline std::string sanitize_filename(const std::string &filename) {
  9797. // Extract basename: find the last path separator (/ or \)
  9798. auto pos = filename.find_last_of("/\\");
  9799. auto result =
  9800. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9801. // Strip null bytes
  9802. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9803. // Trim whitespace
  9804. {
  9805. auto start = result.find_first_not_of(" \t");
  9806. auto end = result.find_last_not_of(" \t");
  9807. result = (start == std::string::npos)
  9808. ? ""
  9809. : result.substr(start, end - start + 1);
  9810. }
  9811. // Reject . and ..
  9812. if (result == "." || result == "..") { return ""; }
  9813. return result;
  9814. }
  9815. inline std::string append_query_params(const std::string &path,
  9816. const Params &params) {
  9817. std::string path_with_query = path;
  9818. thread_local const std::regex re("[^?]+\\?.*");
  9819. auto delm = std::regex_match(path, re) ? '&' : '?';
  9820. path_with_query += delm + detail::params_to_query_str(params);
  9821. return path_with_query;
  9822. }
  9823. // Header utilities
  9824. inline std::pair<std::string, std::string>
  9825. make_range_header(const Ranges &ranges) {
  9826. std::string field = "bytes=";
  9827. auto i = 0;
  9828. for (const auto &r : ranges) {
  9829. if (i != 0) { field += ", "; }
  9830. if (r.first != -1) { field += std::to_string(r.first); }
  9831. field += '-';
  9832. if (r.second != -1) { field += std::to_string(r.second); }
  9833. i++;
  9834. }
  9835. return std::make_pair("Range", std::move(field));
  9836. }
  9837. inline std::pair<std::string, std::string>
  9838. make_basic_authentication_header(const std::string &username,
  9839. const std::string &password, bool is_proxy) {
  9840. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9841. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9842. return std::make_pair(key, std::move(field));
  9843. }
  9844. inline std::pair<std::string, std::string>
  9845. make_bearer_token_authentication_header(const std::string &token,
  9846. bool is_proxy = false) {
  9847. auto field = "Bearer " + token;
  9848. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9849. return std::make_pair(key, std::move(field));
  9850. }
  9851. // Request implementation
  9852. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9853. size_t id) const {
  9854. return detail::get_header_value_u64(headers, key, def, id);
  9855. }
  9856. inline bool Request::has_header(const std::string &key) const {
  9857. return detail::has_header(headers, key);
  9858. }
  9859. inline std::string Request::get_header_value(const std::string &key,
  9860. const char *def, size_t id) const {
  9861. return detail::get_header_value(headers, key, def, id);
  9862. }
  9863. inline size_t Request::get_header_value_count(const std::string &key) const {
  9864. return detail::get_header_value_count(headers, key);
  9865. }
  9866. inline void Request::set_header(const std::string &key,
  9867. const std::string &val) {
  9868. detail::set_header(headers, key, val);
  9869. }
  9870. inline bool Request::has_trailer(const std::string &key) const {
  9871. return trailers.find(key) != trailers.end();
  9872. }
  9873. inline std::string Request::get_trailer_value(const std::string &key,
  9874. size_t id) const {
  9875. return detail::get_multimap_value(trailers, key, id);
  9876. }
  9877. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9878. return trailers.count(key);
  9879. }
  9880. inline bool Request::has_param(const std::string &key) const {
  9881. return params.find(key) != params.end();
  9882. }
  9883. inline std::string Request::get_param_value(const std::string &key,
  9884. size_t id) const {
  9885. return detail::get_multimap_value(params, key, id);
  9886. }
  9887. inline std::vector<std::string>
  9888. Request::get_param_values(const std::string &key) const {
  9889. auto rng = params.equal_range(key);
  9890. std::vector<std::string> values;
  9891. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9892. for (auto it = rng.first; it != rng.second; ++it) {
  9893. values.push_back(it->second);
  9894. }
  9895. return values;
  9896. }
  9897. inline size_t Request::get_param_value_count(const std::string &key) const {
  9898. return params.count(key);
  9899. }
  9900. inline bool Request::is_multipart_form_data() const {
  9901. const auto &content_type = get_header_value("Content-Type");
  9902. return detail::extract_media_type(content_type) == "multipart/form-data";
  9903. }
  9904. // Multipart FormData implementation
  9905. inline std::string MultipartFormData::get_field(const std::string &key,
  9906. size_t id) const {
  9907. auto rng = fields.equal_range(key);
  9908. auto it = detail::bounded_next(rng.first, id, rng.second);
  9909. if (it != rng.second) { return it->second.content; }
  9910. return std::string();
  9911. }
  9912. inline std::vector<std::string>
  9913. MultipartFormData::get_fields(const std::string &key) const {
  9914. std::vector<std::string> values;
  9915. auto rng = fields.equal_range(key);
  9916. for (auto it = rng.first; it != rng.second; it++) {
  9917. values.push_back(it->second.content);
  9918. }
  9919. return values;
  9920. }
  9921. inline bool MultipartFormData::has_field(const std::string &key) const {
  9922. return fields.find(key) != fields.end();
  9923. }
  9924. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9925. return fields.count(key);
  9926. }
  9927. inline FormData MultipartFormData::get_file(const std::string &key,
  9928. size_t id) const {
  9929. return detail::get_multimap_value(files, key, id);
  9930. }
  9931. inline std::vector<FormData>
  9932. MultipartFormData::get_files(const std::string &key) const {
  9933. std::vector<FormData> values;
  9934. auto rng = files.equal_range(key);
  9935. for (auto it = rng.first; it != rng.second; it++) {
  9936. values.push_back(it->second);
  9937. }
  9938. return values;
  9939. }
  9940. inline bool MultipartFormData::has_file(const std::string &key) const {
  9941. return files.find(key) != files.end();
  9942. }
  9943. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9944. return files.count(key);
  9945. }
  9946. // Multipart FormData writer implementation
  9947. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9948. return detail::is_multipart_boundary_chars_valid(boundary);
  9949. }
  9950. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9951. : boundary_(detail::make_multipart_data_boundary()) {}
  9952. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9953. : boundary_(std::move(boundary)) {}
  9954. inline const std::string &MultipartFormDataWriter::boundary() const {
  9955. return boundary_;
  9956. }
  9957. inline std::string MultipartFormDataWriter::content_type() const {
  9958. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9959. }
  9960. inline std::string
  9961. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9962. return detail::serialize_multipart_formdata(items, boundary_);
  9963. }
  9964. inline size_t MultipartFormDataWriter::content_length(
  9965. const UploadFormDataItems &items) const {
  9966. return detail::get_multipart_content_length(items, boundary_);
  9967. }
  9968. inline std::string
  9969. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9970. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9971. }
  9972. inline std::string MultipartFormDataWriter::item_end() {
  9973. return detail::serialize_multipart_formdata_item_end();
  9974. }
  9975. inline std::string MultipartFormDataWriter::finish() const {
  9976. return detail::serialize_multipart_formdata_finish(boundary_);
  9977. }
  9978. // Response implementation
  9979. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9980. size_t id) const {
  9981. return detail::get_header_value_u64(headers, key, def, id);
  9982. }
  9983. inline bool Response::has_header(const std::string &key) const {
  9984. return headers.find(key) != headers.end();
  9985. }
  9986. inline std::string Response::get_header_value(const std::string &key,
  9987. const char *def,
  9988. size_t id) const {
  9989. return detail::get_header_value(headers, key, def, id);
  9990. }
  9991. inline size_t Response::get_header_value_count(const std::string &key) const {
  9992. return detail::get_header_value_count(headers, key);
  9993. }
  9994. inline void Response::set_header(const std::string &key,
  9995. const std::string &val) {
  9996. detail::set_header(headers, key, val);
  9997. }
  9998. inline bool Response::has_trailer(const std::string &key) const {
  9999. return trailers.find(key) != trailers.end();
  10000. }
  10001. inline std::string Response::get_trailer_value(const std::string &key,
  10002. size_t id) const {
  10003. return detail::get_multimap_value(trailers, key, id);
  10004. }
  10005. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10006. return trailers.count(key);
  10007. }
  10008. inline void Response::set_redirect(const std::string &url, int stat) {
  10009. if (detail::fields::is_field_value(url)) {
  10010. set_header("Location", url);
  10011. if (300 <= stat && stat < 400) {
  10012. this->status = stat;
  10013. } else {
  10014. this->status = StatusCode::Found_302;
  10015. }
  10016. }
  10017. }
  10018. inline void Response::set_content(const char *s, size_t n,
  10019. const std::string &content_type) {
  10020. body.assign(s, n);
  10021. auto rng = headers.equal_range("Content-Type");
  10022. headers.erase(rng.first, rng.second);
  10023. set_header("Content-Type", content_type);
  10024. content_coding_ = detail::EncodingType::None;
  10025. }
  10026. inline void Response::set_content(const std::string &s,
  10027. const std::string &content_type) {
  10028. set_content(s.data(), s.size(), content_type);
  10029. }
  10030. inline void Response::set_content(std::string &&s,
  10031. const std::string &content_type) {
  10032. body = std::move(s);
  10033. auto rng = headers.equal_range("Content-Type");
  10034. headers.erase(rng.first, rng.second);
  10035. set_header("Content-Type", content_type);
  10036. content_coding_ = detail::EncodingType::None;
  10037. }
  10038. inline void Response::set_content_provider(
  10039. size_t in_length, const std::string &content_type, ContentProvider provider,
  10040. ContentProviderResourceReleaser resource_releaser) {
  10041. set_header("Content-Type", content_type);
  10042. content_length_ = in_length;
  10043. if (in_length > 0) { content_provider_ = std::move(provider); }
  10044. content_provider_resource_releaser_ = std::move(resource_releaser);
  10045. is_chunked_content_provider_ = false;
  10046. is_file_content_provider_ = false;
  10047. content_coding_ = detail::EncodingType::None;
  10048. }
  10049. inline void Response::set_content_provider(
  10050. const std::string &content_type, ContentProviderWithoutLength provider,
  10051. ContentProviderResourceReleaser resource_releaser) {
  10052. set_header("Content-Type", content_type);
  10053. content_length_ = 0;
  10054. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10055. content_provider_resource_releaser_ = std::move(resource_releaser);
  10056. is_chunked_content_provider_ = false;
  10057. is_file_content_provider_ = false;
  10058. content_coding_ = detail::EncodingType::None;
  10059. }
  10060. inline void Response::set_chunked_content_provider(
  10061. const std::string &content_type, ContentProviderWithoutLength provider,
  10062. ContentProviderResourceReleaser resource_releaser) {
  10063. set_header("Content-Type", content_type);
  10064. content_length_ = 0;
  10065. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10066. content_provider_resource_releaser_ = std::move(resource_releaser);
  10067. is_chunked_content_provider_ = true;
  10068. is_file_content_provider_ = false;
  10069. content_coding_ = detail::EncodingType::None;
  10070. }
  10071. inline void Response::set_file_content(const std::string &path,
  10072. const std::string &content_type) {
  10073. file_content_path_ = path;
  10074. file_content_content_type_ = content_type;
  10075. }
  10076. inline void Response::set_file_content(const std::string &path) {
  10077. file_content_path_ = path;
  10078. }
  10079. // Result implementation
  10080. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10081. size_t def,
  10082. size_t id) const {
  10083. return detail::get_header_value_u64(request_headers_, key, def, id);
  10084. }
  10085. inline bool Result::has_request_header(const std::string &key) const {
  10086. return request_headers_.find(key) != request_headers_.end();
  10087. }
  10088. inline std::string Result::get_request_header_value(const std::string &key,
  10089. const char *def,
  10090. size_t id) const {
  10091. return detail::get_header_value(request_headers_, key, def, id);
  10092. }
  10093. inline size_t
  10094. Result::get_request_header_value_count(const std::string &key) const {
  10095. return request_headers_.count(key);
  10096. }
  10097. // Stream implementation
  10098. inline ssize_t Stream::write(const char *ptr) {
  10099. return write(ptr, strlen(ptr));
  10100. }
  10101. inline ssize_t Stream::write(const std::string &s) {
  10102. return write(s.data(), s.size());
  10103. }
  10104. // BodyReader implementation
  10105. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10106. if (!stream) {
  10107. last_error = Error::Connection;
  10108. return -1;
  10109. }
  10110. if (eof) { return 0; }
  10111. if (!chunked) {
  10112. // Content-Length based reading
  10113. if (has_content_length && bytes_read >= content_length) {
  10114. eof = true;
  10115. return 0;
  10116. }
  10117. auto to_read = len;
  10118. if (has_content_length) {
  10119. auto remaining = content_length - bytes_read;
  10120. to_read = (std::min)(len, remaining);
  10121. }
  10122. auto n = stream->read(buf, to_read);
  10123. if (n < 0) {
  10124. last_error = stream->get_error();
  10125. if (last_error == Error::Success) { last_error = Error::Read; }
  10126. eof = true;
  10127. return n;
  10128. }
  10129. if (n == 0) {
  10130. // Unexpected EOF before content_length
  10131. last_error = stream->get_error();
  10132. if (last_error == Error::Success) { last_error = Error::Read; }
  10133. eof = true;
  10134. return 0;
  10135. }
  10136. bytes_read += static_cast<size_t>(n);
  10137. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10138. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10139. last_error = Error::ExceedMaxPayloadSize;
  10140. eof = true;
  10141. return -1;
  10142. }
  10143. return n;
  10144. }
  10145. // Chunked transfer encoding: delegate to shared decoder instance.
  10146. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10147. size_t chunk_offset = 0;
  10148. size_t chunk_total = 0;
  10149. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10150. if (n < 0) {
  10151. last_error = stream->get_error();
  10152. if (last_error == Error::Success) { last_error = Error::Read; }
  10153. eof = true;
  10154. return n;
  10155. }
  10156. if (n == 0) {
  10157. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10158. eof = true;
  10159. return 0;
  10160. }
  10161. bytes_read += static_cast<size_t>(n);
  10162. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10163. last_error = Error::ExceedMaxPayloadSize;
  10164. eof = true;
  10165. return -1;
  10166. }
  10167. return n;
  10168. }
  10169. // ThreadPool implementation
  10170. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10171. time_t idle_timeout_sec)
  10172. : base_thread_count_(n), max_queued_requests_(mqr),
  10173. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10174. shutdown_(false) {
  10175. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10176. if (max_n != 0 && max_n < n) {
  10177. std::string msg = "max_threads must be >= base_threads";
  10178. throw std::invalid_argument(msg);
  10179. }
  10180. #endif
  10181. max_thread_count_ = max_n == 0 ? n : max_n;
  10182. threads_.reserve(base_thread_count_);
  10183. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10184. try {
  10185. #endif
  10186. for (size_t i = 0; i < base_thread_count_; i++) {
  10187. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10188. }
  10189. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10190. } catch (...) {
  10191. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10192. // signal the workers we already spawned to exit and join them so the
  10193. // vector destructor does not see joinable threads (which would call
  10194. // std::terminate). Then rethrow so the caller learns of the failure.
  10195. {
  10196. std::unique_lock<std::mutex> lock(mutex_);
  10197. shutdown_ = true;
  10198. }
  10199. cond_.notify_all();
  10200. for (auto &t : threads_) {
  10201. if (t.joinable()) { t.join(); }
  10202. }
  10203. throw;
  10204. }
  10205. #endif
  10206. }
  10207. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10208. {
  10209. std::unique_lock<std::mutex> lock(mutex_);
  10210. if (shutdown_) { return false; }
  10211. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10212. return false;
  10213. }
  10214. jobs_.push_back(std::move(fn));
  10215. // Spawn a dynamic thread if no idle threads and under max
  10216. if (idle_thread_count_ == 0 &&
  10217. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10218. cleanup_finished_threads();
  10219. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10220. }
  10221. }
  10222. cond_.notify_one();
  10223. return true;
  10224. }
  10225. inline void ThreadPool::shutdown() {
  10226. {
  10227. std::unique_lock<std::mutex> lock(mutex_);
  10228. shutdown_ = true;
  10229. }
  10230. cond_.notify_all();
  10231. for (auto &t : threads_) {
  10232. if (t.joinable()) { t.join(); }
  10233. }
  10234. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10235. // with worker threads that call move_to_finished() concurrently.
  10236. std::list<std::thread> remaining_dynamic;
  10237. {
  10238. std::unique_lock<std::mutex> lock(mutex_);
  10239. remaining_dynamic = std::move(dynamic_threads_);
  10240. }
  10241. for (auto &t : remaining_dynamic) {
  10242. if (t.joinable()) { t.join(); }
  10243. }
  10244. std::unique_lock<std::mutex> lock(mutex_);
  10245. cleanup_finished_threads();
  10246. }
  10247. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10248. // Must be called with mutex_ held
  10249. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10250. if (it->get_id() == id) {
  10251. finished_threads_.push_back(std::move(*it));
  10252. dynamic_threads_.erase(it);
  10253. return;
  10254. }
  10255. }
  10256. }
  10257. inline void ThreadPool::cleanup_finished_threads() {
  10258. // Must be called with mutex_ held
  10259. for (auto &t : finished_threads_) {
  10260. if (t.joinable()) { t.join(); }
  10261. }
  10262. finished_threads_.clear();
  10263. }
  10264. inline void ThreadPool::worker(bool is_dynamic) {
  10265. for (;;) {
  10266. std::function<void()> fn;
  10267. {
  10268. std::unique_lock<std::mutex> lock(mutex_);
  10269. idle_thread_count_++;
  10270. if (is_dynamic) {
  10271. auto has_work =
  10272. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10273. [&] { return !jobs_.empty() || shutdown_; });
  10274. if (!has_work) {
  10275. // Timed out with no work - exit this dynamic thread
  10276. idle_thread_count_--;
  10277. move_to_finished(std::this_thread::get_id());
  10278. break;
  10279. }
  10280. } else {
  10281. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10282. }
  10283. idle_thread_count_--;
  10284. if (shutdown_ && jobs_.empty()) { break; }
  10285. fn = std::move(jobs_.front());
  10286. jobs_.pop_front();
  10287. }
  10288. assert(true == static_cast<bool>(fn));
  10289. fn();
  10290. }
  10291. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10292. !defined(LIBRESSL_VERSION_NUMBER)
  10293. OPENSSL_thread_stop();
  10294. #endif
  10295. }
  10296. /*
  10297. * Group 1 (continued): detail namespace - Stream implementations
  10298. */
  10299. namespace detail {
  10300. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10301. time_t timeout_sec, time_t timeout_usec,
  10302. time_t &actual_timeout_sec,
  10303. time_t &actual_timeout_usec) {
  10304. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10305. auto actual_timeout_msec =
  10306. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10307. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10308. actual_timeout_sec = actual_timeout_msec / 1000;
  10309. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10310. }
  10311. // Socket stream implementation
  10312. inline SocketStream::SocketStream(
  10313. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10314. time_t write_timeout_sec, time_t write_timeout_usec,
  10315. time_t max_timeout_msec,
  10316. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10317. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10318. read_timeout_usec_(read_timeout_usec),
  10319. write_timeout_sec_(write_timeout_sec),
  10320. write_timeout_usec_(write_timeout_usec),
  10321. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10322. read_buff_(read_buff_size_, 0) {}
  10323. inline SocketStream::~SocketStream() = default;
  10324. inline bool SocketStream::is_readable() const {
  10325. return read_buff_off_ < read_buff_content_size_;
  10326. }
  10327. inline bool SocketStream::wait_readable() const {
  10328. if (max_timeout_msec_ <= 0) {
  10329. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10330. }
  10331. time_t read_timeout_sec;
  10332. time_t read_timeout_usec;
  10333. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10334. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10335. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10336. }
  10337. inline bool SocketStream::wait_writable() const {
  10338. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10339. }
  10340. inline bool SocketStream::ensure_readable() {
  10341. if (readable_hint_) {
  10342. readable_hint_ = false;
  10343. return true;
  10344. }
  10345. return wait_readable();
  10346. }
  10347. inline const char *SocketStream::buffered_data(size_t &size) const {
  10348. size = read_buff_content_size_ - read_buff_off_;
  10349. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10350. }
  10351. inline void SocketStream::consume_buffered(size_t size) {
  10352. assert(size <= read_buff_content_size_ - read_buff_off_);
  10353. read_buff_off_ += size;
  10354. }
  10355. inline bool SocketStream::is_peer_alive() const {
  10356. return detail::is_socket_alive(sock_);
  10357. }
  10358. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10359. #ifdef _WIN32
  10360. size =
  10361. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10362. #else
  10363. size = (std::min)(size,
  10364. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10365. #endif
  10366. if (read_buff_off_ < read_buff_content_size_) {
  10367. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10368. if (size <= remaining_size) {
  10369. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10370. read_buff_off_ += size;
  10371. return static_cast<ssize_t>(size);
  10372. } else {
  10373. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10374. read_buff_off_ += remaining_size;
  10375. return static_cast<ssize_t>(remaining_size);
  10376. }
  10377. }
  10378. if (!ensure_readable()) {
  10379. error_ = Error::Timeout;
  10380. return -1;
  10381. }
  10382. read_buff_off_ = 0;
  10383. read_buff_content_size_ = 0;
  10384. if (size < read_buff_size_) {
  10385. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10386. CPPHTTPLIB_RECV_FLAGS);
  10387. if (n <= 0) {
  10388. if (n == 0) {
  10389. error_ = Error::ConnectionClosed;
  10390. } else {
  10391. error_ = Error::Read;
  10392. }
  10393. return n;
  10394. } else if (n <= static_cast<ssize_t>(size)) {
  10395. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10396. return n;
  10397. } else {
  10398. memcpy(ptr, read_buff_.data(), size);
  10399. read_buff_off_ = size;
  10400. read_buff_content_size_ = static_cast<size_t>(n);
  10401. return static_cast<ssize_t>(size);
  10402. }
  10403. } else {
  10404. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10405. if (n <= 0) {
  10406. if (n == 0) {
  10407. error_ = Error::ConnectionClosed;
  10408. } else {
  10409. error_ = Error::Read;
  10410. }
  10411. }
  10412. return n;
  10413. }
  10414. }
  10415. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10416. if (!wait_writable()) { return -1; }
  10417. #if defined(_WIN32) && !defined(_WIN64)
  10418. size =
  10419. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10420. #endif
  10421. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10422. }
  10423. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10424. int &port) const {
  10425. return detail::get_remote_ip_and_port(sock_, ip, port);
  10426. }
  10427. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10428. int &port) const {
  10429. return detail::get_local_ip_and_port(sock_, ip, port);
  10430. }
  10431. inline socket_t SocketStream::socket() const { return sock_; }
  10432. inline time_t SocketStream::duration() const {
  10433. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10434. std::chrono::steady_clock::now() - start_time_)
  10435. .count();
  10436. }
  10437. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10438. read_timeout_sec_ = sec;
  10439. read_timeout_usec_ = usec;
  10440. }
  10441. // Buffer stream implementation
  10442. inline bool BufferStream::is_readable() const { return true; }
  10443. inline bool BufferStream::wait_readable() const { return true; }
  10444. inline bool BufferStream::wait_writable() const { return true; }
  10445. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10446. #if defined(_MSC_VER) && _MSC_VER < 1910
  10447. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10448. #else
  10449. auto len_read = buffer.copy(ptr, size, position);
  10450. #endif
  10451. position += static_cast<size_t>(len_read);
  10452. return static_cast<ssize_t>(len_read);
  10453. }
  10454. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10455. buffer.append(ptr, size);
  10456. return static_cast<ssize_t>(size);
  10457. }
  10458. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10459. int & /*port*/) const {}
  10460. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10461. int & /*port*/) const {}
  10462. inline socket_t BufferStream::socket() const { return 0; }
  10463. inline time_t BufferStream::duration() const { return 0; }
  10464. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10465. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10466. : MatcherBase(pattern) {
  10467. constexpr const char marker[] = "/:";
  10468. // One past the last ending position of a path param substring
  10469. std::size_t last_param_end = 0;
  10470. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10471. // Needed to ensure that parameter names are unique during matcher
  10472. // construction
  10473. // If exceptions are disabled, only last duplicate path
  10474. // parameter will be set
  10475. std::unordered_set<std::string> param_name_set;
  10476. #endif
  10477. while (true) {
  10478. const auto marker_pos = pattern.find(
  10479. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10480. if (marker_pos == std::string::npos) { break; }
  10481. static_fragments_.push_back(
  10482. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10483. const auto param_name_start = marker_pos + str_len(marker);
  10484. auto sep_pos = pattern.find(separator, param_name_start);
  10485. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10486. auto param_name =
  10487. pattern.substr(param_name_start, sep_pos - param_name_start);
  10488. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10489. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10490. std::string msg = "Encountered path parameter '" + param_name +
  10491. "' multiple times in route pattern '" + pattern + "'.";
  10492. throw std::invalid_argument(msg);
  10493. }
  10494. #endif
  10495. param_names_.push_back(std::move(param_name));
  10496. last_param_end = sep_pos + 1;
  10497. }
  10498. if (last_param_end < pattern.length()) {
  10499. static_fragments_.push_back(pattern.substr(last_param_end));
  10500. }
  10501. }
  10502. inline bool PathParamsMatcher::match(Request &request) const {
  10503. request.matches = std::smatch();
  10504. request.path_params.clear();
  10505. // A pattern without parameters is just a literal path to compare against
  10506. if (param_names_.empty()) { return request.path == pattern(); }
  10507. request.path_params.reserve(param_names_.size());
  10508. // One past the position at which the path matched the pattern last time
  10509. std::size_t starting_pos = 0;
  10510. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10511. const auto &fragment = static_fragments_[i];
  10512. if (starting_pos + fragment.length() > request.path.length()) {
  10513. return false;
  10514. }
  10515. // Avoid unnecessary allocation by using strncmp instead of substr +
  10516. // comparison
  10517. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10518. fragment.length()) != 0) {
  10519. return false;
  10520. }
  10521. starting_pos += fragment.length();
  10522. // Should only happen when we have a static fragment after a param
  10523. // Example: '/users/:id/subscriptions'
  10524. // The 'subscriptions' fragment here does not have a corresponding param
  10525. if (i >= param_names_.size()) { continue; }
  10526. auto sep_pos = request.path.find(separator, starting_pos);
  10527. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10528. const auto &param_name = param_names_[i];
  10529. request.path_params.emplace(
  10530. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10531. // Mark everything up to '/' as matched
  10532. starting_pos = sep_pos + 1;
  10533. }
  10534. // Returns false if the path is longer than the pattern
  10535. return starting_pos >= request.path.length();
  10536. }
  10537. inline bool RegexMatcher::match(Request &request) const {
  10538. request.path_params.clear();
  10539. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10540. // a non-match rather than risking a stack overflow in std::regex_match.
  10541. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10542. return false;
  10543. }
  10544. return std::regex_match(request.path, request.matches, regex_);
  10545. }
  10546. // Enclose IPv6 address in brackets if needed
  10547. inline std::string prepare_host_string(const std::string &host) {
  10548. // Enclose IPv6 address in brackets (but not if already enclosed)
  10549. if (host.find(':') == std::string::npos ||
  10550. (!host.empty() && host[0] == '[')) {
  10551. // IPv4, hostname, or already bracketed IPv6
  10552. return host;
  10553. } else {
  10554. // IPv6 address without brackets
  10555. return "[" + host + "]";
  10556. }
  10557. }
  10558. inline std::string make_host_and_port_string(const std::string &host, int port,
  10559. bool is_ssl) {
  10560. auto result = prepare_host_string(host);
  10561. // Append port if not default
  10562. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10563. ; // do nothing
  10564. } else {
  10565. result += ":" + std::to_string(port);
  10566. }
  10567. return result;
  10568. }
  10569. // Create "host:port" string always including port number (for CONNECT method)
  10570. inline std::string
  10571. make_host_and_port_string_always_port(const std::string &host, int port) {
  10572. return prepare_host_string(host) + ":" + std::to_string(port);
  10573. }
  10574. // Value for the Host header a client sends when the caller supplied none.
  10575. // Only the value: callers decide where in their header list it goes.
  10576. inline std::string make_default_host_header_value(const std::string &host,
  10577. int port, bool is_ssl,
  10578. int address_family) {
  10579. if (address_family == AF_UNIX) { return "localhost"; }
  10580. return make_host_and_port_string(host, port, is_ssl);
  10581. }
  10582. inline void add_default_user_agent_header(Request &req) {
  10583. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10584. if (!req.has_header("User-Agent")) {
  10585. req.set_header("User-Agent",
  10586. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10587. }
  10588. #else
  10589. (void)req;
  10590. #endif
  10591. }
  10592. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10593. NormalizedTarget normalize_target(const std::string &host);
  10594. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10595. bool host_matches_no_proxy(const NormalizedTarget &target,
  10596. const std::vector<NoProxyEntry> &entries);
  10597. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10598. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10599. if (prefix_bits == 0) { return true; }
  10600. int full_bytes = prefix_bits / 8;
  10601. int rem_bits = prefix_bits % 8;
  10602. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10603. static_cast<size_t>(full_bytes)) != 0) {
  10604. return false;
  10605. }
  10606. if (rem_bits == 0) { return true; }
  10607. auto i = static_cast<size_t>(full_bytes);
  10608. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10609. return (ip[i] & mask) == (net[i] & mask);
  10610. }
  10611. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10612. if (token.empty()) { return false; }
  10613. if (token == "*") {
  10614. out.kind = NoProxyKind::Wildcard;
  10615. return true;
  10616. }
  10617. auto slash = token.find('/');
  10618. std::string addr_part =
  10619. (slash == std::string::npos) ? token : token.substr(0, slash);
  10620. std::string prefix_part =
  10621. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10622. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10623. // don't silently treat it as a /32 (or /128).
  10624. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10625. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10626. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10627. // when brackets are present.
  10628. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10629. addr_part.back() == ']';
  10630. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10631. if (!bracketed) {
  10632. struct in_addr v4;
  10633. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10634. int prefix = 32;
  10635. if (!prefix_part.empty() &&
  10636. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10637. prefix)) {
  10638. return false;
  10639. }
  10640. out.kind = NoProxyKind::IPv4Cidr;
  10641. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10642. out.prefix_bits = prefix;
  10643. return true;
  10644. }
  10645. }
  10646. struct in6_addr v6;
  10647. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10648. int prefix = 128;
  10649. if (!prefix_part.empty() &&
  10650. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10651. prefix)) {
  10652. return false;
  10653. }
  10654. out.kind = NoProxyKind::IPv6Cidr;
  10655. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10656. out.prefix_bits = prefix;
  10657. return true;
  10658. }
  10659. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10660. // the entry is malformed — don't fall through to the hostname branch.
  10661. if (bracketed) { return false; }
  10662. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10663. if (slash != std::string::npos) { return false; }
  10664. // Port-specific entries (host:port) are not supported.
  10665. if (token.find(':') != std::string::npos) { return false; }
  10666. std::string hostname = case_ignore::to_lower(token);
  10667. while (!hostname.empty() && hostname.front() == '.') {
  10668. hostname.erase(hostname.begin());
  10669. }
  10670. while (!hostname.empty() && hostname.back() == '.') {
  10671. hostname.pop_back();
  10672. }
  10673. if (hostname.empty()) { return false; }
  10674. out.kind = NoProxyKind::HostnameSuffix;
  10675. out.hostname_pattern = std::move(hostname);
  10676. return true;
  10677. }
  10678. inline NormalizedTarget normalize_target(const std::string &host) {
  10679. NormalizedTarget t;
  10680. std::string h = host;
  10681. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10682. h = h.substr(1, h.size() - 2);
  10683. }
  10684. // Strip a single trailing dot so "example.com." canonicalizes to
  10685. // "example.com".
  10686. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10687. t.hostname = case_ignore::to_lower(h);
  10688. if (!t.hostname.empty()) {
  10689. struct in_addr v4;
  10690. struct in6_addr v6;
  10691. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10692. t.is_ipv4 = true;
  10693. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10694. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10695. t.is_ipv6 = true;
  10696. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10697. }
  10698. }
  10699. return t;
  10700. }
  10701. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10702. const std::vector<NoProxyEntry> &entries) {
  10703. if (target.hostname.empty()) { return false; }
  10704. for (const auto &e : entries) {
  10705. switch (e.kind) {
  10706. case NoProxyKind::Wildcard: return true;
  10707. case NoProxyKind::IPv4Cidr:
  10708. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10709. return true;
  10710. }
  10711. break;
  10712. case NoProxyKind::IPv6Cidr:
  10713. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10714. return true;
  10715. }
  10716. break;
  10717. case NoProxyKind::HostnameSuffix:
  10718. if (target.is_ipv4 || target.is_ipv6) { break; }
  10719. if (target.hostname == e.hostname_pattern) { return true; }
  10720. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10721. // an entry of "example.com".
  10722. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10723. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10724. if (target.hostname[offset - 1] == '.' &&
  10725. target.hostname.compare(offset, e.hostname_pattern.size(),
  10726. e.hostname_pattern) == 0) {
  10727. return true;
  10728. }
  10729. }
  10730. break;
  10731. }
  10732. }
  10733. return false;
  10734. }
  10735. template <typename T>
  10736. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10737. T header_writer, Error &error) {
  10738. for (const auto &h : headers) {
  10739. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10740. error = Error::InvalidHeaders;
  10741. return false;
  10742. }
  10743. }
  10744. if (header_writer(strm, headers) <= 0) {
  10745. error = Error::Write;
  10746. return false;
  10747. }
  10748. return true;
  10749. }
  10750. } // namespace detail
  10751. /*
  10752. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10753. */
  10754. #ifdef CPPHTTPLIB_SSL_ENABLED
  10755. namespace detail {
  10756. // SSL socket stream implementation
  10757. inline SSLSocketStream::SSLSocketStream(
  10758. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10759. time_t read_timeout_usec, time_t write_timeout_sec,
  10760. time_t write_timeout_usec, time_t max_timeout_msec,
  10761. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10762. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10763. read_timeout_usec_(read_timeout_usec),
  10764. write_timeout_sec_(write_timeout_sec),
  10765. write_timeout_usec_(write_timeout_usec),
  10766. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10767. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10768. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10769. // Note: create_session() also clears this, but SSLClient currently
  10770. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10771. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10772. // SSL session was created.
  10773. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10774. #endif
  10775. }
  10776. inline SSLSocketStream::~SSLSocketStream() = default;
  10777. inline bool SSLSocketStream::is_readable() const {
  10778. return tls::pending(session_) > 0;
  10779. }
  10780. inline bool SSLSocketStream::wait_readable() const {
  10781. if (max_timeout_msec_ <= 0) {
  10782. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10783. }
  10784. time_t read_timeout_sec;
  10785. time_t read_timeout_usec;
  10786. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10787. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10788. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10789. }
  10790. inline bool SSLSocketStream::wait_writable() const {
  10791. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10792. !tls::is_peer_closed(session_, sock_);
  10793. }
  10794. inline bool SSLSocketStream::ensure_readable() {
  10795. if (readable_hint_) {
  10796. readable_hint_ = false;
  10797. return true;
  10798. }
  10799. return wait_readable();
  10800. }
  10801. inline bool SSLSocketStream::is_peer_alive() const {
  10802. return !tls::is_peer_closed(session_, sock_);
  10803. }
  10804. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10805. if (tls::pending(session_) > 0) {
  10806. tls::TlsError err;
  10807. auto ret = tls::read(session_, ptr, size, err);
  10808. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10809. error_ = Error::ConnectionClosed;
  10810. }
  10811. return ret;
  10812. } else if (ensure_readable()) {
  10813. tls::TlsError err;
  10814. auto ret = tls::read(session_, ptr, size, err);
  10815. if (ret < 0) {
  10816. auto n = 1000;
  10817. #ifdef _WIN32
  10818. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10819. (err.code == tls::ErrorCode::SyscallError &&
  10820. WSAGetLastError() == WSAETIMEDOUT))) {
  10821. #else
  10822. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10823. #endif
  10824. if (tls::pending(session_) > 0) {
  10825. return tls::read(session_, ptr, size, err);
  10826. } else if (wait_readable()) {
  10827. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10828. ret = tls::read(session_, ptr, size, err);
  10829. if (ret >= 0) { return ret; }
  10830. } else {
  10831. break;
  10832. }
  10833. }
  10834. assert(ret < 0);
  10835. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10836. error_ = Error::ConnectionClosed;
  10837. }
  10838. return ret;
  10839. } else {
  10840. error_ = Error::Timeout;
  10841. return -1;
  10842. }
  10843. }
  10844. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10845. if (wait_writable()) {
  10846. auto handle_size =
  10847. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10848. tls::TlsError err;
  10849. auto ret = tls::write(session_, ptr, handle_size, err);
  10850. if (ret < 0) {
  10851. auto n = 1000;
  10852. #ifdef _WIN32
  10853. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10854. (err.code == tls::ErrorCode::SyscallError &&
  10855. WSAGetLastError() == WSAETIMEDOUT))) {
  10856. #else
  10857. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10858. #endif
  10859. if (wait_writable()) {
  10860. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10861. ret = tls::write(session_, ptr, handle_size, err);
  10862. if (ret >= 0) { return ret; }
  10863. } else {
  10864. break;
  10865. }
  10866. }
  10867. assert(ret < 0);
  10868. }
  10869. return ret;
  10870. }
  10871. return -1;
  10872. }
  10873. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10874. int &port) const {
  10875. detail::get_remote_ip_and_port(sock_, ip, port);
  10876. }
  10877. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10878. int &port) const {
  10879. detail::get_local_ip_and_port(sock_, ip, port);
  10880. }
  10881. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10882. inline time_t SSLSocketStream::duration() const {
  10883. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10884. std::chrono::steady_clock::now() - start_time_)
  10885. .count();
  10886. }
  10887. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10888. read_timeout_sec_ = sec;
  10889. read_timeout_usec_ = usec;
  10890. }
  10891. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10892. tls::session_t session,
  10893. time_t read_timeout_sec,
  10894. time_t read_timeout_usec,
  10895. time_t write_timeout_sec,
  10896. time_t write_timeout_usec)
  10897. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10898. read_timeout_usec_(read_timeout_usec),
  10899. write_timeout_sec_(write_timeout_sec),
  10900. write_timeout_usec_(write_timeout_usec),
  10901. start_time_(std::chrono::steady_clock::now()) {
  10902. // The receive and send paths run on different threads, so each TLS call is
  10903. // driven in non-blocking mode and readiness is awaited with select()
  10904. // outside the session lock. Set the socket non-blocking once here; it is
  10905. // never flipped back, so no thread races on the flag.
  10906. detail::set_nonblocking(sock_, true);
  10907. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10908. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10909. #endif
  10910. }
  10911. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10912. inline bool WebSocketSSLStream::is_readable() const {
  10913. std::lock_guard<std::mutex> guard(session_mutex_);
  10914. return tls::pending(session_) > 0;
  10915. }
  10916. inline bool WebSocketSSLStream::wait_readable() const {
  10917. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10918. }
  10919. inline bool WebSocketSSLStream::wait_writable() const {
  10920. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10921. // that probe toggles the socket's blocking flag, which would race with the
  10922. // concurrent reader on a permanently non-blocking socket.
  10923. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10924. }
  10925. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10926. tls::TlsError err;
  10927. auto n = 1000;
  10928. while (--n >= 0) {
  10929. {
  10930. std::lock_guard<std::mutex> guard(session_mutex_);
  10931. auto ret = tls::read(session_, ptr, size, err);
  10932. if (ret > 0) { return ret; }
  10933. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10934. error_ = Error::ConnectionClosed;
  10935. return ret;
  10936. }
  10937. }
  10938. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10939. // direction: the send path shares this session, so output it left pending
  10940. // has to be flushed before more input can be decrypted. Anything else is
  10941. // a hard error.
  10942. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10943. #ifdef _WIN32
  10944. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10945. needs_readable =
  10946. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10947. WSAGetLastError() == WSAETIMEDOUT);
  10948. #endif
  10949. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10950. error_ = Error::Read;
  10951. return -1;
  10952. }
  10953. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10954. error_ = Error::Timeout;
  10955. return -1;
  10956. }
  10957. }
  10958. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10959. // to tell a timeout from a close would otherwise see whatever the previous
  10960. // failure left behind (error_ is never cleared on success).
  10961. error_ = Error::Read;
  10962. return -1;
  10963. }
  10964. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10965. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10966. tls::TlsError err;
  10967. auto n = 1000;
  10968. while (--n >= 0) {
  10969. {
  10970. std::lock_guard<std::mutex> guard(session_mutex_);
  10971. auto ret = tls::write(session_, ptr, handle_size, err);
  10972. if (ret >= 0) { return ret; }
  10973. }
  10974. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10975. // or a post-handshake message must be consumed before the record goes
  10976. // out. Anything else is a hard error.
  10977. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10978. #ifdef _WIN32
  10979. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10980. needs_writable =
  10981. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10982. WSAGetLastError() == WSAETIMEDOUT);
  10983. #endif
  10984. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10985. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10986. }
  10987. return -1;
  10988. }
  10989. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10990. int &port) const {
  10991. detail::get_remote_ip_and_port(sock_, ip, port);
  10992. }
  10993. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10994. int &port) const {
  10995. detail::get_local_ip_and_port(sock_, ip, port);
  10996. }
  10997. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10998. inline time_t WebSocketSSLStream::duration() const {
  10999. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11000. std::chrono::steady_clock::now() - start_time_)
  11001. .count();
  11002. }
  11003. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11004. read_timeout_sec_ = sec;
  11005. read_timeout_usec_ = usec;
  11006. }
  11007. } // namespace detail
  11008. #endif // CPPHTTPLIB_SSL_ENABLED
  11009. /*
  11010. * Group 4: Server implementation
  11011. */
  11012. // HTTP server implementation
  11013. inline Server::Server()
  11014. : new_task_queue([] {
  11015. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11016. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11017. }) {
  11018. #ifndef _WIN32
  11019. signal(SIGPIPE, SIG_IGN);
  11020. #endif
  11021. }
  11022. inline Server::~Server() = default;
  11023. inline std::unique_ptr<detail::MatcherBase>
  11024. Server::make_matcher(const std::string &pattern) {
  11025. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11026. // a path params pattern
  11027. if (pattern.find("/:") != std::string::npos) {
  11028. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11029. }
  11030. // A pattern with no regex metacharacter only has to be compared literally,
  11031. // which is what PathParamsMatcher already does when it captures no
  11032. // parameter, so std::regex is only worth building for the patterns that
  11033. // actually need it
  11034. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11035. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11036. }
  11037. return detail::make_unique<detail::RegexMatcher>(pattern);
  11038. }
  11039. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11040. return add_handler(get_handlers_, pattern, std::move(handler));
  11041. }
  11042. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11043. return add_handler(post_handlers_, pattern, std::move(handler));
  11044. }
  11045. inline Server &Server::Post(const std::string &pattern,
  11046. HandlerWithContentReader handler) {
  11047. return add_handler(post_handlers_for_content_reader_, pattern,
  11048. std::move(handler));
  11049. }
  11050. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11051. return add_handler(put_handlers_, pattern, std::move(handler));
  11052. }
  11053. inline Server &Server::Put(const std::string &pattern,
  11054. HandlerWithContentReader handler) {
  11055. return add_handler(put_handlers_for_content_reader_, pattern,
  11056. std::move(handler));
  11057. }
  11058. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11059. return add_handler(patch_handlers_, pattern, std::move(handler));
  11060. }
  11061. inline Server &Server::Patch(const std::string &pattern,
  11062. HandlerWithContentReader handler) {
  11063. return add_handler(patch_handlers_for_content_reader_, pattern,
  11064. std::move(handler));
  11065. }
  11066. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11067. return add_handler(delete_handlers_, pattern, std::move(handler));
  11068. }
  11069. inline Server &Server::Delete(const std::string &pattern,
  11070. HandlerWithContentReader handler) {
  11071. return add_handler(delete_handlers_for_content_reader_, pattern,
  11072. std::move(handler));
  11073. }
  11074. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11075. return add_handler(options_handlers_, pattern, std::move(handler));
  11076. }
  11077. inline const std::set<std::string> &Server::builtin_methods() {
  11078. thread_local const std::set<std::string> methods{
  11079. "GET", "HEAD", "POST", "PUT", "DELETE",
  11080. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11081. return methods;
  11082. }
  11083. inline Server::CustomHandlerEntry *
  11084. Server::custom_entry_for_registration(const std::string &method) {
  11085. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11086. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11087. // routing() before the custom tables are consulted, so a route registered
  11088. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11089. // there and would be reachable, but they carry protocol-level meaning
  11090. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11091. // library does not route.
  11092. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11093. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11094. has_invalid_registration_ = true;
  11095. return nullptr;
  11096. }
  11097. return &custom_handlers_[method];
  11098. }
  11099. inline Server &Server::CustomRoute(const std::string &method,
  11100. const std::string &pattern,
  11101. Handler handler) {
  11102. auto *entry = custom_entry_for_registration(method);
  11103. if (!entry) { return *this; }
  11104. return add_handler(entry->handlers, pattern, std::move(handler));
  11105. }
  11106. inline Server &Server::CustomRoute(const std::string &method,
  11107. const std::string &pattern,
  11108. HandlerWithContentReader handler) {
  11109. auto *entry = custom_entry_for_registration(method);
  11110. if (!entry) { return *this; }
  11111. return add_handler(entry->handlers_for_content_reader, pattern,
  11112. std::move(handler));
  11113. }
  11114. inline const Server::CustomHandlerEntry *
  11115. Server::find_custom_entry(const std::string &method) const {
  11116. // find() alone would be correct here. The empty() check is what keeps the
  11117. // per-request cost off servers that never call CustomRoute(), which is the
  11118. // overwhelmingly common case; keep it rather than walking into the tree.
  11119. if (custom_handlers_.empty()) { return nullptr; }
  11120. auto it = custom_handlers_.find(method);
  11121. return it == custom_handlers_.end() ? nullptr : &it->second;
  11122. }
  11123. inline Server &Server::WebSocket(const std::string &pattern,
  11124. WebSocketHandler handler) {
  11125. websocket_handlers_.push_back(
  11126. {make_matcher(pattern), std::move(handler), nullptr});
  11127. return *this;
  11128. }
  11129. inline Server &Server::WebSocket(const std::string &pattern,
  11130. WebSocketHandler handler,
  11131. SubProtocolSelector sub_protocol_selector) {
  11132. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11133. std::move(sub_protocol_selector)});
  11134. return *this;
  11135. }
  11136. inline bool Server::set_base_dir(const std::string &dir,
  11137. const std::string &mount_point) {
  11138. return set_mount_point(mount_point, dir);
  11139. }
  11140. inline bool Server::set_mount_point(const std::string &mount_point,
  11141. const std::string &dir, Headers headers) {
  11142. detail::FileStat stat(dir);
  11143. if (stat.is_dir()) {
  11144. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11145. if (!mnt.empty() && mnt[0] == '/') {
  11146. std::string resolved_base;
  11147. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11148. #if defined(_WIN32)
  11149. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11150. resolved_base += '\\';
  11151. }
  11152. #else
  11153. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11154. #endif
  11155. }
  11156. base_dirs_.push_back(
  11157. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11158. return true;
  11159. }
  11160. }
  11161. return false;
  11162. }
  11163. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11164. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11165. if (it->mount_point == mount_point) {
  11166. base_dirs_.erase(it);
  11167. return true;
  11168. }
  11169. }
  11170. return false;
  11171. }
  11172. inline Server &
  11173. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11174. const std::string &mime) {
  11175. file_extension_and_mimetype_map_[ext] = mime;
  11176. return *this;
  11177. }
  11178. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11179. default_file_mimetype_ = mime;
  11180. return *this;
  11181. }
  11182. inline Server &Server::set_file_request_handler(Handler handler) {
  11183. file_request_handler_ = std::move(handler);
  11184. return *this;
  11185. }
  11186. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11187. std::true_type) {
  11188. error_handler_ = std::move(handler);
  11189. return *this;
  11190. }
  11191. inline Server &Server::set_error_handler_core(Handler handler,
  11192. std::false_type) {
  11193. error_handler_ = [handler](const Request &req, Response &res) {
  11194. handler(req, res);
  11195. return HandlerResponse::Handled;
  11196. };
  11197. return *this;
  11198. }
  11199. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11200. exception_handler_ = std::move(handler);
  11201. return *this;
  11202. }
  11203. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11204. pre_routing_handler_ = std::move(handler);
  11205. return *this;
  11206. }
  11207. inline Server &Server::set_post_routing_handler(Handler handler) {
  11208. post_routing_handler_ = std::move(handler);
  11209. return *this;
  11210. }
  11211. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11212. pre_request_handler_ = std::move(handler);
  11213. return *this;
  11214. }
  11215. inline Server &Server::set_logger(Logger logger) {
  11216. logger_ = std::move(logger);
  11217. return *this;
  11218. }
  11219. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11220. error_logger_ = std::move(error_logger);
  11221. return *this;
  11222. }
  11223. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11224. pre_compression_logger_ = std::move(logger);
  11225. return *this;
  11226. }
  11227. inline Server &
  11228. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11229. expect_100_continue_handler_ = std::move(handler);
  11230. return *this;
  11231. }
  11232. inline Server &Server::set_start_handler(StartHandler handler) {
  11233. start_handler_ = std::move(handler);
  11234. return *this;
  11235. }
  11236. inline Server &Server::set_address_family(int family) {
  11237. address_family_ = family;
  11238. return *this;
  11239. }
  11240. inline Server &Server::set_tcp_nodelay(bool on) {
  11241. tcp_nodelay_ = on;
  11242. return *this;
  11243. }
  11244. inline Server &Server::set_ipv6_v6only(bool on) {
  11245. ipv6_v6only_ = on;
  11246. return *this;
  11247. }
  11248. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11249. socket_options_ = std::move(socket_options);
  11250. return *this;
  11251. }
  11252. inline Server &Server::set_default_headers(Headers headers) {
  11253. default_headers_ = std::move(headers);
  11254. return *this;
  11255. }
  11256. inline Server &Server::set_header_writer(
  11257. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11258. header_writer_ = writer;
  11259. return *this;
  11260. }
  11261. inline Server &
  11262. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11263. trusted_proxies_ = proxies;
  11264. return *this;
  11265. }
  11266. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11267. keep_alive_max_count_ = count;
  11268. return *this;
  11269. }
  11270. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11271. keep_alive_timeout_sec_ = sec;
  11272. return *this;
  11273. }
  11274. template <class Rep, class Period>
  11275. inline Server &Server::set_keep_alive_timeout(
  11276. const std::chrono::duration<Rep, Period> &duration) {
  11277. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11278. set_keep_alive_timeout(sec);
  11279. });
  11280. return *this;
  11281. }
  11282. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11283. read_timeout_sec_ = sec;
  11284. read_timeout_usec_ = usec;
  11285. return *this;
  11286. }
  11287. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11288. write_timeout_sec_ = sec;
  11289. write_timeout_usec_ = usec;
  11290. return *this;
  11291. }
  11292. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11293. idle_interval_sec_ = sec;
  11294. idle_interval_usec_ = usec;
  11295. return *this;
  11296. }
  11297. inline Server &Server::set_payload_max_length(size_t length) {
  11298. payload_max_length_ = length;
  11299. return *this;
  11300. }
  11301. inline Server &Server::set_static_file_compression(bool on) {
  11302. static_file_compression_ = on;
  11303. return *this;
  11304. }
  11305. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11306. static_file_compression_min_length_ = length;
  11307. return *this;
  11308. }
  11309. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11310. static_file_compression_max_length_ = length;
  11311. return *this;
  11312. }
  11313. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11314. websocket_max_missed_pongs_ = count;
  11315. return *this;
  11316. }
  11317. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11318. websocket_ping_interval_sec_ = sec;
  11319. return *this;
  11320. }
  11321. template <class Rep, class Period>
  11322. inline Server &Server::set_websocket_ping_interval(
  11323. const std::chrono::duration<Rep, Period> &duration) {
  11324. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11325. set_websocket_ping_interval(sec);
  11326. });
  11327. return *this;
  11328. }
  11329. inline bool Server::bind_to_port(const std::string &host, int port,
  11330. int socket_flags) {
  11331. auto ret = bind_internal(host, port, socket_flags);
  11332. if (ret == -1) { is_decommissioned = true; }
  11333. return ret >= 0;
  11334. }
  11335. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11336. auto ret = bind_internal(host, 0, socket_flags);
  11337. if (ret == -1) { is_decommissioned = true; }
  11338. return ret;
  11339. }
  11340. inline bool Server::listen_after_bind() { return listen_internal(); }
  11341. inline bool Server::listen(const std::string &host, int port,
  11342. int socket_flags) {
  11343. return bind_to_port(host, port, socket_flags) && listen_internal();
  11344. }
  11345. inline bool Server::is_running() const { return is_running_; }
  11346. inline void Server::wait_until_ready() const {
  11347. while (!is_running_ && !is_decommissioned) {
  11348. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11349. }
  11350. }
  11351. inline void Server::stop() noexcept {
  11352. // Release the listening socket whether or not the accept loop is running:
  11353. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11354. // exchange is what makes this safe to call concurrently with the accept loop.
  11355. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11356. if (sock != INVALID_SOCKET) {
  11357. detail::shutdown_socket(sock);
  11358. detail::close_socket(sock);
  11359. }
  11360. is_decommissioned = false;
  11361. }
  11362. inline void Server::decommission() { is_decommissioned = true; }
  11363. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11364. auto len = strlen(s);
  11365. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11366. len -= 2;
  11367. {
  11368. size_t count = 0;
  11369. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11370. switch (count) {
  11371. case 0: req.method = std::string(b, e); break;
  11372. case 1: req.target = std::string(b, e); break;
  11373. case 2: req.version = std::string(b, e); break;
  11374. default: break;
  11375. }
  11376. count++;
  11377. });
  11378. if (count != 3) { return false; }
  11379. }
  11380. // A method outside the built-in set is accepted only when a handler has been
  11381. // registered for it with CustomRoute().
  11382. const auto &methods = builtin_methods();
  11383. if (methods.find(req.method) == methods.end() &&
  11384. !find_custom_entry(req.method)) {
  11385. output_error_log(Error::InvalidHTTPMethod, &req);
  11386. return false;
  11387. }
  11388. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11389. output_error_log(Error::InvalidHTTPVersion, &req);
  11390. return false;
  11391. }
  11392. if (!detail::fields::is_request_target(req.target)) { return false; }
  11393. {
  11394. // Skip URL fragment
  11395. for (size_t i = 0; i < req.target.size(); i++) {
  11396. if (req.target[i] == '#') {
  11397. req.target.erase(i);
  11398. break;
  11399. }
  11400. }
  11401. detail::divide(req.target, '?',
  11402. [&](const char *lhs_data, std::size_t lhs_size,
  11403. const char *rhs_data, std::size_t rhs_size) {
  11404. req.path =
  11405. decode_path_component(std::string(lhs_data, lhs_size));
  11406. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11407. });
  11408. }
  11409. return true;
  11410. }
  11411. inline bool Server::write_response(Stream &strm, bool close_connection,
  11412. Request &req, Response &res) {
  11413. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11414. // incorrectly to the error content.
  11415. req.ranges.clear();
  11416. return write_response_core(strm, close_connection, req, res, false);
  11417. }
  11418. inline bool Server::write_response_with_content(Stream &strm,
  11419. bool close_connection,
  11420. const Request &req,
  11421. Response &res) {
  11422. return write_response_core(strm, close_connection, req, res, true);
  11423. }
  11424. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11425. const Request &req, Response &res,
  11426. bool need_apply_ranges) {
  11427. assert(res.status != -1);
  11428. if (400 <= res.status && error_handler_ &&
  11429. error_handler_(req, res) == HandlerResponse::Handled) {
  11430. need_apply_ranges = true;
  11431. }
  11432. std::string content_type;
  11433. std::string boundary;
  11434. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11435. // Prepare additional headers
  11436. if (close_connection ||
  11437. detail::has_header_token(req.headers, "Connection", "close") ||
  11438. 400 <= res.status || // Don't leave connections open after errors
  11439. // The client withholds the body until `100 Continue`, which was never
  11440. // sent, so whether and when the body follows is unknown.
  11441. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11442. res.set_header("Connection", "close");
  11443. } else {
  11444. std::string s = "timeout=";
  11445. s += std::to_string(keep_alive_timeout_sec_);
  11446. s += ", max=";
  11447. s += std::to_string(keep_alive_max_count_);
  11448. res.set_header("Keep-Alive", s);
  11449. }
  11450. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11451. !res.has_header("Content-Type")) {
  11452. res.set_header("Content-Type", "text/plain");
  11453. }
  11454. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11455. !res.has_header("Content-Length")) {
  11456. res.set_header("Content-Length", "0");
  11457. }
  11458. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11459. res.set_header("Accept-Ranges", "bytes");
  11460. }
  11461. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11462. // Response line and headers
  11463. detail::BufferStream bstrm;
  11464. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11465. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11466. // Combine a small body with the headers so the whole response leaves in a
  11467. // single write. A large body is written on its own instead: a copy of it
  11468. // costs more than the extra write saves.
  11469. auto send_body = req.method != "HEAD";
  11470. auto body_is_separate = false;
  11471. auto provider_done = false;
  11472. if (send_body && !res.body.empty() && !res.content_provider_) {
  11473. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11474. bstrm.write(res.body.data(), res.body.size());
  11475. } else {
  11476. body_is_separate = true;
  11477. }
  11478. } else if (send_body && res.content_provider_ &&
  11479. res.is_file_content_provider_ &&
  11480. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11481. // A small file is read into the same buffer. Other providers may produce
  11482. // their data over time, so they are never held back.
  11483. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11484. return false;
  11485. }
  11486. provider_done = true;
  11487. }
  11488. // Log before writing to avoid race condition with client-side code that
  11489. // accesses logger-captured data immediately after receiving the response.
  11490. output_log(req, res);
  11491. // Flush buffer
  11492. auto &data = bstrm.get_buffer();
  11493. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11494. if (body_is_separate) {
  11495. return detail::write_data(strm, res.body.data(), res.body.size());
  11496. }
  11497. // Streaming body
  11498. if (send_body && res.content_provider_) {
  11499. if (!provider_done &&
  11500. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11501. return false;
  11502. }
  11503. res.content_provider_success_ = true;
  11504. }
  11505. return true;
  11506. }
  11507. inline bool
  11508. Server::write_content_with_provider(Stream &strm, const Request &req,
  11509. Response &res, const std::string &boundary,
  11510. const std::string &content_type) {
  11511. auto is_shutting_down = [this]() {
  11512. return this->svr_sock_ == INVALID_SOCKET;
  11513. };
  11514. if (res.content_length_ > 0) {
  11515. // Only a 206 response is served as a partial representation, matching the
  11516. // condition `apply_ranges()` used to decide the Content-Length and the
  11517. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11518. // only for a 2xx status, slicing under any other status would write a body
  11519. // that disagrees with the header already sent, from an unchecked offset.
  11520. auto is_partial =
  11521. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11522. if (!is_partial) {
  11523. return detail::write_content(strm, res.content_provider_, 0,
  11524. res.content_length_, is_shutting_down);
  11525. } else if (req.ranges.size() == 1) {
  11526. auto offset_and_length = detail::get_range_offset_and_length(
  11527. req.ranges[0], res.content_length_);
  11528. return detail::write_content(strm, res.content_provider_,
  11529. offset_and_length.first,
  11530. offset_and_length.second, is_shutting_down);
  11531. } else {
  11532. return detail::write_multipart_ranges_data(
  11533. strm, req, res, boundary, content_type, res.content_length_,
  11534. is_shutting_down);
  11535. }
  11536. } else {
  11537. if (res.is_chunked_content_provider_) {
  11538. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11539. // re-negotiating here would disagree with them, e.g. once a handler's
  11540. // own Content-Encoding header suppresses the negotiation.
  11541. auto compressor = detail::make_compressor(res.content_coding_);
  11542. if (!compressor) {
  11543. compressor = detail::make_unique<detail::nocompressor>();
  11544. }
  11545. return detail::write_content_chunked(strm, res.content_provider_,
  11546. is_shutting_down, *compressor);
  11547. } else {
  11548. return detail::write_content_without_length(strm, res.content_provider_,
  11549. is_shutting_down);
  11550. }
  11551. }
  11552. }
  11553. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11554. FormFields::iterator cur_field;
  11555. FormFiles::iterator cur_file;
  11556. auto is_text_field = false;
  11557. size_t count = 0;
  11558. if (read_content_core(
  11559. strm, req, res,
  11560. // Regular
  11561. [&](const char *buf, size_t n) {
  11562. // Prevent arithmetic overflow when checking sizes.
  11563. // Avoid computing (req.body.size() + n) directly because
  11564. // adding two unsigned `size_t` values can wrap around and
  11565. // produce a small result instead of indicating overflow.
  11566. // Instead, check using subtraction: ensure `n` does not
  11567. // exceed the remaining capacity `max_size() - size()`.
  11568. if (req.body.size() >= req.body.max_size() ||
  11569. n > req.body.max_size() - req.body.size()) {
  11570. return false;
  11571. }
  11572. // Limit decompressed body size to payload_max_length_ to protect
  11573. // against "zip bomb" attacks where a small compressed payload
  11574. // decompresses to a massive size.
  11575. if (payload_max_length_ > 0 &&
  11576. (req.body.size() >= payload_max_length_ ||
  11577. n > payload_max_length_ - req.body.size())) {
  11578. return false;
  11579. }
  11580. req.body.append(buf, n);
  11581. return true;
  11582. },
  11583. // Multipart FormData
  11584. [&](const FormData &file) {
  11585. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11586. output_error_log(Error::TooManyFormDataFiles, &req);
  11587. return false;
  11588. }
  11589. if (file.filename.empty()) {
  11590. cur_field = req.form.fields.emplace(
  11591. file.name, FormField{file.name, file.content, file.headers});
  11592. is_text_field = true;
  11593. } else {
  11594. cur_file = req.form.files.emplace(file.name, file);
  11595. is_text_field = false;
  11596. }
  11597. return true;
  11598. },
  11599. [&](const char *buf, size_t n) {
  11600. if (is_text_field) {
  11601. auto &content = cur_field->second.content;
  11602. if (content.size() + n > content.max_size()) { return false; }
  11603. content.append(buf, n);
  11604. } else {
  11605. auto &content = cur_file->second.content;
  11606. if (content.size() + n > content.max_size()) { return false; }
  11607. content.append(buf, n);
  11608. }
  11609. return true;
  11610. })) {
  11611. const auto &content_type = req.get_header_value("Content-Type");
  11612. if (detail::extract_media_type(content_type) ==
  11613. "application/x-www-form-urlencoded") {
  11614. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11615. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11616. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11617. return false;
  11618. }
  11619. detail::parse_query_text(req.body, req.params);
  11620. }
  11621. return true;
  11622. }
  11623. return false;
  11624. }
  11625. inline bool Server::read_content_with_content_receiver(
  11626. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11627. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11628. return read_content_core(strm, req, res, std::move(receiver),
  11629. std::move(multipart_header),
  11630. std::move(multipart_receiver));
  11631. }
  11632. inline bool Server::read_content_core(
  11633. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11634. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11635. detail::FormDataParser multipart_form_data_parser;
  11636. ContentReceiverWithProgress out;
  11637. if (req.is_multipart_form_data()) {
  11638. const auto &content_type = req.get_header_value("Content-Type");
  11639. std::string boundary;
  11640. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11641. res.status = StatusCode::BadRequest_400;
  11642. output_error_log(Error::MultipartParsing, &req);
  11643. return false;
  11644. }
  11645. multipart_form_data_parser.set_boundary(std::move(boundary));
  11646. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11647. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11648. multipart_receiver);
  11649. };
  11650. } else {
  11651. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11652. size_t /*len*/) { return receiver(buf, n); };
  11653. }
  11654. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11655. // For non-SSL builds we still scan non-persistent connections for stray
  11656. // body bytes so the payload limit is enforced (413). On keep-alive,
  11657. // pending bytes may be the next request (issue #2450), so skip.
  11658. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11659. if (!req.has_header("Content-Length") &&
  11660. !detail::is_chunked_transfer_encoding(req.headers)) {
  11661. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11662. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11663. auto has_data = strm.is_readable();
  11664. if (!has_data) {
  11665. auto s = strm.socket();
  11666. if (s != INVALID_SOCKET) {
  11667. has_data = detail::select_read(s, 0, 0) > 0;
  11668. }
  11669. }
  11670. if (has_data) {
  11671. // Route through the same decompressing reader used by the
  11672. // length-framed and chunked paths below, so payload_max_length_ is
  11673. // enforced on the decompressed size here too instead of only on the
  11674. // compressed wire bytes.
  11675. return detail::read_content(strm, req, payload_max_length_, res.status,
  11676. nullptr, out, true);
  11677. }
  11678. }
  11679. return true;
  11680. }
  11681. #else
  11682. if (!req.has_header("Content-Length") &&
  11683. !detail::is_chunked_transfer_encoding(req.headers)) {
  11684. return true;
  11685. }
  11686. #endif
  11687. // The client is waiting for this before it sends the body.
  11688. if (req.expect_100_continue_pending_) {
  11689. req.expect_100_continue_pending_ = false;
  11690. detail::write_response_line(strm, StatusCode::Continue_100);
  11691. strm.write("\r\n");
  11692. }
  11693. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11694. out, true)) {
  11695. return false;
  11696. }
  11697. req.body_consumed_ = true;
  11698. if (req.is_multipart_form_data()) {
  11699. if (!multipart_form_data_parser.is_valid()) {
  11700. res.status = StatusCode::BadRequest_400;
  11701. output_error_log(Error::MultipartParsing, &req);
  11702. return false;
  11703. }
  11704. }
  11705. return true;
  11706. }
  11707. inline bool Server::handle_file_request(Request &req, Response &res) {
  11708. for (const auto &entry : base_dirs_) {
  11709. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11710. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11711. // One that already ends in '/' (the root mount among them) carries its own
  11712. // boundary; set_mount_point() guarantees the mount point is not empty.
  11713. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11714. (entry.mount_point.back() == '/' ||
  11715. req.path.size() == entry.mount_point.size() ||
  11716. req.path[entry.mount_point.size()] == '/')) {
  11717. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11718. if (detail::is_valid_path(sub_path)) {
  11719. auto path = entry.base_dir + sub_path;
  11720. if (path.back() == '/') { path += "index.html"; }
  11721. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11722. // but symlinks/junctions can still escape the base directory.
  11723. if (!entry.resolved_base_dir.empty()) {
  11724. std::string resolved_path;
  11725. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11726. !detail::is_path_within_base(resolved_path,
  11727. entry.resolved_base_dir)) {
  11728. res.status = StatusCode::Forbidden_403;
  11729. return true;
  11730. }
  11731. }
  11732. detail::FileStat stat(path);
  11733. if (stat.is_dir()) {
  11734. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11735. return true;
  11736. }
  11737. if (stat.is_file()) {
  11738. for (const auto &kv : entry.headers) {
  11739. res.set_header(kv.first, kv.second);
  11740. }
  11741. auto content_type_of = [&]() {
  11742. return detail::find_content_type(
  11743. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11744. };
  11745. // Only the ETag needs the content type this early, and only to name
  11746. // the coding. Deciding it here would otherwise put a regex in front
  11747. // of the 304 below, which serving a file never used to pay for.
  11748. std::string content_type;
  11749. auto encoding = detail::EncodingType::None;
  11750. if (static_file_compression_) {
  11751. content_type = content_type_of();
  11752. encoding =
  11753. static_file_encoding(req, res, content_type, stat.size());
  11754. }
  11755. // The ETag names the representation actually sent, so a client that
  11756. // cached the compressed form revalidates against the compressed ETag
  11757. // and still gets a 304, while one that took identity keeps the plain
  11758. // ETag.
  11759. auto etag = detail::compute_etag(
  11760. stat, encoding == detail::EncodingType::None
  11761. ? std::string()
  11762. : std::string("-") + detail::encoding_name(encoding));
  11763. if (!etag.empty()) { res.set_header("ETag", etag); }
  11764. auto mtime = stat.mtime();
  11765. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11766. if (!last_modified.empty()) {
  11767. res.set_header("Last-Modified", last_modified);
  11768. }
  11769. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11770. check_if_range(req, etag, mtime);
  11771. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11772. if (!mm->is_open()) {
  11773. output_error_log(Error::OpenFile, &req);
  11774. return false;
  11775. }
  11776. if (!static_file_compression_) { content_type = content_type_of(); }
  11777. detail::set_file_content_provider(res, mm, content_type, encoding);
  11778. if (req.method != "HEAD" && file_request_handler_) {
  11779. file_request_handler_(req, res);
  11780. }
  11781. return true;
  11782. } else {
  11783. output_error_log(Error::OpenFile, &req);
  11784. }
  11785. }
  11786. }
  11787. }
  11788. return false;
  11789. }
  11790. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11791. const std::string &etag,
  11792. time_t mtime) const {
  11793. // Handle conditional GET:
  11794. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11795. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11796. if (req.has_header("If-None-Match")) {
  11797. if (!etag.empty()) {
  11798. auto val =
  11799. detail::get_combined_header_value(req.headers, "If-None-Match");
  11800. // NOTE: We use exact string matching here. This works correctly
  11801. // because our server always generates weak ETags (W/"..."), and
  11802. // clients typically send back the same ETag they received.
  11803. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11804. // If-None-Match, where W/"x" and "x" would match, but this
  11805. // simplified implementation requires exact matches.
  11806. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11807. [&](const char *b, const char *e) {
  11808. auto seg_len = static_cast<size_t>(e - b);
  11809. return (seg_len == 1 && *b == '*') ||
  11810. (seg_len == etag.size() &&
  11811. std::equal(b, e, etag.begin()));
  11812. });
  11813. if (ret) {
  11814. res.status = StatusCode::NotModified_304;
  11815. return true;
  11816. }
  11817. }
  11818. } else if (req.has_header("If-Modified-Since")) {
  11819. auto val = req.get_header_value("If-Modified-Since");
  11820. auto t = detail::parse_http_date(val);
  11821. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11822. res.status = StatusCode::NotModified_304;
  11823. return true;
  11824. }
  11825. }
  11826. return false;
  11827. }
  11828. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11829. time_t mtime) const {
  11830. // Handle If-Range for partial content requests (RFC 9110
  11831. // Section 13.1.5). If-Range is only evaluated when Range header is
  11832. // present. If the validator matches, serve partial content; otherwise
  11833. // serve full content.
  11834. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11835. auto val = req.get_header_value("If-Range");
  11836. auto is_valid_range = [&]() {
  11837. if (detail::is_strong_etag(val)) {
  11838. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11839. // comparison.
  11840. return (!etag.empty() && val == etag);
  11841. } else if (detail::is_weak_etag(val)) {
  11842. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11843. return false;
  11844. } else {
  11845. // HTTP-date comparison
  11846. auto t = detail::parse_http_date(val);
  11847. return (t != static_cast<time_t>(-1) && mtime <= t);
  11848. }
  11849. };
  11850. if (!is_valid_range()) {
  11851. // Validator doesn't match: ignore Range and serve full content
  11852. req.ranges.clear();
  11853. return false;
  11854. }
  11855. }
  11856. return true;
  11857. }
  11858. inline socket_t
  11859. Server::create_server_socket(const std::string &host, int port,
  11860. int socket_flags,
  11861. SocketOptions socket_options) const {
  11862. return detail::create_socket(
  11863. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11864. ipv6_v6only_, std::move(socket_options),
  11865. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11866. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11867. output_error_log(Error::BindIPAddress, nullptr);
  11868. return false;
  11869. }
  11870. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11871. output_error_log(Error::Listen, nullptr);
  11872. return false;
  11873. }
  11874. return true;
  11875. });
  11876. }
  11877. inline int Server::bind_internal(const std::string &host, int port,
  11878. int socket_flags) {
  11879. if (is_decommissioned) { return -1; }
  11880. if (!is_valid()) { return -1; }
  11881. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11882. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11883. if (port == 0) {
  11884. struct sockaddr_storage addr;
  11885. socklen_t addr_len = sizeof(addr);
  11886. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11887. &addr_len) == -1) {
  11888. output_error_log(Error::GetSockName, nullptr);
  11889. return -1;
  11890. }
  11891. if (addr.ss_family == AF_INET) {
  11892. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11893. } else if (addr.ss_family == AF_INET6) {
  11894. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11895. } else {
  11896. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11897. return -1;
  11898. }
  11899. } else {
  11900. return port;
  11901. }
  11902. }
  11903. inline bool Server::listen_internal() {
  11904. // A stop() between bind and listen leaves nothing to accept on. Report
  11905. // failure instead of returning success without ever serving, and mark the
  11906. // server decommissioned the way any failed listen does so that a concurrent
  11907. // wait_until_ready() wakes up instead of spinning forever.
  11908. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11909. is_decommissioned = true;
  11910. return false;
  11911. }
  11912. auto ret = true;
  11913. is_running_ = true;
  11914. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11915. if (start_handler_) { start_handler_(); }
  11916. {
  11917. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11918. while (svr_sock_ != INVALID_SOCKET) {
  11919. #ifndef _WIN32
  11920. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11921. #endif
  11922. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11923. idle_interval_usec_);
  11924. if (val == 0) { // Timeout
  11925. task_queue->on_idle();
  11926. continue;
  11927. }
  11928. #ifndef _WIN32
  11929. }
  11930. #endif
  11931. #if defined _WIN32
  11932. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11933. // OVERLAPPED
  11934. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11935. #elif defined SOCK_CLOEXEC
  11936. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11937. #else
  11938. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11939. #endif
  11940. if (sock == INVALID_SOCKET) {
  11941. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11942. // touches the CRT errno, so the two have to be asked platform by
  11943. // platform rather than by testing errno here.
  11944. if (detail::is_accept_resource_error()) {
  11945. // The per-process descriptor limit or the network stack's buffer
  11946. // space has been reached. Try to accept new connections after a
  11947. // short sleep.
  11948. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11949. continue;
  11950. } else if (detail::is_accept_transient_error()) {
  11951. continue;
  11952. }
  11953. // Take the descriptor out of svr_sock_ before closing it: a later
  11954. // stop() would otherwise shutdown()/close() a value the OS may have
  11955. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11956. // gone. The exchange also settles the race with a concurrent stop(),
  11957. // since whichever side takes the descriptor closes it exactly once.
  11958. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11959. if (listen_sock != INVALID_SOCKET) {
  11960. detail::close_socket(listen_sock);
  11961. ret = false;
  11962. output_error_log(Error::Connection, nullptr);
  11963. } else {
  11964. ; // The server socket was closed by user.
  11965. }
  11966. break;
  11967. }
  11968. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11969. read_timeout_sec_, read_timeout_usec_);
  11970. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11971. write_timeout_sec_, write_timeout_usec_);
  11972. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11973. if (!task_queue->enqueue(
  11974. [this, sock]() { process_and_close_socket(sock); })) {
  11975. output_error_log(Error::ResourceExhaustion, nullptr);
  11976. detail::shutdown_socket(sock);
  11977. detail::close_socket(sock);
  11978. }
  11979. }
  11980. task_queue->shutdown();
  11981. }
  11982. is_decommissioned = !ret;
  11983. return ret;
  11984. }
  11985. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11986. if (pre_routing_handler_ &&
  11987. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11988. return true;
  11989. }
  11990. // File handler
  11991. if ((req.method == "GET" || req.method == "HEAD") &&
  11992. handle_file_request(req, res)) {
  11993. return true;
  11994. }
  11995. const auto *custom = find_custom_entry(req.method);
  11996. // The second clause mirrors what expect_content() does unconditionally for
  11997. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11998. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11999. // `allprop`) would skip its handler and fall through to 404.
  12000. if (detail::expect_content(req) ||
  12001. (custom && !custom->handlers_for_content_reader.empty())) {
  12002. // Content reader handler
  12003. {
  12004. // Track whether the ContentReader was aborted due to the decompressed
  12005. // payload exceeding `payload_max_length_`.
  12006. // The user handler runs after the lambda returns, so we must restore the
  12007. // 413 status if the handler overwrites it.
  12008. bool content_reader_payload_too_large = false;
  12009. ContentReader reader(
  12010. [&](ContentReceiver receiver) {
  12011. auto result = read_content_with_content_receiver(
  12012. strm, req, res, std::move(receiver), nullptr, nullptr);
  12013. if (!result) {
  12014. output_error_log(Error::Read, &req);
  12015. if (res.status == StatusCode::PayloadTooLarge_413) {
  12016. content_reader_payload_too_large = true;
  12017. }
  12018. }
  12019. return result;
  12020. },
  12021. [&](FormDataHeader header, ContentReceiver receiver) {
  12022. auto result = read_content_with_content_receiver(
  12023. strm, req, res, nullptr, std::move(header),
  12024. std::move(receiver));
  12025. if (!result) {
  12026. output_error_log(Error::Read, &req);
  12027. if (res.status == StatusCode::PayloadTooLarge_413) {
  12028. content_reader_payload_too_large = true;
  12029. }
  12030. }
  12031. return result;
  12032. });
  12033. bool dispatched = false;
  12034. if (req.method == "POST") {
  12035. dispatched = dispatch_request_for_content_reader(
  12036. req, res, std::move(reader), post_handlers_for_content_reader_);
  12037. } else if (req.method == "PUT") {
  12038. dispatched = dispatch_request_for_content_reader(
  12039. req, res, std::move(reader), put_handlers_for_content_reader_);
  12040. } else if (req.method == "PATCH") {
  12041. dispatched = dispatch_request_for_content_reader(
  12042. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12043. } else if (req.method == "DELETE") {
  12044. dispatched = dispatch_request_for_content_reader(
  12045. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12046. } else if (custom) {
  12047. dispatched = dispatch_request_for_content_reader(
  12048. req, res, std::move(reader), custom->handlers_for_content_reader);
  12049. }
  12050. if (dispatched) {
  12051. if (content_reader_payload_too_large) {
  12052. // Enforce the limit: override any status the handler may have set
  12053. // and return false so the error path sends a plain 413 response.
  12054. res.status = StatusCode::PayloadTooLarge_413;
  12055. res.body.clear();
  12056. res.content_length_ = 0;
  12057. res.content_provider_ = nullptr;
  12058. return false;
  12059. }
  12060. return true;
  12061. }
  12062. }
  12063. // NOTE: `req.body` is not read here. For a regular handler the body is
  12064. // read inside dispatch_request(), after the route has matched and the
  12065. // pre-request handler has approved the request, so that a rejected
  12066. // request (e.g. failed authentication) never forces us to buffer a
  12067. // potentially large body.
  12068. }
  12069. // Regular handler
  12070. if (req.method == "GET" || req.method == "HEAD") {
  12071. return dispatch_request(req, res, get_handlers_, strm);
  12072. } else if (req.method == "POST") {
  12073. return dispatch_request(req, res, post_handlers_, strm);
  12074. } else if (req.method == "PUT") {
  12075. return dispatch_request(req, res, put_handlers_, strm);
  12076. } else if (req.method == "DELETE") {
  12077. return dispatch_request(req, res, delete_handlers_, strm);
  12078. } else if (req.method == "OPTIONS") {
  12079. return dispatch_request(req, res, options_handlers_, strm);
  12080. } else if (req.method == "PATCH") {
  12081. return dispatch_request(req, res, patch_handlers_, strm);
  12082. } else if (custom) {
  12083. return dispatch_request(req, res, custom->handlers, strm);
  12084. }
  12085. res.status = StatusCode::BadRequest_400;
  12086. return false;
  12087. }
  12088. inline bool Server::dispatch_request(Request &req, Response &res,
  12089. const Handlers &handlers, Stream &strm) {
  12090. for (const auto &x : handlers) {
  12091. const auto &matcher = x.first;
  12092. const auto &handler = x.second;
  12093. if (matcher->match(req)) {
  12094. req.matched_route = matcher->pattern();
  12095. // Run the pre-request handler before reading the body so a rejected
  12096. // request (e.g. failed authentication) never forces us to buffer a
  12097. // potentially large body. `req.matched_route` is available here.
  12098. if (pre_request_handler_ &&
  12099. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12100. return true;
  12101. }
  12102. // The route matched and the request was approved; read the body now.
  12103. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12104. output_error_log(Error::Read, &req);
  12105. return false;
  12106. }
  12107. handler(req, res);
  12108. return true;
  12109. }
  12110. }
  12111. return false;
  12112. }
  12113. // Decides the content coding for a response served straight from a file. Both
  12114. // the ETag, which has to name the representation actually sent, and
  12115. // `apply_static_file_compression()` go through this, so the two cannot drift
  12116. // apart.
  12117. inline detail::EncodingType
  12118. Server::static_file_encoding(const Request &req, const Response &res,
  12119. const std::string &content_type,
  12120. size_t length) const {
  12121. if (!static_file_compression_) { return detail::EncodingType::None; }
  12122. // Nothing to compress, and an empty file already answers with
  12123. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12124. // turn an empty body into a 20-byte gzip stream.
  12125. if (length == 0) { return detail::EncodingType::None; }
  12126. // A file that already fits in a single packet gains nothing from being made
  12127. // smaller, since it still travels in that one segment, and a file of a few
  12128. // bytes comes out larger than it went in.
  12129. if (length < static_file_compression_min_length_) {
  12130. return detail::EncodingType::None;
  12131. }
  12132. // RFC 9110 applies Range to the representation after content coding, so a
  12133. // compressed 206 would mean compressing the whole file and then slicing it.
  12134. // Serve ranges from the identity representation instead.
  12135. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12136. if (static_file_compression_max_length_ > 0 &&
  12137. length > static_file_compression_max_length_) {
  12138. return detail::EncodingType::None;
  12139. }
  12140. return detail::encoding_type(req, res, content_type);
  12141. }
  12142. // Compresses a file-backed content provider into `res.body` and takes over the
  12143. // framing headers. Returns false when the response is left untouched.
  12144. inline bool Server::apply_static_file_compression(const Request &req,
  12145. Response &res) const {
  12146. auto type = res.content_coding_;
  12147. if (type == detail::EncodingType::None || !res.content_provider_) {
  12148. return false;
  12149. }
  12150. auto compressor = detail::make_compressor(type);
  12151. if (!compressor) { return false; }
  12152. output_pre_compression_log(req, res);
  12153. std::string compressed;
  12154. if (!detail::compress_content_provider(res.content_provider_,
  12155. res.content_length_, *compressor,
  12156. compressed)) {
  12157. return false;
  12158. }
  12159. res.body.swap(compressed);
  12160. // The provider was consumed in full, so a resource releaser registered with
  12161. // it should hear about a success when the response goes away.
  12162. res.content_provider_success_ = true;
  12163. res.content_provider_ = nullptr;
  12164. res.content_length_ = 0;
  12165. res.content_coding_ = detail::EncodingType::None;
  12166. res.set_header("Content-Encoding", detail::encoding_name(type));
  12167. res.set_header("Vary", "Accept-Encoding");
  12168. res.set_header("Content-Length", std::to_string(res.body.size()));
  12169. return true;
  12170. }
  12171. inline void Server::apply_ranges(const Request &req, Response &res,
  12172. std::string &content_type,
  12173. std::string &boundary) const {
  12174. // A known-length content provider leaves `res.body` empty, so the compressor
  12175. // at the end of this function never runs for one (issue #2545). A file-backed
  12176. // provider is fully readable right here, so compress it and answer with an
  12177. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12178. // takes the same path as `set_content()` from here on. Range requests never
  12179. // get a content coding, so `Content-Range` still names identity bytes and
  12180. // none of the framing below applies.
  12181. if (apply_static_file_compression(req, res)) { return; }
  12182. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12183. auto it = res.headers.find("Content-Type");
  12184. if (it != res.headers.end()) {
  12185. content_type = it->second;
  12186. res.headers.erase(it);
  12187. }
  12188. boundary = detail::make_multipart_data_boundary();
  12189. res.set_header("Content-Type",
  12190. "multipart/byteranges; boundary=" + boundary);
  12191. }
  12192. auto type = detail::encoding_type(req, res);
  12193. if (res.body.empty()) {
  12194. if (res.content_length_ > 0) {
  12195. size_t length = 0;
  12196. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12197. length = res.content_length_;
  12198. } else if (req.ranges.size() == 1) {
  12199. auto offset_and_length = detail::get_range_offset_and_length(
  12200. req.ranges[0], res.content_length_);
  12201. length = offset_and_length.second;
  12202. auto content_range = detail::make_content_range_header_field(
  12203. offset_and_length, res.content_length_);
  12204. res.set_header("Content-Range", content_range);
  12205. } else {
  12206. length = detail::get_multipart_ranges_data_length(
  12207. req, boundary, content_type, res.content_length_);
  12208. }
  12209. res.set_header("Content-Length", std::to_string(length));
  12210. } else {
  12211. if (res.content_provider_) {
  12212. if (res.is_chunked_content_provider_) {
  12213. res.set_header("Transfer-Encoding", "chunked");
  12214. res.content_coding_ = type;
  12215. if (type != detail::EncodingType::None) {
  12216. res.set_header("Content-Encoding", detail::encoding_name(type));
  12217. res.set_header("Vary", "Accept-Encoding");
  12218. }
  12219. }
  12220. }
  12221. }
  12222. } else {
  12223. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12224. ;
  12225. } else if (req.ranges.size() == 1) {
  12226. auto offset_and_length =
  12227. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12228. auto offset = offset_and_length.first;
  12229. auto length = offset_and_length.second;
  12230. auto content_range = detail::make_content_range_header_field(
  12231. offset_and_length, res.body.size());
  12232. res.set_header("Content-Range", content_range);
  12233. assert(offset + length <= res.body.size());
  12234. res.body = res.body.substr(offset, length);
  12235. } else {
  12236. std::string data;
  12237. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12238. res.body.size(), data);
  12239. res.body.swap(data);
  12240. }
  12241. if (type != detail::EncodingType::None) {
  12242. output_pre_compression_log(req, res);
  12243. if (auto compressor = detail::make_compressor(type)) {
  12244. std::string compressed;
  12245. if (compressor->compress(res.body.data(), res.body.size(), true,
  12246. [&](const char *data, size_t data_len) {
  12247. compressed.append(data, data_len);
  12248. return true;
  12249. })) {
  12250. res.body.swap(compressed);
  12251. res.set_header("Content-Encoding", detail::encoding_name(type));
  12252. res.set_header("Vary", "Accept-Encoding");
  12253. }
  12254. }
  12255. }
  12256. res.content_length_ = res.body.size();
  12257. res.set_header("Content-Length", std::to_string(res.content_length_));
  12258. }
  12259. }
  12260. inline bool Server::dispatch_request_for_content_reader(
  12261. Request &req, Response &res, ContentReader content_reader,
  12262. const HandlersForContentReader &handlers) const {
  12263. for (const auto &x : handlers) {
  12264. const auto &matcher = x.first;
  12265. const auto &handler = x.second;
  12266. if (matcher->match(req)) {
  12267. req.matched_route = matcher->pattern();
  12268. if (!pre_request_handler_ ||
  12269. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12270. handler(req, res, content_reader);
  12271. }
  12272. return true;
  12273. }
  12274. }
  12275. return false;
  12276. }
  12277. inline std::string
  12278. get_client_ip(const std::string &x_forwarded_for,
  12279. const std::vector<std::string> &trusted_proxies) {
  12280. // X-Forwarded-For is a comma-separated list per RFC 7239
  12281. std::vector<std::string> ip_list;
  12282. detail::split(x_forwarded_for.data(),
  12283. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12284. [&](const char *b, const char *e) {
  12285. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12286. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12287. });
  12288. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12289. // no segments. Signal "no client IP derived" with an empty string so the
  12290. // caller can fall back to the connection-level remote address.
  12291. if (ip_list.empty()) { return std::string(); }
  12292. // Each hop appends the address it received the request from, so the rightmost
  12293. // entries are the ones written by our own infrastructure while the leftmost
  12294. // are whatever the original client chose to send. Walk from the right and
  12295. // skip trusted proxies; the first address that is not a trusted proxy is the
  12296. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12297. // from the left instead lets a client forge an arbitrary address by following
  12298. // it with a trusted proxy's address, which the left-to-right scan then
  12299. // returned as the client.
  12300. for (size_t i = ip_list.size(); i-- > 0;) {
  12301. const auto &ip = ip_list[i];
  12302. auto is_trusted_proxy =
  12303. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12304. [&](const std::string &proxy) { return ip == proxy; });
  12305. if (!is_trusted_proxy) { return ip; }
  12306. }
  12307. // Every hop was a trusted proxy; fall back to the first entry.
  12308. return ip_list.front();
  12309. }
  12310. inline bool
  12311. Server::process_request(Stream &strm, const std::string &remote_addr,
  12312. int remote_port, const std::string &local_addr,
  12313. int local_port, bool close_connection,
  12314. bool &connection_closed,
  12315. const std::function<void(Request &)> &setup_request,
  12316. bool *websocket_upgraded) {
  12317. std::array<char, 2048> buf{};
  12318. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12319. // Connection has been closed on client
  12320. if (!line_reader.getline()) { return false; }
  12321. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12322. // clients send an extra CRLF after a request body, which would otherwise be
  12323. // parsed as the next request on a persistent connection.
  12324. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12325. return false;
  12326. }
  12327. Request req;
  12328. req.start_time_ = std::chrono::steady_clock::now();
  12329. req.remote_addr = remote_addr;
  12330. req.remote_port = remote_port;
  12331. req.local_addr = local_addr;
  12332. req.local_port = local_port;
  12333. Response res;
  12334. res.version = "HTTP/1.1";
  12335. res.headers = default_headers_;
  12336. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12337. // close the connection after that response, whichever path wrote it (an
  12338. // error status, a handler, or a rejected request). Reading on would also
  12339. // parse whatever the client sent next on a connection it considers done.
  12340. auto honor_connection_close = detail::scope_exit([&] {
  12341. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12342. connection_closed = true;
  12343. }
  12344. });
  12345. // Request line and headers. A rejected message leaves the rest of it (and
  12346. // any body) unread, so the connection cannot be reused: the leftover bytes
  12347. // would be parsed as the next request.
  12348. if (!parse_request_line(line_reader.ptr(), req)) {
  12349. connection_closed = true;
  12350. res.status = StatusCode::BadRequest_400;
  12351. output_error_log(Error::InvalidRequestLine, &req);
  12352. return write_response(strm, close_connection, req, res);
  12353. }
  12354. // Request headers
  12355. if (!detail::read_headers(strm, req.headers)) {
  12356. connection_closed = true;
  12357. res.status = StatusCode::BadRequest_400;
  12358. output_error_log(Error::InvalidHeaders, &req);
  12359. return write_response(strm, close_connection, req, res);
  12360. }
  12361. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12362. // which would otherwise let an intermediary and this parser disagree on
  12363. // where the body ends and enable request smuggling. Three cases: a
  12364. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12365. // or empty), which would otherwise be read as "no body"; a non-zero
  12366. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12367. // tolerated for compatibility with existing clients); and a
  12368. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12369. // length undeterminable. None of them may fall through to the "no body"
  12370. // path, or the body bytes are parsed as the next request on a persistent
  12371. // connection.
  12372. auto is_invalid_content_length = false;
  12373. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12374. is_invalid_content_length);
  12375. if (is_invalid_content_length ||
  12376. detail::has_conflicting_content_length(req.headers) ||
  12377. (req.has_header("Transfer-Encoding") &&
  12378. !detail::is_chunked_transfer_encoding(req.headers))) {
  12379. connection_closed = true;
  12380. res.status = StatusCode::BadRequest_400;
  12381. return write_response(strm, close_connection, req, res);
  12382. }
  12383. // RFC 9112 §3.2: Reject more than one Host field line or an invalid Host
  12384. // value, so that every recipient of the request sees the same authority.
  12385. if (req.get_header_value_count("Host") > 1 ||
  12386. !detail::fields::is_host(req.get_header_value("Host"))) {
  12387. connection_closed = true;
  12388. res.status = StatusCode::BadRequest_400;
  12389. output_error_log(Error::InvalidHeaders, &req);
  12390. return write_response(strm, close_connection, req, res);
  12391. }
  12392. // Check if the request URI doesn't exceed the limit
  12393. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12394. connection_closed = true;
  12395. res.status = StatusCode::UriTooLong_414;
  12396. output_error_log(Error::ExceedUriMaxLength, &req);
  12397. return write_response(strm, close_connection, req, res);
  12398. }
  12399. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12400. connection_closed = true;
  12401. }
  12402. if (req.version == "HTTP/1.0" &&
  12403. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12404. connection_closed = true;
  12405. }
  12406. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12407. // itself a trusted proxy. Otherwise any direct client could spoof
  12408. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12409. auto is_trusted_peer = std::any_of(
  12410. trusted_proxies_.begin(), trusted_proxies_.end(),
  12411. [&](const std::string &proxy) { return proxy == remote_addr; });
  12412. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12413. // Some proxies append the address they observed as a separate
  12414. // X-Forwarded-For field line instead of extending the one the client sent
  12415. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12416. // be scanned. Reading only the first occurrence would hand back the
  12417. // client-supplied, and therefore forgeable, value.
  12418. auto x_forwarded_for =
  12419. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12420. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12421. req.remote_addr = derived.empty() ? remote_addr : derived;
  12422. } else {
  12423. req.remote_addr = remote_addr;
  12424. }
  12425. req.remote_port = remote_port;
  12426. req.local_addr = local_addr;
  12427. req.local_port = local_port;
  12428. if (req.has_header("Accept")) {
  12429. auto accept_header =
  12430. detail::get_combined_header_value(req.headers, "Accept");
  12431. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12432. connection_closed = true;
  12433. res.status = StatusCode::BadRequest_400;
  12434. output_error_log(Error::HTTPParsing, &req);
  12435. return write_response(strm, close_connection, req, res);
  12436. }
  12437. }
  12438. if (req.has_header("Range")) {
  12439. const auto &range_header_value = req.get_header_value("Range");
  12440. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12441. connection_closed = true;
  12442. res.status = StatusCode::RangeNotSatisfiable_416;
  12443. output_error_log(Error::InvalidRangeHeader, &req);
  12444. return write_response(strm, close_connection, req, res);
  12445. }
  12446. }
  12447. if (setup_request) { setup_request(req); }
  12448. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12449. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12450. // must be ignored. An expectation we do not recognize is left alone; the
  12451. // 417 the section allows for one is a MAY, not a requirement.
  12452. //
  12453. // `100 Continue` itself is deferred until the body is actually read (see
  12454. // read_content_core), so a request rejected by a later handler never
  12455. // invites the client to send a body nobody will read.
  12456. if (req.version != "HTTP/1.0" &&
  12457. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12458. int status = StatusCode::Continue_100;
  12459. if (expect_100_continue_handler_) {
  12460. status = expect_100_continue_handler_(req, res);
  12461. }
  12462. if (status == StatusCode::Continue_100) {
  12463. req.expect_100_continue_pending_ = true;
  12464. } else {
  12465. if (res.status == -1) { res.status = status; }
  12466. connection_closed = true;
  12467. return write_response(strm, true, req, res);
  12468. }
  12469. }
  12470. // Setup `is_connection_closed` method
  12471. auto sock = strm.socket();
  12472. req.is_connection_closed = [sock]() {
  12473. return !detail::is_socket_alive(sock);
  12474. };
  12475. // WebSocket upgrade
  12476. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12477. // that authentication and other middleware can reject the request with an
  12478. // HTTP response (e.g., 401) before the protocol switches.
  12479. if (detail::is_websocket_upgrade(req)) {
  12480. if (pre_routing_handler_ &&
  12481. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12482. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12483. return write_response_with_content(strm, close_connection, req, res);
  12484. }
  12485. // Find matching WebSocket handler
  12486. for (const auto &entry : websocket_handlers_) {
  12487. if (entry.matcher->match(req)) {
  12488. req.matched_route = entry.matcher->pattern();
  12489. if (pre_request_handler_ &&
  12490. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12491. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12492. return write_response_with_content(strm, close_connection, req, res);
  12493. }
  12494. // Compute accept key
  12495. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12496. auto accept_key = detail::websocket_accept_key(client_key);
  12497. // Negotiate subprotocol
  12498. std::string selected_subprotocol;
  12499. if (entry.sub_protocol_selector) {
  12500. auto protocol_header = detail::get_combined_header_value(
  12501. req.headers, "Sec-WebSocket-Protocol");
  12502. if (!protocol_header.empty()) {
  12503. std::vector<std::string> protocols;
  12504. detail::split(protocol_header.data(),
  12505. protocol_header.data() + protocol_header.size(), ',',
  12506. [&](const char *b, const char *e) {
  12507. protocols.emplace_back(b, e);
  12508. });
  12509. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12510. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12511. if (std::find(protocols.begin(), protocols.end(),
  12512. selected_subprotocol) == protocols.end()) {
  12513. selected_subprotocol.clear();
  12514. }
  12515. }
  12516. }
  12517. // Send 101 Switching Protocols
  12518. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12519. "Upgrade: websocket\r\n"
  12520. "Connection: Upgrade\r\n"
  12521. "Sec-WebSocket-Accept: " +
  12522. accept_key + "\r\n";
  12523. if (!selected_subprotocol.empty()) {
  12524. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12525. return false;
  12526. }
  12527. handshake_response +=
  12528. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12529. }
  12530. handshake_response += "\r\n";
  12531. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12532. 0) {
  12533. return false;
  12534. }
  12535. connection_closed = true;
  12536. if (websocket_upgraded) { *websocket_upgraded = true; }
  12537. {
  12538. #ifdef CPPHTTPLIB_SSL_ENABLED
  12539. if (req.ssl) {
  12540. // wss: the heartbeat ping thread and the read path enter the same
  12541. // TLS session from different threads. Hand the WebSocket a stream
  12542. // that serializes every TLS call, so the shared SSLSocketStream on
  12543. // the plain HTTP/HTTPS paths stays untouched.
  12544. auto ws_strm =
  12545. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12546. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12547. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12548. write_timeout_sec_, write_timeout_usec_));
  12549. ws::WebSocket ws(std::move(ws_strm), req, true,
  12550. websocket_ping_interval_sec_,
  12551. websocket_max_missed_pongs_);
  12552. entry.handler(req, ws);
  12553. return true;
  12554. }
  12555. #endif
  12556. // Use WebSocket-specific read timeout instead of HTTP timeout
  12557. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12558. 0);
  12559. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12560. websocket_max_missed_pongs_);
  12561. entry.handler(req, ws);
  12562. }
  12563. return true;
  12564. }
  12565. }
  12566. // No matching handler - fall through to 404
  12567. }
  12568. // Routing
  12569. auto routed = false;
  12570. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12571. routed = routing(req, res, strm);
  12572. #else
  12573. try {
  12574. routed = routing(req, res, strm);
  12575. } catch (std::exception &) {
  12576. if (exception_handler_) {
  12577. auto ep = std::current_exception();
  12578. exception_handler_(req, res, ep);
  12579. routed = true;
  12580. } else {
  12581. res.status = StatusCode::InternalServerError_500;
  12582. }
  12583. } catch (...) {
  12584. if (exception_handler_) {
  12585. auto ep = std::current_exception();
  12586. exception_handler_(req, res, ep);
  12587. routed = true;
  12588. } else {
  12589. res.status = StatusCode::InternalServerError_500;
  12590. }
  12591. }
  12592. #endif
  12593. auto ret = false;
  12594. if (routed) {
  12595. if (res.status == -1) {
  12596. res.status = req.ranges.empty() ? StatusCode::OK_200
  12597. : StatusCode::PartialContent_206;
  12598. }
  12599. // Serve file content by using a content provider
  12600. auto file_open_error = false;
  12601. if (!res.file_content_path_.empty()) {
  12602. const auto &path = res.file_content_path_;
  12603. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12604. if (!mm->is_open()) {
  12605. res.body.clear();
  12606. res.content_length_ = 0;
  12607. res.content_provider_ = nullptr;
  12608. res.status = StatusCode::NotFound_404;
  12609. output_error_log(Error::OpenFile, &req);
  12610. file_open_error = true;
  12611. } else {
  12612. auto content_type = res.file_content_content_type_;
  12613. if (content_type.empty()) {
  12614. content_type = detail::find_content_type(
  12615. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12616. }
  12617. detail::set_file_content_provider(
  12618. res, mm, content_type,
  12619. static_file_encoding(req, res, content_type, mm->size()));
  12620. }
  12621. }
  12622. if (file_open_error) {
  12623. ret = write_response(strm, close_connection, req, res);
  12624. } else if (detail::range_error(req, res)) {
  12625. res.body.clear();
  12626. res.content_length_ = 0;
  12627. res.content_provider_ = nullptr;
  12628. res.status = StatusCode::RangeNotSatisfiable_416;
  12629. ret = write_response(strm, close_connection, req, res);
  12630. } else {
  12631. ret = write_response_with_content(strm, close_connection, req, res);
  12632. }
  12633. } else {
  12634. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12635. ret = write_response(strm, close_connection, req, res);
  12636. }
  12637. // Drain any unconsumed framed body to prevent request smuggling on
  12638. // keep-alive. Without framing there is no body to drain — reading would
  12639. // consume the next request (issue #2450). If the response has committed the
  12640. // connection to close, there is no next request to protect.
  12641. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12642. !detail::has_header_token(res.headers, "Connection", "close")) {
  12643. int dummy_status;
  12644. if (!detail::read_content(
  12645. strm, req, payload_max_length_, dummy_status, nullptr,
  12646. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12647. connection_closed = true;
  12648. }
  12649. }
  12650. return ret;
  12651. }
  12652. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12653. inline bool Server::process_and_close_socket(socket_t sock) {
  12654. std::string remote_addr;
  12655. int remote_port = 0;
  12656. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12657. std::string local_addr;
  12658. int local_port = 0;
  12659. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12660. bool websocket_upgraded = false;
  12661. auto ret = serve_guarded([&]() {
  12662. return detail::process_server_socket(
  12663. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12664. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12665. write_timeout_usec_,
  12666. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12667. return process_request(strm, remote_addr, remote_port, local_addr,
  12668. local_port, close_connection,
  12669. connection_closed, nullptr,
  12670. &websocket_upgraded);
  12671. });
  12672. });
  12673. detail::drain_and_close_socket(sock);
  12674. return ret;
  12675. }
  12676. inline void Server::output_log(const Request &req, const Response &res) const {
  12677. if (logger_) {
  12678. std::lock_guard<std::mutex> guard(logger_mutex_);
  12679. logger_(req, res);
  12680. }
  12681. }
  12682. inline void Server::output_pre_compression_log(const Request &req,
  12683. const Response &res) const {
  12684. if (pre_compression_logger_) {
  12685. std::lock_guard<std::mutex> guard(logger_mutex_);
  12686. pre_compression_logger_(req, res);
  12687. }
  12688. }
  12689. inline void Server::output_error_log(const Error &err,
  12690. const Request *req) const {
  12691. if (error_logger_) {
  12692. std::lock_guard<std::mutex> guard(logger_mutex_);
  12693. error_logger_(err, req);
  12694. }
  12695. }
  12696. /*
  12697. * Group 5: ClientImpl and Client (Universal) implementation
  12698. */
  12699. // HTTP client implementation
  12700. inline ClientImpl::ClientImpl(const std::string &host)
  12701. : ClientImpl(host, 80, std::string(), std::string()) {}
  12702. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12703. : ClientImpl(host, port, std::string(), std::string()) {}
  12704. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12705. const std::string &client_cert_path,
  12706. const std::string &client_key_path)
  12707. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12708. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12709. inline ClientImpl::~ClientImpl() {
  12710. // Wait until all the requests in flight are handled.
  12711. size_t retry_count = 10;
  12712. while (retry_count-- > 0) {
  12713. {
  12714. std::lock_guard<std::mutex> guard(socket_mutex_);
  12715. if (socket_requests_in_flight_ == 0) { break; }
  12716. }
  12717. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12718. }
  12719. std::lock_guard<std::mutex> guard(socket_mutex_);
  12720. shutdown_socket(socket_);
  12721. close_socket(socket_);
  12722. }
  12723. inline bool ClientImpl::is_valid() const { return true; }
  12724. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12725. client_cert_path_ = rhs.client_cert_path_;
  12726. client_key_path_ = rhs.client_key_path_;
  12727. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12728. read_timeout_sec_ = rhs.read_timeout_sec_;
  12729. read_timeout_usec_ = rhs.read_timeout_usec_;
  12730. write_timeout_sec_ = rhs.write_timeout_sec_;
  12731. write_timeout_usec_ = rhs.write_timeout_usec_;
  12732. max_timeout_msec_ = rhs.max_timeout_msec_;
  12733. basic_auth_username_ = rhs.basic_auth_username_;
  12734. basic_auth_password_ = rhs.basic_auth_password_;
  12735. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12736. keep_alive_ = rhs.keep_alive_;
  12737. follow_location_ = rhs.follow_location_;
  12738. path_encode_ = rhs.path_encode_;
  12739. address_family_ = rhs.address_family_;
  12740. tcp_nodelay_ = rhs.tcp_nodelay_;
  12741. ipv6_v6only_ = rhs.ipv6_v6only_;
  12742. socket_options_ = rhs.socket_options_;
  12743. compress_ = rhs.compress_;
  12744. decompress_ = rhs.decompress_;
  12745. payload_max_length_ = rhs.payload_max_length_;
  12746. has_payload_max_length_ = rhs.has_payload_max_length_;
  12747. interface_ = rhs.interface_;
  12748. proxy_host_ = rhs.proxy_host_;
  12749. proxy_port_ = rhs.proxy_port_;
  12750. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12751. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12752. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12753. no_proxy_entries_ = rhs.no_proxy_entries_;
  12754. logger_ = rhs.logger_;
  12755. error_logger_ = rhs.error_logger_;
  12756. #ifdef CPPHTTPLIB_SSL_ENABLED
  12757. digest_auth_username_ = rhs.digest_auth_username_;
  12758. digest_auth_password_ = rhs.digest_auth_password_;
  12759. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12760. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12761. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12762. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12763. server_certificate_verification_ = rhs.server_certificate_verification_;
  12764. server_hostname_verification_ = rhs.server_hostname_verification_;
  12765. system_ca_mode_ = rhs.system_ca_mode_;
  12766. #endif
  12767. }
  12768. inline bool
  12769. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12770. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12771. if (no_proxy_entries_.empty()) { return true; }
  12772. // host_ is const so its normalized form is invariant; cache it. The
  12773. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12774. if (host == host_) {
  12775. if (!host_normalized_valid_) {
  12776. host_normalized_ = detail::normalize_target(host_);
  12777. host_normalized_valid_ = true;
  12778. }
  12779. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12780. }
  12781. auto target = detail::normalize_target(host);
  12782. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12783. }
  12784. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12785. if (is_proxy_enabled_for_host(host_)) {
  12786. return detail::create_client_socket(
  12787. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12788. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12789. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12790. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12791. }
  12792. // Check is custom IP or hostname specified for host_
  12793. std::string connect_host;
  12794. std::string ip;
  12795. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12796. return detail::create_client_socket(
  12797. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12798. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12799. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12800. write_timeout_usec_, interface_, error);
  12801. }
  12802. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12803. Error &error) {
  12804. auto sock = create_client_socket(error);
  12805. if (sock == INVALID_SOCKET) { return false; }
  12806. socket.sock = sock;
  12807. return true;
  12808. }
  12809. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12810. return create_and_connect_socket(socket, error);
  12811. }
  12812. inline bool ClientImpl::setup_proxy_connection(
  12813. Socket & /*socket*/,
  12814. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12815. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12816. return true;
  12817. }
  12818. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12819. bool /*shutdown_gracefully*/) {
  12820. // If there are any requests in flight from threads other than us, then it's
  12821. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12822. assert(socket_requests_in_flight_ == 0 ||
  12823. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12824. }
  12825. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12826. if (socket.sock == INVALID_SOCKET) { return; }
  12827. detail::shutdown_socket(socket.sock);
  12828. }
  12829. inline void ClientImpl::close_socket(Socket &socket) {
  12830. // If there are requests in flight in another thread, usually closing
  12831. // the socket will be fine and they will simply receive an error when
  12832. // using the closed socket, but it is still a bug since rarely the OS
  12833. // may reassign the socket id to be used for a new socket, and then
  12834. // suddenly they will be operating on a live socket that is different
  12835. // than the one they intended!
  12836. assert(socket_requests_in_flight_ == 0 ||
  12837. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12838. // It is also a bug if this happens while SSL is still active
  12839. #ifdef CPPHTTPLIB_SSL_ENABLED
  12840. assert(socket.ssl == nullptr);
  12841. #endif
  12842. if (socket.sock == INVALID_SOCKET) { return; }
  12843. detail::close_socket(socket.sock);
  12844. socket.sock = INVALID_SOCKET;
  12845. }
  12846. inline void ClientImpl::disconnect(bool gracefully) {
  12847. shutdown_ssl(socket_, gracefully);
  12848. shutdown_socket(socket_);
  12849. close_socket(socket_);
  12850. }
  12851. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12852. Response &res,
  12853. bool skip_100_continue) const {
  12854. std::array<char, 2048> buf{};
  12855. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12856. if (!line_reader.getline()) { return false; }
  12857. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12858. res.reason)) {
  12859. return req.method == "CONNECT";
  12860. }
  12861. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12862. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12863. if (!line_reader.getline()) { return false; } // CRLF
  12864. if (!line_reader.getline()) { return false; } // next response line
  12865. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12866. res.reason)) {
  12867. return false;
  12868. }
  12869. }
  12870. return true;
  12871. }
  12872. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12873. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12874. auto ret = send_(req, res, error);
  12875. if (error == Error::SSLPeerCouldBeClosed_) {
  12876. assert(!ret);
  12877. ret = send_(req, res, error);
  12878. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12879. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12880. }
  12881. return ret;
  12882. }
  12883. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12884. {
  12885. std::lock_guard<std::mutex> guard(socket_mutex_);
  12886. // Set this to false immediately - if it ever gets set to true by the end
  12887. // of the request, we know another thread instructed us to close the
  12888. // socket.
  12889. socket_should_be_closed_when_request_is_done_ = false;
  12890. auto is_alive = false;
  12891. if (socket_.is_open()) {
  12892. is_alive = detail::is_socket_alive(socket_.sock);
  12893. #ifdef CPPHTTPLIB_SSL_ENABLED
  12894. if (is_alive && is_ssl()) {
  12895. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12896. is_alive = false;
  12897. }
  12898. }
  12899. #endif
  12900. if (!is_alive) {
  12901. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12902. disconnect(/*gracefully=*/false);
  12903. }
  12904. }
  12905. if (!is_alive) {
  12906. if (!ensure_socket_connection(socket_, error)) {
  12907. output_error_log(error, &req);
  12908. return false;
  12909. }
  12910. {
  12911. auto success = true;
  12912. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12913. error)) {
  12914. if (!success) { output_error_log(error, &req); }
  12915. return success;
  12916. }
  12917. }
  12918. }
  12919. // Mark the current socket as being in use so that it cannot be closed by
  12920. // anyone else while this request is ongoing, even though we will be
  12921. // releasing the mutex.
  12922. if (socket_requests_in_flight_ > 1) {
  12923. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12924. }
  12925. socket_requests_in_flight_ += 1;
  12926. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12927. }
  12928. for (const auto &header : default_headers_) {
  12929. if (req.headers.find(header.first) == req.headers.end()) {
  12930. req.headers.insert(header);
  12931. }
  12932. }
  12933. auto ret = false;
  12934. auto close_connection = !keep_alive_;
  12935. auto se = detail::scope_exit([&]() {
  12936. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12937. std::lock_guard<std::mutex> guard(socket_mutex_);
  12938. socket_requests_in_flight_ -= 1;
  12939. if (socket_requests_in_flight_ <= 0) {
  12940. assert(socket_requests_in_flight_ == 0);
  12941. socket_requests_are_from_thread_ = std::thread::id();
  12942. }
  12943. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12944. !ret) {
  12945. disconnect(/*gracefully=*/true);
  12946. }
  12947. });
  12948. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12949. return handle_request(strm, req, res, close_connection, error);
  12950. });
  12951. if (!ret) {
  12952. if (error == Error::Success) {
  12953. error = Error::Unknown;
  12954. output_error_log(error, &req);
  12955. }
  12956. }
  12957. return ret;
  12958. }
  12959. inline Result ClientImpl::send(const Request &req) {
  12960. auto req2 = req;
  12961. return send_(std::move(req2));
  12962. }
  12963. inline Result ClientImpl::send_(Request &&req) {
  12964. auto res = detail::make_unique<Response>();
  12965. auto error = Error::Success;
  12966. auto ret = send(req, *res, error);
  12967. #ifdef CPPHTTPLIB_SSL_ENABLED
  12968. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12969. last_ssl_error_, last_backend_error_};
  12970. #else
  12971. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12972. #endif
  12973. }
  12974. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12975. const std::string &ct) {
  12976. (void)for_stream;
  12977. // Default headers are meant for the origin and may carry its credentials, so
  12978. // keep them off the CONNECT request the proxy reads.
  12979. if (r.method != "CONNECT") {
  12980. for (const auto &header : default_headers_) {
  12981. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12982. }
  12983. }
  12984. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12985. // prepend it rather than appending it after the caller's own fields.
  12986. if (!r.has_header("Host")) {
  12987. r.headers.emplace_front(
  12988. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12989. address_family_));
  12990. }
  12991. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12992. if (!r.content_receiver) {
  12993. if (!r.has_header("Accept-Encoding")) {
  12994. std::string accept_encoding;
  12995. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12996. accept_encoding = "br";
  12997. #endif
  12998. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12999. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13000. accept_encoding += "gzip, deflate";
  13001. #endif
  13002. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13003. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13004. accept_encoding += "zstd";
  13005. #endif
  13006. r.set_header("Accept-Encoding", accept_encoding);
  13007. }
  13008. detail::add_default_user_agent_header(r);
  13009. }
  13010. if (!r.body.empty()) {
  13011. if (!ct.empty() && !r.has_header("Content-Type")) {
  13012. r.headers.emplace("Content-Type", ct);
  13013. }
  13014. if (!r.has_header("Content-Length")) {
  13015. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13016. }
  13017. }
  13018. }
  13019. inline ClientImpl::StreamHandle
  13020. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13021. const Params &params, const Headers &headers,
  13022. const std::string &body,
  13023. const std::string &content_type) {
  13024. StreamHandle handle;
  13025. handle.response = detail::make_unique<Response>();
  13026. handle.error = Error::Success;
  13027. // Encode the target exactly like the buffered send path does, so that the
  13028. // same `path` produces the same request line through either API.
  13029. auto raw_query_path =
  13030. params.empty() ? path : append_query_params(path, params);
  13031. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13032. handle.connection_ = detail::make_unique<ClientConnection>();
  13033. {
  13034. std::lock_guard<std::mutex> guard(socket_mutex_);
  13035. auto is_alive = false;
  13036. if (socket_.is_open()) {
  13037. is_alive = detail::is_socket_alive(socket_.sock);
  13038. #ifdef CPPHTTPLIB_SSL_ENABLED
  13039. if (is_alive && is_ssl()) {
  13040. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13041. is_alive = false;
  13042. }
  13043. }
  13044. #endif
  13045. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13046. }
  13047. if (!is_alive) {
  13048. if (!ensure_socket_connection(socket_, handle.error)) {
  13049. handle.response.reset();
  13050. return handle;
  13051. }
  13052. {
  13053. auto success = true;
  13054. auto start_time = std::chrono::steady_clock::now();
  13055. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13056. success, handle.error)) {
  13057. if (!success) { handle.response.reset(); }
  13058. return handle;
  13059. }
  13060. }
  13061. }
  13062. transfer_socket_ownership_to_handle(handle);
  13063. }
  13064. #ifdef CPPHTTPLIB_SSL_ENABLED
  13065. if (is_ssl() && handle.connection_->session) {
  13066. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13067. handle.connection_->sock, handle.connection_->session,
  13068. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13069. write_timeout_usec_);
  13070. } else {
  13071. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13072. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13073. write_timeout_sec_, write_timeout_usec_);
  13074. }
  13075. #else
  13076. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13077. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13078. write_timeout_sec_, write_timeout_usec_);
  13079. #endif
  13080. handle.stream_ = handle.socket_stream_.get();
  13081. Request req;
  13082. req.method = method;
  13083. req.path = query_path;
  13084. req.headers = headers;
  13085. req.body = body;
  13086. prepare_default_headers(req, true, content_type);
  13087. auto &strm = *handle.stream_;
  13088. // Build the request line and headers in memory first, like write_request()
  13089. // does, so that a rejected header leaves nothing on the wire.
  13090. {
  13091. detail::BufferStream bstrm;
  13092. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13093. handle.error = Error::Write;
  13094. handle.response.reset();
  13095. return handle;
  13096. }
  13097. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13098. handle.error)) {
  13099. handle.response.reset();
  13100. return handle;
  13101. }
  13102. const auto &data = bstrm.get_buffer();
  13103. if (!detail::write_data(strm, data.data(), data.size())) {
  13104. handle.error = Error::Write;
  13105. handle.response.reset();
  13106. return handle;
  13107. }
  13108. }
  13109. if (!body.empty()) {
  13110. if (strm.write(body.data(), body.size()) < 0) {
  13111. handle.error = Error::Write;
  13112. handle.response.reset();
  13113. return handle;
  13114. }
  13115. }
  13116. if (!read_response_line(strm, req, *handle.response) ||
  13117. !detail::read_headers(strm, handle.response->headers)) {
  13118. handle.error = Error::Read;
  13119. handle.response.reset();
  13120. return handle;
  13121. }
  13122. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13123. // (204/304) response legitimately carries framing headers with no body.
  13124. if (method != "HEAD" &&
  13125. handle.response->status != StatusCode::NoContent_204 &&
  13126. handle.response->status != StatusCode::NotModified_304 &&
  13127. detail::has_conflicting_content_length(handle.response->headers)) {
  13128. handle.error = Error::Read;
  13129. handle.response.reset();
  13130. return handle;
  13131. }
  13132. handle.body_reader_.stream = handle.stream_;
  13133. handle.body_reader_.payload_max_length = payload_max_length_;
  13134. if (handle.response->has_header("Content-Length")) {
  13135. bool is_invalid = false;
  13136. auto content_length = detail::get_header_value_u64(
  13137. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13138. if (is_invalid) {
  13139. handle.error = Error::Read;
  13140. handle.response.reset();
  13141. return handle;
  13142. }
  13143. handle.body_reader_.has_content_length = true;
  13144. handle.body_reader_.content_length = content_length;
  13145. }
  13146. handle.body_reader_.chunked =
  13147. detail::is_chunked_transfer_encoding(handle.response->headers);
  13148. auto content_encoding = detail::get_combined_header_value(
  13149. handle.response->headers, "Content-Encoding");
  13150. if (!content_encoding.empty()) {
  13151. // Same policy as prepare_content_receiver(): reject a coding we know about
  13152. // but were not built with, pass an unrecognized one through as-is.
  13153. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13154. if (!handle.decompressor_) {
  13155. if (detail::is_known_content_encoding(content_encoding)) {
  13156. handle.error = Error::UnsupportedContentEncoding;
  13157. handle.response.reset();
  13158. return handle;
  13159. }
  13160. } else if (!handle.decompressor_->is_valid()) {
  13161. handle.error = Error::Compression;
  13162. handle.response.reset();
  13163. return handle;
  13164. }
  13165. }
  13166. return handle;
  13167. }
  13168. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13169. if (!is_valid() || !response) { return -1; }
  13170. if (decompressor_) { return read_with_decompression(buf, len); }
  13171. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13172. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13173. trailers_parsed_ = true;
  13174. if (body_reader_.chunked_decoder) {
  13175. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13176. response->trailers, response->headers)) {
  13177. return n;
  13178. }
  13179. } else {
  13180. detail::ChunkedDecoder dec(*stream_);
  13181. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13182. return n;
  13183. }
  13184. }
  13185. }
  13186. return n;
  13187. }
  13188. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13189. size_t len) {
  13190. if (decompress_offset_ < decompress_buffer_.size()) {
  13191. auto available = decompress_buffer_.size() - decompress_offset_;
  13192. auto to_copy = (std::min)(len, available);
  13193. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13194. decompress_offset_ += to_copy;
  13195. decompressed_bytes_read_ += to_copy;
  13196. return static_cast<ssize_t>(to_copy);
  13197. }
  13198. decompress_buffer_.clear();
  13199. decompress_offset_ = 0;
  13200. constexpr size_t kDecompressionBufferSize = 8192;
  13201. char compressed_buf[kDecompressionBufferSize];
  13202. while (true) {
  13203. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13204. sizeof(compressed_buf));
  13205. if (n <= 0) { return n; }
  13206. bool decompress_ok = decompressor_->decompress(
  13207. compressed_buf, static_cast<size_t>(n),
  13208. [this](const char *data, size_t data_len) {
  13209. decompress_buffer_.append(data, data_len);
  13210. auto limit = body_reader_.payload_max_length;
  13211. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13212. return false;
  13213. }
  13214. return true;
  13215. });
  13216. if (!decompress_ok) {
  13217. body_reader_.last_error = Error::Read;
  13218. return -1;
  13219. }
  13220. if (!decompress_buffer_.empty()) { break; }
  13221. }
  13222. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13223. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13224. decompress_offset_ = to_copy;
  13225. decompressed_bytes_read_ += to_copy;
  13226. return static_cast<ssize_t>(to_copy);
  13227. }
  13228. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13229. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13230. return;
  13231. }
  13232. trailers_parsed_ = true;
  13233. const auto bufsiz = 128;
  13234. char line_buf[bufsiz];
  13235. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13236. if (!line_reader.getline()) { return; }
  13237. if (!detail::parse_trailers(line_reader, response->trailers,
  13238. response->headers)) {
  13239. return;
  13240. }
  13241. }
  13242. namespace detail {
  13243. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13244. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13245. size_t &out_chunk_offset,
  13246. size_t &out_chunk_total) {
  13247. if (finished) { return 0; }
  13248. if (chunk_remaining == 0) {
  13249. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13250. if (!lr.getline()) { return -1; }
  13251. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13252. // the line terminator is never mistaken for line content.
  13253. const char *eol = lr.ptr() + lr.size();
  13254. if (lr.end_with_crlf()) {
  13255. eol -= 2;
  13256. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13257. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13258. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13259. // has to come off here or the check below would reject the line.
  13260. eol -= 1;
  13261. }
  13262. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13263. const char *p = lr.ptr();
  13264. int v = 0;
  13265. if (p == eol || !is_hex(*p, v)) { return -1; }
  13266. size_t chunk_len = 0;
  13267. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13268. for (; p < eol && is_hex(*p, v); ++p) {
  13269. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13270. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13271. }
  13272. while (p < eol && is_space_or_tab(*p)) {
  13273. ++p;
  13274. }
  13275. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13276. // terminator, and it is built from tokens and quoted-strings, so it never
  13277. // holds a CR, LF or any other control character. getline() reads up to the
  13278. // CRLF, so a bare LF left in here would be swallowed as extension text
  13279. // while an intermediary that ends the line on it delimits the chunks
  13280. // differently, and the two disagree on where the body ends (request
  13281. // smuggling).
  13282. if (p < eol && *p != ';') { return -1; }
  13283. for (; p < eol; ++p) {
  13284. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13285. }
  13286. if (chunk_len == 0) {
  13287. chunk_remaining = 0;
  13288. finished = true;
  13289. out_chunk_offset = 0;
  13290. out_chunk_total = 0;
  13291. return 0;
  13292. }
  13293. chunk_remaining = chunk_len;
  13294. last_chunk_total = chunk_remaining;
  13295. last_chunk_offset = 0;
  13296. }
  13297. auto to_read = (std::min)(chunk_remaining, len);
  13298. auto n = strm.read(buf, to_read);
  13299. if (n <= 0) { return -1; }
  13300. auto offset_before = last_chunk_offset;
  13301. last_chunk_offset += static_cast<size_t>(n);
  13302. chunk_remaining -= static_cast<size_t>(n);
  13303. out_chunk_offset = offset_before;
  13304. out_chunk_total = last_chunk_total;
  13305. if (chunk_remaining == 0) {
  13306. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13307. if (!lr.getline()) { return -1; }
  13308. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13309. }
  13310. return n;
  13311. }
  13312. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13313. const Headers &src_headers) {
  13314. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13315. if (!lr.getline()) { return false; }
  13316. return parse_trailers(lr, dest, src_headers);
  13317. }
  13318. } // namespace detail
  13319. inline void
  13320. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13321. handle.connection_->sock = socket_.sock;
  13322. #ifdef CPPHTTPLIB_SSL_ENABLED
  13323. handle.connection_->session = socket_.ssl;
  13324. socket_.ssl = nullptr;
  13325. #endif
  13326. socket_.sock = INVALID_SOCKET;
  13327. }
  13328. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13329. Response &res, bool close_connection,
  13330. Error &error) {
  13331. if (req.path.empty()) {
  13332. error = Error::Connection;
  13333. output_error_log(error, &req);
  13334. return false;
  13335. }
  13336. auto req_save = req;
  13337. bool ret;
  13338. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13339. auto req2 = req;
  13340. req2.path = "http://" +
  13341. detail::make_host_and_port_string(host_, port_, false) +
  13342. req.path;
  13343. ret = process_request(strm, req2, res, close_connection, error);
  13344. req = std::move(req2);
  13345. req.path = req_save.path;
  13346. } else {
  13347. ret = process_request(strm, req, res, close_connection, error);
  13348. }
  13349. if (!ret) { return false; }
  13350. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13351. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13352. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13353. // for this to be safe.
  13354. // This is safe to call because handle_request is only called by send_
  13355. // which locks the request mutex during the process. It would be a bug
  13356. // to call it from a different thread since it's a thread-safety issue
  13357. // to do these things to the socket if another thread is using the socket.
  13358. std::lock_guard<std::mutex> guard(socket_mutex_);
  13359. disconnect(/*gracefully=*/true);
  13360. }
  13361. if (300 < res.status && res.status < 400 && follow_location_) {
  13362. req = std::move(req_save);
  13363. ret = redirect(req, res, error);
  13364. }
  13365. #ifdef CPPHTTPLIB_SSL_ENABLED
  13366. if ((res.status == StatusCode::Unauthorized_401 ||
  13367. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13368. req.authorization_count_ < 5) {
  13369. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13370. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13371. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13372. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13373. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13374. return ret;
  13375. }
  13376. const auto &username =
  13377. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13378. const auto &password =
  13379. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13380. if (!username.empty() && !password.empty()) {
  13381. std::map<std::string, std::string> auth;
  13382. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13383. Request new_req = req;
  13384. new_req.authorization_count_ += 1;
  13385. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13386. : "Authorization");
  13387. new_req.headers.insert(detail::make_digest_authentication_header(
  13388. req, auth, new_req.authorization_count_, detail::random_string(10),
  13389. username, password, is_proxy));
  13390. Response new_res;
  13391. ret = send(new_req, new_res, error);
  13392. if (ret) { res = std::move(new_res); }
  13393. }
  13394. }
  13395. }
  13396. #endif
  13397. return ret;
  13398. }
  13399. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13400. if (req.redirect_count_ == 0) {
  13401. error = Error::ExceedRedirectCount;
  13402. output_error_log(error, &req);
  13403. return false;
  13404. }
  13405. auto location = res.get_header_value("location");
  13406. if (location.empty()) { return false; }
  13407. detail::UrlComponents uc;
  13408. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13409. uc)) {
  13410. return false;
  13411. }
  13412. // Only follow http/https redirects
  13413. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13414. return false;
  13415. }
  13416. auto scheme = is_ssl() ? "https" : "http";
  13417. auto next_scheme = std::move(uc.scheme);
  13418. auto next_host = std::move(uc.host);
  13419. auto port_str = std::move(uc.port);
  13420. auto next_path = std::move(uc.path);
  13421. auto next_query = std::move(uc.query);
  13422. auto next_port = port_;
  13423. if (!port_str.empty()) {
  13424. if (!detail::parse_port(port_str, next_port)) { return false; }
  13425. } else if (!next_scheme.empty()) {
  13426. next_port = next_scheme == "https" ? 443 : 80;
  13427. }
  13428. if (next_scheme.empty()) { next_scheme = scheme; }
  13429. if (next_host.empty()) { next_host = host_; }
  13430. if (next_path.empty()) { next_path = "/"; }
  13431. auto path = std::move(next_path) + next_query;
  13432. // Same host redirect - use current client
  13433. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13434. return detail::redirect(*this, req, res, path, location, error);
  13435. }
  13436. // Cross-host/scheme redirect - create new client with robust setup
  13437. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13438. path, location, error);
  13439. }
  13440. // New method for robust redirect client creation
  13441. inline bool ClientImpl::create_redirect_client(
  13442. const std::string &scheme, const std::string &host, int port, Request &req,
  13443. Response &res, const std::string &path, const std::string &location,
  13444. Error &error) {
  13445. // Determine if we need SSL
  13446. auto need_ssl = (scheme == "https");
  13447. // Clean up request headers that are host/client specific
  13448. // Remove headers that should not be carried over to new host
  13449. auto headers_to_remove = std::vector<std::string>{
  13450. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13451. for (const auto &header_name : headers_to_remove) {
  13452. auto it = req.headers.find(header_name);
  13453. while (it != req.headers.end()) {
  13454. it = req.headers.erase(it);
  13455. it = req.headers.find(header_name);
  13456. }
  13457. }
  13458. // Create appropriate client type and handle redirect
  13459. if (need_ssl) {
  13460. #ifdef CPPHTTPLIB_SSL_ENABLED
  13461. // Create SSL client for HTTPS redirect
  13462. SSLClient redirect_client(host, port);
  13463. // Setup basic client configuration first
  13464. setup_redirect_client(redirect_client);
  13465. redirect_client.enable_server_certificate_verification(
  13466. server_certificate_verification_);
  13467. redirect_client.enable_server_hostname_verification(
  13468. server_hostname_verification_);
  13469. redirect_client.system_ca_mode_ = system_ca_mode_;
  13470. // Transfer CA certificate to redirect client
  13471. if (!ca_cert_pem_.empty()) {
  13472. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13473. ca_cert_pem_.size());
  13474. }
  13475. if (!ca_cert_file_path_.empty()) {
  13476. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13477. }
  13478. // Client certificates are set through constructor for SSLClient
  13479. // NOTE: SSLClient constructor already takes client_cert_path and
  13480. // client_key_path so we need to create it properly if client certs are
  13481. // needed
  13482. // Execute the redirect
  13483. return detail::redirect(redirect_client, req, res, path, location, error);
  13484. #else
  13485. // SSL not supported - set appropriate error
  13486. error = Error::SSLConnection;
  13487. output_error_log(error, &req);
  13488. return false;
  13489. #endif
  13490. } else {
  13491. // HTTP redirect
  13492. ClientImpl redirect_client(host, port);
  13493. // Setup client with robust configuration
  13494. setup_redirect_client(redirect_client);
  13495. // Execute the redirect
  13496. return detail::redirect(redirect_client, req, res, path, location, error);
  13497. }
  13498. }
  13499. // New method for robust client setup (based on basic_manual_redirect.cpp
  13500. // logic)
  13501. template <typename ClientType>
  13502. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13503. // Copy basic settings first
  13504. client.set_connection_timeout(connection_timeout_sec_);
  13505. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13506. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13507. client.set_keep_alive(keep_alive_);
  13508. client.set_follow_location(
  13509. true); // Enable redirects to handle multi-step redirects
  13510. client.set_path_encode(path_encode_);
  13511. client.set_compress(compress_);
  13512. client.set_decompress(decompress_);
  13513. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13514. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13515. // 15.4, credentials must not be forwarded when redirecting to a different
  13516. // host. This function is only called for cross-host redirects; same-host
  13517. // redirects are handled directly in ClientImpl::redirect().
  13518. // Copy the proxy configuration unconditionally; the per-target bypass is
  13519. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13520. // still use the proxy.
  13521. client.no_proxy_entries_ = no_proxy_entries_;
  13522. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13523. client.set_proxy(proxy_host_, proxy_port_);
  13524. if (!proxy_basic_auth_username_.empty() ||
  13525. !proxy_basic_auth_password_.empty()) {
  13526. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13527. proxy_basic_auth_password_);
  13528. }
  13529. if (!proxy_bearer_token_auth_token_.empty()) {
  13530. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13531. }
  13532. #ifdef CPPHTTPLIB_SSL_ENABLED
  13533. if (!proxy_digest_auth_username_.empty()) {
  13534. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13535. proxy_digest_auth_password_);
  13536. }
  13537. #endif
  13538. }
  13539. // Copy network and socket settings
  13540. client.set_address_family(address_family_);
  13541. client.set_tcp_nodelay(tcp_nodelay_);
  13542. client.set_ipv6_v6only(ipv6_v6only_);
  13543. if (socket_options_) { client.set_socket_options(socket_options_); }
  13544. if (!interface_.empty()) { client.set_interface(interface_); }
  13545. // Copy logging and headers
  13546. if (logger_) { client.set_logger(logger_); }
  13547. if (error_logger_) { client.set_error_logger(error_logger_); }
  13548. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13549. // Each new client should generate its own headers based on its target host
  13550. }
  13551. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13552. const Request &req,
  13553. Error &error) const {
  13554. auto is_shutting_down = []() { return false; };
  13555. if (req.is_chunked_content_provider_) {
  13556. auto compressor = compress_ ? detail::create_compressor().first
  13557. : std::unique_ptr<detail::compressor>();
  13558. if (!compressor) {
  13559. compressor = detail::make_unique<detail::nocompressor>();
  13560. }
  13561. return detail::write_content_chunked(strm, req.content_provider_,
  13562. is_shutting_down, *compressor, error);
  13563. } else {
  13564. return detail::write_content_with_progress(
  13565. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13566. req.upload_progress, error);
  13567. }
  13568. }
  13569. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13570. bool close_connection, Error &error,
  13571. bool skip_body, bool &rejected_locally) {
  13572. rejected_locally = false;
  13573. // Prepare additional headers
  13574. if (close_connection) {
  13575. if (!req.has_header("Connection")) {
  13576. req.set_header("Connection", "close");
  13577. }
  13578. }
  13579. std::string ct_for_defaults;
  13580. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13581. ct_for_defaults = "text/plain";
  13582. }
  13583. prepare_default_headers(req, false, ct_for_defaults);
  13584. if (req.body.empty()) {
  13585. if (req.content_provider_) {
  13586. if (!req.is_chunked_content_provider_) {
  13587. if (!req.has_header("Content-Length")) {
  13588. auto length = std::to_string(req.content_length_);
  13589. req.set_header("Content-Length", length);
  13590. }
  13591. }
  13592. } else {
  13593. if (req.method == "POST" || req.method == "PUT" ||
  13594. req.method == "PATCH") {
  13595. req.set_header("Content-Length", "0");
  13596. }
  13597. }
  13598. }
  13599. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13600. // it opens is read by the origin. Each credential goes only to its own hop.
  13601. auto is_connect = req.method == "CONNECT";
  13602. if (!is_connect && !req.has_header("Authorization")) {
  13603. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13604. req.headers.insert(make_basic_authentication_header(
  13605. basic_auth_username_, basic_auth_password_, false));
  13606. } else if (!bearer_token_auth_token_.empty()) {
  13607. req.headers.insert(make_bearer_token_authentication_header(
  13608. bearer_token_auth_token_, false));
  13609. }
  13610. }
  13611. // Proxy-Authorization is only sent when the proxy reads this message —
  13612. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13613. // would leak proxy credentials to the destination server.
  13614. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13615. if ((!proxy_basic_auth_username_.empty() ||
  13616. !proxy_basic_auth_password_.empty()) &&
  13617. !req.has_header("Proxy-Authorization")) {
  13618. req.headers.insert(make_basic_authentication_header(
  13619. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13620. }
  13621. if (!proxy_bearer_token_auth_token_.empty() &&
  13622. !req.has_header("Proxy-Authorization")) {
  13623. req.headers.insert(make_bearer_token_authentication_header(
  13624. proxy_bearer_token_auth_token_, true));
  13625. }
  13626. }
  13627. // Request line and headers
  13628. {
  13629. detail::BufferStream bstrm;
  13630. // Extract the query from req.path. The encoding itself is delegated to
  13631. // `encode_request_target`; the raw query is still needed here to decide
  13632. // between populating `req.params` from it and falling back to building a
  13633. // query out of caller-supplied `req.params`.
  13634. auto query_pos = req.path.find('?');
  13635. auto query_part = query_pos == std::string::npos
  13636. ? std::string()
  13637. : req.path.substr(query_pos + 1);
  13638. auto path_with_query =
  13639. detail::encode_request_target(req.path, path_encode_);
  13640. if (!query_part.empty()) {
  13641. // The query already came in through `req.path`; still populate
  13642. // `req.params` for handlers/users who read them.
  13643. detail::parse_query_text(query_part, req.params);
  13644. } else if (!req.params.empty()) {
  13645. // No query in `req.path`; build one from `req.params` so existing
  13646. // callers that pass `Params` separately continue to work.
  13647. path_with_query = append_query_params(path_with_query, req.params);
  13648. }
  13649. // Write request line and headers
  13650. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13651. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13652. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13653. // fail the request cleanly instead of emitting a request-line-less,
  13654. // header-injecting request.
  13655. error = Error::Write;
  13656. rejected_locally = true;
  13657. output_error_log(error, &req);
  13658. return false;
  13659. }
  13660. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13661. error)) {
  13662. rejected_locally = true;
  13663. output_error_log(error, &req);
  13664. return false;
  13665. }
  13666. // Flush buffer
  13667. auto &data = bstrm.get_buffer();
  13668. if (!detail::write_data(strm, data.data(), data.size())) {
  13669. error = Error::Write;
  13670. output_error_log(error, &req);
  13671. return false;
  13672. }
  13673. }
  13674. // After sending request line and headers, wait briefly for an early server
  13675. // response (e.g. 4xx) and avoid sending a potentially large request body
  13676. // unnecessarily. This workaround is only enabled on Windows because Unix
  13677. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13678. // buffering can accept large writes even when the peer already responded.
  13679. // Check the stream first (which covers SSL via `is_readable()`), then
  13680. // fall back to select on the socket. Only perform the wait for very large
  13681. // request bodies to avoid interfering with normal small requests and
  13682. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13683. // response. Skip this check when using Expect: 100-continue, as the protocol
  13684. // handles early responses properly.
  13685. #if defined(_WIN32)
  13686. if (!skip_body &&
  13687. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13688. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13689. auto start = std::chrono::high_resolution_clock::now();
  13690. for (;;) {
  13691. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13692. // from SSL internals. If the underlying socket is readable, assume an
  13693. // early response may be present.
  13694. auto sock = strm.socket();
  13695. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13696. return false;
  13697. }
  13698. // Fallback to stream-level check for non-socket streams or when the
  13699. // socket isn't reporting readable. Avoid using `is_readable()` for
  13700. // SSL, since `SSL_pending()` may report buffered records that do not
  13701. // indicate a complete application-level response yet.
  13702. if (!is_ssl() && strm.is_readable()) { return false; }
  13703. auto now = std::chrono::high_resolution_clock::now();
  13704. auto elapsed =
  13705. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13706. .count();
  13707. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13708. break;
  13709. }
  13710. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13711. }
  13712. }
  13713. #endif
  13714. // Body
  13715. if (skip_body) { return true; }
  13716. return write_request_body(strm, req, error);
  13717. }
  13718. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13719. Error &error) {
  13720. if (req.body.empty()) {
  13721. return write_content_with_provider(strm, req, error);
  13722. }
  13723. if (req.upload_progress) {
  13724. auto body_size = req.body.size();
  13725. size_t written = 0;
  13726. auto data = req.body.data();
  13727. while (written < body_size) {
  13728. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13729. if (!detail::write_data(strm, data + written, to_write)) {
  13730. error = Error::Write;
  13731. output_error_log(error, &req);
  13732. return false;
  13733. }
  13734. written += to_write;
  13735. if (!req.upload_progress(written, body_size)) {
  13736. error = Error::Canceled;
  13737. output_error_log(error, &req);
  13738. return false;
  13739. }
  13740. }
  13741. } else {
  13742. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13743. error = Error::Write;
  13744. output_error_log(error, &req);
  13745. return false;
  13746. }
  13747. }
  13748. return true;
  13749. }
  13750. inline std::unique_ptr<Response>
  13751. ClientImpl::send_with_content_provider_and_receiver(
  13752. Request &req, const char *body, size_t content_length,
  13753. ContentProvider content_provider,
  13754. ContentProviderWithoutLength content_provider_without_length,
  13755. const std::string &content_type, ContentReceiver content_receiver,
  13756. Error &error) {
  13757. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13758. auto enc = compress_
  13759. ? detail::create_compressor()
  13760. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13761. nullptr, nullptr);
  13762. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13763. if (enc.first && !content_provider_without_length) {
  13764. auto &compressor = enc.first;
  13765. if (content_provider) {
  13766. auto ok = true;
  13767. auto finished = false;
  13768. size_t offset = 0;
  13769. DataSink data_sink;
  13770. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13771. if (ok) {
  13772. auto last = offset + data_len == content_length;
  13773. auto ret = compressor->compress(
  13774. data, data_len, last,
  13775. [&](const char *compressed_data, size_t compressed_data_len) {
  13776. req.body.append(compressed_data, compressed_data_len);
  13777. return true;
  13778. });
  13779. if (ret) {
  13780. offset += data_len;
  13781. } else {
  13782. ok = false;
  13783. }
  13784. }
  13785. return ok;
  13786. };
  13787. // As in detail::write_content_with_progress(): the body is framed by
  13788. // content_length, so a provider that finishes early has truncated it.
  13789. // Stop and report that instead of calling the provider forever.
  13790. data_sink.done = [&]() { finished = true; };
  13791. while (ok && !finished && offset < content_length) {
  13792. if (!content_provider(offset, content_length - offset, data_sink)) {
  13793. error = Error::Canceled;
  13794. output_error_log(error, &req);
  13795. return nullptr;
  13796. }
  13797. }
  13798. // A short body here means either the provider stopped early or the
  13799. // compressor gave up. The branch below reports a failing compressor as
  13800. // Error::Compression, so keep the two distinguishable.
  13801. if (offset < content_length) {
  13802. error = ok ? Error::Write : Error::Compression;
  13803. output_error_log(error, &req);
  13804. return nullptr;
  13805. }
  13806. } else {
  13807. if (!compressor->compress(body, content_length, true,
  13808. [&](const char *data, size_t data_len) {
  13809. req.body.append(data, data_len);
  13810. return true;
  13811. })) {
  13812. error = Error::Compression;
  13813. output_error_log(error, &req);
  13814. return nullptr;
  13815. }
  13816. }
  13817. } else {
  13818. if (content_provider) {
  13819. req.content_length_ = content_length;
  13820. req.content_provider_ = std::move(content_provider);
  13821. req.is_chunked_content_provider_ = false;
  13822. } else if (content_provider_without_length) {
  13823. req.content_length_ = 0;
  13824. req.content_provider_ = detail::ContentProviderAdapter(
  13825. std::move(content_provider_without_length));
  13826. req.is_chunked_content_provider_ = true;
  13827. req.set_header("Transfer-Encoding", "chunked");
  13828. } else {
  13829. req.body.assign(body, content_length);
  13830. }
  13831. }
  13832. if (content_receiver) {
  13833. req.content_receiver =
  13834. [content_receiver](const char *data, size_t data_length,
  13835. size_t /*offset*/, size_t /*total_length*/) {
  13836. return content_receiver(data, data_length);
  13837. };
  13838. }
  13839. auto res = detail::make_unique<Response>();
  13840. return send(req, *res, error) ? std::move(res) : nullptr;
  13841. }
  13842. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13843. const std::string &method, const std::string &path, const Headers &headers,
  13844. const char *body, size_t content_length, ContentProvider content_provider,
  13845. ContentProviderWithoutLength content_provider_without_length,
  13846. const std::string &content_type, ContentReceiver content_receiver,
  13847. UploadProgress progress) {
  13848. Request req;
  13849. req.method = method;
  13850. req.headers = headers;
  13851. req.path = path;
  13852. req.upload_progress = std::move(progress);
  13853. if (max_timeout_msec_ > 0) {
  13854. req.start_time_ = std::chrono::steady_clock::now();
  13855. }
  13856. auto error = Error::Success;
  13857. auto res = send_with_content_provider_and_receiver(
  13858. req, body, content_length, std::move(content_provider),
  13859. std::move(content_provider_without_length), content_type,
  13860. std::move(content_receiver), error);
  13861. #ifdef CPPHTTPLIB_SSL_ENABLED
  13862. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13863. last_backend_error_};
  13864. #else
  13865. return Result{std::move(res), error, std::move(req.headers)};
  13866. #endif
  13867. }
  13868. inline void ClientImpl::output_log(const Request &req,
  13869. const Response &res) const {
  13870. if (logger_) {
  13871. std::lock_guard<std::mutex> guard(logger_mutex_);
  13872. logger_(req, res);
  13873. }
  13874. }
  13875. inline void ClientImpl::output_error_log(const Error &err,
  13876. const Request *req) const {
  13877. if (error_logger_) {
  13878. std::lock_guard<std::mutex> guard(logger_mutex_);
  13879. error_logger_(err, req);
  13880. }
  13881. }
  13882. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13883. Response &res, bool close_connection,
  13884. Error &error) {
  13885. // Auto-add Expect: 100-continue for large bodies
  13886. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13887. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13888. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13889. req.set_header("Expect", "100-continue");
  13890. }
  13891. }
  13892. // Check for Expect: 100-continue
  13893. auto expect_100_continue =
  13894. detail::has_header_token(req.headers, "Expect", "100-continue");
  13895. // Send request (skip body if using Expect: 100-continue)
  13896. auto rejected_locally = false;
  13897. auto write_request_success =
  13898. write_request(strm, req, close_connection, error, expect_100_continue,
  13899. rejected_locally);
  13900. // A failed write normally still reads the response below, since the server
  13901. // may have answered early (e.g. 413/414) and closed while the body was being
  13902. // sent. A request rejected before any byte reached the socket gets no such
  13903. // response, and waiting for one would block until the read timeout.
  13904. if (rejected_locally) { return false; }
  13905. #ifdef CPPHTTPLIB_SSL_ENABLED
  13906. if (is_ssl() && !expect_100_continue) {
  13907. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13908. if (!is_proxy_enabled) {
  13909. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13910. error = Error::SSLPeerCouldBeClosed_;
  13911. output_error_log(error, &req);
  13912. return false;
  13913. }
  13914. }
  13915. }
  13916. #endif
  13917. // Handle Expect: 100-continue.
  13918. //
  13919. // Wait for an interim/early response by attempting to read the status line
  13920. // under a short timeout, instead of trusting raw socket readability. Over
  13921. // TLS, post-handshake records (e.g. session tickets) make the socket
  13922. // readable without any HTTP response being available; relying on
  13923. // `select_read` there caused the body to be withheld forever and the
  13924. // request to fail with `Read` (#2458). If no status line arrives within the
  13925. // timeout, send the body anyway (matching curl's behavior).
  13926. auto status_line_read = false;
  13927. if (expect_100_continue && write_request_success) {
  13928. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13929. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13930. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13931. strm.set_read_timeout(sec, usec);
  13932. status_line_read = read_response_line(strm, req, res, false);
  13933. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13934. }
  13935. if (!status_line_read) {
  13936. // No interim response within the timeout: send the body and handle the
  13937. // response as usual.
  13938. if (!write_request_body(strm, req, error)) { return false; }
  13939. expect_100_continue = false; // Switch to normal response handling
  13940. }
  13941. }
  13942. // Receive response and headers
  13943. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13944. if ((!status_line_read &&
  13945. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13946. !detail::read_headers(strm, res.headers)) {
  13947. if (write_request_success) { error = Error::Read; }
  13948. output_error_log(error, &req);
  13949. return false;
  13950. }
  13951. if (!write_request_success) { return false; }
  13952. // Handle Expect: 100-continue response
  13953. if (expect_100_continue) {
  13954. if (res.status == StatusCode::Continue_100) {
  13955. // Server accepted, send the body
  13956. if (!write_request_body(strm, req, error)) { return false; }
  13957. // Read the actual response
  13958. res.headers.clear();
  13959. res.body.clear();
  13960. if (!read_response_line(strm, req, res) ||
  13961. !detail::read_headers(strm, res.headers)) {
  13962. error = Error::Read;
  13963. output_error_log(error, &req);
  13964. return false;
  13965. }
  13966. }
  13967. // If not 100 Continue, server returned an error; proceed with that response
  13968. }
  13969. // Body
  13970. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13971. req.method != "CONNECT") {
  13972. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13973. // whose final transfer coding is not chunked is not ambiguous: its body
  13974. // runs until the server closes the connection, so it is not rejected.
  13975. // HEAD/204 are excluded above and a 304 carries no body.
  13976. if (res.status != StatusCode::NotModified_304 &&
  13977. detail::has_conflicting_content_length(res.headers)) {
  13978. error = Error::Read;
  13979. output_error_log(error, &req);
  13980. return false;
  13981. }
  13982. auto redirect = 300 < res.status && res.status < 400 &&
  13983. res.status != StatusCode::NotModified_304 &&
  13984. follow_location_;
  13985. if (req.response_handler && !redirect) {
  13986. if (!req.response_handler(res)) {
  13987. error = Error::Canceled;
  13988. output_error_log(error, &req);
  13989. return false;
  13990. }
  13991. }
  13992. auto out =
  13993. req.content_receiver
  13994. ? static_cast<ContentReceiverWithProgress>(
  13995. [&](const char *buf, size_t n, size_t off, size_t len) {
  13996. if (redirect) { return true; }
  13997. auto ret = req.content_receiver(buf, n, off, len);
  13998. if (!ret) {
  13999. error = Error::Canceled;
  14000. output_error_log(error, &req);
  14001. }
  14002. return ret;
  14003. })
  14004. : static_cast<ContentReceiverWithProgress>(
  14005. [&](const char *buf, size_t n, size_t /*off*/,
  14006. size_t /*len*/) {
  14007. assert(res.body.size() + n <= res.body.max_size());
  14008. if (payload_max_length_ > 0 &&
  14009. (res.body.size() >= payload_max_length_ ||
  14010. n > payload_max_length_ - res.body.size())) {
  14011. return false;
  14012. }
  14013. res.body.append(buf, n);
  14014. return true;
  14015. });
  14016. auto progress = [&](size_t current, size_t total) {
  14017. if (!req.download_progress || redirect) { return true; }
  14018. auto ret = req.download_progress(current, total);
  14019. if (!ret) {
  14020. error = Error::Canceled;
  14021. output_error_log(error, &req);
  14022. }
  14023. return ret;
  14024. };
  14025. if (res.has_header("Content-Length")) {
  14026. if (!req.content_receiver) {
  14027. auto len = res.get_header_value_u64("Content-Length");
  14028. if (len > res.body.max_size()) {
  14029. error = Error::Read;
  14030. output_error_log(error, &req);
  14031. return false;
  14032. }
  14033. // Cap the reservation by payload_max_length_ to avoid OOM when a
  14034. // hostile or malformed server sends an enormous Content-Length.
  14035. // The actual body read below is bounded by payload_max_length_,
  14036. // so reserving more than that is never useful.
  14037. auto reserve_len = static_cast<size_t>(len);
  14038. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  14039. reserve_len = payload_max_length_;
  14040. }
  14041. res.body.reserve(reserve_len);
  14042. }
  14043. }
  14044. if (res.status != StatusCode::NotModified_304) {
  14045. auto content_status = 0;
  14046. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14047. ? (std::numeric_limits<size_t>::max)()
  14048. : payload_max_length_;
  14049. if (!detail::read_content(strm, res, max_length, content_status,
  14050. std::move(progress), std::move(out),
  14051. decompress_)) {
  14052. if (error != Error::Canceled) {
  14053. // Tell the caller apart from a plain read failure when the body could
  14054. // not be decoded because of its Content-Encoding.
  14055. switch (content_status) {
  14056. case StatusCode::UnsupportedMediaType_415:
  14057. error = Error::UnsupportedContentEncoding;
  14058. break;
  14059. case StatusCode::InternalServerError_500:
  14060. error = Error::Compression;
  14061. break;
  14062. default: error = Error::Read; break;
  14063. }
  14064. }
  14065. output_error_log(error, &req);
  14066. return false;
  14067. }
  14068. }
  14069. }
  14070. // Log
  14071. output_log(req, res);
  14072. return true;
  14073. }
  14074. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14075. const std::string &boundary, const UploadFormDataItems &items,
  14076. const FormDataProviderItems &provider_items) const {
  14077. size_t cur_item = 0;
  14078. size_t cur_start = 0;
  14079. // cur_item and cur_start are copied to within the std::function and
  14080. // maintain state between successive calls
  14081. return [&, cur_item, cur_start](size_t offset,
  14082. DataSink &sink) mutable -> bool {
  14083. if (!offset && !items.empty()) {
  14084. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14085. return true;
  14086. } else if (cur_item < provider_items.size()) {
  14087. if (!cur_start) {
  14088. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14089. provider_items[cur_item], boundary);
  14090. offset += begin.size();
  14091. cur_start = offset;
  14092. sink.os << begin;
  14093. }
  14094. DataSink cur_sink;
  14095. auto has_data = true;
  14096. cur_sink.write = sink.write;
  14097. // Forward is_writable so a provider item asking whether it may keep
  14098. // going gets the outer sink's answer rather than the default `true`.
  14099. cur_sink.is_writable = sink.is_writable;
  14100. cur_sink.done = [&]() { has_data = false; };
  14101. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14102. return false;
  14103. }
  14104. if (!has_data) {
  14105. sink.os << detail::serialize_multipart_formdata_item_end();
  14106. cur_item++;
  14107. cur_start = 0;
  14108. }
  14109. return true;
  14110. } else {
  14111. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14112. sink.done();
  14113. return true;
  14114. }
  14115. };
  14116. }
  14117. inline bool ClientImpl::process_socket(
  14118. const Socket &socket,
  14119. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14120. std::function<bool(Stream &strm)> callback) {
  14121. return detail::process_client_socket(
  14122. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14123. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14124. }
  14125. inline bool ClientImpl::is_ssl() const { return false; }
  14126. inline Result ClientImpl::Get(const std::string &path,
  14127. DownloadProgress progress) {
  14128. return Get(path, Headers(), std::move(progress));
  14129. }
  14130. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14131. DownloadProgress progress) {
  14132. return Get(path, params, Headers(), std::move(progress));
  14133. }
  14134. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14135. const Headers &headers,
  14136. DownloadProgress progress) {
  14137. if (params.empty()) { return Get(path, headers); }
  14138. std::string path_with_query = append_query_params(path, params);
  14139. return Get(path_with_query, headers, std::move(progress));
  14140. }
  14141. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14142. DownloadProgress progress) {
  14143. Request req;
  14144. req.method = "GET";
  14145. req.path = path;
  14146. req.headers = headers;
  14147. req.download_progress = std::move(progress);
  14148. if (max_timeout_msec_ > 0) {
  14149. req.start_time_ = std::chrono::steady_clock::now();
  14150. }
  14151. return send_(std::move(req));
  14152. }
  14153. inline Result ClientImpl::Get(const std::string &path,
  14154. ContentReceiver content_receiver,
  14155. DownloadProgress progress) {
  14156. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14157. std::move(progress));
  14158. }
  14159. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14160. ContentReceiver content_receiver,
  14161. DownloadProgress progress) {
  14162. return Get(path, headers, nullptr, std::move(content_receiver),
  14163. std::move(progress));
  14164. }
  14165. inline Result ClientImpl::Get(const std::string &path,
  14166. ResponseHandler response_handler,
  14167. ContentReceiver content_receiver,
  14168. DownloadProgress progress) {
  14169. return Get(path, Headers(), std::move(response_handler),
  14170. std::move(content_receiver), std::move(progress));
  14171. }
  14172. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14173. ResponseHandler response_handler,
  14174. ContentReceiver content_receiver,
  14175. DownloadProgress progress) {
  14176. Request req;
  14177. req.method = "GET";
  14178. req.path = path;
  14179. req.headers = headers;
  14180. req.response_handler = std::move(response_handler);
  14181. req.content_receiver =
  14182. [content_receiver](const char *data, size_t data_length,
  14183. size_t /*offset*/, size_t /*total_length*/) {
  14184. return content_receiver(data, data_length);
  14185. };
  14186. req.download_progress = std::move(progress);
  14187. if (max_timeout_msec_ > 0) {
  14188. req.start_time_ = std::chrono::steady_clock::now();
  14189. }
  14190. return send_(std::move(req));
  14191. }
  14192. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14193. const Headers &headers,
  14194. ContentReceiver content_receiver,
  14195. DownloadProgress progress) {
  14196. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14197. std::move(progress));
  14198. }
  14199. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14200. const Headers &headers,
  14201. ResponseHandler response_handler,
  14202. ContentReceiver content_receiver,
  14203. DownloadProgress progress) {
  14204. if (params.empty()) {
  14205. return Get(path, headers, std::move(response_handler),
  14206. std::move(content_receiver), std::move(progress));
  14207. }
  14208. std::string path_with_query = append_query_params(path, params);
  14209. return Get(path_with_query, headers, std::move(response_handler),
  14210. std::move(content_receiver), std::move(progress));
  14211. }
  14212. inline Result ClientImpl::Head(const std::string &path) {
  14213. return Head(path, Headers());
  14214. }
  14215. inline Result ClientImpl::Head(const std::string &path,
  14216. const Headers &headers) {
  14217. Request req;
  14218. req.method = "HEAD";
  14219. req.headers = headers;
  14220. req.path = path;
  14221. if (max_timeout_msec_ > 0) {
  14222. req.start_time_ = std::chrono::steady_clock::now();
  14223. }
  14224. return send_(std::move(req));
  14225. }
  14226. inline Result ClientImpl::Post(const std::string &path) {
  14227. return Post(path, std::string(), std::string());
  14228. }
  14229. inline Result ClientImpl::Post(const std::string &path,
  14230. const Headers &headers) {
  14231. return Post(path, headers, nullptr, 0, std::string());
  14232. }
  14233. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14234. size_t content_length,
  14235. const std::string &content_type,
  14236. UploadProgress progress) {
  14237. return Post(path, Headers(), body, content_length, content_type, progress);
  14238. }
  14239. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14240. const std::string &content_type,
  14241. UploadProgress progress) {
  14242. return Post(path, Headers(), body, content_type, progress);
  14243. }
  14244. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14245. return Post(path, Headers(), params);
  14246. }
  14247. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14248. ContentProvider content_provider,
  14249. const std::string &content_type,
  14250. UploadProgress progress) {
  14251. return Post(path, Headers(), content_length, std::move(content_provider),
  14252. content_type, progress);
  14253. }
  14254. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14255. ContentProvider content_provider,
  14256. const std::string &content_type,
  14257. ContentReceiver content_receiver,
  14258. UploadProgress progress) {
  14259. return Post(path, Headers(), content_length, std::move(content_provider),
  14260. content_type, std::move(content_receiver), progress);
  14261. }
  14262. inline Result ClientImpl::Post(const std::string &path,
  14263. ContentProviderWithoutLength content_provider,
  14264. const std::string &content_type,
  14265. UploadProgress progress) {
  14266. return Post(path, Headers(), std::move(content_provider), content_type,
  14267. progress);
  14268. }
  14269. inline Result ClientImpl::Post(const std::string &path,
  14270. ContentProviderWithoutLength content_provider,
  14271. const std::string &content_type,
  14272. ContentReceiver content_receiver,
  14273. UploadProgress progress) {
  14274. return Post(path, Headers(), std::move(content_provider), content_type,
  14275. std::move(content_receiver), progress);
  14276. }
  14277. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14278. const Params &params) {
  14279. auto query = detail::params_to_query_str(params);
  14280. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14281. }
  14282. inline Result ClientImpl::Post(const std::string &path,
  14283. const UploadFormDataItems &items,
  14284. UploadProgress progress) {
  14285. return Post(path, Headers(), items, progress);
  14286. }
  14287. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14288. const UploadFormDataItems &items,
  14289. UploadProgress progress) {
  14290. const auto &boundary = detail::make_multipart_data_boundary();
  14291. const auto &content_type =
  14292. detail::serialize_multipart_formdata_get_content_type(boundary);
  14293. auto content_length = detail::get_multipart_content_length(items, boundary);
  14294. return Post(path, headers, content_length,
  14295. detail::make_multipart_content_provider(items, boundary),
  14296. content_type, progress);
  14297. }
  14298. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14299. const UploadFormDataItems &items,
  14300. const std::string &boundary,
  14301. UploadProgress progress) {
  14302. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14303. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14304. }
  14305. const auto &content_type =
  14306. detail::serialize_multipart_formdata_get_content_type(boundary);
  14307. auto content_length = detail::get_multipart_content_length(items, boundary);
  14308. return Post(path, headers, content_length,
  14309. detail::make_multipart_content_provider(items, boundary),
  14310. content_type, progress);
  14311. }
  14312. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14313. const char *body, size_t content_length,
  14314. const std::string &content_type,
  14315. UploadProgress progress) {
  14316. return send_with_content_provider_and_receiver(
  14317. "POST", path, headers, body, content_length, nullptr, nullptr,
  14318. content_type, nullptr, progress);
  14319. }
  14320. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14321. const std::string &body,
  14322. const std::string &content_type,
  14323. UploadProgress progress) {
  14324. return send_with_content_provider_and_receiver(
  14325. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14326. content_type, nullptr, progress);
  14327. }
  14328. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14329. size_t content_length,
  14330. ContentProvider content_provider,
  14331. const std::string &content_type,
  14332. UploadProgress progress) {
  14333. return send_with_content_provider_and_receiver(
  14334. "POST", path, headers, nullptr, content_length,
  14335. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14336. }
  14337. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14338. size_t content_length,
  14339. ContentProvider content_provider,
  14340. const std::string &content_type,
  14341. ContentReceiver content_receiver,
  14342. DownloadProgress progress) {
  14343. return send_with_content_provider_and_receiver(
  14344. "POST", path, headers, nullptr, content_length,
  14345. std::move(content_provider), nullptr, content_type,
  14346. std::move(content_receiver), std::move(progress));
  14347. }
  14348. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14349. ContentProviderWithoutLength content_provider,
  14350. const std::string &content_type,
  14351. UploadProgress progress) {
  14352. return send_with_content_provider_and_receiver(
  14353. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14354. content_type, nullptr, progress);
  14355. }
  14356. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14357. ContentProviderWithoutLength content_provider,
  14358. const std::string &content_type,
  14359. ContentReceiver content_receiver,
  14360. DownloadProgress progress) {
  14361. return send_with_content_provider_and_receiver(
  14362. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14363. content_type, std::move(content_receiver), std::move(progress));
  14364. }
  14365. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14366. const UploadFormDataItems &items,
  14367. const FormDataProviderItems &provider_items,
  14368. UploadProgress progress) {
  14369. const auto &boundary = detail::make_multipart_data_boundary();
  14370. const auto &content_type =
  14371. detail::serialize_multipart_formdata_get_content_type(boundary);
  14372. return send_with_content_provider_and_receiver(
  14373. "POST", path, headers, nullptr, 0, nullptr,
  14374. get_multipart_content_provider(boundary, items, provider_items),
  14375. content_type, nullptr, progress);
  14376. }
  14377. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14378. const std::string &body,
  14379. const std::string &content_type,
  14380. ContentReceiver content_receiver,
  14381. DownloadProgress progress) {
  14382. Request req;
  14383. req.method = "POST";
  14384. req.path = path;
  14385. req.headers = headers;
  14386. req.body = body;
  14387. req.content_receiver =
  14388. [content_receiver](const char *data, size_t data_length,
  14389. size_t /*offset*/, size_t /*total_length*/) {
  14390. return content_receiver(data, data_length);
  14391. };
  14392. req.download_progress = std::move(progress);
  14393. if (max_timeout_msec_ > 0) {
  14394. req.start_time_ = std::chrono::steady_clock::now();
  14395. }
  14396. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14397. return send_(std::move(req));
  14398. }
  14399. inline Result ClientImpl::Put(const std::string &path) {
  14400. return Put(path, std::string(), std::string());
  14401. }
  14402. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14403. return Put(path, headers, nullptr, 0, std::string());
  14404. }
  14405. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14406. size_t content_length,
  14407. const std::string &content_type,
  14408. UploadProgress progress) {
  14409. return Put(path, Headers(), body, content_length, content_type, progress);
  14410. }
  14411. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14412. const std::string &content_type,
  14413. UploadProgress progress) {
  14414. return Put(path, Headers(), body, content_type, progress);
  14415. }
  14416. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14417. return Put(path, Headers(), params);
  14418. }
  14419. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14420. ContentProvider content_provider,
  14421. const std::string &content_type,
  14422. UploadProgress progress) {
  14423. return Put(path, Headers(), content_length, std::move(content_provider),
  14424. content_type, progress);
  14425. }
  14426. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14427. ContentProvider content_provider,
  14428. const std::string &content_type,
  14429. ContentReceiver content_receiver,
  14430. UploadProgress progress) {
  14431. return Put(path, Headers(), content_length, std::move(content_provider),
  14432. content_type, std::move(content_receiver), progress);
  14433. }
  14434. inline Result ClientImpl::Put(const std::string &path,
  14435. ContentProviderWithoutLength content_provider,
  14436. const std::string &content_type,
  14437. UploadProgress progress) {
  14438. return Put(path, Headers(), std::move(content_provider), content_type,
  14439. progress);
  14440. }
  14441. inline Result ClientImpl::Put(const std::string &path,
  14442. ContentProviderWithoutLength content_provider,
  14443. const std::string &content_type,
  14444. ContentReceiver content_receiver,
  14445. UploadProgress progress) {
  14446. return Put(path, Headers(), std::move(content_provider), content_type,
  14447. std::move(content_receiver), progress);
  14448. }
  14449. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14450. const Params &params) {
  14451. auto query = detail::params_to_query_str(params);
  14452. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14453. }
  14454. inline Result ClientImpl::Put(const std::string &path,
  14455. const UploadFormDataItems &items,
  14456. UploadProgress progress) {
  14457. return Put(path, Headers(), items, progress);
  14458. }
  14459. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14460. const UploadFormDataItems &items,
  14461. UploadProgress progress) {
  14462. const auto &boundary = detail::make_multipart_data_boundary();
  14463. const auto &content_type =
  14464. detail::serialize_multipart_formdata_get_content_type(boundary);
  14465. auto content_length = detail::get_multipart_content_length(items, boundary);
  14466. return Put(path, headers, content_length,
  14467. detail::make_multipart_content_provider(items, boundary),
  14468. content_type, progress);
  14469. }
  14470. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14471. const UploadFormDataItems &items,
  14472. const std::string &boundary,
  14473. UploadProgress progress) {
  14474. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14475. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14476. }
  14477. const auto &content_type =
  14478. detail::serialize_multipart_formdata_get_content_type(boundary);
  14479. auto content_length = detail::get_multipart_content_length(items, boundary);
  14480. return Put(path, headers, content_length,
  14481. detail::make_multipart_content_provider(items, boundary),
  14482. content_type, progress);
  14483. }
  14484. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14485. const char *body, size_t content_length,
  14486. const std::string &content_type,
  14487. UploadProgress progress) {
  14488. return send_with_content_provider_and_receiver(
  14489. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14490. content_type, nullptr, progress);
  14491. }
  14492. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14493. const std::string &body,
  14494. const std::string &content_type,
  14495. UploadProgress progress) {
  14496. return send_with_content_provider_and_receiver(
  14497. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14498. content_type, nullptr, progress);
  14499. }
  14500. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14501. size_t content_length,
  14502. ContentProvider content_provider,
  14503. const std::string &content_type,
  14504. UploadProgress progress) {
  14505. return send_with_content_provider_and_receiver(
  14506. "PUT", path, headers, nullptr, content_length,
  14507. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14508. }
  14509. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14510. size_t content_length,
  14511. ContentProvider content_provider,
  14512. const std::string &content_type,
  14513. ContentReceiver content_receiver,
  14514. UploadProgress progress) {
  14515. return send_with_content_provider_and_receiver(
  14516. "PUT", path, headers, nullptr, content_length,
  14517. std::move(content_provider), nullptr, content_type,
  14518. std::move(content_receiver), progress);
  14519. }
  14520. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14521. ContentProviderWithoutLength content_provider,
  14522. const std::string &content_type,
  14523. UploadProgress progress) {
  14524. return send_with_content_provider_and_receiver(
  14525. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14526. content_type, nullptr, progress);
  14527. }
  14528. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14529. ContentProviderWithoutLength content_provider,
  14530. const std::string &content_type,
  14531. ContentReceiver content_receiver,
  14532. UploadProgress progress) {
  14533. return send_with_content_provider_and_receiver(
  14534. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14535. content_type, std::move(content_receiver), progress);
  14536. }
  14537. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14538. const UploadFormDataItems &items,
  14539. const FormDataProviderItems &provider_items,
  14540. UploadProgress progress) {
  14541. const auto &boundary = detail::make_multipart_data_boundary();
  14542. const auto &content_type =
  14543. detail::serialize_multipart_formdata_get_content_type(boundary);
  14544. return send_with_content_provider_and_receiver(
  14545. "PUT", path, headers, nullptr, 0, nullptr,
  14546. get_multipart_content_provider(boundary, items, provider_items),
  14547. content_type, nullptr, progress);
  14548. }
  14549. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14550. const std::string &body,
  14551. const std::string &content_type,
  14552. ContentReceiver content_receiver,
  14553. DownloadProgress progress) {
  14554. Request req;
  14555. req.method = "PUT";
  14556. req.path = path;
  14557. req.headers = headers;
  14558. req.body = body;
  14559. req.content_receiver =
  14560. [content_receiver](const char *data, size_t data_length,
  14561. size_t /*offset*/, size_t /*total_length*/) {
  14562. return content_receiver(data, data_length);
  14563. };
  14564. req.download_progress = std::move(progress);
  14565. if (max_timeout_msec_ > 0) {
  14566. req.start_time_ = std::chrono::steady_clock::now();
  14567. }
  14568. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14569. return send_(std::move(req));
  14570. }
  14571. inline Result ClientImpl::Patch(const std::string &path) {
  14572. return Patch(path, std::string(), std::string());
  14573. }
  14574. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14575. UploadProgress progress) {
  14576. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14577. }
  14578. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14579. size_t content_length,
  14580. const std::string &content_type,
  14581. UploadProgress progress) {
  14582. return Patch(path, Headers(), body, content_length, content_type, progress);
  14583. }
  14584. inline Result ClientImpl::Patch(const std::string &path,
  14585. const std::string &body,
  14586. const std::string &content_type,
  14587. UploadProgress progress) {
  14588. return Patch(path, Headers(), body, content_type, progress);
  14589. }
  14590. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14591. return Patch(path, Headers(), params);
  14592. }
  14593. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14594. ContentProvider content_provider,
  14595. const std::string &content_type,
  14596. UploadProgress progress) {
  14597. return Patch(path, Headers(), content_length, std::move(content_provider),
  14598. content_type, progress);
  14599. }
  14600. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14601. ContentProvider content_provider,
  14602. const std::string &content_type,
  14603. ContentReceiver content_receiver,
  14604. UploadProgress progress) {
  14605. return Patch(path, Headers(), content_length, std::move(content_provider),
  14606. content_type, std::move(content_receiver), progress);
  14607. }
  14608. inline Result ClientImpl::Patch(const std::string &path,
  14609. ContentProviderWithoutLength content_provider,
  14610. const std::string &content_type,
  14611. UploadProgress progress) {
  14612. return Patch(path, Headers(), std::move(content_provider), content_type,
  14613. progress);
  14614. }
  14615. inline Result ClientImpl::Patch(const std::string &path,
  14616. ContentProviderWithoutLength content_provider,
  14617. const std::string &content_type,
  14618. ContentReceiver content_receiver,
  14619. UploadProgress progress) {
  14620. return Patch(path, Headers(), std::move(content_provider), content_type,
  14621. std::move(content_receiver), progress);
  14622. }
  14623. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14624. const Params &params) {
  14625. auto query = detail::params_to_query_str(params);
  14626. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14627. }
  14628. inline Result ClientImpl::Patch(const std::string &path,
  14629. const UploadFormDataItems &items,
  14630. UploadProgress progress) {
  14631. return Patch(path, Headers(), items, progress);
  14632. }
  14633. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14634. const UploadFormDataItems &items,
  14635. UploadProgress progress) {
  14636. const auto &boundary = detail::make_multipart_data_boundary();
  14637. const auto &content_type =
  14638. detail::serialize_multipart_formdata_get_content_type(boundary);
  14639. auto content_length = detail::get_multipart_content_length(items, boundary);
  14640. return Patch(path, headers, content_length,
  14641. detail::make_multipart_content_provider(items, boundary),
  14642. content_type, progress);
  14643. }
  14644. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14645. const UploadFormDataItems &items,
  14646. const std::string &boundary,
  14647. UploadProgress progress) {
  14648. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14649. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14650. }
  14651. const auto &content_type =
  14652. detail::serialize_multipart_formdata_get_content_type(boundary);
  14653. auto content_length = detail::get_multipart_content_length(items, boundary);
  14654. return Patch(path, headers, content_length,
  14655. detail::make_multipart_content_provider(items, boundary),
  14656. content_type, progress);
  14657. }
  14658. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14659. const char *body, size_t content_length,
  14660. const std::string &content_type,
  14661. UploadProgress progress) {
  14662. return send_with_content_provider_and_receiver(
  14663. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14664. content_type, nullptr, progress);
  14665. }
  14666. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14667. const std::string &body,
  14668. const std::string &content_type,
  14669. UploadProgress progress) {
  14670. return send_with_content_provider_and_receiver(
  14671. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14672. content_type, nullptr, progress);
  14673. }
  14674. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14675. size_t content_length,
  14676. ContentProvider content_provider,
  14677. const std::string &content_type,
  14678. UploadProgress progress) {
  14679. return send_with_content_provider_and_receiver(
  14680. "PATCH", path, headers, nullptr, content_length,
  14681. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14682. }
  14683. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14684. size_t content_length,
  14685. ContentProvider content_provider,
  14686. const std::string &content_type,
  14687. ContentReceiver content_receiver,
  14688. UploadProgress progress) {
  14689. return send_with_content_provider_and_receiver(
  14690. "PATCH", path, headers, nullptr, content_length,
  14691. std::move(content_provider), nullptr, content_type,
  14692. std::move(content_receiver), progress);
  14693. }
  14694. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14695. ContentProviderWithoutLength content_provider,
  14696. const std::string &content_type,
  14697. UploadProgress progress) {
  14698. return send_with_content_provider_and_receiver(
  14699. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14700. content_type, nullptr, progress);
  14701. }
  14702. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14703. ContentProviderWithoutLength content_provider,
  14704. const std::string &content_type,
  14705. ContentReceiver content_receiver,
  14706. UploadProgress progress) {
  14707. return send_with_content_provider_and_receiver(
  14708. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14709. content_type, std::move(content_receiver), progress);
  14710. }
  14711. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14712. const UploadFormDataItems &items,
  14713. const FormDataProviderItems &provider_items,
  14714. UploadProgress progress) {
  14715. const auto &boundary = detail::make_multipart_data_boundary();
  14716. const auto &content_type =
  14717. detail::serialize_multipart_formdata_get_content_type(boundary);
  14718. return send_with_content_provider_and_receiver(
  14719. "PATCH", path, headers, nullptr, 0, nullptr,
  14720. get_multipart_content_provider(boundary, items, provider_items),
  14721. content_type, nullptr, progress);
  14722. }
  14723. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14724. const std::string &body,
  14725. const std::string &content_type,
  14726. ContentReceiver content_receiver,
  14727. DownloadProgress progress) {
  14728. Request req;
  14729. req.method = "PATCH";
  14730. req.path = path;
  14731. req.headers = headers;
  14732. req.body = body;
  14733. req.content_receiver =
  14734. [content_receiver](const char *data, size_t data_length,
  14735. size_t /*offset*/, size_t /*total_length*/) {
  14736. return content_receiver(data, data_length);
  14737. };
  14738. req.download_progress = std::move(progress);
  14739. if (max_timeout_msec_ > 0) {
  14740. req.start_time_ = std::chrono::steady_clock::now();
  14741. }
  14742. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14743. return send_(std::move(req));
  14744. }
  14745. inline Result ClientImpl::Delete(const std::string &path,
  14746. DownloadProgress progress) {
  14747. return Delete(path, Headers(), std::string(), std::string(), progress);
  14748. }
  14749. inline Result ClientImpl::Delete(const std::string &path,
  14750. const Headers &headers,
  14751. DownloadProgress progress) {
  14752. return Delete(path, headers, std::string(), std::string(), progress);
  14753. }
  14754. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14755. size_t content_length,
  14756. const std::string &content_type,
  14757. DownloadProgress progress) {
  14758. return Delete(path, Headers(), body, content_length, content_type, progress);
  14759. }
  14760. inline Result ClientImpl::Delete(const std::string &path,
  14761. const std::string &body,
  14762. const std::string &content_type,
  14763. DownloadProgress progress) {
  14764. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14765. progress);
  14766. }
  14767. inline Result ClientImpl::Delete(const std::string &path,
  14768. const Headers &headers,
  14769. const std::string &body,
  14770. const std::string &content_type,
  14771. DownloadProgress progress) {
  14772. return Delete(path, headers, body.data(), body.size(), content_type,
  14773. progress);
  14774. }
  14775. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14776. DownloadProgress progress) {
  14777. return Delete(path, Headers(), params, progress);
  14778. }
  14779. inline Result ClientImpl::Delete(const std::string &path,
  14780. const Headers &headers, const Params &params,
  14781. DownloadProgress progress) {
  14782. auto query = detail::params_to_query_str(params);
  14783. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14784. progress);
  14785. }
  14786. inline Result ClientImpl::Delete(const std::string &path,
  14787. const Headers &headers, const char *body,
  14788. size_t content_length,
  14789. const std::string &content_type,
  14790. DownloadProgress progress) {
  14791. Request req;
  14792. req.method = "DELETE";
  14793. req.headers = headers;
  14794. req.path = path;
  14795. req.download_progress = std::move(progress);
  14796. if (max_timeout_msec_ > 0) {
  14797. req.start_time_ = std::chrono::steady_clock::now();
  14798. }
  14799. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14800. req.body.assign(body, content_length);
  14801. return send_(std::move(req));
  14802. }
  14803. inline Result ClientImpl::Options(const std::string &path) {
  14804. return Options(path, Headers());
  14805. }
  14806. inline Result ClientImpl::Options(const std::string &path,
  14807. const Headers &headers) {
  14808. Request req;
  14809. req.method = "OPTIONS";
  14810. req.headers = headers;
  14811. req.path = path;
  14812. if (max_timeout_msec_ > 0) {
  14813. req.start_time_ = std::chrono::steady_clock::now();
  14814. }
  14815. return send_(std::move(req));
  14816. }
  14817. inline void ClientImpl::stop() {
  14818. std::lock_guard<std::mutex> guard(socket_mutex_);
  14819. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14820. // do is to shutdown_socket, so that threads using this socket suddenly
  14821. // discover they can't read/write any more and error out. Everything else
  14822. // (closing the socket, shutting ssl down) is unsafe because these actions
  14823. // are not thread-safe.
  14824. if (socket_requests_in_flight_ > 0) {
  14825. shutdown_socket(socket_);
  14826. // Aside from that, we set a flag for the socket to be closed when we're
  14827. // done.
  14828. socket_should_be_closed_when_request_is_done_ = true;
  14829. return;
  14830. }
  14831. disconnect(/*gracefully=*/true);
  14832. }
  14833. inline std::string ClientImpl::host() const { return host_; }
  14834. inline int ClientImpl::port() const { return port_; }
  14835. inline size_t ClientImpl::is_socket_open() const {
  14836. std::lock_guard<std::mutex> guard(socket_mutex_);
  14837. return socket_.is_open();
  14838. }
  14839. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14840. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14841. connection_timeout_sec_ = sec;
  14842. connection_timeout_usec_ = usec;
  14843. }
  14844. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14845. read_timeout_sec_ = sec;
  14846. read_timeout_usec_ = usec;
  14847. }
  14848. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14849. write_timeout_sec_ = sec;
  14850. write_timeout_usec_ = usec;
  14851. }
  14852. inline void ClientImpl::set_max_timeout(time_t msec) {
  14853. max_timeout_msec_ = msec;
  14854. }
  14855. inline void ClientImpl::set_basic_auth(const std::string &username,
  14856. const std::string &password) {
  14857. basic_auth_username_ = username;
  14858. basic_auth_password_ = password;
  14859. }
  14860. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14861. bearer_token_auth_token_ = token;
  14862. }
  14863. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14864. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14865. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14866. inline void
  14867. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14868. addr_map_ = std::move(addr_map);
  14869. }
  14870. inline void ClientImpl::set_default_headers(Headers headers) {
  14871. default_headers_ = std::move(headers);
  14872. }
  14873. inline void ClientImpl::set_header_writer(
  14874. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14875. header_writer_ = writer;
  14876. }
  14877. inline void ClientImpl::set_address_family(int family) {
  14878. address_family_ = family;
  14879. }
  14880. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14881. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14882. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14883. socket_options_ = std::move(socket_options);
  14884. }
  14885. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14886. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14887. inline void ClientImpl::set_payload_max_length(size_t length) {
  14888. payload_max_length_ = length;
  14889. has_payload_max_length_ = true;
  14890. }
  14891. inline void ClientImpl::set_interface(const std::string &intf) {
  14892. interface_ = intf;
  14893. }
  14894. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14895. proxy_host_ = host;
  14896. proxy_port_ = port;
  14897. std::lock_guard<std::mutex> guard(socket_mutex_);
  14898. disconnect(/*gracefully=*/true);
  14899. }
  14900. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14901. const std::string &password) {
  14902. proxy_basic_auth_username_ = username;
  14903. proxy_basic_auth_password_ = password;
  14904. }
  14905. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14906. proxy_bearer_token_auth_token_ = token;
  14907. }
  14908. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14909. std::vector<detail::NoProxyEntry> parsed;
  14910. parsed.reserve(patterns.size());
  14911. for (const auto &p : patterns) {
  14912. auto trimmed = detail::trim_copy(p);
  14913. if (trimmed.empty()) { continue; }
  14914. detail::NoProxyEntry entry;
  14915. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14916. parsed.push_back(std::move(entry));
  14917. }
  14918. }
  14919. no_proxy_entries_ = std::move(parsed);
  14920. std::lock_guard<std::mutex> guard(socket_mutex_);
  14921. disconnect(/*gracefully=*/true);
  14922. }
  14923. #ifdef CPPHTTPLIB_SSL_ENABLED
  14924. inline void ClientImpl::set_digest_auth(const std::string &username,
  14925. const std::string &password) {
  14926. digest_auth_username_ = username;
  14927. digest_auth_password_ = password;
  14928. }
  14929. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14930. const std::string &ca_cert_dir_path) {
  14931. ca_cert_file_path_ = ca_cert_file_path;
  14932. ca_cert_dir_path_ = ca_cert_dir_path;
  14933. }
  14934. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14935. const std::string &password) {
  14936. proxy_digest_auth_username_ = username;
  14937. proxy_digest_auth_password_ = password;
  14938. }
  14939. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14940. server_certificate_verification_ = enabled;
  14941. }
  14942. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14943. server_hostname_verification_ = enabled;
  14944. }
  14945. inline void ClientImpl::enable_system_ca(bool enabled) {
  14946. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14947. }
  14948. #endif
  14949. inline void ClientImpl::set_logger(Logger logger) {
  14950. logger_ = std::move(logger);
  14951. }
  14952. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14953. error_logger_ = std::move(error_logger);
  14954. }
  14955. /*
  14956. * SSL/TLS Common Implementation
  14957. */
  14958. inline ClientConnection::~ClientConnection() {
  14959. #ifdef CPPHTTPLIB_SSL_ENABLED
  14960. if (session) {
  14961. tls::shutdown(session, true);
  14962. tls::free_session(session);
  14963. session = nullptr;
  14964. }
  14965. #endif
  14966. if (sock != INVALID_SOCKET) {
  14967. detail::close_socket(sock);
  14968. sock = INVALID_SOCKET;
  14969. }
  14970. }
  14971. // Universal client implementation
  14972. inline Client::Client(const std::string &scheme_host_port)
  14973. : Client(scheme_host_port, std::string(), std::string()) {}
  14974. inline Client::Client(const std::string &scheme_host_port,
  14975. const std::string &client_cert_path,
  14976. const std::string &client_key_path) {
  14977. detail::UrlComponents uc;
  14978. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14979. auto &scheme = uc.scheme;
  14980. #ifdef CPPHTTPLIB_SSL_ENABLED
  14981. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14982. #else
  14983. if (!scheme.empty() && scheme != "http") {
  14984. #endif
  14985. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14986. std::string msg = "'" + scheme + "' scheme is not supported.";
  14987. throw std::invalid_argument(msg);
  14988. #endif
  14989. return;
  14990. }
  14991. auto is_ssl = scheme == "https";
  14992. auto host = std::move(uc.host);
  14993. auto port = is_ssl ? 443 : 80;
  14994. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14995. if (is_ssl) {
  14996. #ifdef CPPHTTPLIB_SSL_ENABLED
  14997. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14998. client_key_path);
  14999. is_ssl_ = is_ssl;
  15000. #endif
  15001. } else {
  15002. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15003. client_key_path);
  15004. }
  15005. } else {
  15006. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15007. // if port param below changes.
  15008. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15009. client_cert_path, client_key_path);
  15010. }
  15011. }
  15012. inline Client::Client(const std::string &host, int port)
  15013. : Client(host, port, std::string(), std::string()) {}
  15014. inline Client::Client(const std::string &host, int port,
  15015. const std::string &client_cert_path,
  15016. const std::string &client_key_path)
  15017. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15018. client_key_path)) {}
  15019. inline Client::~Client() = default;
  15020. inline bool Client::is_valid() const {
  15021. return cli_ != nullptr && cli_->is_valid();
  15022. }
  15023. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15024. return cli_->Get(path, std::move(progress));
  15025. }
  15026. inline Result Client::Get(const std::string &path, const Headers &headers,
  15027. DownloadProgress progress) {
  15028. return cli_->Get(path, headers, std::move(progress));
  15029. }
  15030. inline Result Client::Get(const std::string &path,
  15031. ContentReceiver content_receiver,
  15032. DownloadProgress progress) {
  15033. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15034. }
  15035. inline Result Client::Get(const std::string &path, const Headers &headers,
  15036. ContentReceiver content_receiver,
  15037. DownloadProgress progress) {
  15038. return cli_->Get(path, headers, std::move(content_receiver),
  15039. std::move(progress));
  15040. }
  15041. inline Result Client::Get(const std::string &path,
  15042. ResponseHandler response_handler,
  15043. ContentReceiver content_receiver,
  15044. DownloadProgress progress) {
  15045. return cli_->Get(path, std::move(response_handler),
  15046. std::move(content_receiver), std::move(progress));
  15047. }
  15048. inline Result Client::Get(const std::string &path, const Headers &headers,
  15049. ResponseHandler response_handler,
  15050. ContentReceiver content_receiver,
  15051. DownloadProgress progress) {
  15052. return cli_->Get(path, headers, std::move(response_handler),
  15053. std::move(content_receiver), std::move(progress));
  15054. }
  15055. inline Result Client::Get(const std::string &path, const Params &params,
  15056. DownloadProgress progress) {
  15057. return cli_->Get(path, params, std::move(progress));
  15058. }
  15059. inline Result Client::Get(const std::string &path, const Params &params,
  15060. const Headers &headers, DownloadProgress progress) {
  15061. return cli_->Get(path, params, headers, std::move(progress));
  15062. }
  15063. inline Result Client::Get(const std::string &path, const Params &params,
  15064. const Headers &headers,
  15065. ContentReceiver content_receiver,
  15066. DownloadProgress progress) {
  15067. return cli_->Get(path, params, headers, std::move(content_receiver),
  15068. std::move(progress));
  15069. }
  15070. inline Result Client::Get(const std::string &path, const Params &params,
  15071. const Headers &headers,
  15072. ResponseHandler response_handler,
  15073. ContentReceiver content_receiver,
  15074. DownloadProgress progress) {
  15075. return cli_->Get(path, params, headers, std::move(response_handler),
  15076. std::move(content_receiver), std::move(progress));
  15077. }
  15078. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15079. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15080. return cli_->Head(path, headers);
  15081. }
  15082. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15083. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15084. return cli_->Post(path, headers);
  15085. }
  15086. inline Result Client::Post(const std::string &path, const char *body,
  15087. size_t content_length,
  15088. const std::string &content_type,
  15089. UploadProgress progress) {
  15090. return cli_->Post(path, body, content_length, content_type, progress);
  15091. }
  15092. inline Result Client::Post(const std::string &path, const Headers &headers,
  15093. const char *body, size_t content_length,
  15094. const std::string &content_type,
  15095. UploadProgress progress) {
  15096. return cli_->Post(path, headers, body, content_length, content_type,
  15097. progress);
  15098. }
  15099. inline Result Client::Post(const std::string &path, const std::string &body,
  15100. const std::string &content_type,
  15101. UploadProgress progress) {
  15102. return cli_->Post(path, body, content_type, progress);
  15103. }
  15104. inline Result Client::Post(const std::string &path, const Headers &headers,
  15105. const std::string &body,
  15106. const std::string &content_type,
  15107. UploadProgress progress) {
  15108. return cli_->Post(path, headers, body, content_type, progress);
  15109. }
  15110. inline Result Client::Post(const std::string &path, size_t content_length,
  15111. ContentProvider content_provider,
  15112. const std::string &content_type,
  15113. UploadProgress progress) {
  15114. return cli_->Post(path, content_length, std::move(content_provider),
  15115. content_type, progress);
  15116. }
  15117. inline Result Client::Post(const std::string &path, size_t content_length,
  15118. ContentProvider content_provider,
  15119. const std::string &content_type,
  15120. ContentReceiver content_receiver,
  15121. UploadProgress progress) {
  15122. return cli_->Post(path, content_length, std::move(content_provider),
  15123. content_type, std::move(content_receiver), progress);
  15124. }
  15125. inline Result Client::Post(const std::string &path,
  15126. ContentProviderWithoutLength content_provider,
  15127. const std::string &content_type,
  15128. UploadProgress progress) {
  15129. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15130. }
  15131. inline Result Client::Post(const std::string &path,
  15132. ContentProviderWithoutLength content_provider,
  15133. const std::string &content_type,
  15134. ContentReceiver content_receiver,
  15135. UploadProgress progress) {
  15136. return cli_->Post(path, std::move(content_provider), content_type,
  15137. std::move(content_receiver), progress);
  15138. }
  15139. inline Result Client::Post(const std::string &path, const Headers &headers,
  15140. size_t content_length,
  15141. ContentProvider content_provider,
  15142. const std::string &content_type,
  15143. UploadProgress progress) {
  15144. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15145. content_type, progress);
  15146. }
  15147. inline Result Client::Post(const std::string &path, const Headers &headers,
  15148. size_t content_length,
  15149. ContentProvider content_provider,
  15150. const std::string &content_type,
  15151. ContentReceiver content_receiver,
  15152. DownloadProgress progress) {
  15153. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15154. content_type, std::move(content_receiver), progress);
  15155. }
  15156. inline Result Client::Post(const std::string &path, const Headers &headers,
  15157. ContentProviderWithoutLength content_provider,
  15158. const std::string &content_type,
  15159. UploadProgress progress) {
  15160. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15161. progress);
  15162. }
  15163. inline Result Client::Post(const std::string &path, const Headers &headers,
  15164. ContentProviderWithoutLength content_provider,
  15165. const std::string &content_type,
  15166. ContentReceiver content_receiver,
  15167. DownloadProgress progress) {
  15168. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15169. std::move(content_receiver), progress);
  15170. }
  15171. inline Result Client::Post(const std::string &path, const Params &params) {
  15172. return cli_->Post(path, params);
  15173. }
  15174. inline Result Client::Post(const std::string &path, const Headers &headers,
  15175. const Params &params) {
  15176. return cli_->Post(path, headers, params);
  15177. }
  15178. inline Result Client::Post(const std::string &path,
  15179. const UploadFormDataItems &items,
  15180. UploadProgress progress) {
  15181. return cli_->Post(path, items, progress);
  15182. }
  15183. inline Result Client::Post(const std::string &path, const Headers &headers,
  15184. const UploadFormDataItems &items,
  15185. UploadProgress progress) {
  15186. return cli_->Post(path, headers, items, progress);
  15187. }
  15188. inline Result Client::Post(const std::string &path, const Headers &headers,
  15189. const UploadFormDataItems &items,
  15190. const std::string &boundary,
  15191. UploadProgress progress) {
  15192. return cli_->Post(path, headers, items, boundary, progress);
  15193. }
  15194. inline Result Client::Post(const std::string &path, const Headers &headers,
  15195. const UploadFormDataItems &items,
  15196. const FormDataProviderItems &provider_items,
  15197. UploadProgress progress) {
  15198. return cli_->Post(path, headers, items, provider_items, progress);
  15199. }
  15200. inline Result Client::Post(const std::string &path, const Headers &headers,
  15201. const std::string &body,
  15202. const std::string &content_type,
  15203. ContentReceiver content_receiver,
  15204. DownloadProgress progress) {
  15205. return cli_->Post(path, headers, body, content_type,
  15206. std::move(content_receiver), progress);
  15207. }
  15208. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15209. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15210. return cli_->Put(path, headers);
  15211. }
  15212. inline Result Client::Put(const std::string &path, const char *body,
  15213. size_t content_length,
  15214. const std::string &content_type,
  15215. UploadProgress progress) {
  15216. return cli_->Put(path, body, content_length, content_type, progress);
  15217. }
  15218. inline Result Client::Put(const std::string &path, const Headers &headers,
  15219. const char *body, size_t content_length,
  15220. const std::string &content_type,
  15221. UploadProgress progress) {
  15222. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15223. }
  15224. inline Result Client::Put(const std::string &path, const std::string &body,
  15225. const std::string &content_type,
  15226. UploadProgress progress) {
  15227. return cli_->Put(path, body, content_type, progress);
  15228. }
  15229. inline Result Client::Put(const std::string &path, const Headers &headers,
  15230. const std::string &body,
  15231. const std::string &content_type,
  15232. UploadProgress progress) {
  15233. return cli_->Put(path, headers, body, content_type, progress);
  15234. }
  15235. inline Result Client::Put(const std::string &path, size_t content_length,
  15236. ContentProvider content_provider,
  15237. const std::string &content_type,
  15238. UploadProgress progress) {
  15239. return cli_->Put(path, content_length, std::move(content_provider),
  15240. content_type, progress);
  15241. }
  15242. inline Result Client::Put(const std::string &path, size_t content_length,
  15243. ContentProvider content_provider,
  15244. const std::string &content_type,
  15245. ContentReceiver content_receiver,
  15246. UploadProgress progress) {
  15247. return cli_->Put(path, content_length, std::move(content_provider),
  15248. content_type, std::move(content_receiver), progress);
  15249. }
  15250. inline Result Client::Put(const std::string &path,
  15251. ContentProviderWithoutLength content_provider,
  15252. const std::string &content_type,
  15253. UploadProgress progress) {
  15254. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15255. }
  15256. inline Result Client::Put(const std::string &path,
  15257. ContentProviderWithoutLength content_provider,
  15258. const std::string &content_type,
  15259. ContentReceiver content_receiver,
  15260. UploadProgress progress) {
  15261. return cli_->Put(path, std::move(content_provider), content_type,
  15262. std::move(content_receiver), progress);
  15263. }
  15264. inline Result Client::Put(const std::string &path, const Headers &headers,
  15265. size_t content_length,
  15266. ContentProvider content_provider,
  15267. const std::string &content_type,
  15268. UploadProgress progress) {
  15269. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15270. content_type, progress);
  15271. }
  15272. inline Result Client::Put(const std::string &path, const Headers &headers,
  15273. size_t content_length,
  15274. ContentProvider content_provider,
  15275. const std::string &content_type,
  15276. ContentReceiver content_receiver,
  15277. UploadProgress progress) {
  15278. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15279. content_type, std::move(content_receiver), progress);
  15280. }
  15281. inline Result Client::Put(const std::string &path, const Headers &headers,
  15282. ContentProviderWithoutLength content_provider,
  15283. const std::string &content_type,
  15284. UploadProgress progress) {
  15285. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15286. progress);
  15287. }
  15288. inline Result Client::Put(const std::string &path, const Headers &headers,
  15289. ContentProviderWithoutLength content_provider,
  15290. const std::string &content_type,
  15291. ContentReceiver content_receiver,
  15292. UploadProgress progress) {
  15293. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15294. std::move(content_receiver), progress);
  15295. }
  15296. inline Result Client::Put(const std::string &path, const Params &params) {
  15297. return cli_->Put(path, params);
  15298. }
  15299. inline Result Client::Put(const std::string &path, const Headers &headers,
  15300. const Params &params) {
  15301. return cli_->Put(path, headers, params);
  15302. }
  15303. inline Result Client::Put(const std::string &path,
  15304. const UploadFormDataItems &items,
  15305. UploadProgress progress) {
  15306. return cli_->Put(path, items, progress);
  15307. }
  15308. inline Result Client::Put(const std::string &path, const Headers &headers,
  15309. const UploadFormDataItems &items,
  15310. UploadProgress progress) {
  15311. return cli_->Put(path, headers, items, progress);
  15312. }
  15313. inline Result Client::Put(const std::string &path, const Headers &headers,
  15314. const UploadFormDataItems &items,
  15315. const std::string &boundary,
  15316. UploadProgress progress) {
  15317. return cli_->Put(path, headers, items, boundary, progress);
  15318. }
  15319. inline Result Client::Put(const std::string &path, const Headers &headers,
  15320. const UploadFormDataItems &items,
  15321. const FormDataProviderItems &provider_items,
  15322. UploadProgress progress) {
  15323. return cli_->Put(path, headers, items, provider_items, progress);
  15324. }
  15325. inline Result Client::Put(const std::string &path, const Headers &headers,
  15326. const std::string &body,
  15327. const std::string &content_type,
  15328. ContentReceiver content_receiver,
  15329. DownloadProgress progress) {
  15330. return cli_->Put(path, headers, body, content_type, content_receiver,
  15331. progress);
  15332. }
  15333. inline Result Client::Patch(const std::string &path) {
  15334. return cli_->Patch(path);
  15335. }
  15336. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15337. return cli_->Patch(path, headers);
  15338. }
  15339. inline Result Client::Patch(const std::string &path, const char *body,
  15340. size_t content_length,
  15341. const std::string &content_type,
  15342. UploadProgress progress) {
  15343. return cli_->Patch(path, body, content_length, content_type, progress);
  15344. }
  15345. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15346. const char *body, size_t content_length,
  15347. const std::string &content_type,
  15348. UploadProgress progress) {
  15349. return cli_->Patch(path, headers, body, content_length, content_type,
  15350. progress);
  15351. }
  15352. inline Result Client::Patch(const std::string &path, const std::string &body,
  15353. const std::string &content_type,
  15354. UploadProgress progress) {
  15355. return cli_->Patch(path, body, content_type, progress);
  15356. }
  15357. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15358. const std::string &body,
  15359. const std::string &content_type,
  15360. UploadProgress progress) {
  15361. return cli_->Patch(path, headers, body, content_type, progress);
  15362. }
  15363. inline Result Client::Patch(const std::string &path, size_t content_length,
  15364. ContentProvider content_provider,
  15365. const std::string &content_type,
  15366. UploadProgress progress) {
  15367. return cli_->Patch(path, content_length, std::move(content_provider),
  15368. content_type, progress);
  15369. }
  15370. inline Result Client::Patch(const std::string &path, size_t content_length,
  15371. ContentProvider content_provider,
  15372. const std::string &content_type,
  15373. ContentReceiver content_receiver,
  15374. UploadProgress progress) {
  15375. return cli_->Patch(path, content_length, std::move(content_provider),
  15376. content_type, std::move(content_receiver), progress);
  15377. }
  15378. inline Result Client::Patch(const std::string &path,
  15379. ContentProviderWithoutLength content_provider,
  15380. const std::string &content_type,
  15381. UploadProgress progress) {
  15382. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15383. }
  15384. inline Result Client::Patch(const std::string &path,
  15385. ContentProviderWithoutLength content_provider,
  15386. const std::string &content_type,
  15387. ContentReceiver content_receiver,
  15388. UploadProgress progress) {
  15389. return cli_->Patch(path, std::move(content_provider), content_type,
  15390. std::move(content_receiver), progress);
  15391. }
  15392. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15393. size_t content_length,
  15394. ContentProvider content_provider,
  15395. const std::string &content_type,
  15396. UploadProgress progress) {
  15397. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15398. content_type, progress);
  15399. }
  15400. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15401. size_t content_length,
  15402. ContentProvider content_provider,
  15403. const std::string &content_type,
  15404. ContentReceiver content_receiver,
  15405. UploadProgress progress) {
  15406. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15407. content_type, std::move(content_receiver), progress);
  15408. }
  15409. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15410. ContentProviderWithoutLength content_provider,
  15411. const std::string &content_type,
  15412. UploadProgress progress) {
  15413. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15414. progress);
  15415. }
  15416. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15417. ContentProviderWithoutLength content_provider,
  15418. const std::string &content_type,
  15419. ContentReceiver content_receiver,
  15420. UploadProgress progress) {
  15421. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15422. std::move(content_receiver), progress);
  15423. }
  15424. inline Result Client::Patch(const std::string &path, const Params &params) {
  15425. return cli_->Patch(path, params);
  15426. }
  15427. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15428. const Params &params) {
  15429. return cli_->Patch(path, headers, params);
  15430. }
  15431. inline Result Client::Patch(const std::string &path,
  15432. const UploadFormDataItems &items,
  15433. UploadProgress progress) {
  15434. return cli_->Patch(path, items, progress);
  15435. }
  15436. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15437. const UploadFormDataItems &items,
  15438. UploadProgress progress) {
  15439. return cli_->Patch(path, headers, items, progress);
  15440. }
  15441. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15442. const UploadFormDataItems &items,
  15443. const std::string &boundary,
  15444. UploadProgress progress) {
  15445. return cli_->Patch(path, headers, items, boundary, progress);
  15446. }
  15447. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15448. const UploadFormDataItems &items,
  15449. const FormDataProviderItems &provider_items,
  15450. UploadProgress progress) {
  15451. return cli_->Patch(path, headers, items, provider_items, progress);
  15452. }
  15453. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15454. const std::string &body,
  15455. const std::string &content_type,
  15456. ContentReceiver content_receiver,
  15457. DownloadProgress progress) {
  15458. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15459. progress);
  15460. }
  15461. inline Result Client::Delete(const std::string &path,
  15462. DownloadProgress progress) {
  15463. return cli_->Delete(path, progress);
  15464. }
  15465. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15466. DownloadProgress progress) {
  15467. return cli_->Delete(path, headers, progress);
  15468. }
  15469. inline Result Client::Delete(const std::string &path, const char *body,
  15470. size_t content_length,
  15471. const std::string &content_type,
  15472. DownloadProgress progress) {
  15473. return cli_->Delete(path, body, content_length, content_type, progress);
  15474. }
  15475. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15476. const char *body, size_t content_length,
  15477. const std::string &content_type,
  15478. DownloadProgress progress) {
  15479. return cli_->Delete(path, headers, body, content_length, content_type,
  15480. progress);
  15481. }
  15482. inline Result Client::Delete(const std::string &path, const std::string &body,
  15483. const std::string &content_type,
  15484. DownloadProgress progress) {
  15485. return cli_->Delete(path, body, content_type, progress);
  15486. }
  15487. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15488. const std::string &body,
  15489. const std::string &content_type,
  15490. DownloadProgress progress) {
  15491. return cli_->Delete(path, headers, body, content_type, progress);
  15492. }
  15493. inline Result Client::Delete(const std::string &path, const Params &params,
  15494. DownloadProgress progress) {
  15495. return cli_->Delete(path, params, progress);
  15496. }
  15497. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15498. const Params &params, DownloadProgress progress) {
  15499. return cli_->Delete(path, headers, params, progress);
  15500. }
  15501. inline Result Client::Options(const std::string &path) {
  15502. return cli_->Options(path);
  15503. }
  15504. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15505. return cli_->Options(path, headers);
  15506. }
  15507. inline ClientImpl::StreamHandle
  15508. Client::open_stream(const std::string &method, const std::string &path,
  15509. const Params &params, const Headers &headers,
  15510. const std::string &body, const std::string &content_type) {
  15511. return cli_->open_stream(method, path, params, headers, body, content_type);
  15512. }
  15513. inline bool Client::send(Request &req, Response &res, Error &error) {
  15514. return cli_->send(req, res, error);
  15515. }
  15516. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15517. inline void Client::stop() { cli_->stop(); }
  15518. inline std::string Client::host() const { return cli_->host(); }
  15519. inline int Client::port() const { return cli_->port(); }
  15520. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15521. inline socket_t Client::socket() const { return cli_->socket(); }
  15522. inline void
  15523. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15524. cli_->set_hostname_addr_map(std::move(addr_map));
  15525. }
  15526. inline void Client::set_default_headers(Headers headers) {
  15527. cli_->set_default_headers(std::move(headers));
  15528. }
  15529. inline void Client::set_header_writer(
  15530. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15531. cli_->set_header_writer(writer);
  15532. }
  15533. inline void Client::set_address_family(int family) {
  15534. cli_->set_address_family(family);
  15535. }
  15536. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15537. inline void Client::set_socket_options(SocketOptions socket_options) {
  15538. cli_->set_socket_options(std::move(socket_options));
  15539. }
  15540. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15541. cli_->set_connection_timeout(sec, usec);
  15542. }
  15543. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15544. cli_->set_read_timeout(sec, usec);
  15545. }
  15546. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15547. cli_->set_write_timeout(sec, usec);
  15548. }
  15549. inline void Client::set_basic_auth(const std::string &username,
  15550. const std::string &password) {
  15551. cli_->set_basic_auth(username, password);
  15552. }
  15553. inline void Client::set_bearer_token_auth(const std::string &token) {
  15554. cli_->set_bearer_token_auth(token);
  15555. }
  15556. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15557. inline void Client::set_follow_location(bool on) {
  15558. cli_->set_follow_location(on);
  15559. }
  15560. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15561. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15562. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15563. inline void Client::set_payload_max_length(size_t length) {
  15564. cli_->set_payload_max_length(length);
  15565. }
  15566. inline void Client::set_interface(const std::string &intf) {
  15567. cli_->set_interface(intf);
  15568. }
  15569. inline void Client::set_proxy(const std::string &host, int port) {
  15570. cli_->set_proxy(host, port);
  15571. }
  15572. inline void Client::set_proxy_basic_auth(const std::string &username,
  15573. const std::string &password) {
  15574. cli_->set_proxy_basic_auth(username, password);
  15575. }
  15576. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15577. cli_->set_proxy_bearer_token_auth(token);
  15578. }
  15579. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15580. cli_->set_no_proxy(patterns);
  15581. }
  15582. inline void Client::set_logger(Logger logger) {
  15583. cli_->set_logger(std::move(logger));
  15584. }
  15585. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15586. cli_->set_error_logger(std::move(error_logger));
  15587. }
  15588. /*
  15589. * Group 6: SSL Server and Client implementation
  15590. */
  15591. #ifdef CPPHTTPLIB_SSL_ENABLED
  15592. // SSL HTTP server implementation
  15593. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15594. const char *client_ca_cert_file_path,
  15595. const char *client_ca_cert_dir_path,
  15596. const char *private_key_password) {
  15597. using namespace tls;
  15598. ctx_ = create_server_context();
  15599. if (!ctx_) { return; }
  15600. // Load server certificate and private key
  15601. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15602. private_key_password)) {
  15603. last_ssl_error_ = static_cast<int>(get_error());
  15604. free_context(ctx_);
  15605. ctx_ = nullptr;
  15606. return;
  15607. }
  15608. // Load client CA certificates for client authentication
  15609. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15610. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15611. client_ca_cert_dir_path)) {
  15612. last_ssl_error_ = static_cast<int>(get_error());
  15613. free_context(ctx_);
  15614. ctx_ = nullptr;
  15615. return;
  15616. }
  15617. // Enable client certificate verification
  15618. set_verify_client(ctx_, true);
  15619. }
  15620. }
  15621. inline SSLServer::SSLServer(const PemMemory &pem) {
  15622. using namespace tls;
  15623. ctx_ = create_server_context();
  15624. if (ctx_) {
  15625. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15626. pem.private_key_password)) {
  15627. last_ssl_error_ = static_cast<int>(get_error());
  15628. free_context(ctx_);
  15629. ctx_ = nullptr;
  15630. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15631. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15632. last_ssl_error_ = static_cast<int>(get_error());
  15633. free_context(ctx_);
  15634. ctx_ = nullptr;
  15635. } else {
  15636. set_verify_client(ctx_, true);
  15637. }
  15638. }
  15639. }
  15640. }
  15641. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15642. using namespace tls;
  15643. ctx_ = create_server_context();
  15644. if (ctx_) {
  15645. if (!setup_callback(ctx_)) {
  15646. free_context(ctx_);
  15647. ctx_ = nullptr;
  15648. }
  15649. }
  15650. }
  15651. inline SSLServer::~SSLServer() {
  15652. if (ctx_) { tls::free_context(ctx_); }
  15653. }
  15654. inline bool SSLServer::is_valid() const {
  15655. return ctx_ != nullptr && Server::is_valid();
  15656. }
  15657. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15658. using namespace tls;
  15659. // Create TLS session with mutex protection
  15660. session_t session = nullptr;
  15661. {
  15662. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15663. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15664. }
  15665. if (!session) {
  15666. last_ssl_error_ = static_cast<int>(get_error());
  15667. detail::shutdown_socket(sock);
  15668. detail::close_socket(sock);
  15669. return false;
  15670. }
  15671. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15672. bool handshake_done = false;
  15673. bool ret = false;
  15674. bool websocket_upgraded = false;
  15675. auto cleanup = detail::scope_exit([&] {
  15676. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15677. free_session(session);
  15678. detail::shutdown_socket(sock);
  15679. detail::close_socket(sock);
  15680. });
  15681. // Perform TLS accept handshake with timeout
  15682. TlsError tls_err;
  15683. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15684. &tls_err)) {
  15685. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15686. // Map TlsError to legacy ssl_error for backward compatibility
  15687. if (tls_err.code == ErrorCode::WantRead) {
  15688. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15689. } else if (tls_err.code == ErrorCode::WantWrite) {
  15690. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15691. } else {
  15692. last_ssl_error_ = SSL_ERROR_SSL;
  15693. }
  15694. #else
  15695. last_ssl_error_ = static_cast<int>(get_error());
  15696. #endif
  15697. return false;
  15698. }
  15699. handshake_done = true;
  15700. std::string remote_addr;
  15701. int remote_port = 0;
  15702. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15703. std::string local_addr;
  15704. int local_port = 0;
  15705. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15706. ret = serve_guarded([&]() {
  15707. return detail::process_server_socket_ssl(
  15708. svr_sock_, session, sock, keep_alive_max_count_,
  15709. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15710. write_timeout_sec_, write_timeout_usec_,
  15711. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15712. return process_request(
  15713. strm, remote_addr, remote_port, local_addr, local_port,
  15714. close_connection, connection_closed,
  15715. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15716. });
  15717. });
  15718. return ret;
  15719. }
  15720. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15721. const char *key_pem,
  15722. const char *client_ca_pem,
  15723. const char *password) {
  15724. if (!ctx_) { return false; }
  15725. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15726. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15727. return false;
  15728. }
  15729. if (client_ca_pem) {
  15730. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15731. }
  15732. return true;
  15733. }
  15734. // SSL HTTP client implementation
  15735. inline SSLClient::~SSLClient() {
  15736. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15737. // base function rather than the derived function once we get to the
  15738. // base class destructor, and won't free the SSL (causing a leak).
  15739. // This must happen before the context is freed below: some backends
  15740. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15741. // context, so freeing the context first leaves close_notify reading
  15742. // freed memory.
  15743. shutdown_ssl_impl(socket_, true);
  15744. if (ctx_) {
  15745. tls::free_context(ctx_);
  15746. ctx_ = nullptr;
  15747. }
  15748. }
  15749. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15750. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15751. shutdown_ssl_impl(socket, shutdown_gracefully);
  15752. }
  15753. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15754. bool shutdown_gracefully) {
  15755. if (socket.sock == INVALID_SOCKET) {
  15756. assert(socket.ssl == nullptr);
  15757. return;
  15758. }
  15759. if (socket.ssl) {
  15760. tls::shutdown(socket.ssl, shutdown_gracefully);
  15761. {
  15762. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15763. tls::free_session(socket.ssl);
  15764. }
  15765. socket.ssl = nullptr;
  15766. }
  15767. assert(socket.ssl == nullptr);
  15768. }
  15769. inline bool SSLClient::process_socket(
  15770. const Socket &socket,
  15771. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15772. std::function<bool(Stream &strm)> callback) {
  15773. assert(socket.ssl);
  15774. return detail::process_client_socket_ssl(
  15775. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15776. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15777. std::move(callback));
  15778. }
  15779. inline bool SSLClient::is_ssl() const { return true; }
  15780. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15781. if (!is_valid()) {
  15782. error = Error::SSLConnection;
  15783. return false;
  15784. }
  15785. return ClientImpl::create_and_connect_socket(socket, error);
  15786. }
  15787. inline bool SSLClient::setup_proxy_connection(
  15788. Socket &socket,
  15789. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15790. Response &res, bool &success, Error &error) {
  15791. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15792. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15793. return false;
  15794. }
  15795. if (!initialize_ssl(socket, error)) {
  15796. success = false;
  15797. return false;
  15798. }
  15799. return true;
  15800. }
  15801. // Assumes that socket_mutex_ is locked and that there are no requests in
  15802. // flight
  15803. inline bool SSLClient::connect_with_proxy(
  15804. Socket &socket,
  15805. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15806. Response &res, bool &success, Error &error) {
  15807. success = true;
  15808. Response proxy_res;
  15809. if (!detail::process_client_socket(
  15810. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15811. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15812. start_time, [&](Stream &strm) {
  15813. Request req2;
  15814. req2.method = "CONNECT";
  15815. req2.path =
  15816. detail::make_host_and_port_string_always_port(host_, port_);
  15817. if (max_timeout_msec_ > 0) {
  15818. req2.start_time_ = std::chrono::steady_clock::now();
  15819. }
  15820. return process_request(strm, req2, proxy_res, false, error);
  15821. })) {
  15822. // Thread-safe to close everything because we are assuming there are no
  15823. // requests in flight
  15824. shutdown_ssl(socket, true);
  15825. shutdown_socket(socket);
  15826. close_socket(socket);
  15827. success = false;
  15828. return false;
  15829. }
  15830. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15831. if (!proxy_digest_auth_username_.empty() &&
  15832. !proxy_digest_auth_password_.empty()) {
  15833. std::map<std::string, std::string> auth;
  15834. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15835. // Close the current socket and create a new one for the authenticated
  15836. // request
  15837. shutdown_ssl(socket, true);
  15838. shutdown_socket(socket);
  15839. close_socket(socket);
  15840. // Create a new socket for the authenticated CONNECT request
  15841. if (!ensure_socket_connection(socket, error)) {
  15842. success = false;
  15843. output_error_log(error, nullptr);
  15844. return false;
  15845. }
  15846. proxy_res = Response();
  15847. if (!detail::process_client_socket(
  15848. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15849. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15850. start_time, [&](Stream &strm) {
  15851. Request req3;
  15852. req3.method = "CONNECT";
  15853. req3.path = detail::make_host_and_port_string_always_port(
  15854. host_, port_);
  15855. req3.headers.insert(detail::make_digest_authentication_header(
  15856. req3, auth, 1, detail::random_string(10),
  15857. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15858. true));
  15859. if (max_timeout_msec_ > 0) {
  15860. req3.start_time_ = std::chrono::steady_clock::now();
  15861. }
  15862. return process_request(strm, req3, proxy_res, false, error);
  15863. })) {
  15864. // Thread-safe to close everything because we are assuming there are
  15865. // no requests in flight
  15866. shutdown_ssl(socket, true);
  15867. shutdown_socket(socket);
  15868. close_socket(socket);
  15869. success = false;
  15870. return false;
  15871. }
  15872. }
  15873. }
  15874. }
  15875. // If status code is not 200, proxy request is failed.
  15876. // Set error to ProxyConnection and return proxy response
  15877. // as the response of the request
  15878. if (proxy_res.status != StatusCode::OK_200) {
  15879. error = Error::ProxyConnection;
  15880. output_error_log(error, nullptr);
  15881. res = std::move(proxy_res);
  15882. // Thread-safe to close everything because we are assuming there are
  15883. // no requests in flight
  15884. shutdown_ssl(socket, true);
  15885. shutdown_socket(socket);
  15886. close_socket(socket);
  15887. return false;
  15888. }
  15889. return true;
  15890. }
  15891. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15892. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15893. if (is_proxy_enabled_for_host(host_)) { return true; }
  15894. if (!initialize_ssl(socket, error)) {
  15895. shutdown_socket(socket);
  15896. close_socket(socket);
  15897. return false;
  15898. }
  15899. return true;
  15900. }
  15901. // SSL HTTP client implementation
  15902. inline SSLClient::SSLClient(const std::string &host)
  15903. : SSLClient(host, 443, std::string(), std::string()) {}
  15904. inline SSLClient::SSLClient(const std::string &host, int port)
  15905. : SSLClient(host, port, std::string(), std::string()) {}
  15906. inline void SSLClient::init_ctx() {
  15907. ctx_ = tls::create_client_context();
  15908. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15909. }
  15910. inline void SSLClient::reset_ctx_on_error() {
  15911. last_backend_error_ = tls::get_error();
  15912. tls::free_context(ctx_);
  15913. ctx_ = nullptr;
  15914. }
  15915. inline SSLClient::SSLClient(const std::string &host, int port,
  15916. const std::string &client_cert_path,
  15917. const std::string &client_key_path,
  15918. const std::string &private_key_password)
  15919. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15920. init_ctx();
  15921. if (!ctx_) { return; }
  15922. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15923. const char *password =
  15924. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15925. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15926. client_key_path.c_str(), password)) {
  15927. reset_ctx_on_error();
  15928. }
  15929. }
  15930. }
  15931. inline SSLClient::SSLClient(const std::string &host, int port,
  15932. const PemMemory &pem)
  15933. : ClientImpl(host, port) {
  15934. init_ctx();
  15935. if (!ctx_) { return; }
  15936. if (pem.cert_pem && pem.key_pem) {
  15937. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15938. pem.private_key_password)) {
  15939. reset_ctx_on_error();
  15940. }
  15941. }
  15942. }
  15943. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15944. if (ca_cert_store && ctx_) {
  15945. // set_ca_store takes ownership of ca_cert_store
  15946. tls::set_ca_store(ctx_, ca_cert_store);
  15947. ca_cert_store_set_ = true;
  15948. } else if (ca_cert_store) {
  15949. tls::free_ca_store(ca_cert_store);
  15950. }
  15951. }
  15952. inline void
  15953. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15954. if (!ctx_) { return; }
  15955. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15956. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  15957. #endif
  15958. tls::set_verify_callback(ctx_, verifier);
  15959. }
  15960. inline void SSLClient::set_session_verifier(
  15961. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15962. session_verifier_ = std::move(verifier);
  15963. }
  15964. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15965. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15966. enable_windows_cert_verification_ = enabled;
  15967. }
  15968. #endif
  15969. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15970. std::size_t size) {
  15971. if (ctx_ && ca_cert && size > 0) {
  15972. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15973. tls::load_ca_pem(ctx_, ca_cert, size);
  15974. }
  15975. }
  15976. inline bool SSLClient::load_certs() {
  15977. auto ret = true;
  15978. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15979. // one client is shared across concurrent requests here.
  15980. std::call_once(initialize_cert_, [&]() {
  15981. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15982. ret = detail::load_client_ca_config(
  15983. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15984. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15985. last_backend_error_);
  15986. });
  15987. return ret;
  15988. }
  15989. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15990. // Load CA certificates if server verification is enabled
  15991. if (server_certificate_verification_) {
  15992. if (!load_certs()) {
  15993. error = Error::SSLLoadingCerts;
  15994. output_error_log(error, nullptr);
  15995. return false;
  15996. }
  15997. }
  15998. detail::ClientTlsSessionOptions options;
  15999. options.server_hostname_verification = server_hostname_verification_;
  16000. options.session_verifier = session_verifier_;
  16001. options.ctx_mutex = &ctx_mutex_;
  16002. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16003. // Skip Schannel when a custom CA cert is specified, as the Windows
  16004. // certificate store would not know about user-provided CA certificates.
  16005. // Also skip when system CA trust is explicitly disabled.
  16006. options.windows_cert_verification =
  16007. enable_windows_cert_verification_ &&
  16008. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16009. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16010. // Only a verifier set through set_server_certificate_verifier() is seen
  16011. // here, not one installed with tls::set_verify_callback() directly.
  16012. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  16013. #endif
  16014. tls::session_t session = nullptr;
  16015. // Use scope_exit to ensure session is freed on error paths
  16016. bool success = false;
  16017. auto session_guard = detail::scope_exit([&] {
  16018. if (!success) { tls::free_session(session); }
  16019. });
  16020. detail::ClientTlsSessionError tls_error;
  16021. if (!detail::setup_client_tls_session(
  16022. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16023. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16024. options)) {
  16025. error = tls_error.error;
  16026. last_ssl_error_ = tls_error.ssl_error;
  16027. last_backend_error_ = tls_error.backend_error;
  16028. output_error_log(error, nullptr);
  16029. return false;
  16030. }
  16031. success = true;
  16032. socket.ssl = session;
  16033. return true;
  16034. }
  16035. inline void Client::set_digest_auth(const std::string &username,
  16036. const std::string &password) {
  16037. cli_->set_digest_auth(username, password);
  16038. }
  16039. inline void Client::set_proxy_digest_auth(const std::string &username,
  16040. const std::string &password) {
  16041. cli_->set_proxy_digest_auth(username, password);
  16042. }
  16043. inline void Client::enable_server_certificate_verification(bool enabled) {
  16044. cli_->enable_server_certificate_verification(enabled);
  16045. }
  16046. inline void Client::enable_server_hostname_verification(bool enabled) {
  16047. cli_->enable_server_hostname_verification(enabled);
  16048. }
  16049. inline void Client::enable_system_ca(bool enabled) {
  16050. cli_->enable_system_ca(enabled);
  16051. }
  16052. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16053. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16054. if (is_ssl_) {
  16055. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16056. enabled);
  16057. }
  16058. }
  16059. #endif
  16060. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16061. const std::string &ca_cert_dir_path) {
  16062. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16063. }
  16064. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16065. if (is_ssl_) {
  16066. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16067. } else if (ca_cert_store) {
  16068. tls::free_ca_store(ca_cert_store);
  16069. }
  16070. }
  16071. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16072. if (is_ssl_) {
  16073. // Use the PEM-based path so the CA data is retained for redirect transfer
  16074. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16075. }
  16076. }
  16077. inline void
  16078. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16079. if (is_ssl_) {
  16080. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16081. std::move(verifier));
  16082. }
  16083. }
  16084. inline void Client::set_session_verifier(
  16085. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16086. if (is_ssl_) {
  16087. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16088. }
  16089. }
  16090. inline tls::ctx_t Client::tls_context() const {
  16091. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16092. return nullptr;
  16093. }
  16094. #endif // CPPHTTPLIB_SSL_ENABLED
  16095. /*
  16096. * Group 7: TLS abstraction layer - Common API
  16097. */
  16098. #ifdef CPPHTTPLIB_SSL_ENABLED
  16099. namespace tls {
  16100. // Helper for PeerCert construction
  16101. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16102. return PeerCert(get_peer_cert(session));
  16103. }
  16104. namespace impl {
  16105. inline VerifyCallback &get_verify_callback() {
  16106. static thread_local VerifyCallback callback;
  16107. return callback;
  16108. }
  16109. inline VerifyCallback &get_mbedtls_verify_callback() {
  16110. static thread_local VerifyCallback callback;
  16111. return callback;
  16112. }
  16113. // Check if a string is an IPv4 address
  16114. inline bool is_ipv4_address(const std::string &str) {
  16115. int dots = 0;
  16116. for (char c : str) {
  16117. if (c == '.') {
  16118. dots++;
  16119. } else if (!detail::is_ascii_digit(c)) {
  16120. return false;
  16121. }
  16122. }
  16123. return dots == 3;
  16124. }
  16125. // Parse IPv4 address string to bytes
  16126. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16127. const char *p = str.c_str();
  16128. for (int i = 0; i < 4; i++) {
  16129. if (i > 0) {
  16130. if (*p != '.') { return false; }
  16131. p++;
  16132. }
  16133. int val = 0;
  16134. int digits = 0;
  16135. while (detail::is_ascii_digit(*p)) {
  16136. val = val * 10 + (*p - '0');
  16137. if (val > 255) { return false; }
  16138. p++;
  16139. digits++;
  16140. }
  16141. if (digits == 0) { return false; }
  16142. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16143. if (digits > 1 && *(p - digits) == '0') { return false; }
  16144. out[i] = static_cast<unsigned char>(val);
  16145. }
  16146. return *p == '\0';
  16147. }
  16148. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16149. // `out` must have room for at least 16 bytes. Returns the address length
  16150. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16151. // literal. Used to match a host against iPAddress SANs the same way the
  16152. // OpenSSL backend does via X509_check_ip.
  16153. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16154. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16155. struct in6_addr addr6 = {};
  16156. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16157. memcpy(out, &addr6, 16);
  16158. return 16;
  16159. }
  16160. return 0;
  16161. }
  16162. #ifdef _WIN32
  16163. // Enumerate Windows system certificates and call callback with DER data
  16164. template <typename Callback>
  16165. inline bool enumerate_windows_system_certs(Callback cb) {
  16166. bool loaded = false;
  16167. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16168. for (auto store_name : store_names) {
  16169. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16170. if (hStore) {
  16171. PCCERT_CONTEXT pContext = nullptr;
  16172. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16173. nullptr) {
  16174. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16175. loaded = true;
  16176. }
  16177. }
  16178. CertCloseStore(hStore, 0);
  16179. }
  16180. }
  16181. return loaded;
  16182. }
  16183. #endif
  16184. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16185. // Enumerate macOS Keychain certificates and call callback with DER data
  16186. template <typename Callback>
  16187. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16188. bool loaded = false;
  16189. const SecTrustSettingsDomain domains[] = {
  16190. kSecTrustSettingsDomainSystem,
  16191. kSecTrustSettingsDomainAdmin,
  16192. kSecTrustSettingsDomainUser,
  16193. };
  16194. for (auto domain : domains) {
  16195. CFArrayRef certs = nullptr;
  16196. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16197. if (status != errSecSuccess || !certs) {
  16198. if (certs) CFRelease(certs);
  16199. continue;
  16200. }
  16201. CFIndex count = CFArrayGetCount(certs);
  16202. for (CFIndex i = 0; i < count; i++) {
  16203. SecCertificateRef cert =
  16204. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16205. CFDataRef data = SecCertificateCopyData(cert);
  16206. if (data) {
  16207. if (cb(CFDataGetBytePtr(data),
  16208. static_cast<size_t>(CFDataGetLength(data)))) {
  16209. loaded = true;
  16210. }
  16211. CFRelease(data);
  16212. }
  16213. }
  16214. CFRelease(certs);
  16215. }
  16216. return loaded;
  16217. }
  16218. #endif
  16219. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16220. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16221. // Common CA certificate file paths on Linux/Unix
  16222. inline const char **system_ca_paths() {
  16223. static const char *paths[] = {
  16224. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16225. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16226. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16227. "/etc/pki/tls/cacert.pem", // OpenELEC
  16228. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16229. nullptr};
  16230. return paths;
  16231. }
  16232. // Common CA certificate directory paths on Linux/Unix
  16233. inline const char **system_ca_dirs() {
  16234. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16235. "/etc/pki/tls/certs", // RHEL/CentOS
  16236. "/usr/share/ca-certificates", // Other
  16237. nullptr};
  16238. return dirs;
  16239. }
  16240. #endif
  16241. } // namespace impl
  16242. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16243. const char *ca_dir) {
  16244. if (!ctx) { return false; }
  16245. bool success = true;
  16246. if (ca_file && *ca_file) {
  16247. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16248. }
  16249. if (ca_dir && *ca_dir) {
  16250. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16251. }
  16252. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16253. // Set CA list for client certificate request (CertificateRequest message)
  16254. if (ca_file && *ca_file) {
  16255. auto list = SSL_load_client_CA_file(ca_file);
  16256. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16257. }
  16258. #endif
  16259. return success;
  16260. }
  16261. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16262. const char *password) {
  16263. return set_client_cert_pem(ctx, cert, key, password);
  16264. }
  16265. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16266. const char *key_path, const char *password) {
  16267. return set_client_cert_file(ctx, cert_path, key_path, password);
  16268. }
  16269. // PeerCert implementation
  16270. inline PeerCert::PeerCert() = default;
  16271. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16272. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16273. other.cert_ = nullptr;
  16274. }
  16275. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16276. if (this != &other) {
  16277. if (cert_) { free_cert(cert_); }
  16278. cert_ = other.cert_;
  16279. other.cert_ = nullptr;
  16280. }
  16281. return *this;
  16282. }
  16283. inline PeerCert::~PeerCert() {
  16284. if (cert_) { free_cert(cert_); }
  16285. }
  16286. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16287. inline std::string PeerCert::subject_cn() const {
  16288. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16289. }
  16290. inline std::string PeerCert::issuer_name() const {
  16291. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16292. }
  16293. inline bool PeerCert::check_hostname(const char *hostname) const {
  16294. return cert_ ? verify_hostname(cert_, hostname) : false;
  16295. }
  16296. inline std::vector<SanEntry> PeerCert::sans() const {
  16297. std::vector<SanEntry> result;
  16298. if (cert_) { get_cert_sans(cert_, result); }
  16299. return result;
  16300. }
  16301. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16302. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16303. }
  16304. inline std::string PeerCert::serial() const {
  16305. return cert_ ? get_cert_serial(cert_) : std::string();
  16306. }
  16307. // VerifyContext method implementations
  16308. inline std::string VerifyContext::subject_cn() const {
  16309. return cert ? get_cert_subject_cn(cert) : std::string();
  16310. }
  16311. inline std::string VerifyContext::issuer_name() const {
  16312. return cert ? get_cert_issuer_name(cert) : std::string();
  16313. }
  16314. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16315. return cert ? verify_hostname(cert, hostname) : false;
  16316. }
  16317. inline std::vector<SanEntry> VerifyContext::sans() const {
  16318. std::vector<SanEntry> result;
  16319. if (cert) { get_cert_sans(cert, result); }
  16320. return result;
  16321. }
  16322. inline bool VerifyContext::validity(time_t &not_before,
  16323. time_t &not_after) const {
  16324. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16325. }
  16326. inline std::string VerifyContext::serial() const {
  16327. return cert ? get_cert_serial(cert) : std::string();
  16328. }
  16329. // TlsError static method implementation
  16330. inline std::string TlsError::verify_error_to_string(long error_code) {
  16331. return verify_error_string(error_code);
  16332. }
  16333. } // namespace tls
  16334. // Request::peer_cert() implementation
  16335. inline tls::PeerCert Request::peer_cert() const {
  16336. return tls::get_peer_cert_from_session(ssl);
  16337. }
  16338. // Request::sni() implementation
  16339. inline std::string Request::sni() const {
  16340. if (!ssl) { return std::string(); }
  16341. const char *s = tls::get_sni(ssl);
  16342. return s ? std::string(s) : std::string();
  16343. }
  16344. #endif // CPPHTTPLIB_SSL_ENABLED
  16345. /*
  16346. * Group 8: TLS abstraction layer - OpenSSL backend
  16347. */
  16348. /*
  16349. * OpenSSL Backend Implementation
  16350. */
  16351. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16352. namespace tls {
  16353. namespace impl {
  16354. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16355. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16356. switch (ssl_error) {
  16357. case SSL_ERROR_NONE: return ErrorCode::Success;
  16358. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16359. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16360. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16361. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16362. case SSL_ERROR_SSL:
  16363. default: return ErrorCode::Fatal;
  16364. }
  16365. }
  16366. // Helper: Create client CA list from PEM string
  16367. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16368. // Caller takes ownership of returned list
  16369. inline STACK_OF(X509_NAME) *
  16370. create_client_ca_list_from_pem(const char *ca_pem) {
  16371. if (!ca_pem) { return nullptr; }
  16372. auto ca_list = sk_X509_NAME_new_null();
  16373. if (!ca_list) { return nullptr; }
  16374. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16375. if (!bio) {
  16376. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16377. return nullptr;
  16378. }
  16379. X509 *cert = nullptr;
  16380. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16381. nullptr) {
  16382. const X509_NAME *name = X509_get_subject_name(cert);
  16383. if (name) {
  16384. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16385. }
  16386. X509_free(cert);
  16387. }
  16388. BIO_free(bio);
  16389. return ca_list;
  16390. }
  16391. // OpenSSL verify callback wrapper
  16392. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16393. auto &callback = get_verify_callback();
  16394. if (!callback) { return preverify_ok; }
  16395. // Get SSL object from X509_STORE_CTX
  16396. auto ssl = static_cast<SSL *>(
  16397. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16398. if (!ssl) { return preverify_ok; }
  16399. // Get current certificate and depth
  16400. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16401. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16402. int error = X509_STORE_CTX_get_error(ctx);
  16403. // Build context
  16404. VerifyContext verify_ctx;
  16405. verify_ctx.session = static_cast<session_t>(ssl);
  16406. verify_ctx.cert = static_cast<cert_t>(cert);
  16407. verify_ctx.depth = depth;
  16408. verify_ctx.preverify_ok = (preverify_ok != 0);
  16409. verify_ctx.error_code = error;
  16410. verify_ctx.error_string =
  16411. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16412. return callback(verify_ctx) ? 1 : 0;
  16413. }
  16414. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16415. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16416. // that must be released with release_store_objects
  16417. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16418. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16419. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16420. #endif
  16421. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16422. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16423. return X509_STORE_get1_objects(store);
  16424. #else
  16425. return X509_STORE_get0_objects(store);
  16426. #endif
  16427. }
  16428. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16429. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16430. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16431. #else
  16432. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16433. #endif
  16434. }
  16435. } // namespace impl
  16436. inline ctx_t create_client_context() {
  16437. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16438. if (ctx) {
  16439. // Disable auto-retry to properly handle non-blocking I/O
  16440. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16441. // Set minimum TLS version
  16442. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16443. }
  16444. return static_cast<ctx_t>(ctx);
  16445. }
  16446. inline void free_context(ctx_t ctx) {
  16447. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16448. }
  16449. inline bool set_min_version(ctx_t ctx, Version version) {
  16450. if (!ctx) return false;
  16451. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16452. static_cast<int>(version)) == 1;
  16453. }
  16454. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16455. if (!ctx || !pem || len == 0) return false;
  16456. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16457. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16458. if (!store) return false;
  16459. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16460. if (!bio) return false;
  16461. bool ok = true;
  16462. X509 *cert = nullptr;
  16463. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16464. nullptr) {
  16465. if (X509_STORE_add_cert(store, cert) != 1) {
  16466. // Ignore duplicate errors
  16467. auto err = ERR_peek_last_error();
  16468. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16469. ok = false;
  16470. }
  16471. }
  16472. X509_free(cert);
  16473. if (!ok) break;
  16474. }
  16475. BIO_free(bio);
  16476. // Clear any "no more certificates" errors
  16477. ERR_clear_error();
  16478. return ok;
  16479. }
  16480. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16481. if (!ctx || !file_path) return false;
  16482. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16483. nullptr) == 1;
  16484. }
  16485. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16486. if (!ctx || !dir_path) return false;
  16487. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16488. dir_path) == 1;
  16489. }
  16490. inline bool load_system_certs(ctx_t ctx) {
  16491. if (!ctx) return false;
  16492. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16493. #ifdef _WIN32
  16494. // Windows: Load from system certificate store (ROOT and CA)
  16495. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16496. if (!store) return false;
  16497. bool loaded_any = false;
  16498. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16499. for (auto store_name : store_names) {
  16500. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16501. if (!hStore) continue;
  16502. PCCERT_CONTEXT pContext = nullptr;
  16503. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16504. nullptr) {
  16505. const unsigned char *data = pContext->pbCertEncoded;
  16506. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16507. if (x509) {
  16508. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16509. X509_free(x509);
  16510. }
  16511. }
  16512. CertCloseStore(hStore, 0);
  16513. }
  16514. return loaded_any;
  16515. #elif defined(__APPLE__)
  16516. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16517. // macOS: Load from Keychain
  16518. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16519. if (!store) return false;
  16520. bool loaded_any = false;
  16521. const SecTrustSettingsDomain domains[] = {
  16522. kSecTrustSettingsDomainSystem,
  16523. kSecTrustSettingsDomainAdmin,
  16524. kSecTrustSettingsDomainUser,
  16525. };
  16526. for (auto domain : domains) {
  16527. CFArrayRef certs = nullptr;
  16528. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16529. !certs) {
  16530. if (certs) CFRelease(certs);
  16531. continue;
  16532. }
  16533. auto count = CFArrayGetCount(certs);
  16534. for (CFIndex i = 0; i < count; i++) {
  16535. auto cert = reinterpret_cast<SecCertificateRef>(
  16536. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16537. CFDataRef der = SecCertificateCopyData(cert);
  16538. if (der) {
  16539. const unsigned char *data = CFDataGetBytePtr(der);
  16540. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16541. if (x509) {
  16542. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16543. X509_free(x509);
  16544. }
  16545. CFRelease(der);
  16546. }
  16547. }
  16548. CFRelease(certs);
  16549. }
  16550. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16551. #else
  16552. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16553. #endif
  16554. #else
  16555. // Other Unix: use default verify paths
  16556. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16557. #endif
  16558. }
  16559. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16560. const char *password) {
  16561. if (!ctx || !cert || !key) return false;
  16562. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16563. // Load certificate
  16564. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16565. if (!cert_bio) return false;
  16566. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16567. BIO_free(cert_bio);
  16568. if (!x509) return false;
  16569. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16570. X509_free(x509);
  16571. if (!cert_ok) return false;
  16572. // Load private key
  16573. auto key_bio = BIO_new_mem_buf(key, -1);
  16574. if (!key_bio) return false;
  16575. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16576. password ? const_cast<char *>(password)
  16577. : nullptr);
  16578. BIO_free(key_bio);
  16579. if (!pkey) return false;
  16580. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16581. EVP_PKEY_free(pkey);
  16582. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16583. }
  16584. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16585. const char *key_path, const char *password) {
  16586. if (!ctx || !cert_path || !key_path) return false;
  16587. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16588. if (password && password[0] != '\0') {
  16589. SSL_CTX_set_default_passwd_cb_userdata(
  16590. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16591. }
  16592. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16593. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16594. }
  16595. inline ctx_t create_server_context() {
  16596. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16597. if (ctx) {
  16598. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16599. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16600. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16601. }
  16602. return static_cast<ctx_t>(ctx);
  16603. }
  16604. inline void set_verify_client(ctx_t ctx, bool require) {
  16605. if (!ctx) return;
  16606. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16607. require
  16608. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16609. : SSL_VERIFY_NONE,
  16610. nullptr);
  16611. }
  16612. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16613. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16614. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16615. SSL *ssl = SSL_new(ssl_ctx);
  16616. if (!ssl) return nullptr;
  16617. // Disable auto-retry for proper non-blocking I/O handling
  16618. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16619. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16620. if (!bio) {
  16621. SSL_free(ssl);
  16622. return nullptr;
  16623. }
  16624. SSL_set_bio(ssl, bio, bio);
  16625. return static_cast<session_t>(ssl);
  16626. }
  16627. inline void free_session(session_t session) {
  16628. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16629. }
  16630. inline bool set_sni(session_t session, const char *hostname,
  16631. bool /*verify_hostname*/) {
  16632. if (!session || !hostname) return false;
  16633. auto ssl = static_cast<SSL *>(session);
  16634. // Set SNI (Server Name Indication) only - does not enable verification.
  16635. // OpenSSL never binds identity checking to SNI (that happens post-
  16636. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16637. #if defined(OPENSSL_IS_BORINGSSL)
  16638. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16639. #else
  16640. // Direct call instead of macro to suppress -Wold-style-cast warning
  16641. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16642. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16643. #endif
  16644. }
  16645. inline TlsError connect(session_t session) {
  16646. if (!session) { return TlsError(); }
  16647. auto ssl = static_cast<SSL *>(session);
  16648. auto ret = SSL_connect(ssl);
  16649. TlsError err;
  16650. if (ret == 1) {
  16651. err.code = ErrorCode::Success;
  16652. } else {
  16653. auto ssl_err = SSL_get_error(ssl, ret);
  16654. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16655. err.backend_code = ERR_get_error();
  16656. }
  16657. return err;
  16658. }
  16659. inline TlsError accept(session_t session) {
  16660. if (!session) { return TlsError(); }
  16661. auto ssl = static_cast<SSL *>(session);
  16662. auto ret = SSL_accept(ssl);
  16663. TlsError err;
  16664. if (ret == 1) {
  16665. err.code = ErrorCode::Success;
  16666. } else {
  16667. auto ssl_err = SSL_get_error(ssl, ret);
  16668. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16669. err.backend_code = ERR_get_error();
  16670. }
  16671. return err;
  16672. }
  16673. inline bool connect_nonblocking(session_t session, socket_t sock,
  16674. time_t timeout_sec, time_t timeout_usec,
  16675. TlsError *err) {
  16676. if (!session) {
  16677. if (err) { err->code = ErrorCode::Fatal; }
  16678. return false;
  16679. }
  16680. auto ssl = static_cast<SSL *>(session);
  16681. auto bio = SSL_get_rbio(ssl);
  16682. // Set non-blocking mode for handshake
  16683. detail::set_nonblocking(sock, true);
  16684. if (bio) { BIO_set_nbio(bio, 1); }
  16685. auto cleanup = detail::scope_exit([&]() {
  16686. // Restore blocking mode after handshake
  16687. if (bio) { BIO_set_nbio(bio, 0); }
  16688. detail::set_nonblocking(sock, false);
  16689. });
  16690. auto res = 0;
  16691. while ((res = SSL_connect(ssl)) != 1) {
  16692. auto ssl_err = SSL_get_error(ssl, res);
  16693. switch (ssl_err) {
  16694. case SSL_ERROR_WANT_READ:
  16695. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16696. continue;
  16697. }
  16698. break;
  16699. case SSL_ERROR_WANT_WRITE:
  16700. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16701. continue;
  16702. }
  16703. break;
  16704. default: break;
  16705. }
  16706. if (err) {
  16707. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16708. err->backend_code = ERR_get_error();
  16709. }
  16710. return false;
  16711. }
  16712. if (err) { err->code = ErrorCode::Success; }
  16713. return true;
  16714. }
  16715. inline bool accept_nonblocking(session_t session, socket_t sock,
  16716. time_t timeout_sec, time_t timeout_usec,
  16717. TlsError *err) {
  16718. if (!session) {
  16719. if (err) { err->code = ErrorCode::Fatal; }
  16720. return false;
  16721. }
  16722. auto ssl = static_cast<SSL *>(session);
  16723. auto bio = SSL_get_rbio(ssl);
  16724. // Set non-blocking mode for handshake
  16725. detail::set_nonblocking(sock, true);
  16726. if (bio) { BIO_set_nbio(bio, 1); }
  16727. auto cleanup = detail::scope_exit([&]() {
  16728. // Restore blocking mode after handshake
  16729. if (bio) { BIO_set_nbio(bio, 0); }
  16730. detail::set_nonblocking(sock, false);
  16731. });
  16732. auto res = 0;
  16733. while ((res = SSL_accept(ssl)) != 1) {
  16734. auto ssl_err = SSL_get_error(ssl, res);
  16735. switch (ssl_err) {
  16736. case SSL_ERROR_WANT_READ:
  16737. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16738. continue;
  16739. }
  16740. break;
  16741. case SSL_ERROR_WANT_WRITE:
  16742. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16743. continue;
  16744. }
  16745. break;
  16746. default: break;
  16747. }
  16748. if (err) {
  16749. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16750. err->backend_code = ERR_get_error();
  16751. }
  16752. return false;
  16753. }
  16754. if (err) { err->code = ErrorCode::Success; }
  16755. return true;
  16756. }
  16757. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16758. if (!session || !buf) {
  16759. err.code = ErrorCode::Fatal;
  16760. return -1;
  16761. }
  16762. auto ssl = static_cast<SSL *>(session);
  16763. constexpr auto max_len =
  16764. static_cast<size_t>((std::numeric_limits<int>::max)());
  16765. if (len > max_len) { len = max_len; }
  16766. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16767. if (ret > 0) {
  16768. err.code = ErrorCode::Success;
  16769. return ret;
  16770. }
  16771. auto ssl_err = SSL_get_error(ssl, ret);
  16772. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16773. if (err.code == ErrorCode::PeerClosed) {
  16774. return 0;
  16775. } // Gracefully handle the peer closed state.
  16776. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16777. return -1;
  16778. }
  16779. inline ssize_t write(session_t session, const void *buf, size_t len,
  16780. TlsError &err) {
  16781. if (!session || !buf) {
  16782. err.code = ErrorCode::Fatal;
  16783. return -1;
  16784. }
  16785. auto ssl = static_cast<SSL *>(session);
  16786. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16787. if (ret > 0) {
  16788. err.code = ErrorCode::Success;
  16789. return ret;
  16790. }
  16791. auto ssl_err = SSL_get_error(ssl, ret);
  16792. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16793. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16794. return -1;
  16795. }
  16796. inline int pending(const_session_t session) {
  16797. if (!session) return 0;
  16798. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16799. }
  16800. inline void shutdown(session_t session, bool graceful) {
  16801. if (!session) return;
  16802. auto ssl = static_cast<SSL *>(session);
  16803. if (graceful) {
  16804. // Send close_notify without waiting for the peer's. The connection is
  16805. // closed right after this, so a unidirectional shutdown is enough, and an
  16806. // idle peer that never answers would otherwise hold this thread until the
  16807. // read timeout. The other backends do not wait either.
  16808. SSL_shutdown(ssl);
  16809. }
  16810. }
  16811. inline bool is_peer_closed(session_t session, socket_t sock) {
  16812. if (!session) return true;
  16813. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16814. detail::set_nonblocking(sock, true);
  16815. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16816. auto ssl = static_cast<SSL *>(session);
  16817. char buf;
  16818. auto ret = SSL_peek(ssl, &buf, 1);
  16819. if (ret > 0) return false;
  16820. auto err = SSL_get_error(ssl, ret);
  16821. return err == SSL_ERROR_ZERO_RETURN;
  16822. }
  16823. inline cert_t get_peer_cert(const_session_t session) {
  16824. if (!session) return nullptr;
  16825. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16826. static_cast<SSL *>(const_cast<void *>(session))));
  16827. }
  16828. inline size_t get_peer_certs(const_session_t session,
  16829. std::vector<cert_t> &certs) {
  16830. certs.clear();
  16831. if (!session) { return 0; }
  16832. auto ssl = static_cast<const SSL *>(session);
  16833. // On the server side, the chain leaves out the peer's own certificate
  16834. if (SSL_is_server(ssl)) {
  16835. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16836. }
  16837. auto sk = SSL_get_peer_cert_chain(ssl);
  16838. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16839. auto x509 = sk_X509_value(sk, i);
  16840. X509_up_ref(x509);
  16841. certs.push_back(static_cast<cert_t>(x509));
  16842. }
  16843. return certs.size();
  16844. }
  16845. inline void free_cert(cert_t cert) {
  16846. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16847. }
  16848. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16849. if (!cert || !hostname) return false;
  16850. auto x509 = static_cast<X509 *>(cert);
  16851. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16852. if (detail::is_ip_address(hostname)) {
  16853. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16854. }
  16855. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16856. }
  16857. inline uint64_t hostname_mismatch_code() {
  16858. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16859. }
  16860. inline long get_verify_result(const_session_t session) {
  16861. if (!session) return X509_V_ERR_UNSPECIFIED;
  16862. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16863. }
  16864. inline std::string get_cert_subject_cn(cert_t cert) {
  16865. if (!cert) return "";
  16866. auto x509 = static_cast<X509 *>(cert);
  16867. auto subject_name = X509_get_subject_name(x509);
  16868. if (!subject_name) return "";
  16869. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16870. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16871. if (idx < 0) return "";
  16872. auto entry = X509_NAME_get_entry(subject_name, idx);
  16873. if (!entry) return "";
  16874. auto data = X509_NAME_ENTRY_get_data(entry);
  16875. if (!data) return "";
  16876. return std::string(
  16877. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16878. static_cast<size_t>(ASN1_STRING_length(data)));
  16879. }
  16880. inline std::string get_cert_issuer_name(cert_t cert) {
  16881. if (!cert) return "";
  16882. auto x509 = static_cast<X509 *>(cert);
  16883. auto issuer_name = X509_get_issuer_name(x509);
  16884. if (!issuer_name) return "";
  16885. char buf[256];
  16886. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16887. return std::string(buf);
  16888. }
  16889. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16890. sans.clear();
  16891. if (!cert) return false;
  16892. auto x509 = static_cast<X509 *>(cert);
  16893. auto names = static_cast<GENERAL_NAMES *>(
  16894. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16895. if (!names) return true; // No SANs is valid
  16896. auto count = sk_GENERAL_NAME_num(names);
  16897. for (decltype(count) i = 0; i < count; i++) {
  16898. auto gen = sk_GENERAL_NAME_value(names, i);
  16899. if (!gen) continue;
  16900. SanEntry entry;
  16901. switch (gen->type) {
  16902. case GEN_DNS:
  16903. entry.type = SanType::DNS;
  16904. if (gen->d.dNSName) {
  16905. entry.value = std::string(
  16906. reinterpret_cast<const char *>(
  16907. ASN1_STRING_get0_data(gen->d.dNSName)),
  16908. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16909. }
  16910. break;
  16911. case GEN_IPADD:
  16912. entry.type = SanType::IP;
  16913. if (gen->d.iPAddress) {
  16914. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16915. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16916. if (len == 4) {
  16917. // IPv4
  16918. char buf[INET_ADDRSTRLEN];
  16919. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16920. entry.value = buf;
  16921. } else if (len == 16) {
  16922. // IPv6
  16923. char buf[INET6_ADDRSTRLEN];
  16924. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16925. entry.value = buf;
  16926. }
  16927. }
  16928. break;
  16929. case GEN_EMAIL:
  16930. entry.type = SanType::EMAIL;
  16931. if (gen->d.rfc822Name) {
  16932. entry.value = std::string(
  16933. reinterpret_cast<const char *>(
  16934. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16935. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16936. }
  16937. break;
  16938. case GEN_URI:
  16939. entry.type = SanType::URI;
  16940. if (gen->d.uniformResourceIdentifier) {
  16941. entry.value = std::string(
  16942. reinterpret_cast<const char *>(
  16943. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16944. static_cast<size_t>(
  16945. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16946. }
  16947. break;
  16948. default: entry.type = SanType::OTHER; break;
  16949. }
  16950. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16951. }
  16952. GENERAL_NAMES_free(names);
  16953. return true;
  16954. }
  16955. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16956. time_t &not_after) {
  16957. if (!cert) return false;
  16958. auto x509 = static_cast<X509 *>(cert);
  16959. auto nb = X509_get0_notBefore(x509);
  16960. auto na = X509_get0_notAfter(x509);
  16961. if (!nb || !na) return false;
  16962. ASN1_TIME *epoch = ASN1_TIME_new();
  16963. if (!epoch) return false;
  16964. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16965. if (!ASN1_TIME_set(epoch, 0)) return false;
  16966. int pday, psec;
  16967. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16968. not_before = 86400 * (time_t)pday + psec;
  16969. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16970. not_after = 86400 * (time_t)pday + psec;
  16971. return true;
  16972. }
  16973. inline std::string get_cert_serial(cert_t cert) {
  16974. if (!cert) return "";
  16975. auto x509 = static_cast<X509 *>(cert);
  16976. auto serial = X509_get_serialNumber(x509);
  16977. if (!serial) return "";
  16978. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16979. if (!bn) return "";
  16980. auto hex = BN_bn2hex(bn);
  16981. BN_free(bn);
  16982. if (!hex) return "";
  16983. std::string result(hex);
  16984. OPENSSL_free(hex);
  16985. return result;
  16986. }
  16987. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16988. if (!cert) return false;
  16989. auto x509 = static_cast<X509 *>(cert);
  16990. auto len = i2d_X509(x509, nullptr);
  16991. if (len < 0) return false;
  16992. der.resize(static_cast<size_t>(len));
  16993. auto p = der.data();
  16994. i2d_X509(x509, &p);
  16995. return true;
  16996. }
  16997. inline const char *get_sni(const_session_t session) {
  16998. if (!session) return nullptr;
  16999. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17000. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17001. }
  17002. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17003. inline uint64_t get_error() { return ERR_get_error(); }
  17004. inline std::string error_string(uint64_t code) {
  17005. char buf[256];
  17006. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17007. return std::string(buf);
  17008. }
  17009. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17010. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17011. if (!mem) { return nullptr; }
  17012. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17013. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17014. if (!inf) { return nullptr; }
  17015. auto store = X509_STORE_new();
  17016. if (store) {
  17017. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17018. auto itmp = sk_X509_INFO_value(inf, i);
  17019. if (!itmp) { continue; }
  17020. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17021. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17022. }
  17023. }
  17024. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17025. return static_cast<ca_store_t>(store);
  17026. }
  17027. inline void free_ca_store(ca_store_t store) {
  17028. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17029. }
  17030. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17031. if (!ctx || !store) { return false; }
  17032. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17033. auto x509_store = static_cast<X509_STORE *>(store);
  17034. // Check if same store is already set
  17035. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17036. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17037. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17038. return true;
  17039. }
  17040. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17041. certs.clear();
  17042. if (!ctx) { return 0; }
  17043. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17044. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17045. if (!store) { return 0; }
  17046. auto objs = impl::get_store_objects(store);
  17047. if (!objs) { return 0; }
  17048. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17049. auto count = sk_X509_OBJECT_num(objs);
  17050. for (decltype(count) i = 0; i < count; i++) {
  17051. auto obj = sk_X509_OBJECT_value(objs, i);
  17052. if (!obj) { continue; }
  17053. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17054. auto x509 = X509_OBJECT_get0_X509(obj);
  17055. if (x509) {
  17056. // Increment reference count so caller can free it
  17057. X509_up_ref(x509);
  17058. certs.push_back(static_cast<cert_t>(x509));
  17059. }
  17060. }
  17061. }
  17062. return certs.size();
  17063. }
  17064. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17065. std::vector<std::string> names;
  17066. if (!ctx) { return names; }
  17067. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17068. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17069. if (!store) { return names; }
  17070. auto objs = impl::get_store_objects(store);
  17071. if (!objs) { return names; }
  17072. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17073. auto count = sk_X509_OBJECT_num(objs);
  17074. for (decltype(count) i = 0; i < count; i++) {
  17075. auto obj = sk_X509_OBJECT_value(objs, i);
  17076. if (!obj) { continue; }
  17077. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17078. auto x509 = X509_OBJECT_get0_X509(obj);
  17079. if (x509) {
  17080. auto subject = X509_get_subject_name(x509);
  17081. if (subject) {
  17082. char buf[512];
  17083. X509_NAME_oneline(subject, buf, sizeof(buf));
  17084. names.push_back(buf);
  17085. }
  17086. }
  17087. }
  17088. }
  17089. return names;
  17090. }
  17091. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17092. const char *key_pem, const char *password) {
  17093. if (!ctx || !cert_pem || !key_pem) { return false; }
  17094. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17095. // Load certificate from PEM
  17096. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17097. if (!cert_bio) { return false; }
  17098. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17099. BIO_free(cert_bio);
  17100. if (!cert) { return false; }
  17101. // Load private key from PEM
  17102. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17103. if (!key_bio) {
  17104. X509_free(cert);
  17105. return false;
  17106. }
  17107. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17108. password ? const_cast<char *>(password)
  17109. : nullptr);
  17110. BIO_free(key_bio);
  17111. if (!key) {
  17112. X509_free(cert);
  17113. return false;
  17114. }
  17115. // Update certificate and key
  17116. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17117. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17118. X509_free(cert);
  17119. EVP_PKEY_free(key);
  17120. return ret;
  17121. }
  17122. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17123. if (!ctx || !ca_pem) { return false; }
  17124. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17125. // Create new X509_STORE from PEM
  17126. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17127. if (!store) { return false; }
  17128. // SSL_CTX_set_cert_store takes ownership
  17129. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17130. // Set client CA list for client certificate request
  17131. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17132. if (ca_list) {
  17133. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17134. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17135. }
  17136. return true;
  17137. }
  17138. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17139. if (!ctx) { return false; }
  17140. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17141. impl::get_verify_callback() = std::move(callback);
  17142. if (impl::get_verify_callback()) {
  17143. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17144. } else {
  17145. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17146. }
  17147. return true;
  17148. }
  17149. inline long get_verify_error(const_session_t session) {
  17150. if (!session) { return -1; }
  17151. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17152. return SSL_get_verify_result(ssl);
  17153. }
  17154. inline std::string verify_error_string(long error_code) {
  17155. if (error_code == X509_V_OK) { return ""; }
  17156. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17157. return str ? str : "unknown error";
  17158. }
  17159. } // namespace tls
  17160. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17161. /*
  17162. * Group 9: TLS abstraction layer - Mbed TLS backend
  17163. */
  17164. /*
  17165. * Mbed TLS Backend Implementation
  17166. */
  17167. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17168. namespace tls {
  17169. namespace impl {
  17170. // Mbed TLS session wrapper
  17171. struct MbedTlsSession {
  17172. mbedtls_ssl_context ssl;
  17173. socket_t sock = INVALID_SOCKET;
  17174. std::string hostname; // For client: set via set_sni
  17175. std::string sni_hostname; // For server: received from client via SNI callback
  17176. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17177. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17178. // (e.g. a response that arrived while this side was still in its post-write
  17179. // check), the byte is pushed back here and served by the next read().
  17180. unsigned char peeked_byte = 0;
  17181. bool has_peeked_byte = false;
  17182. // Set by set_sni() when the caller disabled hostname verification, so the
  17183. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17184. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17185. // OpenSSL and wolfSSL keep them independent).
  17186. bool suppress_hostname_mismatch = false;
  17187. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  17188. // decide which verify callback to install when hostname verification is
  17189. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  17190. // wired for this context, or a self-contained one otherwise, so a session
  17191. // that never opted into a callback never consults the process-wide
  17192. // set_verify_callback() slot (which some other, unrelated client may have
  17193. // populated).
  17194. bool has_verify_callback = false;
  17195. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17196. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17197. MbedTlsSession(const MbedTlsSession &) = delete;
  17198. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17199. };
  17200. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17201. // queue)
  17202. inline int &mbedtls_last_error() {
  17203. static thread_local int err = 0;
  17204. return err;
  17205. }
  17206. // Helper to map Mbed TLS error to ErrorCode
  17207. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17208. uint32_t verify_flags) {
  17209. if (ret == 0) { return ErrorCode::Success; }
  17210. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17211. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17212. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17213. return ErrorCode::PeerClosed;
  17214. }
  17215. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17216. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17217. out_errno = errno;
  17218. return ErrorCode::SyscallError;
  17219. }
  17220. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17221. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17222. // the handshake's chain verification (see set_sni()); a mismatch there
  17223. // is reported the same way as any other verify_flags bit. Report it as
  17224. // HostnameMismatch, matching the other backends and the post-handshake
  17225. // identity check below, but only when naming is the sole problem -
  17226. // if the chain itself is also untrusted/expired/etc., that takes
  17227. // priority over the naming detail.
  17228. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17229. return ErrorCode::HostnameMismatch;
  17230. }
  17231. return ErrorCode::CertVerifyFailed;
  17232. }
  17233. return ErrorCode::Fatal;
  17234. }
  17235. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17236. // return value, including the verify-flags-dependent HostnameMismatch
  17237. // mapping; shared by connect() and connect_nonblocking() so the
  17238. // backend_code policy for that mapping only lives in one place.
  17239. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17240. int ret) {
  17241. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17242. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17243. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17244. ? static_cast<uint64_t>(verify_flags)
  17245. : static_cast<uint64_t>(-ret);
  17246. }
  17247. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17248. // non-fatal notification delivered between records, not an error and not
  17249. // application data, so I/O calls that see it should just be retried. Kept in
  17250. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17251. // splitting the closing brace across an #if.
  17252. inline bool mbedtls_is_session_ticket(int ret) {
  17253. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17254. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17255. #else
  17256. (void)ret;
  17257. return false;
  17258. #endif
  17259. }
  17260. // BIO-like send callback for Mbed TLS
  17261. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17262. size_t len) {
  17263. auto sock = *static_cast<socket_t *>(ctx);
  17264. #ifdef _WIN32
  17265. auto ret =
  17266. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17267. if (ret == SOCKET_ERROR) {
  17268. int err = WSAGetLastError();
  17269. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17270. return MBEDTLS_ERR_NET_SEND_FAILED;
  17271. }
  17272. #else
  17273. auto ret = send(sock, buf, len, 0);
  17274. if (ret < 0) {
  17275. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17276. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17277. }
  17278. return MBEDTLS_ERR_NET_SEND_FAILED;
  17279. }
  17280. #endif
  17281. return static_cast<int>(ret);
  17282. }
  17283. // BIO-like recv callback for Mbed TLS
  17284. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17285. auto sock = *static_cast<socket_t *>(ctx);
  17286. #ifdef _WIN32
  17287. auto ret =
  17288. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17289. if (ret == SOCKET_ERROR) {
  17290. int err = WSAGetLastError();
  17291. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17292. return MBEDTLS_ERR_NET_RECV_FAILED;
  17293. }
  17294. #else
  17295. auto ret = recv(sock, buf, len, 0);
  17296. if (ret < 0) {
  17297. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17298. return MBEDTLS_ERR_SSL_WANT_READ;
  17299. }
  17300. return MBEDTLS_ERR_NET_RECV_FAILED;
  17301. }
  17302. #endif
  17303. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17304. return static_cast<int>(ret);
  17305. }
  17306. // MbedTlsContext constructor/destructor implementations
  17307. inline MbedTlsContext::MbedTlsContext() {
  17308. mbedtls_ssl_config_init(&conf);
  17309. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17310. mbedtls_entropy_init(&entropy);
  17311. mbedtls_ctr_drbg_init(&ctr_drbg);
  17312. #endif
  17313. mbedtls_x509_crt_init(&ca_chain);
  17314. mbedtls_x509_crt_init(&own_cert);
  17315. mbedtls_pk_init(&own_key);
  17316. }
  17317. inline MbedTlsContext::~MbedTlsContext() {
  17318. mbedtls_pk_free(&own_key);
  17319. mbedtls_x509_crt_free(&own_cert);
  17320. mbedtls_x509_crt_free(&ca_chain);
  17321. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17322. mbedtls_ctr_drbg_free(&ctr_drbg);
  17323. mbedtls_entropy_free(&entropy);
  17324. #endif
  17325. mbedtls_ssl_config_free(&conf);
  17326. }
  17327. // Thread-local storage for SNI captured during handshake
  17328. // This is needed because the SNI callback doesn't have a way to pass
  17329. // session-specific data before the session is fully set up
  17330. inline std::string &mbedpending_sni() {
  17331. static thread_local std::string sni;
  17332. return sni;
  17333. }
  17334. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17335. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17336. const unsigned char *name, size_t name_len) {
  17337. (void)p_ctx;
  17338. (void)ssl;
  17339. // Store SNI name in thread-local storage
  17340. // It will be retrieved and stored in the session after handshake
  17341. if (name && name_len > 0) {
  17342. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17343. } else {
  17344. mbedpending_sni().clear();
  17345. }
  17346. return 0; // Accept any SNI
  17347. }
  17348. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17349. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17350. }
  17351. // Verify callback used when hostname verification is disabled for a session
  17352. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17353. // has_verify_callback is false). Deliberately does not consult
  17354. // get_verify_callback(): that slot is process-wide, so reading it here would
  17355. // pick up whatever another, unrelated client last installed there.
  17356. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17357. mbedtls_x509_crt *, int,
  17358. uint32_t *flags) {
  17359. (void)data;
  17360. mbedtls_clear_cn_mismatch(flags);
  17361. return 0;
  17362. }
  17363. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17364. int cert_depth, uint32_t *flags);
  17365. // MbedTLS verify callback wrapper
  17366. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17367. int cert_depth, uint32_t *flags) {
  17368. // data points to the MbedTlsSession
  17369. auto *session = static_cast<MbedTlsSession *>(data);
  17370. // set_sni() disabled hostname verification for this session: drop the
  17371. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17372. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17373. // SNI. The final pass/fail decision still comes from the remaining flags
  17374. // (or, below, from the user's own verify callback).
  17375. if (session && session->suppress_hostname_mismatch) {
  17376. mbedtls_clear_cn_mismatch(flags);
  17377. }
  17378. auto &callback = get_verify_callback();
  17379. if (!callback) { return 0; } // Continue with default verification
  17380. // Build context
  17381. VerifyContext verify_ctx;
  17382. verify_ctx.session = static_cast<session_t>(session);
  17383. verify_ctx.cert = static_cast<cert_t>(crt);
  17384. verify_ctx.depth = cert_depth;
  17385. verify_ctx.preverify_ok = (*flags == 0);
  17386. verify_ctx.error_code = static_cast<long>(*flags);
  17387. // Convert Mbed TLS flags to error string
  17388. static thread_local char error_buf[256];
  17389. if (*flags != 0) {
  17390. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17391. verify_ctx.error_string = error_buf;
  17392. } else {
  17393. verify_ctx.error_string = nullptr;
  17394. }
  17395. bool accepted = callback(verify_ctx);
  17396. if (accepted) {
  17397. *flags = 0; // Clear all error flags
  17398. return 0;
  17399. }
  17400. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17401. }
  17402. } // namespace impl
  17403. inline ctx_t create_client_context() {
  17404. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17405. if (!ctx) { return nullptr; }
  17406. ctx->is_server = false;
  17407. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17408. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17409. if (!detail::ensure_mbedtls_psa_crypto()) {
  17410. delete ctx;
  17411. return nullptr;
  17412. }
  17413. int ret;
  17414. #else
  17415. // Seed the random number generator
  17416. const char *pers = "httplib_client";
  17417. int ret = mbedtls_ctr_drbg_seed(
  17418. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17419. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17420. if (ret != 0) {
  17421. impl::mbedtls_last_error() = ret;
  17422. delete ctx;
  17423. return nullptr;
  17424. }
  17425. #endif
  17426. // Set up SSL config for client
  17427. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17428. MBEDTLS_SSL_TRANSPORT_STREAM,
  17429. MBEDTLS_SSL_PRESET_DEFAULT);
  17430. if (ret != 0) {
  17431. impl::mbedtls_last_error() = ret;
  17432. delete ctx;
  17433. return nullptr;
  17434. }
  17435. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17436. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17437. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17438. #endif
  17439. // Default: verify peer certificate
  17440. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17441. // Set minimum TLS version to 1.2
  17442. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17443. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17444. #else
  17445. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17446. MBEDTLS_SSL_MINOR_VERSION_3);
  17447. #endif
  17448. return static_cast<ctx_t>(ctx);
  17449. }
  17450. inline ctx_t create_server_context() {
  17451. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17452. if (!ctx) { return nullptr; }
  17453. ctx->is_server = true;
  17454. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17455. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17456. if (!detail::ensure_mbedtls_psa_crypto()) {
  17457. delete ctx;
  17458. return nullptr;
  17459. }
  17460. int ret;
  17461. #else
  17462. // Seed the random number generator
  17463. const char *pers = "httplib_server";
  17464. int ret = mbedtls_ctr_drbg_seed(
  17465. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17466. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17467. if (ret != 0) {
  17468. impl::mbedtls_last_error() = ret;
  17469. delete ctx;
  17470. return nullptr;
  17471. }
  17472. #endif
  17473. // Set up SSL config for server
  17474. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17475. MBEDTLS_SSL_TRANSPORT_STREAM,
  17476. MBEDTLS_SSL_PRESET_DEFAULT);
  17477. if (ret != 0) {
  17478. impl::mbedtls_last_error() = ret;
  17479. delete ctx;
  17480. return nullptr;
  17481. }
  17482. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17483. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17484. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17485. #endif
  17486. // Default: don't verify client
  17487. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17488. // Set minimum TLS version to 1.2
  17489. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17490. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17491. #else
  17492. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17493. MBEDTLS_SSL_MINOR_VERSION_3);
  17494. #endif
  17495. // Set SNI callback to capture client's SNI hostname
  17496. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17497. return static_cast<ctx_t>(ctx);
  17498. }
  17499. inline void free_context(ctx_t ctx) {
  17500. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17501. }
  17502. inline bool set_min_version(ctx_t ctx, Version version) {
  17503. if (!ctx) { return false; }
  17504. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17505. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17506. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17507. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17508. if (version >= Version::TLS1_3) {
  17509. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17510. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17511. #endif
  17512. }
  17513. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17514. #else
  17515. // Mbed TLS 2.x uses major/minor version numbers
  17516. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17517. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17518. if (version >= Version::TLS1_3) {
  17519. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17520. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17521. #else
  17522. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17523. #endif
  17524. }
  17525. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17526. #endif
  17527. return true;
  17528. }
  17529. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17530. if (!ctx || !pem) { return false; }
  17531. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17532. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17533. // Add null terminator if not present
  17534. std::string pem_str(pem, len);
  17535. int ret = mbedtls_x509_crt_parse(
  17536. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17537. pem_str.size() + 1);
  17538. if (ret != 0) {
  17539. impl::mbedtls_last_error() = ret;
  17540. return false;
  17541. }
  17542. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17543. return true;
  17544. }
  17545. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17546. if (!ctx || !file_path) { return false; }
  17547. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17548. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17549. if (ret != 0) {
  17550. impl::mbedtls_last_error() = ret;
  17551. return false;
  17552. }
  17553. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17554. return true;
  17555. }
  17556. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17557. if (!ctx || !dir_path) { return false; }
  17558. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17559. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17560. if (ret < 0) { // Returns number of certs on success, negative on error
  17561. impl::mbedtls_last_error() = ret;
  17562. return false;
  17563. }
  17564. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17565. return true;
  17566. }
  17567. inline bool load_system_certs(ctx_t ctx) {
  17568. if (!ctx) { return false; }
  17569. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17570. bool loaded = false;
  17571. #ifdef _WIN32
  17572. loaded = impl::enumerate_windows_system_certs(
  17573. [&](const unsigned char *data, size_t len) {
  17574. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17575. });
  17576. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17577. loaded = impl::enumerate_macos_keychain_certs(
  17578. [&](const unsigned char *data, size_t len) {
  17579. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17580. });
  17581. #else
  17582. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17583. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17584. loaded = true;
  17585. break;
  17586. }
  17587. }
  17588. if (!loaded) {
  17589. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17590. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17591. loaded = true;
  17592. break;
  17593. }
  17594. }
  17595. }
  17596. #endif
  17597. if (loaded) {
  17598. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17599. }
  17600. return loaded;
  17601. }
  17602. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17603. const char *password) {
  17604. if (!ctx || !cert || !key) { return false; }
  17605. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17606. // Parse certificate
  17607. std::string cert_str(cert);
  17608. int ret = mbedtls_x509_crt_parse(
  17609. &mctx->own_cert,
  17610. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17611. cert_str.size() + 1);
  17612. if (ret != 0) {
  17613. impl::mbedtls_last_error() = ret;
  17614. return false;
  17615. }
  17616. // Parse private key
  17617. std::string key_str(key);
  17618. const unsigned char *pwd =
  17619. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17620. size_t pwd_len = password ? strlen(password) : 0;
  17621. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17622. ret = mbedtls_pk_parse_key(
  17623. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17624. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17625. &mctx->ctr_drbg);
  17626. #else
  17627. ret = mbedtls_pk_parse_key(
  17628. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17629. key_str.size() + 1, pwd, pwd_len);
  17630. #endif
  17631. if (ret != 0) {
  17632. impl::mbedtls_last_error() = ret;
  17633. return false;
  17634. }
  17635. // Verify that the certificate and private key match.
  17636. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17637. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17638. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17639. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17640. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17641. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17642. #else
  17643. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17644. #endif
  17645. if (ret != 0) {
  17646. impl::mbedtls_last_error() = ret;
  17647. return false;
  17648. }
  17649. #endif
  17650. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17651. if (ret != 0) {
  17652. impl::mbedtls_last_error() = ret;
  17653. return false;
  17654. }
  17655. return true;
  17656. }
  17657. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17658. const char *key_path, const char *password) {
  17659. if (!ctx || !cert_path || !key_path) { return false; }
  17660. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17661. // Parse certificate file
  17662. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17663. if (ret != 0) {
  17664. impl::mbedtls_last_error() = ret;
  17665. return false;
  17666. }
  17667. // Parse private key file
  17668. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17669. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17670. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17671. #else
  17672. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17673. #endif
  17674. if (ret != 0) {
  17675. impl::mbedtls_last_error() = ret;
  17676. return false;
  17677. }
  17678. // Verify that the certificate and private key match.
  17679. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17680. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17681. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17682. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17683. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17684. #else
  17685. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17686. #endif
  17687. if (ret != 0) {
  17688. impl::mbedtls_last_error() = ret;
  17689. return false;
  17690. }
  17691. #endif
  17692. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17693. if (ret != 0) {
  17694. impl::mbedtls_last_error() = ret;
  17695. return false;
  17696. }
  17697. return true;
  17698. }
  17699. inline void set_verify_client(ctx_t ctx, bool require) {
  17700. if (!ctx) { return; }
  17701. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17702. mctx->verify_client = require;
  17703. if (require) {
  17704. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17705. } else {
  17706. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17707. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17708. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17709. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17710. : MBEDTLS_SSL_VERIFY_NONE);
  17711. }
  17712. }
  17713. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17714. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17715. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17716. auto session = new (std::nothrow) impl::MbedTlsSession();
  17717. if (!session) { return nullptr; }
  17718. session->sock = sock;
  17719. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17720. if (ret != 0) {
  17721. impl::mbedtls_last_error() = ret;
  17722. delete session;
  17723. return nullptr;
  17724. }
  17725. // Explicitly opt out of in-handshake hostname verification by default;
  17726. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17727. // fails outright when no hostname was set. set_sni() installs the real
  17728. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17729. // caller verifies the certificate identity post-handshake via
  17730. // verify_hostname().
  17731. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17732. // Set BIO callbacks
  17733. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17734. impl::mbedtls_net_recv_cb, nullptr);
  17735. // Set per-session verify callback with session pointer if callback is
  17736. // registered
  17737. session->has_verify_callback = mctx->has_verify_callback;
  17738. if (mctx->has_verify_callback) {
  17739. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17740. session);
  17741. }
  17742. return static_cast<session_t>(session);
  17743. }
  17744. inline void free_session(session_t session) {
  17745. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17746. }
  17747. inline bool set_sni(session_t session, const char *hostname,
  17748. bool verify_hostname) {
  17749. if (!session || !hostname) { return false; }
  17750. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17751. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17752. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17753. // independently, so a disabled hostname check is handled below by masking
  17754. // the resulting mismatch flag instead of skipping this call.
  17755. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17756. if (ret != 0) {
  17757. impl::mbedtls_last_error() = ret;
  17758. return false;
  17759. }
  17760. msession->hostname = hostname;
  17761. if (!verify_hostname) {
  17762. msession->suppress_hostname_mismatch = true;
  17763. // If a user verify callback is already wired for this session,
  17764. // mbedtls_verify_callback() masks the mismatch flag itself before
  17765. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17766. // here would be redundant. Otherwise install the self-contained masking
  17767. // callback, which never touches the process-wide callback slot.
  17768. if (!msession->has_verify_callback) {
  17769. mbedtls_ssl_set_verify(&msession->ssl,
  17770. impl::mbedtls_mask_hostname_mismatch_callback,
  17771. msession);
  17772. }
  17773. }
  17774. return true;
  17775. }
  17776. inline TlsError connect(session_t session) {
  17777. TlsError err;
  17778. if (!session) {
  17779. err.code = ErrorCode::Fatal;
  17780. return err;
  17781. }
  17782. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17783. int ret;
  17784. do {
  17785. ret = mbedtls_ssl_handshake(&msession->ssl);
  17786. } while (impl::mbedtls_is_session_ticket(ret));
  17787. if (ret == 0) {
  17788. err.code = ErrorCode::Success;
  17789. } else {
  17790. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17791. impl::mbedtls_last_error() = ret;
  17792. }
  17793. return err;
  17794. }
  17795. inline TlsError accept(session_t session) {
  17796. // Same as connect for Mbed TLS - handshake works for both client and server
  17797. auto result = connect(session);
  17798. // After successful handshake, capture SNI from thread-local storage
  17799. if (result.code == ErrorCode::Success && session) {
  17800. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17801. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17802. impl::mbedpending_sni().clear();
  17803. }
  17804. return result;
  17805. }
  17806. inline bool connect_nonblocking(session_t session, socket_t sock,
  17807. time_t timeout_sec, time_t timeout_usec,
  17808. TlsError *err) {
  17809. if (!session) {
  17810. if (err) { err->code = ErrorCode::Fatal; }
  17811. return false;
  17812. }
  17813. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17814. // Set socket to non-blocking mode
  17815. detail::set_nonblocking(sock, true);
  17816. auto cleanup =
  17817. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17818. int ret;
  17819. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17820. // Non-fatal TLS 1.3 ticket; retry immediately.
  17821. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17822. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17823. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17824. continue;
  17825. }
  17826. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17827. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17828. continue;
  17829. }
  17830. }
  17831. // TlsError or timeout
  17832. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17833. impl::mbedtls_last_error() = ret;
  17834. return false;
  17835. }
  17836. if (err) { err->code = ErrorCode::Success; }
  17837. return true;
  17838. }
  17839. inline bool accept_nonblocking(session_t session, socket_t sock,
  17840. time_t timeout_sec, time_t timeout_usec,
  17841. TlsError *err) {
  17842. // Same implementation as connect for Mbed TLS
  17843. bool result =
  17844. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17845. // After successful handshake, capture SNI from thread-local storage
  17846. if (result && session) {
  17847. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17848. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17849. impl::mbedpending_sni().clear();
  17850. }
  17851. return result;
  17852. }
  17853. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17854. if (!session || !buf) {
  17855. err.code = ErrorCode::Fatal;
  17856. return -1;
  17857. }
  17858. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17859. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17860. if (msession->has_peeked_byte) {
  17861. if (len == 0) { return 0; }
  17862. auto p = static_cast<unsigned char *>(buf);
  17863. p[0] = msession->peeked_byte;
  17864. msession->has_peeked_byte = false;
  17865. size_t n = 1;
  17866. // Top up with any already-decrypted bytes without risking a block.
  17867. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17868. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17869. if (extra > 0) { n += static_cast<size_t>(extra); }
  17870. }
  17871. err.code = ErrorCode::Success;
  17872. return static_cast<ssize_t>(n);
  17873. }
  17874. int ret;
  17875. do {
  17876. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17877. len);
  17878. } while (impl::mbedtls_is_session_ticket(ret));
  17879. if (ret > 0) {
  17880. err.code = ErrorCode::Success;
  17881. return static_cast<ssize_t>(ret);
  17882. }
  17883. if (ret == 0) {
  17884. err.code = ErrorCode::PeerClosed;
  17885. return 0;
  17886. }
  17887. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17888. err.backend_code = static_cast<uint64_t>(-ret);
  17889. impl::mbedtls_last_error() = ret;
  17890. // mbedTLS signals a clean close_notify via a negative error code rather
  17891. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17892. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17893. return -1;
  17894. }
  17895. inline ssize_t write(session_t session, const void *buf, size_t len,
  17896. TlsError &err) {
  17897. if (!session || !buf) {
  17898. err.code = ErrorCode::Fatal;
  17899. return -1;
  17900. }
  17901. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17902. int ret;
  17903. do {
  17904. ret = mbedtls_ssl_write(&msession->ssl,
  17905. static_cast<const unsigned char *>(buf), len);
  17906. } while (impl::mbedtls_is_session_ticket(ret));
  17907. if (ret > 0) {
  17908. err.code = ErrorCode::Success;
  17909. return static_cast<ssize_t>(ret);
  17910. }
  17911. if (ret == 0) {
  17912. err.code = ErrorCode::PeerClosed;
  17913. return 0;
  17914. }
  17915. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17916. err.backend_code = static_cast<uint64_t>(-ret);
  17917. impl::mbedtls_last_error() = ret;
  17918. return -1;
  17919. }
  17920. inline int pending(const_session_t session) {
  17921. if (!session) { return 0; }
  17922. auto msession =
  17923. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17924. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17925. (msession->has_peeked_byte ? 1 : 0);
  17926. }
  17927. inline void shutdown(session_t session, bool graceful) {
  17928. if (!session) { return; }
  17929. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17930. if (graceful) {
  17931. // Try to send close_notify, but don't block forever
  17932. int ret;
  17933. int attempts = 0;
  17934. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17935. attempts < 3) {
  17936. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17937. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17938. break;
  17939. }
  17940. attempts++;
  17941. }
  17942. }
  17943. }
  17944. inline bool is_peer_closed(session_t session, socket_t sock) {
  17945. if (!session || sock == INVALID_SOCKET) { return true; }
  17946. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17947. // Check if there's already decrypted or pushed-back data available.
  17948. // If so, the connection is definitely alive.
  17949. if (msession->has_peeked_byte ||
  17950. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17951. return false;
  17952. }
  17953. // Set socket to non-blocking to avoid blocking on read
  17954. detail::set_nonblocking(sock, true);
  17955. auto cleanup =
  17956. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17957. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17958. // on application data — e.g. a response that already arrived — push the
  17959. // byte back so the next read() delivers it instead of losing it.
  17960. unsigned char buf;
  17961. int ret;
  17962. do {
  17963. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17964. } while (impl::mbedtls_is_session_ticket(ret));
  17965. // If we got data or WANT_READ (would block), connection is alive
  17966. if (ret > 0) {
  17967. msession->peeked_byte = buf;
  17968. msession->has_peeked_byte = true;
  17969. return false;
  17970. }
  17971. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17972. // If we get a peer close notify or a connection reset, the peer is closed
  17973. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17974. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17975. }
  17976. inline cert_t get_peer_cert(const_session_t session) {
  17977. if (!session) { return nullptr; }
  17978. auto msession =
  17979. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17980. // Mbed TLS returns a pointer to the internal peer cert chain.
  17981. // WARNING: This pointer is only valid while the session is active.
  17982. // Do not use the certificate after calling free_session().
  17983. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17984. return const_cast<mbedtls_x509_crt *>(cert);
  17985. }
  17986. inline size_t get_peer_certs(const_session_t session,
  17987. std::vector<cert_t> &certs) {
  17988. certs.clear();
  17989. // Mbed TLS parses the whole received chain into a list headed by the peer
  17990. // certificate, owned by the session like get_peer_cert()'s result
  17991. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  17992. crt && crt->raw.len > 0; crt = crt->next) {
  17993. certs.push_back(static_cast<cert_t>(crt));
  17994. }
  17995. return certs.size();
  17996. }
  17997. inline void free_cert(cert_t cert) {
  17998. // Mbed TLS: peer certificate is owned by the SSL context.
  17999. // No-op here, but callers should still call this for cross-backend
  18000. // portability.
  18001. (void)cert;
  18002. }
  18003. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18004. if (!cert || !hostname) { return false; }
  18005. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18006. std::string host_str(hostname);
  18007. // Check if hostname is an IP address (IPv4 or IPv6)
  18008. unsigned char ip_bytes[16];
  18009. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18010. auto is_ip = ip_len > 0;
  18011. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18012. // in buf.tag and the raw value in buf.p / buf.len.
  18013. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18014. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18015. const unsigned char *p = san->buf.p;
  18016. size_t len = san->buf.len;
  18017. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18018. if (is_ip) {
  18019. // For an IP host, only a matching iPAddress SAN of the same family
  18020. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18021. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18022. memcmp(p, ip_bytes, ip_len) == 0) {
  18023. return true;
  18024. }
  18025. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18026. std::string san_name(reinterpret_cast<const char *>(p), len);
  18027. if (detail::match_hostname(san_name, host_str)) { return true; }
  18028. }
  18029. san = san->next;
  18030. }
  18031. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18032. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18033. // the OpenSSL backend's X509_check_ip behaves the same way).
  18034. if (!is_ip) {
  18035. char cn[256];
  18036. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18037. if (ret > 0) {
  18038. std::string cn_str(cn);
  18039. // Look for "CN=" in the DN string
  18040. size_t cn_pos = cn_str.find("CN=");
  18041. if (cn_pos != std::string::npos) {
  18042. size_t start = cn_pos + 3;
  18043. size_t end = cn_str.find(',', start);
  18044. std::string cn_value =
  18045. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18046. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18047. }
  18048. }
  18049. }
  18050. return false;
  18051. }
  18052. inline uint64_t hostname_mismatch_code() {
  18053. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18054. }
  18055. inline long get_verify_result(const_session_t session) {
  18056. if (!session) { return -1; }
  18057. auto msession =
  18058. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18059. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18060. // Return 0 (X509_V_OK equivalent) if verification passed
  18061. return flags == 0 ? 0 : static_cast<long>(flags);
  18062. }
  18063. inline std::string get_cert_subject_cn(cert_t cert) {
  18064. if (!cert) return "";
  18065. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18066. // Find the CN in the subject
  18067. const mbedtls_x509_name *name = &x509->subject;
  18068. while (name != nullptr) {
  18069. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18070. return std::string(reinterpret_cast<const char *>(name->val.p),
  18071. name->val.len);
  18072. }
  18073. name = name->next;
  18074. }
  18075. return "";
  18076. }
  18077. inline std::string get_cert_issuer_name(cert_t cert) {
  18078. if (!cert) return "";
  18079. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18080. // Build a human-readable issuer name string
  18081. char buf[512];
  18082. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18083. if (ret < 0) return "";
  18084. return std::string(buf);
  18085. }
  18086. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18087. sans.clear();
  18088. if (!cert) return false;
  18089. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18090. // Parse the Subject Alternative Name extension
  18091. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18092. while (cur != nullptr) {
  18093. if (cur->buf.len > 0) {
  18094. const unsigned char *p = cur->buf.p;
  18095. size_t value_len = cur->buf.len;
  18096. SanEntry entry;
  18097. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18098. case MBEDTLS_X509_SAN_DNS_NAME:
  18099. entry.type = SanType::DNS;
  18100. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18101. break;
  18102. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18103. entry.type = SanType::IP;
  18104. if (value_len == 4) {
  18105. // IPv4
  18106. char buf[16];
  18107. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18108. entry.value = buf;
  18109. } else if (value_len == 16) {
  18110. // IPv6
  18111. char buf[64];
  18112. snprintf(buf, sizeof(buf),
  18113. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18114. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18115. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18116. p[10], p[11], p[12], p[13], p[14], p[15]);
  18117. entry.value = buf;
  18118. }
  18119. break;
  18120. case MBEDTLS_X509_SAN_RFC822_NAME:
  18121. entry.type = SanType::EMAIL;
  18122. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18123. break;
  18124. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18125. entry.type = SanType::URI;
  18126. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18127. break;
  18128. default: entry.type = SanType::OTHER; break;
  18129. }
  18130. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18131. }
  18132. cur = cur->next;
  18133. }
  18134. return true;
  18135. }
  18136. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18137. time_t &not_after) {
  18138. if (!cert) return false;
  18139. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18140. // Convert mbedtls_x509_time to time_t
  18141. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18142. struct tm tm_time = {};
  18143. tm_time.tm_year = t.year - 1900;
  18144. tm_time.tm_mon = t.mon - 1;
  18145. tm_time.tm_mday = t.day;
  18146. tm_time.tm_hour = t.hour;
  18147. tm_time.tm_min = t.min;
  18148. tm_time.tm_sec = t.sec;
  18149. #ifdef _WIN32
  18150. return _mkgmtime(&tm_time);
  18151. #else
  18152. return timegm(&tm_time);
  18153. #endif
  18154. };
  18155. not_before = to_time_t(x509->valid_from);
  18156. not_after = to_time_t(x509->valid_to);
  18157. return true;
  18158. }
  18159. inline std::string get_cert_serial(cert_t cert) {
  18160. if (!cert) return "";
  18161. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18162. // Convert serial number to hex string
  18163. std::string result;
  18164. result.reserve(x509->serial.len * 2);
  18165. for (size_t i = 0; i < x509->serial.len; i++) {
  18166. char hex[3];
  18167. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18168. result += hex;
  18169. }
  18170. return result;
  18171. }
  18172. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18173. if (!cert) return false;
  18174. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18175. if (!crt->raw.p || crt->raw.len == 0) return false;
  18176. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18177. return true;
  18178. }
  18179. inline const char *get_sni(const_session_t session) {
  18180. if (!session) return nullptr;
  18181. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18182. // For server: return SNI received from client during handshake
  18183. if (!msession->sni_hostname.empty()) {
  18184. return msession->sni_hostname.c_str();
  18185. }
  18186. // For client: return the hostname set via set_sni
  18187. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18188. return nullptr;
  18189. }
  18190. inline uint64_t peek_error() {
  18191. // Mbed TLS doesn't have an error queue, return the last error
  18192. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18193. }
  18194. inline uint64_t get_error() {
  18195. // Mbed TLS doesn't have an error queue, return and clear the last error
  18196. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18197. impl::mbedtls_last_error() = 0;
  18198. return err;
  18199. }
  18200. inline std::string error_string(uint64_t code) {
  18201. char buf[256];
  18202. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18203. return std::string(buf);
  18204. }
  18205. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18206. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18207. if (!ca_chain) { return nullptr; }
  18208. mbedtls_x509_crt_init(ca_chain);
  18209. // mbedtls_x509_crt_parse expects null-terminated PEM
  18210. int ret = mbedtls_x509_crt_parse(ca_chain,
  18211. reinterpret_cast<const unsigned char *>(pem),
  18212. len + 1); // +1 for null terminator
  18213. if (ret != 0) {
  18214. // Try without +1 in case PEM is already null-terminated
  18215. ret = mbedtls_x509_crt_parse(
  18216. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18217. if (ret != 0) {
  18218. mbedtls_x509_crt_free(ca_chain);
  18219. delete ca_chain;
  18220. return nullptr;
  18221. }
  18222. }
  18223. return static_cast<ca_store_t>(ca_chain);
  18224. }
  18225. inline void free_ca_store(ca_store_t store) {
  18226. if (store) {
  18227. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18228. mbedtls_x509_crt_free(ca_chain);
  18229. delete ca_chain;
  18230. }
  18231. }
  18232. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18233. if (!ctx || !store) { return false; }
  18234. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18235. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18236. // Free existing CA chain
  18237. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18238. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18239. // Copy the CA chain (deep copy)
  18240. // Parse from the raw data of the source cert
  18241. mbedtls_x509_crt *src = ca_chain;
  18242. while (src != nullptr) {
  18243. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18244. src->raw.len);
  18245. if (ret != 0) {
  18246. free_ca_store(store);
  18247. return false;
  18248. }
  18249. src = src->next;
  18250. }
  18251. // This function takes ownership of the store; the chain was deep-copied
  18252. // above, so release the source
  18253. free_ca_store(store);
  18254. // Update the SSL config to use the new CA chain
  18255. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18256. return true;
  18257. }
  18258. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18259. certs.clear();
  18260. if (!ctx) { return 0; }
  18261. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18262. // Iterate through the CA chain
  18263. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18264. while (cert != nullptr && cert->raw.len > 0) {
  18265. // Create a copy of the certificate for the caller
  18266. auto *copy = new mbedtls_x509_crt;
  18267. mbedtls_x509_crt_init(copy);
  18268. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18269. if (ret == 0) {
  18270. certs.push_back(static_cast<cert_t>(copy));
  18271. } else {
  18272. mbedtls_x509_crt_free(copy);
  18273. delete copy;
  18274. }
  18275. cert = cert->next;
  18276. }
  18277. return certs.size();
  18278. }
  18279. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18280. std::vector<std::string> names;
  18281. if (!ctx) { return names; }
  18282. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18283. // Iterate through the CA chain
  18284. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18285. while (cert != nullptr && cert->raw.len > 0) {
  18286. char buf[512];
  18287. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18288. if (ret > 0) { names.push_back(buf); }
  18289. cert = cert->next;
  18290. }
  18291. return names;
  18292. }
  18293. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18294. const char *key_pem, const char *password) {
  18295. if (!ctx || !cert_pem || !key_pem) { return false; }
  18296. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18297. // Free existing certificate and key
  18298. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18299. mbedtls_pk_free(&mbed_ctx->own_key);
  18300. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18301. mbedtls_pk_init(&mbed_ctx->own_key);
  18302. // Parse certificate PEM
  18303. int ret = mbedtls_x509_crt_parse(
  18304. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18305. strlen(cert_pem) + 1);
  18306. if (ret != 0) {
  18307. impl::mbedtls_last_error() = ret;
  18308. return false;
  18309. }
  18310. // Parse private key PEM
  18311. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18312. ret = mbedtls_pk_parse_key(
  18313. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18314. strlen(key_pem) + 1,
  18315. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18316. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18317. &mbed_ctx->ctr_drbg);
  18318. #else
  18319. ret = mbedtls_pk_parse_key(
  18320. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18321. strlen(key_pem) + 1,
  18322. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18323. password ? strlen(password) : 0);
  18324. #endif
  18325. if (ret != 0) {
  18326. impl::mbedtls_last_error() = ret;
  18327. return false;
  18328. }
  18329. // Configure SSL to use the new certificate and key
  18330. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18331. &mbed_ctx->own_key);
  18332. if (ret != 0) {
  18333. impl::mbedtls_last_error() = ret;
  18334. return false;
  18335. }
  18336. return true;
  18337. }
  18338. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18339. if (!ctx || !ca_pem) { return false; }
  18340. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18341. // Free existing CA chain
  18342. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18343. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18344. // Parse CA PEM
  18345. int ret = mbedtls_x509_crt_parse(
  18346. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18347. strlen(ca_pem) + 1);
  18348. if (ret != 0) {
  18349. impl::mbedtls_last_error() = ret;
  18350. return false;
  18351. }
  18352. // Update SSL config to use new CA chain
  18353. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18354. return true;
  18355. }
  18356. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18357. if (!ctx) { return false; }
  18358. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18359. impl::get_verify_callback() = std::move(callback);
  18360. mbed_ctx->has_verify_callback =
  18361. static_cast<bool>(impl::get_verify_callback());
  18362. if (mbed_ctx->has_verify_callback) {
  18363. // Set OPTIONAL mode to ensure callback is called even when verification
  18364. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18365. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18366. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18367. nullptr);
  18368. } else {
  18369. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18370. }
  18371. return true;
  18372. }
  18373. inline long get_verify_error(const_session_t session) {
  18374. if (!session) { return -1; }
  18375. auto *msession =
  18376. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18377. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18378. }
  18379. inline std::string verify_error_string(long error_code) {
  18380. if (error_code == 0) { return ""; }
  18381. char buf[256];
  18382. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18383. static_cast<uint32_t>(error_code));
  18384. // Remove trailing newline if present
  18385. std::string result(buf);
  18386. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18387. result.pop_back();
  18388. }
  18389. return result;
  18390. }
  18391. } // namespace tls
  18392. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18393. /*
  18394. * Group 10: TLS abstraction layer - wolfSSL backend
  18395. */
  18396. /*
  18397. * wolfSSL Backend Implementation
  18398. */
  18399. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18400. namespace tls {
  18401. namespace impl {
  18402. // wolfSSL session wrapper
  18403. struct WolfSSLSession {
  18404. WOLFSSL *ssl = nullptr;
  18405. socket_t sock = INVALID_SOCKET;
  18406. std::string hostname; // For client: set via set_sni
  18407. std::string sni_hostname; // For server: received from client via SNI callback
  18408. WolfSSLSession() = default;
  18409. ~WolfSSLSession() {
  18410. if (ssl) { wolfSSL_free(ssl); }
  18411. }
  18412. WolfSSLSession(const WolfSSLSession &) = delete;
  18413. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18414. };
  18415. // Thread-local error code accessor for wolfSSL
  18416. inline uint64_t &wolfssl_last_error() {
  18417. static thread_local uint64_t err = 0;
  18418. return err;
  18419. }
  18420. // Helper to map wolfSSL error to ErrorCode.
  18421. // ssl_error is the value from wolfSSL_get_error().
  18422. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18423. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18424. int &out_errno) {
  18425. switch (ssl_error) {
  18426. case SSL_ERROR_NONE: return ErrorCode::Success;
  18427. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18428. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18429. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18430. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18431. default:
  18432. if (ssl) {
  18433. // wolfSSL stores the low-level error code as a negative value.
  18434. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18435. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18436. if (low_err == DOMAIN_NAME_MISMATCH) {
  18437. return ErrorCode::HostnameMismatch;
  18438. }
  18439. // Check verify result to distinguish cert verification from generic SSL
  18440. // errors.
  18441. long vr = wolfSSL_get_verify_result(ssl);
  18442. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18443. }
  18444. return ErrorCode::Fatal;
  18445. }
  18446. }
  18447. // WolfSSLContext constructor/destructor implementations
  18448. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18449. inline WolfSSLContext::~WolfSSLContext() {
  18450. if (ctx) { wolfSSL_CTX_free(ctx); }
  18451. }
  18452. // Thread-local storage for SNI captured during handshake
  18453. inline std::string &wolfssl_pending_sni() {
  18454. static thread_local std::string sni;
  18455. return sni;
  18456. }
  18457. // SNI callback for wolfSSL server to capture client's SNI hostname
  18458. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18459. (void)ret;
  18460. (void)exArg;
  18461. void *name_data = nullptr;
  18462. unsigned short name_len =
  18463. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18464. if (name_data && name_len > 0) {
  18465. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18466. name_len);
  18467. } else {
  18468. wolfssl_pending_sni().clear();
  18469. }
  18470. return 0; // Continue regardless
  18471. }
  18472. // wolfSSL verify callback wrapper
  18473. inline int wolfssl_verify_callback(int preverify_ok,
  18474. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18475. auto &callback = get_verify_callback();
  18476. if (!callback) { return preverify_ok; }
  18477. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18478. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18479. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18480. // Get the WOLFSSL object from the X509_STORE_CTX
  18481. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18482. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18483. VerifyContext verify_ctx;
  18484. verify_ctx.session = static_cast<session_t>(ssl);
  18485. verify_ctx.cert = static_cast<cert_t>(cert);
  18486. verify_ctx.depth = depth;
  18487. verify_ctx.preverify_ok = (preverify_ok != 0);
  18488. verify_ctx.error_code = static_cast<long>(err);
  18489. if (err != 0) {
  18490. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18491. } else {
  18492. verify_ctx.error_string = nullptr;
  18493. }
  18494. bool accepted = callback(verify_ctx);
  18495. return accepted ? 1 : 0;
  18496. }
  18497. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18498. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18499. wolfSSL_CTX_set_default_passwd_cb(
  18500. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18501. auto *pwd = static_cast<const char *>(userdata);
  18502. if (!pwd) return 0;
  18503. auto len = static_cast<int>(strlen(pwd));
  18504. if (len > size) len = size;
  18505. memcpy(buf, pwd, static_cast<size_t>(len));
  18506. return len;
  18507. });
  18508. }
  18509. } // namespace impl
  18510. inline ctx_t create_client_context() {
  18511. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18512. if (!ctx) { return nullptr; }
  18513. ctx->is_server = false;
  18514. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18515. if (!method) {
  18516. delete ctx;
  18517. return nullptr;
  18518. }
  18519. ctx->ctx = wolfSSL_CTX_new(method);
  18520. if (!ctx->ctx) {
  18521. delete ctx;
  18522. return nullptr;
  18523. }
  18524. // Default: verify peer certificate
  18525. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18526. return static_cast<ctx_t>(ctx);
  18527. }
  18528. inline ctx_t create_server_context() {
  18529. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18530. if (!ctx) { return nullptr; }
  18531. ctx->is_server = true;
  18532. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18533. if (!method) {
  18534. delete ctx;
  18535. return nullptr;
  18536. }
  18537. ctx->ctx = wolfSSL_CTX_new(method);
  18538. if (!ctx->ctx) {
  18539. delete ctx;
  18540. return nullptr;
  18541. }
  18542. // Default: don't verify client
  18543. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18544. // Enable SNI on server
  18545. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18546. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18547. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18548. return static_cast<ctx_t>(ctx);
  18549. }
  18550. inline void free_context(ctx_t ctx) {
  18551. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18552. }
  18553. inline bool set_min_version(ctx_t ctx, Version version) {
  18554. if (!ctx) { return false; }
  18555. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18556. int min_ver = WOLFSSL_TLSV1_2;
  18557. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18558. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18559. }
  18560. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18561. if (!ctx || !pem) { return false; }
  18562. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18563. int ret = wolfSSL_CTX_load_verify_buffer(
  18564. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18565. static_cast<long>(len), SSL_FILETYPE_PEM);
  18566. if (ret != SSL_SUCCESS) {
  18567. impl::wolfssl_last_error() =
  18568. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18569. return false;
  18570. }
  18571. wctx->ca_pem_data_.append(pem, len);
  18572. return true;
  18573. }
  18574. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18575. if (!ctx || !file_path) { return false; }
  18576. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18577. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18578. if (ret != SSL_SUCCESS) {
  18579. impl::wolfssl_last_error() =
  18580. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18581. return false;
  18582. }
  18583. return true;
  18584. }
  18585. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18586. if (!ctx || !dir_path) { return false; }
  18587. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18588. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18589. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18590. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18591. // immediately. Return true even on failure since the CA file may have
  18592. // already been loaded, matching OpenSSL's lenient behavior.
  18593. (void)ret;
  18594. return true;
  18595. }
  18596. inline bool load_system_certs(ctx_t ctx) {
  18597. if (!ctx) { return false; }
  18598. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18599. bool loaded = false;
  18600. #ifdef _WIN32
  18601. loaded = impl::enumerate_windows_system_certs(
  18602. [&](const unsigned char *data, size_t len) {
  18603. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18604. static_cast<long>(len),
  18605. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18606. });
  18607. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18608. loaded = impl::enumerate_macos_keychain_certs(
  18609. [&](const unsigned char *data, size_t len) {
  18610. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18611. static_cast<long>(len),
  18612. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18613. });
  18614. #else
  18615. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18616. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18617. SSL_SUCCESS) {
  18618. loaded = true;
  18619. break;
  18620. }
  18621. }
  18622. if (!loaded) {
  18623. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18624. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18625. SSL_SUCCESS) {
  18626. loaded = true;
  18627. break;
  18628. }
  18629. }
  18630. }
  18631. #endif
  18632. return loaded;
  18633. }
  18634. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18635. const char *password) {
  18636. if (!ctx || !cert || !key) { return false; }
  18637. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18638. // Load certificate
  18639. int ret = wolfSSL_CTX_use_certificate_buffer(
  18640. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18641. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18642. if (ret != SSL_SUCCESS) {
  18643. impl::wolfssl_last_error() =
  18644. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18645. return false;
  18646. }
  18647. // Set password callback if password is provided
  18648. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18649. // Load private key
  18650. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18651. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18652. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18653. if (ret != SSL_SUCCESS) {
  18654. impl::wolfssl_last_error() =
  18655. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18656. return false;
  18657. }
  18658. // Verify that the certificate and private key match
  18659. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18660. }
  18661. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18662. const char *key_path, const char *password) {
  18663. if (!ctx || !cert_path || !key_path) { return false; }
  18664. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18665. // Load certificate file
  18666. int ret =
  18667. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18668. if (ret != SSL_SUCCESS) {
  18669. impl::wolfssl_last_error() =
  18670. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18671. return false;
  18672. }
  18673. // Set password callback if password is provided
  18674. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18675. // Load private key file
  18676. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18677. if (ret != SSL_SUCCESS) {
  18678. impl::wolfssl_last_error() =
  18679. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18680. return false;
  18681. }
  18682. // Verify that the certificate and private key match
  18683. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18684. }
  18685. inline void set_verify_client(ctx_t ctx, bool require) {
  18686. if (!ctx) { return; }
  18687. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18688. wctx->verify_client = require;
  18689. if (require) {
  18690. wolfSSL_CTX_set_verify(
  18691. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18692. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18693. } else {
  18694. if (wctx->has_verify_callback) {
  18695. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18696. impl::wolfssl_verify_callback);
  18697. } else {
  18698. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18699. }
  18700. }
  18701. }
  18702. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18703. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18704. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18705. auto session = new (std::nothrow) impl::WolfSSLSession();
  18706. if (!session) { return nullptr; }
  18707. session->sock = sock;
  18708. session->ssl = wolfSSL_new(wctx->ctx);
  18709. if (!session->ssl) {
  18710. impl::wolfssl_last_error() =
  18711. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18712. delete session;
  18713. return nullptr;
  18714. }
  18715. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18716. return static_cast<session_t>(session);
  18717. }
  18718. inline void free_session(session_t session) {
  18719. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18720. }
  18721. inline bool set_sni(session_t session, const char *hostname,
  18722. bool verify_hostname) {
  18723. if (!session || !hostname) { return false; }
  18724. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18725. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18726. static_cast<word16>(strlen(hostname)));
  18727. if (ret != WOLFSSL_SUCCESS) {
  18728. impl::wolfssl_last_error() =
  18729. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18730. return false;
  18731. }
  18732. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18733. // separately from the SNI extension sent above; skip it when hostname
  18734. // verification is disabled so only the chain is checked, matching OpenSSL.
  18735. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18736. wsession->hostname = hostname;
  18737. return true;
  18738. }
  18739. inline TlsError connect(session_t session) {
  18740. TlsError err;
  18741. if (!session) {
  18742. err.code = ErrorCode::Fatal;
  18743. return err;
  18744. }
  18745. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18746. int ret = wolfSSL_connect(wsession->ssl);
  18747. if (ret == SSL_SUCCESS) {
  18748. err.code = ErrorCode::Success;
  18749. } else {
  18750. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18751. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18752. err.backend_code = static_cast<uint64_t>(ssl_error);
  18753. impl::wolfssl_last_error() = err.backend_code;
  18754. }
  18755. return err;
  18756. }
  18757. inline TlsError accept(session_t session) {
  18758. TlsError err;
  18759. if (!session) {
  18760. err.code = ErrorCode::Fatal;
  18761. return err;
  18762. }
  18763. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18764. int ret = wolfSSL_accept(wsession->ssl);
  18765. if (ret == SSL_SUCCESS) {
  18766. err.code = ErrorCode::Success;
  18767. // Capture SNI from thread-local storage after successful handshake
  18768. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18769. impl::wolfssl_pending_sni().clear();
  18770. } else {
  18771. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18772. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18773. err.backend_code = static_cast<uint64_t>(ssl_error);
  18774. impl::wolfssl_last_error() = err.backend_code;
  18775. }
  18776. return err;
  18777. }
  18778. inline bool connect_nonblocking(session_t session, socket_t sock,
  18779. time_t timeout_sec, time_t timeout_usec,
  18780. TlsError *err) {
  18781. if (!session) {
  18782. if (err) { err->code = ErrorCode::Fatal; }
  18783. return false;
  18784. }
  18785. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18786. // Set socket to non-blocking mode
  18787. detail::set_nonblocking(sock, true);
  18788. auto cleanup =
  18789. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18790. int ret;
  18791. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18792. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18793. if (ssl_error == SSL_ERROR_WANT_READ) {
  18794. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18795. continue;
  18796. }
  18797. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18798. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18799. continue;
  18800. }
  18801. }
  18802. // Error or timeout
  18803. if (err) {
  18804. err->code =
  18805. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18806. err->backend_code = static_cast<uint64_t>(ssl_error);
  18807. }
  18808. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18809. return false;
  18810. }
  18811. if (err) { err->code = ErrorCode::Success; }
  18812. return true;
  18813. }
  18814. inline bool accept_nonblocking(session_t session, socket_t sock,
  18815. time_t timeout_sec, time_t timeout_usec,
  18816. TlsError *err) {
  18817. if (!session) {
  18818. if (err) { err->code = ErrorCode::Fatal; }
  18819. return false;
  18820. }
  18821. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18822. // Set socket to non-blocking mode
  18823. detail::set_nonblocking(sock, true);
  18824. auto cleanup =
  18825. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18826. int ret;
  18827. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18828. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18829. if (ssl_error == SSL_ERROR_WANT_READ) {
  18830. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18831. continue;
  18832. }
  18833. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18834. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18835. continue;
  18836. }
  18837. }
  18838. // Error or timeout
  18839. if (err) {
  18840. err->code =
  18841. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18842. err->backend_code = static_cast<uint64_t>(ssl_error);
  18843. }
  18844. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18845. return false;
  18846. }
  18847. if (err) { err->code = ErrorCode::Success; }
  18848. // Capture SNI from thread-local storage after successful handshake
  18849. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18850. impl::wolfssl_pending_sni().clear();
  18851. return true;
  18852. }
  18853. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18854. if (!session || !buf) {
  18855. err.code = ErrorCode::Fatal;
  18856. return -1;
  18857. }
  18858. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18859. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18860. if (ret > 0) {
  18861. err.code = ErrorCode::Success;
  18862. return static_cast<ssize_t>(ret);
  18863. }
  18864. if (ret == 0) {
  18865. err.code = ErrorCode::PeerClosed;
  18866. return 0;
  18867. }
  18868. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18869. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18870. err.backend_code = static_cast<uint64_t>(ssl_error);
  18871. impl::wolfssl_last_error() = err.backend_code;
  18872. return -1;
  18873. }
  18874. inline ssize_t write(session_t session, const void *buf, size_t len,
  18875. TlsError &err) {
  18876. if (!session || !buf) {
  18877. err.code = ErrorCode::Fatal;
  18878. return -1;
  18879. }
  18880. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18881. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18882. if (ret > 0) {
  18883. err.code = ErrorCode::Success;
  18884. return static_cast<ssize_t>(ret);
  18885. }
  18886. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18887. // Treat this as an error (return -1) so callers don't spin in a
  18888. // write loop adding zero to the offset.
  18889. if (ret == 0) {
  18890. err.code = ErrorCode::PeerClosed;
  18891. return -1;
  18892. }
  18893. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18894. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18895. err.backend_code = static_cast<uint64_t>(ssl_error);
  18896. impl::wolfssl_last_error() = err.backend_code;
  18897. return -1;
  18898. }
  18899. inline int pending(const_session_t session) {
  18900. if (!session) { return 0; }
  18901. auto wsession =
  18902. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18903. return wolfSSL_pending(wsession->ssl);
  18904. }
  18905. inline void shutdown(session_t session, bool graceful) {
  18906. if (!session) { return; }
  18907. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18908. if (graceful) {
  18909. int ret;
  18910. int attempts = 0;
  18911. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18912. attempts < 3) {
  18913. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18914. if (ssl_error != SSL_ERROR_WANT_READ &&
  18915. ssl_error != SSL_ERROR_WANT_WRITE) {
  18916. break;
  18917. }
  18918. attempts++;
  18919. }
  18920. } else {
  18921. wolfSSL_shutdown(wsession->ssl);
  18922. }
  18923. }
  18924. inline bool is_peer_closed(session_t session, socket_t sock) {
  18925. if (!session || sock == INVALID_SOCKET) { return true; }
  18926. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18927. // Check if there's already decrypted data available
  18928. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18929. // Set socket to non-blocking to avoid blocking on read
  18930. detail::set_nonblocking(sock, true);
  18931. auto cleanup =
  18932. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18933. // Peek 1 byte to check connection status without consuming data
  18934. unsigned char buf;
  18935. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18936. // If we got data or WANT_READ (would block), connection is alive
  18937. if (ret > 0) { return false; }
  18938. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18939. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18940. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18941. ret == 0;
  18942. }
  18943. inline cert_t get_peer_cert(const_session_t session) {
  18944. if (!session) { return nullptr; }
  18945. auto wsession =
  18946. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18947. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18948. return static_cast<cert_t>(cert);
  18949. }
  18950. inline size_t get_peer_certs(const_session_t session,
  18951. std::vector<cert_t> &certs) {
  18952. certs.clear();
  18953. if (!session) { return 0; }
  18954. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  18955. #ifdef SESSION_CERTS
  18956. auto wsession =
  18957. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18958. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  18959. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  18960. for (int i = 0; i < count; i++) {
  18961. auto x509 = wolfSSL_get_chain_X509(chain, i);
  18962. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18963. }
  18964. #endif
  18965. return certs.size();
  18966. }
  18967. inline void free_cert(cert_t cert) {
  18968. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18969. }
  18970. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18971. if (!cert || !hostname) { return false; }
  18972. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18973. std::string host_str(hostname);
  18974. // Check if hostname is an IP address (IPv4 or IPv6)
  18975. unsigned char ip_bytes[16];
  18976. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18977. auto is_ip = ip_len > 0;
  18978. // Check Subject Alternative Names
  18979. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18980. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18981. if (san_names) {
  18982. int san_count = wolfSSL_sk_num(san_names);
  18983. for (int i = 0; i < san_count; i++) {
  18984. auto *names =
  18985. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18986. if (!names) continue;
  18987. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18988. // DNS name
  18989. unsigned char *dns_name = nullptr;
  18990. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18991. if (dns_name && dns_len > 0) {
  18992. std::string san_name(reinterpret_cast<char *>(dns_name),
  18993. static_cast<size_t>(dns_len));
  18994. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18995. if (detail::match_hostname(san_name, host_str)) {
  18996. wolfSSL_sk_free(san_names);
  18997. return true;
  18998. }
  18999. }
  19000. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19001. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19002. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19003. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19004. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19005. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19006. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19007. wolfSSL_sk_free(san_names);
  19008. return true;
  19009. }
  19010. }
  19011. }
  19012. wolfSSL_sk_free(san_names);
  19013. }
  19014. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19015. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19016. // the OpenSSL backend's X509_check_ip behaves the same way).
  19017. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19018. if (subject) {
  19019. char cn[256] = {};
  19020. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19021. sizeof(cn));
  19022. if (cn_len > 0) {
  19023. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19024. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19025. }
  19026. }
  19027. return false;
  19028. }
  19029. inline uint64_t hostname_mismatch_code() {
  19030. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19031. }
  19032. inline long get_verify_result(const_session_t session) {
  19033. if (!session) { return -1; }
  19034. auto wsession =
  19035. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19036. long result = wolfSSL_get_verify_result(wsession->ssl);
  19037. return result;
  19038. }
  19039. inline std::string get_cert_subject_cn(cert_t cert) {
  19040. if (!cert) return "";
  19041. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19042. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19043. if (!subject) return "";
  19044. char cn[256] = {};
  19045. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19046. sizeof(cn));
  19047. if (cn_len <= 0) return "";
  19048. return std::string(cn, static_cast<size_t>(cn_len));
  19049. }
  19050. inline std::string get_cert_issuer_name(cert_t cert) {
  19051. if (!cert) return "";
  19052. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19053. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19054. if (!issuer) return "";
  19055. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19056. if (!name_str) return "";
  19057. std::string result(name_str);
  19058. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19059. return result;
  19060. }
  19061. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19062. sans.clear();
  19063. if (!cert) return false;
  19064. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19065. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19066. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19067. if (!san_names) return true; // No SANs is not an error
  19068. int count = wolfSSL_sk_num(san_names);
  19069. for (int i = 0; i < count; i++) {
  19070. auto *name =
  19071. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19072. if (!name) continue;
  19073. SanEntry entry;
  19074. switch (name->type) {
  19075. case WOLFSSL_GEN_DNS: {
  19076. entry.type = SanType::DNS;
  19077. unsigned char *dns_name = nullptr;
  19078. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19079. if (dns_name && dns_len > 0) {
  19080. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19081. static_cast<size_t>(dns_len));
  19082. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19083. }
  19084. break;
  19085. }
  19086. case WOLFSSL_GEN_IPADD: {
  19087. entry.type = SanType::IP;
  19088. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19089. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19090. if (ip_data && ip_len == 4) {
  19091. char buf[16];
  19092. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19093. ip_data[2], ip_data[3]);
  19094. entry.value = buf;
  19095. } else if (ip_data && ip_len == 16) {
  19096. char buf[64];
  19097. snprintf(buf, sizeof(buf),
  19098. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19099. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19100. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19101. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19102. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19103. ip_data[14], ip_data[15]);
  19104. entry.value = buf;
  19105. }
  19106. break;
  19107. }
  19108. case WOLFSSL_GEN_EMAIL:
  19109. entry.type = SanType::EMAIL;
  19110. {
  19111. unsigned char *email = nullptr;
  19112. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19113. if (email && email_len > 0) {
  19114. entry.value = std::string(reinterpret_cast<char *>(email),
  19115. static_cast<size_t>(email_len));
  19116. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19117. }
  19118. }
  19119. break;
  19120. case WOLFSSL_GEN_URI:
  19121. entry.type = SanType::URI;
  19122. {
  19123. unsigned char *uri = nullptr;
  19124. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19125. &uri, name->d.uniformResourceIdentifier);
  19126. if (uri && uri_len > 0) {
  19127. entry.value = std::string(reinterpret_cast<char *>(uri),
  19128. static_cast<size_t>(uri_len));
  19129. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19130. }
  19131. }
  19132. break;
  19133. default: entry.type = SanType::OTHER; break;
  19134. }
  19135. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19136. }
  19137. wolfSSL_sk_free(san_names);
  19138. return true;
  19139. }
  19140. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19141. time_t &not_after) {
  19142. if (!cert) return false;
  19143. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19144. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19145. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19146. if (!nb || !na) return false;
  19147. // wolfSSL_ASN1_TIME_to_tm is available
  19148. struct tm tm_nb = {}, tm_na = {};
  19149. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19150. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19151. #ifdef _WIN32
  19152. not_before = _mkgmtime(&tm_nb);
  19153. not_after = _mkgmtime(&tm_na);
  19154. #else
  19155. not_before = timegm(&tm_nb);
  19156. not_after = timegm(&tm_na);
  19157. #endif
  19158. return true;
  19159. }
  19160. inline std::string get_cert_serial(cert_t cert) {
  19161. if (!cert) return "";
  19162. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19163. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19164. if (!serial_asn1) return "";
  19165. // Get the serial number data
  19166. int len = serial_asn1->length;
  19167. unsigned char *data = serial_asn1->data;
  19168. if (!data || len <= 0) return "";
  19169. std::string result;
  19170. result.reserve(static_cast<size_t>(len) * 2);
  19171. for (int i = 0; i < len; i++) {
  19172. char hex[3];
  19173. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19174. result += hex;
  19175. }
  19176. return result;
  19177. }
  19178. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19179. if (!cert) return false;
  19180. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19181. int der_len = 0;
  19182. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19183. if (!der_data || der_len <= 0) return false;
  19184. der.assign(der_data, der_data + der_len);
  19185. return true;
  19186. }
  19187. inline const char *get_sni(const_session_t session) {
  19188. if (!session) return nullptr;
  19189. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19190. // For server: return SNI received from client during handshake
  19191. if (!wsession->sni_hostname.empty()) {
  19192. return wsession->sni_hostname.c_str();
  19193. }
  19194. // For client: return the hostname set via set_sni
  19195. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19196. return nullptr;
  19197. }
  19198. inline uint64_t peek_error() {
  19199. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19200. }
  19201. inline uint64_t get_error() {
  19202. uint64_t err = impl::wolfssl_last_error();
  19203. impl::wolfssl_last_error() = 0;
  19204. return err;
  19205. }
  19206. inline std::string error_string(uint64_t code) {
  19207. char buf[256];
  19208. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19209. return std::string(buf);
  19210. }
  19211. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19212. if (!pem || len == 0) { return nullptr; }
  19213. // Validate by attempting to load into a temporary ctx
  19214. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19215. if (!tmp_ctx) { return nullptr; }
  19216. int ret = wolfSSL_CTX_load_verify_buffer(
  19217. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19218. static_cast<long>(len), SSL_FILETYPE_PEM);
  19219. wolfSSL_CTX_free(tmp_ctx);
  19220. if (ret != SSL_SUCCESS) { return nullptr; }
  19221. return static_cast<ca_store_t>(
  19222. new impl::WolfSSLCAStore{std::string(pem, len)});
  19223. }
  19224. inline void free_ca_store(ca_store_t store) {
  19225. delete static_cast<impl::WolfSSLCAStore *>(store);
  19226. }
  19227. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19228. if (!ctx || !store) { return false; }
  19229. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19230. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19231. int ret = wolfSSL_CTX_load_verify_buffer(
  19232. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19233. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19234. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19235. // This function takes ownership of the store; the PEM data was copied into
  19236. // the context, so release the source
  19237. free_ca_store(store);
  19238. return ret == SSL_SUCCESS;
  19239. }
  19240. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19241. certs.clear();
  19242. if (!ctx) { return 0; }
  19243. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19244. if (wctx->ca_pem_data_.empty()) { return 0; }
  19245. const std::string &pem = wctx->ca_pem_data_;
  19246. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19247. const std::string end_marker = "-----END CERTIFICATE-----";
  19248. size_t pos = 0;
  19249. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19250. size_t end_pos = pem.find(end_marker, pos);
  19251. if (end_pos == std::string::npos) { break; }
  19252. end_pos += end_marker.size();
  19253. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19254. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19255. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19256. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19257. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19258. pos = end_pos;
  19259. }
  19260. return certs.size();
  19261. }
  19262. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19263. std::vector<std::string> names;
  19264. if (!ctx) { return names; }
  19265. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19266. if (wctx->ca_pem_data_.empty()) { return names; }
  19267. const std::string &pem = wctx->ca_pem_data_;
  19268. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19269. const std::string end_marker = "-----END CERTIFICATE-----";
  19270. size_t pos = 0;
  19271. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19272. size_t end_pos = pem.find(end_marker, pos);
  19273. if (end_pos == std::string::npos) { break; }
  19274. end_pos += end_marker.size();
  19275. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19276. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19277. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19278. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19279. if (x509) {
  19280. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19281. if (subject) {
  19282. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19283. if (name_str) {
  19284. names.push_back(name_str);
  19285. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19286. }
  19287. }
  19288. wolfSSL_X509_free(x509);
  19289. }
  19290. pos = end_pos;
  19291. }
  19292. return names;
  19293. }
  19294. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19295. const char *key_pem, const char *password) {
  19296. if (!ctx || !cert_pem || !key_pem) { return false; }
  19297. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19298. // Load new certificate
  19299. int ret = wolfSSL_CTX_use_certificate_buffer(
  19300. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19301. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19302. if (ret != SSL_SUCCESS) {
  19303. impl::wolfssl_last_error() =
  19304. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19305. return false;
  19306. }
  19307. // Set password if provided
  19308. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19309. // Load new private key
  19310. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19311. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19312. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19313. if (ret != SSL_SUCCESS) {
  19314. impl::wolfssl_last_error() =
  19315. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19316. return false;
  19317. }
  19318. return true;
  19319. }
  19320. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19321. if (!ctx || !ca_pem) { return false; }
  19322. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19323. int ret = wolfSSL_CTX_load_verify_buffer(
  19324. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19325. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19326. if (ret != SSL_SUCCESS) {
  19327. impl::wolfssl_last_error() =
  19328. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19329. return false;
  19330. }
  19331. return true;
  19332. }
  19333. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19334. if (!ctx) { return false; }
  19335. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19336. impl::get_verify_callback() = std::move(callback);
  19337. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19338. if (wctx->has_verify_callback) {
  19339. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19340. impl::wolfssl_verify_callback);
  19341. } else {
  19342. wolfSSL_CTX_set_verify(
  19343. wctx->ctx,
  19344. wctx->verify_client
  19345. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19346. : SSL_VERIFY_NONE,
  19347. nullptr);
  19348. }
  19349. return true;
  19350. }
  19351. inline long get_verify_error(const_session_t session) {
  19352. if (!session) { return -1; }
  19353. auto *wsession =
  19354. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19355. return wolfSSL_get_verify_result(wsession->ssl);
  19356. }
  19357. inline std::string verify_error_string(long error_code) {
  19358. if (error_code == 0) { return ""; }
  19359. const char *str =
  19360. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19361. return str ? std::string(str) : std::string();
  19362. }
  19363. } // namespace tls
  19364. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19365. // WebSocket implementation
  19366. namespace ws {
  19367. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19368. bool fin) {
  19369. std::lock_guard<std::mutex> lock(write_mutex_);
  19370. if (closed_) { return false; }
  19371. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19372. }
  19373. inline ReadResult WebSocket::read(std::string &msg) {
  19374. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19375. while (!closed_) {
  19376. Opcode opcode;
  19377. std::string payload;
  19378. bool fin;
  19379. impl::FrameRead r =
  19380. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19381. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19382. // A timeout landed on a frame boundary: the connection is untouched and
  19383. // still usable, so hand control back without closing it. That is only
  19384. // useful to a caller who asked for the timeout; the compile-time default
  19385. // is a backstop against a peer gone quiet, and elapsing it closes the
  19386. // connection so a plain `while (ws.read(msg))` loop ends.
  19387. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19388. if (r != impl::FrameRead::Ok) {
  19389. closed_ = true;
  19390. return Fail;
  19391. }
  19392. switch (opcode) {
  19393. case Opcode::Ping: {
  19394. std::lock_guard<std::mutex> lock(write_mutex_);
  19395. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19396. payload.size(), true, !is_server_);
  19397. continue;
  19398. }
  19399. case Opcode::Pong: {
  19400. std::lock_guard<std::mutex> lock(ping_mutex_);
  19401. unacked_pings_ = 0;
  19402. continue;
  19403. }
  19404. case Opcode::Close: {
  19405. if (!closed_.exchange(true)) {
  19406. // Echo close frame back
  19407. std::lock_guard<std::mutex> lock(write_mutex_);
  19408. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19409. payload.size(), true, !is_server_);
  19410. }
  19411. return Fail;
  19412. }
  19413. case Opcode::Text:
  19414. case Opcode::Binary: {
  19415. auto result = opcode == Opcode::Text ? Text : Binary;
  19416. msg = std::move(payload);
  19417. // Handle fragmentation
  19418. if (!fin) {
  19419. while (true) {
  19420. Opcode cont_opcode;
  19421. std::string cont_payload;
  19422. bool cont_fin;
  19423. // A timeout is not reportable here: half of a fragmented message is
  19424. // already in `msg` and read() has no way to resume it, so it is a
  19425. // failure like any other. Timeouts are only ever seen on a message
  19426. // boundary.
  19427. if (impl::read_websocket_frame(
  19428. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19429. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19430. impl::FrameRead::Ok) {
  19431. closed_ = true;
  19432. return Fail;
  19433. }
  19434. if (cont_opcode == Opcode::Ping) {
  19435. std::lock_guard<std::mutex> lock(write_mutex_);
  19436. detail::write_websocket_frame(
  19437. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19438. true, !is_server_);
  19439. continue;
  19440. }
  19441. if (cont_opcode == Opcode::Pong) {
  19442. std::lock_guard<std::mutex> lock(ping_mutex_);
  19443. unacked_pings_ = 0;
  19444. continue;
  19445. }
  19446. if (cont_opcode == Opcode::Close) {
  19447. if (!closed_.exchange(true)) {
  19448. std::lock_guard<std::mutex> lock(write_mutex_);
  19449. detail::write_websocket_frame(
  19450. strm_, Opcode::Close, cont_payload.data(),
  19451. cont_payload.size(), true, !is_server_);
  19452. }
  19453. return Fail;
  19454. }
  19455. // RFC 6455: continuation frames must use opcode 0x0
  19456. if (cont_opcode != Opcode::Continuation) {
  19457. closed_ = true;
  19458. return Fail;
  19459. }
  19460. msg += cont_payload;
  19461. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19462. closed_ = true;
  19463. return Fail;
  19464. }
  19465. if (cont_fin) { break; }
  19466. }
  19467. }
  19468. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19469. if (result == Text && !impl::is_valid_utf8(msg)) {
  19470. // close() takes the read lock to wait for the peer's Close reply, so
  19471. // it must not run while this thread still holds it.
  19472. read_lock.unlock();
  19473. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19474. return Fail;
  19475. }
  19476. return result;
  19477. }
  19478. default: closed_ = true; return Fail;
  19479. }
  19480. }
  19481. return Fail;
  19482. }
  19483. inline bool WebSocket::send(const std::string &data) {
  19484. return send_frame(Opcode::Text, data.data(), data.size());
  19485. }
  19486. inline bool WebSocket::send(const char *data, size_t len) {
  19487. return send_frame(Opcode::Binary, data, len);
  19488. }
  19489. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19490. if (closed_.exchange(true)) { return; }
  19491. ping_cv_.notify_all();
  19492. std::string payload;
  19493. auto code = static_cast<uint16_t>(status);
  19494. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19495. payload.push_back(static_cast<char>(code & 0xFF));
  19496. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19497. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19498. payload += reason.substr(0, 123);
  19499. {
  19500. std::lock_guard<std::mutex> lock(write_mutex_);
  19501. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19502. payload.size(), true, !is_server_);
  19503. }
  19504. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19505. // Close response before closing the TCP connection.
  19506. //
  19507. // Wait only when no other thread is parsing frames. When one is, it is the
  19508. // thread positioned to see the peer's reply, and reading here would take
  19509. // bytes out of the message it is assembling. Bailing out also leaves the
  19510. // stream, including its read timeout, entirely to that thread.
  19511. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19512. if (!read_lock.owns_lock()) { return; }
  19513. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19514. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19515. Opcode op;
  19516. std::string resp;
  19517. bool fin;
  19518. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19519. impl::FrameRead::Ok) {
  19520. if (op == Opcode::Close) { break; }
  19521. }
  19522. }
  19523. inline WebSocket::~WebSocket() {
  19524. {
  19525. std::lock_guard<std::mutex> lock(ping_mutex_);
  19526. closed_ = true;
  19527. }
  19528. ping_cv_.notify_all();
  19529. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19530. }
  19531. inline void WebSocket::start_heartbeat() {
  19532. if (ping_interval_sec_ == 0) { return; }
  19533. ping_thread_ = std::thread([this]() {
  19534. std::unique_lock<std::mutex> lock(ping_mutex_);
  19535. // The predicate keeps a spurious wakeup from sending a ping early
  19536. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19537. [this]() { return closed_.load(); })) {
  19538. // If the peer has failed to respond to the previous pings, give up.
  19539. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19540. // opt-in liveness check controlled by max_missed_pongs_.
  19541. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19542. lock.unlock();
  19543. close(CloseStatus::GoingAway, "pong timeout");
  19544. // Wake a read() blocked on the unresponsive peer. Only the read side
  19545. // is shut down: a TLS backend answers the EOF with an alert, and
  19546. // writing it to a socket closed for writing raises SIGPIPE.
  19547. #ifdef _WIN32
  19548. shutdown(strm_.socket(), SD_RECEIVE);
  19549. #else
  19550. shutdown(strm_.socket(), SHUT_RD);
  19551. #endif
  19552. return;
  19553. }
  19554. lock.unlock();
  19555. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19556. lock.lock();
  19557. closed_ = true;
  19558. break;
  19559. }
  19560. lock.lock();
  19561. unacked_pings_++;
  19562. }
  19563. });
  19564. }
  19565. inline const Request &WebSocket::request() const { return req_; }
  19566. inline bool WebSocket::is_open() const { return !closed_; }
  19567. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19568. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19569. // poll(), where 0 would instead mean "return immediately", so hand it the
  19570. // negative poll uses for an unbounded wait.
  19571. if (sec == 0 && usec == 0) { sec = -1; }
  19572. strm_.set_read_timeout(sec, usec);
  19573. read_timeout_set_ = true;
  19574. }
  19575. // WebSocketClient implementation
  19576. inline WebSocketClient::WebSocketClient(
  19577. const std::string &scheme_host_port_path, const Headers &headers)
  19578. : headers_(headers) {
  19579. detail::UrlComponents uc;
  19580. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19581. !uc.host.empty() && !uc.path.empty()) {
  19582. auto &scheme = uc.scheme;
  19583. #ifdef CPPHTTPLIB_SSL_ENABLED
  19584. if (scheme != "ws" && scheme != "wss") {
  19585. #else
  19586. if (scheme != "ws") {
  19587. #endif
  19588. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19589. std::string msg = "'" + scheme + "' scheme is not supported.";
  19590. throw std::invalid_argument(msg);
  19591. #endif
  19592. return;
  19593. }
  19594. auto is_ssl = scheme == "wss";
  19595. host_ = std::move(uc.host);
  19596. port_ = is_ssl ? 443 : 80;
  19597. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19598. path_ = std::move(uc.path);
  19599. if (!uc.query.empty()) { path_ += uc.query; }
  19600. #ifdef CPPHTTPLIB_SSL_ENABLED
  19601. is_ssl_ = is_ssl;
  19602. if (is_ssl_) {
  19603. // The context lives as long as the client so that CA configuration
  19604. // survives reconnects; sessions are created per connection.
  19605. tls_ctx_ = tls::create_client_context();
  19606. if (!tls_ctx_) { return; }
  19607. }
  19608. #else
  19609. if (is_ssl) { return; }
  19610. #endif
  19611. is_valid_ = true;
  19612. }
  19613. }
  19614. #ifdef CPPHTTPLIB_SSL_ENABLED
  19615. inline WebSocketClient::WebSocketClient(
  19616. const std::string &scheme_host_port_path, const PemMemory &pem,
  19617. const Headers &headers)
  19618. : WebSocketClient(scheme_host_port_path, headers) {
  19619. // For ws:// URLs the client certificate is silently ignored, consistent
  19620. // with the TLS-only setters such as set_ca_cert_path().
  19621. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19622. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19623. pem.private_key_password)) {
  19624. tls::free_context(tls_ctx_);
  19625. tls_ctx_ = nullptr;
  19626. is_valid_ = false;
  19627. }
  19628. }
  19629. }
  19630. #endif
  19631. inline WebSocketClient::~WebSocketClient() {
  19632. shutdown_and_close();
  19633. #ifdef CPPHTTPLIB_SSL_ENABLED
  19634. if (tls_ctx_) {
  19635. tls::free_context(tls_ctx_);
  19636. tls_ctx_ = nullptr;
  19637. }
  19638. #endif
  19639. }
  19640. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19641. inline void WebSocketClient::shutdown_and_close() {
  19642. // Send the close frame while the TLS session is still alive: ws_ holds an
  19643. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19644. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19645. if (ws_ && ws_->is_open()) { ws_->close(); }
  19646. ws_.reset();
  19647. #ifdef CPPHTTPLIB_SSL_ENABLED
  19648. if (is_ssl_) {
  19649. if (tls_session_) {
  19650. tls::shutdown(tls_session_, true);
  19651. tls::free_session(tls_session_);
  19652. tls_session_ = nullptr;
  19653. }
  19654. }
  19655. #endif
  19656. if (sock_ != INVALID_SOCKET) {
  19657. detail::shutdown_socket(sock_);
  19658. detail::close_socket(sock_);
  19659. sock_ = INVALID_SOCKET;
  19660. }
  19661. }
  19662. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19663. Error &error, int &ssl_error,
  19664. uint64_t &ssl_backend_error) {
  19665. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19666. // The streams wait with poll(), where 0 instead means "return immediately",
  19667. // so they are given the negative poll uses for an unbounded wait.
  19668. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19669. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19670. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19671. // The handshake belongs to establishing the connection, so an unset read
  19672. // timeout leaves it bounded by the connection timeout instead of forever.
  19673. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19674. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19675. #ifdef CPPHTTPLIB_SSL_ENABLED
  19676. if (is_ssl_) {
  19677. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19678. // is not safe to call concurrently on one client to begin with, since
  19679. // nothing else here is guarded either.
  19680. if (server_certificate_verification_ && !certs_loaded_) {
  19681. uint64_t backend_error = 0;
  19682. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19683. ca_cert_dir_path_, custom_ca_loaded_,
  19684. system_ca_mode_, backend_error);
  19685. certs_loaded_ = true;
  19686. }
  19687. detail::ClientTlsSessionOptions options;
  19688. options.server_hostname_verification = server_hostname_verification_;
  19689. detail::ClientTlsSessionError tls_error;
  19690. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19691. server_certificate_verification_,
  19692. hs_sec, hs_usec, &tls_error,
  19693. options)) {
  19694. error = tls_error.error;
  19695. ssl_error = tls_error.ssl_error;
  19696. ssl_backend_error = tls_error.backend_error;
  19697. return false;
  19698. }
  19699. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19700. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19701. write_timeout_usec_));
  19702. return true;
  19703. }
  19704. #else
  19705. (void)error;
  19706. (void)ssl_error;
  19707. (void)ssl_backend_error;
  19708. (void)hs_sec;
  19709. (void)hs_usec;
  19710. #endif
  19711. strm = std::unique_ptr<Stream>(
  19712. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19713. write_timeout_sec_, write_timeout_usec_));
  19714. return true;
  19715. }
  19716. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19717. #ifdef CPPHTTPLIB_SSL_ENABLED
  19718. auto is_ssl = is_ssl_;
  19719. #else
  19720. auto is_ssl = false;
  19721. #endif
  19722. if (!req.has_header("Host")) {
  19723. req.headers.emplace("Host", detail::make_default_host_header_value(
  19724. host_, port_, is_ssl, address_family_));
  19725. }
  19726. detail::add_default_user_agent_header(req);
  19727. }
  19728. inline Result WebSocketClient::connect() {
  19729. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19730. shutdown_and_close();
  19731. // Check is custom IP or hostname specified for host_
  19732. std::string connect_host;
  19733. std::string ip;
  19734. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19735. auto error = Error::Success;
  19736. sock_ = detail::create_client_socket(
  19737. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19738. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19739. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19740. write_timeout_usec_, interface_, error);
  19741. if (sock_ == INVALID_SOCKET) {
  19742. if (error == Error::Success) { error = Error::Connection; }
  19743. return Result{error, -1, Headers{}};
  19744. }
  19745. std::unique_ptr<Stream> strm;
  19746. auto stream_error = Error::SSLConnection;
  19747. int ssl_error = 0;
  19748. uint64_t ssl_backend_error = 0;
  19749. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19750. shutdown_and_close();
  19751. #ifdef CPPHTTPLIB_SSL_ENABLED
  19752. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19753. #else
  19754. return Result{stream_error, -1, Headers{}};
  19755. #endif
  19756. }
  19757. Request req;
  19758. req.method = "GET";
  19759. req.path = path_;
  19760. req.headers = headers_;
  19761. prepare_default_headers(req);
  19762. detail::WebSocketUpgradeResponse upgrade;
  19763. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19764. shutdown_and_close();
  19765. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19766. }
  19767. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19768. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19769. websocket_ping_interval_sec_,
  19770. websocket_max_missed_pongs_));
  19771. // The stream was created with the timeout already; tell the WebSocket
  19772. // whether it came from the caller, so read() knows to report it as Timeout.
  19773. ws_->read_timeout_set_ = read_timeout_set_;
  19774. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19775. }
  19776. inline ReadResult WebSocketClient::read(std::string &msg) {
  19777. if (!ws_) { return Fail; }
  19778. return ws_->read(msg);
  19779. }
  19780. inline bool WebSocketClient::send(const std::string &data) {
  19781. if (!ws_) { return false; }
  19782. return ws_->send(data);
  19783. }
  19784. inline bool WebSocketClient::send(const char *data, size_t len) {
  19785. if (!ws_) { return false; }
  19786. return ws_->send(data, len);
  19787. }
  19788. inline void WebSocketClient::close(CloseStatus status,
  19789. const std::string &reason) {
  19790. if (ws_) { ws_->close(status, reason); }
  19791. }
  19792. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19793. inline const std::string &WebSocketClient::subprotocol() const {
  19794. return subprotocol_;
  19795. }
  19796. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19797. read_timeout_sec_ = sec;
  19798. read_timeout_usec_ = usec;
  19799. read_timeout_set_ = true;
  19800. // The members above only seed the next connect(); read() consults the
  19801. // stream, so an already-open connection has to be told directly.
  19802. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19803. }
  19804. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19805. write_timeout_sec_ = sec;
  19806. write_timeout_usec_ = usec;
  19807. }
  19808. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19809. websocket_ping_interval_sec_ = sec;
  19810. }
  19811. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19812. websocket_max_missed_pongs_ = count;
  19813. }
  19814. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19815. inline void WebSocketClient::set_address_family(int family) {
  19816. address_family_ = family;
  19817. }
  19818. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19819. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19820. socket_options_ = std::move(socket_options);
  19821. }
  19822. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19823. connection_timeout_sec_ = sec;
  19824. connection_timeout_usec_ = usec;
  19825. }
  19826. inline void WebSocketClient::set_interface(const std::string &intf) {
  19827. interface_ = intf;
  19828. }
  19829. inline void WebSocketClient::set_hostname_addr_map(
  19830. std::map<std::string, std::string> addr_map) {
  19831. addr_map_ = std::move(addr_map);
  19832. }
  19833. #ifdef CPPHTTPLIB_SSL_ENABLED
  19834. inline void
  19835. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19836. const std::string &ca_cert_dir_path) {
  19837. ca_cert_file_path_ = ca_cert_file_path;
  19838. ca_cert_dir_path_ = ca_cert_dir_path;
  19839. }
  19840. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19841. if (store && tls_ctx_) {
  19842. // set_ca_store takes ownership of store
  19843. tls::set_ca_store(tls_ctx_, store);
  19844. custom_ca_loaded_ = true;
  19845. } else if (store) {
  19846. tls::free_ca_store(store);
  19847. }
  19848. }
  19849. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19850. std::size_t size) {
  19851. if (tls_ctx_ && ca_cert && size > 0) {
  19852. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19853. custom_ca_loaded_ = true;
  19854. }
  19855. }
  19856. inline void
  19857. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19858. server_certificate_verification_ = enabled;
  19859. }
  19860. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19861. server_hostname_verification_ = enabled;
  19862. }
  19863. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19864. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19865. }
  19866. #endif // CPPHTTPLIB_SSL_ENABLED
  19867. } // namespace ws
  19868. // ----------------------------------------------------------------------------
  19869. } // namespace httplib
  19870. #endif // CPPHTTPLIB_HTTPLIB_H