httplib.h 788 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.58.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003a00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. /*
  18. * Configuration
  19. */
  20. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  21. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  22. #endif
  23. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  24. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  25. #endif
  26. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  27. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  28. #endif
  29. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  30. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  31. #endif
  32. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  33. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  34. #endif
  35. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  36. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  37. #endif
  38. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  39. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  40. #endif
  41. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  42. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  43. #endif
  44. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  45. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  46. #endif
  47. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  48. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  49. #endif
  50. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  51. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  52. #endif
  53. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  54. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  55. #endif
  56. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  57. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  58. #endif
  59. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  60. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  61. #endif
  62. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  63. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  64. #endif
  65. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  66. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  67. #endif
  68. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  69. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  70. #endif
  71. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  72. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  73. #endif
  74. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  75. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  76. #endif
  77. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  78. #ifdef _WIN32
  79. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  80. #else
  81. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  82. #endif
  83. #endif
  84. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  85. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  86. #endif
  87. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  88. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  89. #endif
  90. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  91. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  92. #endif
  93. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  94. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  95. #endif
  96. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  97. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  98. #endif
  99. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  100. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  101. #endif
  102. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  103. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  104. #endif
  105. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  106. // 1400 rather than a round number: a body that already fits in one 1500-byte
  107. // MTU gains nothing from being made smaller.
  108. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  109. #endif
  110. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  111. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  112. #endif
  113. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  114. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  115. #endif
  116. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  117. // recurses roughly once per matched character for quantified patterns such
  118. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  119. // a default ~8MB thread stack that has been observed to take on the order of
  120. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  121. // margin below that (well under the 8192-byte request URI limit) while still
  122. // fitting any realistic route segment; raise it if a route legitimately needs
  123. // longer paths. Regex routes are never applied to paths longer than this.
  124. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  125. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  126. #endif
  127. #ifndef CPPHTTPLIB_TCP_NODELAY
  128. #define CPPHTTPLIB_TCP_NODELAY false
  129. #endif
  130. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  131. #define CPPHTTPLIB_IPV6_V6ONLY false
  132. #endif
  133. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  134. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  135. #endif
  136. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  137. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  138. #endif
  139. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  140. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  141. #endif
  142. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  143. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  144. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  145. ? std::thread::hardware_concurrency() - 1 \
  146. : 0))
  147. #endif
  148. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  149. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  150. #endif
  151. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  152. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  153. #endif
  154. #ifndef CPPHTTPLIB_RECV_FLAGS
  155. #define CPPHTTPLIB_RECV_FLAGS 0
  156. #endif
  157. #ifndef CPPHTTPLIB_SEND_FLAGS
  158. #define CPPHTTPLIB_SEND_FLAGS 0
  159. #endif
  160. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  161. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  162. #endif
  163. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  164. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  165. #endif
  166. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  167. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  168. #endif
  169. // One macro used to set the read timeout for both sides. They want different
  170. // defaults: a client's read timeout is the caller's own tool (it waits forever
  171. // until asked not to), while a server keeps a ceiling that reclaims a worker
  172. // from a peer that has gone quiet. The old name still works and sets both.
  173. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  174. #pragma message( \
  175. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  176. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  177. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  178. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  179. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  180. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #endif
  182. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  183. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  184. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  185. #endif
  186. #endif
  187. // 0 waits forever. A read timeout is how a caller gets control back to send on
  188. // the same connection; it is not a liveness check (that is ping/pong). Only a
  189. // timeout set at runtime through set_read_timeout() is reported as
  190. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  191. // ws::Fail and closes the connection.
  192. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  202. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  205. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  206. #endif
  207. /*
  208. * Headers
  209. */
  210. #ifdef _WIN32
  211. #ifndef _CRT_SECURE_NO_WARNINGS
  212. #define _CRT_SECURE_NO_WARNINGS
  213. #endif //_CRT_SECURE_NO_WARNINGS
  214. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  215. #define _CRT_NONSTDC_NO_DEPRECATE
  216. #endif //_CRT_NONSTDC_NO_DEPRECATE
  217. #if defined(_MSC_VER)
  218. #if _MSC_VER < 1900
  219. #error Sorry, Visual Studio versions prior to 2015 are not supported
  220. #endif
  221. #pragma comment(lib, "ws2_32.lib")
  222. #ifndef _SSIZE_T_DEFINED
  223. using ssize_t = __int64;
  224. #define _SSIZE_T_DEFINED
  225. #endif
  226. #endif // _MSC_VER
  227. #ifndef S_ISREG
  228. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  229. #endif // S_ISREG
  230. #ifndef S_ISDIR
  231. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  232. #endif // S_ISDIR
  233. #ifndef NOMINMAX
  234. #define NOMINMAX
  235. #endif // NOMINMAX
  236. #include <io.h>
  237. #include <winsock2.h>
  238. #include <ws2tcpip.h>
  239. #if defined(__has_include)
  240. #if __has_include(<afunix.h>)
  241. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  242. #include <afunix.h>
  243. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  244. #endif
  245. #endif
  246. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  247. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  248. #endif
  249. using nfds_t = unsigned long;
  250. using socket_t = SOCKET;
  251. using socklen_t = int;
  252. #else // not _WIN32
  253. #include <arpa/inet.h>
  254. #if !defined(_AIX) && !defined(__MVS__)
  255. #include <ifaddrs.h>
  256. #endif
  257. #ifdef __MVS__
  258. #include <strings.h>
  259. #ifndef NI_MAXHOST
  260. #define NI_MAXHOST 1025
  261. #endif
  262. #endif
  263. #include <net/if.h>
  264. #include <netdb.h>
  265. #include <netinet/in.h>
  266. #ifdef __linux__
  267. #include <resolv.h>
  268. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  269. #endif
  270. #include <csignal>
  271. #include <netinet/tcp.h>
  272. #include <poll.h>
  273. #include <pthread.h>
  274. #include <sys/mman.h>
  275. #include <sys/socket.h>
  276. #include <sys/un.h>
  277. #include <unistd.h>
  278. using socket_t = int;
  279. #ifndef INVALID_SOCKET
  280. #define INVALID_SOCKET (-1)
  281. #endif
  282. #endif //_WIN32
  283. #if defined(__APPLE__)
  284. #include <TargetConditionals.h>
  285. #endif
  286. #include <algorithm>
  287. #include <array>
  288. #include <atomic>
  289. #include <cassert>
  290. #include <chrono>
  291. #include <climits>
  292. #include <condition_variable>
  293. #include <cstdlib>
  294. #include <cstring>
  295. #include <errno.h>
  296. #include <exception>
  297. #include <fcntl.h>
  298. #include <fstream>
  299. #include <functional>
  300. #include <iomanip>
  301. #include <iostream>
  302. #include <iterator>
  303. #include <list>
  304. #include <map>
  305. #include <memory>
  306. #include <mutex>
  307. #include <random>
  308. #include <regex>
  309. #include <set>
  310. #include <sstream>
  311. #include <string>
  312. #include <sys/stat.h>
  313. #include <system_error>
  314. #include <thread>
  315. #include <type_traits>
  316. #include <unordered_map>
  317. #include <unordered_set>
  318. #include <utility>
  319. #include <vector>
  320. // On macOS with a TLS backend, enable Keychain root certificates by default
  321. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  322. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  323. // only; on those platforms the user must provide a CA bundle explicitly.
  324. #if defined(__APPLE__) && defined(__clang__) && \
  325. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  326. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  327. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  328. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  329. #if TARGET_OS_OSX
  330. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  331. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  332. #endif
  333. #endif
  334. #endif
  335. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  336. defined(__APPLE__) && !TARGET_OS_OSX
  337. #error \
  338. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  339. #endif
  340. // On Windows, enable Schannel certificate verification by default
  341. // unless the user explicitly opts out.
  342. #if defined(_WIN32) && \
  343. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  344. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  345. #endif
  346. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  347. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  348. #if TARGET_OS_MAC && defined(__clang__)
  349. #include <CFNetwork/CFHost.h>
  350. #include <CoreFoundation/CoreFoundation.h>
  351. #endif
  352. #endif
  353. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  354. #ifdef _WIN32
  355. #include <wincrypt.h>
  356. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  357. // used
  358. #undef X509_NAME
  359. #undef X509_CERT_PAIR
  360. #undef X509_EXTENSIONS
  361. #undef PKCS7_SIGNER_INFO
  362. #ifdef _MSC_VER
  363. #pragma comment(lib, "crypt32.lib")
  364. #endif
  365. #endif // _WIN32
  366. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  367. #if TARGET_OS_OSX
  368. #include <Security/Security.h>
  369. #endif
  370. #endif
  371. #include <openssl/err.h>
  372. #include <openssl/evp.h>
  373. #include <openssl/ssl.h>
  374. #include <openssl/x509v3.h>
  375. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  376. #include <openssl/applink.c>
  377. #endif
  378. #include <iostream>
  379. #include <sstream>
  380. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  381. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  382. #error Please use OpenSSL or a current version of BoringSSL
  383. #endif
  384. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  385. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  386. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  387. #endif
  388. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  389. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  390. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  391. // in with this first include group so the version gating below can use it.
  392. #include <mbedtls/error.h>
  393. #include <mbedtls/net_sockets.h>
  394. #include <mbedtls/oid.h>
  395. #include <mbedtls/pk.h>
  396. #include <mbedtls/ssl.h>
  397. #include <mbedtls/version.h>
  398. #include <mbedtls/x509_crt.h>
  399. #if MBEDTLS_VERSION_MAJOR >= 4
  400. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  401. #include <psa/crypto.h>
  402. #else
  403. #include <mbedtls/ctr_drbg.h>
  404. #include <mbedtls/entropy.h>
  405. #include <mbedtls/md5.h>
  406. #include <mbedtls/sha1.h>
  407. #include <mbedtls/sha256.h>
  408. #include <mbedtls/sha512.h>
  409. #endif
  410. #ifdef _WIN32
  411. #include <wincrypt.h>
  412. #ifdef _MSC_VER
  413. #pragma comment(lib, "crypt32.lib")
  414. #endif
  415. #endif // _WIN32
  416. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  417. #if TARGET_OS_OSX
  418. #include <Security/Security.h>
  419. #endif
  420. #endif
  421. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  422. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  423. #if MBEDTLS_VERSION_MAJOR >= 4
  424. #define CPPHTTPLIB_MBEDTLS_V4
  425. #endif
  426. #if MBEDTLS_VERSION_MAJOR >= 3
  427. #define CPPHTTPLIB_MBEDTLS_V3
  428. #endif
  429. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  430. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  431. #include <wolfssl/options.h>
  432. #include <wolfssl/openssl/x509v3.h>
  433. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  434. #ifndef WOLFSSL_GEN_EMAIL
  435. #define WOLFSSL_GEN_EMAIL 1
  436. #endif
  437. #ifndef WOLFSSL_GEN_DNS
  438. #define WOLFSSL_GEN_DNS 2
  439. #endif
  440. #ifndef WOLFSSL_GEN_URI
  441. #define WOLFSSL_GEN_URI 6
  442. #endif
  443. #ifndef WOLFSSL_GEN_IPADD
  444. #define WOLFSSL_GEN_IPADD 7
  445. #endif
  446. #include <wolfssl/ssl.h>
  447. #include <wolfssl/wolfcrypt/hash.h>
  448. #include <wolfssl/wolfcrypt/md5.h>
  449. #include <wolfssl/wolfcrypt/sha256.h>
  450. #include <wolfssl/wolfcrypt/sha512.h>
  451. #ifdef _WIN32
  452. #include <wincrypt.h>
  453. #ifdef _MSC_VER
  454. #pragma comment(lib, "crypt32.lib")
  455. #endif
  456. #endif // _WIN32
  457. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  458. #if TARGET_OS_OSX
  459. #include <Security/Security.h>
  460. #endif
  461. #endif
  462. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  463. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  464. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  465. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  466. #define CPPHTTPLIB_SSL_ENABLED
  467. #endif
  468. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  469. #include <zlib.h>
  470. #endif
  471. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  472. #include <brotli/decode.h>
  473. #include <brotli/encode.h>
  474. #endif
  475. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  476. #include <zstd.h>
  477. #endif
  478. /*
  479. * Declaration
  480. */
  481. namespace httplib {
  482. namespace ws {
  483. class WebSocket;
  484. } // namespace ws
  485. namespace detail {
  486. /*
  487. * Backport std::make_unique from C++14.
  488. *
  489. * NOTE: This code came up with the following stackoverflow post:
  490. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  491. *
  492. */
  493. template <class T, class... Args>
  494. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  495. make_unique(Args &&...args) {
  496. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  497. }
  498. template <class T>
  499. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  500. make_unique(std::size_t n) {
  501. typedef typename std::remove_extent<T>::type RT;
  502. return std::unique_ptr<T>(new RT[n]);
  503. }
  504. // Locale-independent ASCII character classification. The <cctype>
  505. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  506. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  507. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  508. // classified without regard to the locale.
  509. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  510. inline bool is_ascii_alpha(char c) {
  511. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  512. }
  513. inline bool is_ascii_alnum(char c) {
  514. return is_ascii_digit(c) || is_ascii_alpha(c);
  515. }
  516. namespace case_ignore {
  517. inline unsigned char to_lower(int c) {
  518. const static unsigned char table[256] = {
  519. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  520. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  521. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  522. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  523. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  524. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  525. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  526. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  527. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  528. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  529. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  530. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  531. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  532. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  533. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  534. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  535. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  536. 255,
  537. };
  538. return table[(unsigned char)(char)c];
  539. }
  540. inline std::string to_lower(const std::string &s) {
  541. std::string result = s;
  542. std::transform(
  543. result.begin(), result.end(), result.begin(),
  544. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  545. return result;
  546. }
  547. inline bool equal(const std::string &a, const std::string &b) {
  548. return a.size() == b.size() &&
  549. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  550. return to_lower(ca) == to_lower(cb);
  551. });
  552. }
  553. struct equal_to {
  554. bool operator()(const std::string &a, const std::string &b) const {
  555. return equal(a, b);
  556. }
  557. };
  558. struct hash {
  559. size_t operator()(const std::string &key) const {
  560. return hash_core(key.data(), key.size(), 0);
  561. }
  562. size_t hash_core(const char *s, size_t l, size_t h) const {
  563. return (l == 0) ? h
  564. : hash_core(s + 1, l - 1,
  565. // Unsets the 6 high bits of h, therefore no
  566. // overflow happens
  567. (((std::numeric_limits<size_t>::max)() >> 6) &
  568. h * 33) ^
  569. static_cast<unsigned char>(to_lower(*s)));
  570. }
  571. };
  572. template <typename T>
  573. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  574. detail::case_ignore::equal_to>;
  575. } // namespace case_ignore
  576. // This is based on
  577. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  578. struct scope_exit {
  579. explicit scope_exit(std::function<void(void)> &&f)
  580. : exit_function(std::move(f)), execute_on_destruction{true} {}
  581. scope_exit(scope_exit &&rhs) noexcept
  582. : exit_function(std::move(rhs.exit_function)),
  583. execute_on_destruction{rhs.execute_on_destruction} {
  584. rhs.release();
  585. }
  586. ~scope_exit() {
  587. if (execute_on_destruction) { this->exit_function(); }
  588. }
  589. void release() { this->execute_on_destruction = false; }
  590. private:
  591. scope_exit(const scope_exit &) = delete;
  592. void operator=(const scope_exit &) = delete;
  593. scope_exit &operator=(scope_exit &&) = delete;
  594. std::function<void(void)> exit_function;
  595. bool execute_on_destruction;
  596. };
  597. // Simple from_chars implementation for integer and double types (C++17
  598. // substitute)
  599. template <typename T> struct from_chars_result {
  600. const char *ptr;
  601. std::errc ec;
  602. };
  603. template <typename T>
  604. inline from_chars_result<T> from_chars(const char *first, const char *last,
  605. T &value, int base = 10) {
  606. value = 0;
  607. const char *p = first;
  608. bool negative = false;
  609. if (p != last && *p == '-') {
  610. negative = true;
  611. ++p;
  612. }
  613. if (p == last) { return {first, std::errc::invalid_argument}; }
  614. T result = 0;
  615. for (; p != last; ++p) {
  616. char c = *p;
  617. int digit = -1;
  618. if (is_ascii_digit(c)) {
  619. digit = c - '0';
  620. } else if ('a' <= c && c <= 'z') {
  621. digit = c - 'a' + 10;
  622. } else if ('A' <= c && c <= 'Z') {
  623. digit = c - 'A' + 10;
  624. } else {
  625. break;
  626. }
  627. if (digit < 0 || digit >= base) { break; }
  628. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  629. return {p, std::errc::result_out_of_range};
  630. }
  631. result = result * base + digit;
  632. }
  633. if (p == first || (negative && p == first + 1)) {
  634. return {first, std::errc::invalid_argument};
  635. }
  636. value = negative ? T(0) - result : result;
  637. return {p, std::errc{}};
  638. }
  639. // from_chars for double (hand-written, locale-independent)
  640. //
  641. // The only double consumed by this library is the HTTP quality value, whose
  642. // grammar is (RFC 9110 12.4.2):
  643. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  644. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  645. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  646. // '.' always the decimal separator (std::strtod would instead read it from the
  647. // global C locale, mis-parsing q-values once an embedder calls
  648. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  649. // the result to [0, 1], so inputs outside that range need not be distinguished
  650. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  651. // cases that exponent and wide-range handling would introduce.
  652. inline from_chars_result<double> from_chars(const char *first, const char *last,
  653. double &value) {
  654. value = 0.0;
  655. const char *p = first;
  656. // Each 1eN is exactly representable, so a single final division by the
  657. // matching entry yields a correctly-rounded result.
  658. static const double powers_of_ten[] = {
  659. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  660. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  661. const int max_frac_digits =
  662. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  663. // Accumulate digits into a 64-bit integer and remember how many were
  664. // fractional. Two independent caps keep this bounded and safe:
  665. // * accumulation saturates before mantissa could overflow uint64_t, and
  666. // * frac_digits is capped at max_frac_digits so it is always a valid index
  667. // into powers_of_ten (without this an input like "0.000...0" would never
  668. // grow mantissa, so the saturation cap alone would not bound it).
  669. // Both caps only drop digits far beyond the precision a q-value needs; any
  670. // value they would change is well outside [0, 1] and rejected by the caller.
  671. uint64_t mantissa = 0;
  672. int frac_digits = 0;
  673. bool seen_digit = false;
  674. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  675. auto accumulate = [&](char c) {
  676. if (mantissa <= limit) {
  677. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  678. return true;
  679. }
  680. return false;
  681. };
  682. for (; p != last && is_ascii_digit(*p); ++p) {
  683. seen_digit = true;
  684. accumulate(*p);
  685. }
  686. if (p != last && *p == '.') {
  687. ++p;
  688. for (; p != last && is_ascii_digit(*p); ++p) {
  689. seen_digit = true;
  690. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  691. }
  692. }
  693. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  694. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  695. return {p, std::errc{}};
  696. }
  697. inline bool parse_port(const char *s, size_t len, int &port) {
  698. int val = 0;
  699. auto r = from_chars(s, s + len, val);
  700. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  701. port = val;
  702. return true;
  703. }
  704. inline bool parse_port(const std::string &s, int &port) {
  705. return parse_port(s.data(), s.size(), port);
  706. }
  707. struct UrlComponents {
  708. std::string scheme;
  709. std::string host;
  710. std::string port;
  711. std::string path;
  712. std::string query;
  713. };
  714. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  715. uc = {};
  716. size_t pos = 0;
  717. auto sep = url.find("://");
  718. if (sep != std::string::npos) {
  719. uc.scheme = url.substr(0, sep);
  720. // Scheme must be [a-z]+ only
  721. if (uc.scheme.empty()) { return false; }
  722. for (auto c : uc.scheme) {
  723. if (c < 'a' || c > 'z') { return false; }
  724. }
  725. pos = sep + 3;
  726. } else if (url.compare(0, 2, "//") == 0) {
  727. pos = 2;
  728. }
  729. auto has_authority_prefix = pos > 0;
  730. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  731. url[0] != '?' && url[0] != '#');
  732. if (has_authority) {
  733. if (pos < url.size() && url[pos] == '[') {
  734. auto close = url.find(']', pos);
  735. if (close == std::string::npos) { return false; }
  736. uc.host = url.substr(pos + 1, close - pos - 1);
  737. // IPv6 host must be [a-fA-F0-9:]+ only
  738. if (uc.host.empty()) { return false; }
  739. for (auto c : uc.host) {
  740. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  741. (c >= 'A' && c <= 'F') || c == ':')) {
  742. return false;
  743. }
  744. }
  745. pos = close + 1;
  746. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  747. // path, query or fragment delimiter (or the end of input). Otherwise the
  748. // trailing bytes would be folded into the path while the connection
  749. // still targets the bracketed address.
  750. if (pos < url.size()) {
  751. auto c = url[pos];
  752. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  753. }
  754. } else {
  755. auto end = url.find_first_of(":/?#", pos);
  756. if (end == std::string::npos) { end = url.size(); }
  757. uc.host = url.substr(pos, end - pos);
  758. pos = end;
  759. }
  760. if (pos < url.size() && url[pos] == ':') {
  761. ++pos;
  762. auto end = url.find_first_of("/?#", pos);
  763. if (end == std::string::npos) { end = url.size(); }
  764. uc.port = url.substr(pos, end - pos);
  765. pos = end;
  766. }
  767. // Without :// or //, the entire input must be consumed as host[:port].
  768. // If there is leftover (path, query, etc.), this is not a valid
  769. // host[:port] string — clear and reparse as a plain path.
  770. if (!has_authority_prefix && pos < url.size()) {
  771. uc.host.clear();
  772. uc.port.clear();
  773. pos = 0;
  774. }
  775. }
  776. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  777. auto end = url.find_first_of("?#", pos);
  778. if (end == std::string::npos) { end = url.size(); }
  779. uc.path = url.substr(pos, end - pos);
  780. pos = end;
  781. }
  782. if (pos < url.size() && url[pos] == '?') {
  783. auto end = url.find('#', pos);
  784. if (end == std::string::npos) { end = url.size(); }
  785. uc.query = url.substr(pos, end - pos);
  786. }
  787. return true;
  788. }
  789. // Resolves a relative-path or query-only Location value against the path of
  790. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  791. // references starting with '/' are returned unchanged.
  792. inline std::string resolve_relative_location(const std::string &location,
  793. const std::string &base) {
  794. if (location.empty() || location[0] == '/') { return location; }
  795. // A ':' in the first segment means the value has a scheme.
  796. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  797. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  798. auto base_path = base.substr(0, base.find_first_of("?#"));
  799. if (location[0] == '?') { return base_path + location; }
  800. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  801. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  802. // Remove "." and ".." segments from the merged path.
  803. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  804. std::string path;
  805. size_t i = 0;
  806. while (i < path_end) {
  807. auto next = (std::min)(merged.find('/', i + 1), path_end);
  808. auto segment = merged.substr(i + 1, next - i - 1);
  809. auto is_last = next == path_end;
  810. if (segment == "." || segment == "..") {
  811. if (segment == "..") {
  812. path.erase((std::min)(path.rfind('/'), path.size()));
  813. }
  814. if (is_last) { path += '/'; }
  815. } else {
  816. path += '/';
  817. path += segment;
  818. }
  819. i = next;
  820. }
  821. if (path.empty()) { path = "/"; }
  822. return path + merged.substr(path_end);
  823. }
  824. } // namespace detail
  825. enum class SSLVerifierResponse {
  826. // no decision has been made, use the built-in certificate verifier
  827. NoDecisionMade,
  828. // connection certificate is verified and accepted
  829. CertificateAccepted,
  830. // connection certificate was processed but is rejected
  831. CertificateRejected
  832. };
  833. // System CA loading policy for SSL clients. Auto (the default) loads system
  834. // CA certs only when no custom CA is configured; enable_system_ca() switches
  835. // to an explicit policy.
  836. enum class SystemCAMode { Auto, Enabled, Disabled };
  837. enum StatusCode {
  838. // Information responses
  839. Continue_100 = 100,
  840. SwitchingProtocol_101 = 101,
  841. Processing_102 = 102,
  842. EarlyHints_103 = 103,
  843. // Successful responses
  844. OK_200 = 200,
  845. Created_201 = 201,
  846. Accepted_202 = 202,
  847. NonAuthoritativeInformation_203 = 203,
  848. NoContent_204 = 204,
  849. ResetContent_205 = 205,
  850. PartialContent_206 = 206,
  851. MultiStatus_207 = 207,
  852. AlreadyReported_208 = 208,
  853. IMUsed_226 = 226,
  854. // Redirection messages
  855. MultipleChoices_300 = 300,
  856. MovedPermanently_301 = 301,
  857. Found_302 = 302,
  858. SeeOther_303 = 303,
  859. NotModified_304 = 304,
  860. UseProxy_305 = 305,
  861. unused_306 = 306,
  862. TemporaryRedirect_307 = 307,
  863. PermanentRedirect_308 = 308,
  864. // Client error responses
  865. BadRequest_400 = 400,
  866. Unauthorized_401 = 401,
  867. PaymentRequired_402 = 402,
  868. Forbidden_403 = 403,
  869. NotFound_404 = 404,
  870. MethodNotAllowed_405 = 405,
  871. NotAcceptable_406 = 406,
  872. ProxyAuthenticationRequired_407 = 407,
  873. RequestTimeout_408 = 408,
  874. Conflict_409 = 409,
  875. Gone_410 = 410,
  876. LengthRequired_411 = 411,
  877. PreconditionFailed_412 = 412,
  878. PayloadTooLarge_413 = 413,
  879. UriTooLong_414 = 414,
  880. UnsupportedMediaType_415 = 415,
  881. RangeNotSatisfiable_416 = 416,
  882. ExpectationFailed_417 = 417,
  883. ImATeapot_418 = 418,
  884. MisdirectedRequest_421 = 421,
  885. UnprocessableContent_422 = 422,
  886. Locked_423 = 423,
  887. FailedDependency_424 = 424,
  888. TooEarly_425 = 425,
  889. UpgradeRequired_426 = 426,
  890. PreconditionRequired_428 = 428,
  891. TooManyRequests_429 = 429,
  892. RequestHeaderFieldsTooLarge_431 = 431,
  893. UnavailableForLegalReasons_451 = 451,
  894. // Server error responses
  895. InternalServerError_500 = 500,
  896. NotImplemented_501 = 501,
  897. BadGateway_502 = 502,
  898. ServiceUnavailable_503 = 503,
  899. GatewayTimeout_504 = 504,
  900. HttpVersionNotSupported_505 = 505,
  901. VariantAlsoNegotiates_506 = 506,
  902. InsufficientStorage_507 = 507,
  903. LoopDetected_508 = 508,
  904. NotExtended_510 = 510,
  905. NetworkAuthenticationRequired_511 = 511,
  906. };
  907. namespace detail {
  908. // A multimap that keeps its entries in the order they were inserted.
  909. //
  910. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  911. // fields sharing a field name significant and forbids a proxy from reordering
  912. // them, and a query string's parameters are meaningful in the order the caller
  913. // wrote them. Neither standard container expresses it: std::unordered_multimap
  914. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  915. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  916. // key, which would drop control data such as Host behind whatever else the
  917. // message carries and alphabetise a query string.
  918. //
  919. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  920. // scan, which beats hashing for the handful of entries a message carries
  921. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  922. //
  923. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  924. // Params, whose parameter names are case-sensitive, not.
  925. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  926. public:
  927. using key_type = std::string;
  928. using mapped_type = Mapped;
  929. using value_type = std::pair<std::string, Mapped>;
  930. using size_type = std::size_t;
  931. using difference_type = std::ptrdiff_t;
  932. using reference = value_type &;
  933. using const_reference = const value_type &;
  934. private:
  935. static size_type npos() { return static_cast<size_type>(-1); }
  936. static bool keys_equal(const std::string &a, const std::string &b) {
  937. return KeyEqual()(a, b);
  938. }
  939. // Iterating yields every entry in insertion order, but equal_range() and
  940. // find() have to walk only the entries sharing one key, which are not
  941. // adjacent. Both are the same iterator type: key_idx_ selects between the
  942. // two traversals, and since equality compares only the position, an iterator
  943. // restricted to one key still compares equal to end().
  944. template <typename V> class iterator_t {
  945. public:
  946. using iterator_category = std::bidirectional_iterator_tag;
  947. using value_type = insertion_ordered_multimap::value_type;
  948. using difference_type = insertion_ordered_multimap::difference_type;
  949. using pointer = V *;
  950. using reference = V &;
  951. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  952. template <typename U,
  953. typename std::enable_if<std::is_convertible<U *, V *>::value,
  954. int>::type = 0>
  955. iterator_t(const iterator_t<U> &rhs)
  956. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  957. key_idx_(rhs.key_idx_) {}
  958. reference operator*() const { return data_[idx_]; }
  959. pointer operator->() const { return data_ + idx_; }
  960. iterator_t &operator++() {
  961. // Saturating, so that advancing past the last entry of a key (which
  962. // get_multimap_value() does when asked for an out-of-range id) stays at
  963. // end() instead of running off the container.
  964. if (idx_ >= size_) { return *this; }
  965. ++idx_;
  966. if (key_idx_ != npos()) {
  967. while (idx_ < size_ && !matches(idx_)) {
  968. ++idx_;
  969. }
  970. }
  971. return *this;
  972. }
  973. iterator_t operator++(int) {
  974. auto tmp = *this;
  975. ++*this;
  976. return tmp;
  977. }
  978. iterator_t &operator--() {
  979. if (idx_ == 0) { return *this; }
  980. --idx_;
  981. if (key_idx_ != npos()) {
  982. while (idx_ > 0 && !matches(idx_)) {
  983. --idx_;
  984. }
  985. }
  986. return *this;
  987. }
  988. iterator_t operator--(int) {
  989. auto tmp = *this;
  990. --*this;
  991. return tmp;
  992. }
  993. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  994. return idx_ == rhs.idx_;
  995. }
  996. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  997. return idx_ != rhs.idx_;
  998. }
  999. private:
  1000. friend class insertion_ordered_multimap;
  1001. template <typename> friend class iterator_t;
  1002. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1003. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1004. bool matches(size_type i) const {
  1005. return keys_equal(data_[i].first, data_[key_idx_].first);
  1006. }
  1007. V *data_;
  1008. size_type idx_;
  1009. size_type size_;
  1010. size_type key_idx_;
  1011. };
  1012. public:
  1013. using iterator = iterator_t<value_type>;
  1014. using const_iterator = iterator_t<const value_type>;
  1015. insertion_ordered_multimap() = default;
  1016. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1017. : entries_(il) {}
  1018. template <typename InputIt>
  1019. insertion_ordered_multimap(InputIt first, InputIt last)
  1020. : entries_(first, last) {}
  1021. iterator begin() { return make_iter(0, npos()); }
  1022. iterator end() { return make_iter(entries_.size(), npos()); }
  1023. const_iterator begin() const { return make_citer(0, npos()); }
  1024. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1025. const_iterator cbegin() const { return begin(); }
  1026. const_iterator cend() const { return end(); }
  1027. bool empty() const { return entries_.empty(); }
  1028. size_type size() const { return entries_.size(); }
  1029. void clear() { entries_.clear(); }
  1030. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1031. iterator insert(const value_type &val) {
  1032. entries_.push_back(val);
  1033. return make_iter(entries_.size() - 1, npos());
  1034. }
  1035. iterator insert(value_type &&val) {
  1036. entries_.push_back(std::move(val));
  1037. return make_iter(entries_.size() - 1, npos());
  1038. }
  1039. template <typename... Args> iterator emplace(Args &&...args) {
  1040. entries_.emplace_back(std::forward<Args>(args)...);
  1041. return make_iter(entries_.size() - 1, npos());
  1042. }
  1043. // For entries that have to lead the message, such as the Host header field
  1044. // (RFC 9110 5.3 recommends sending control data first).
  1045. template <typename... Args> iterator emplace_front(Args &&...args) {
  1046. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1047. return make_iter(0, npos());
  1048. }
  1049. iterator find(const std::string &key) {
  1050. auto i = index_of(key);
  1051. return i == npos() ? end() : make_iter(i, i);
  1052. }
  1053. const_iterator find(const std::string &key) const {
  1054. auto i = index_of(key);
  1055. return i == npos() ? end() : make_citer(i, i);
  1056. }
  1057. size_type count(const std::string &key) const {
  1058. size_type n = 0;
  1059. for (const auto &entry : entries_) {
  1060. if (keys_equal(entry.first, key)) { n++; }
  1061. }
  1062. return n;
  1063. }
  1064. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1065. auto i = index_of(key);
  1066. return i == npos() ? std::make_pair(end(), end())
  1067. : std::make_pair(make_iter(i, i), end());
  1068. }
  1069. std::pair<const_iterator, const_iterator>
  1070. equal_range(const std::string &key) const {
  1071. auto i = index_of(key);
  1072. return i == npos() ? std::make_pair(end(), end())
  1073. : std::make_pair(make_citer(i, i), end());
  1074. }
  1075. size_type erase(const std::string &key) {
  1076. auto before = entries_.size();
  1077. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1078. [&](const value_type &entry) {
  1079. return keys_equal(entry.first, key);
  1080. }),
  1081. entries_.end());
  1082. return before - entries_.size();
  1083. }
  1084. iterator erase(const_iterator pos) {
  1085. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1086. return make_iter(pos.idx_, npos());
  1087. }
  1088. // Erases what iterating [first, last) would actually visit, so erasing an
  1089. // equal_range() removes only the entries with that key, not everything
  1090. // positioned between them.
  1091. iterator erase(const_iterator first, const_iterator last) {
  1092. auto from = first.idx_;
  1093. auto to = last.idx_;
  1094. if (from >= to) { return make_iter(from, npos()); }
  1095. auto begin_it = entries_.begin();
  1096. auto from_it = begin_it + static_cast<difference_type>(from);
  1097. auto to_it = begin_it + static_cast<difference_type>(to);
  1098. if (first.key_idx_ == npos()) {
  1099. entries_.erase(from_it, to_it);
  1100. } else {
  1101. auto key = entries_[first.key_idx_].first;
  1102. auto keep = from_it;
  1103. for (auto it = from_it; it != to_it; ++it) {
  1104. if (!keys_equal(it->first, key)) {
  1105. if (keep != it) { *keep = std::move(*it); }
  1106. ++keep;
  1107. }
  1108. }
  1109. if (keep != to_it) {
  1110. keep = std::move(to_it, entries_.end(), keep);
  1111. } else {
  1112. keep = entries_.end();
  1113. }
  1114. entries_.erase(keep, entries_.end());
  1115. }
  1116. return make_iter(from, npos());
  1117. }
  1118. friend bool operator==(const insertion_ordered_multimap &lhs,
  1119. const insertion_ordered_multimap &rhs) {
  1120. return lhs.entries_ == rhs.entries_;
  1121. }
  1122. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1123. const insertion_ordered_multimap &rhs) {
  1124. return !(lhs == rhs);
  1125. }
  1126. private:
  1127. size_type index_of(const std::string &key) const {
  1128. for (size_type i = 0; i < entries_.size(); i++) {
  1129. if (keys_equal(entries_[i].first, key)) { return i; }
  1130. }
  1131. return npos();
  1132. }
  1133. iterator make_iter(size_type idx, size_type key_idx) {
  1134. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1135. }
  1136. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1137. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1138. }
  1139. std::vector<value_type> entries_;
  1140. };
  1141. } // namespace detail
  1142. using Headers =
  1143. detail::insertion_ordered_multimap<std::string,
  1144. detail::case_ignore::equal_to>;
  1145. // Query parameter names are case-sensitive, unlike header field names.
  1146. using Params =
  1147. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1148. using Match = std::smatch;
  1149. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1150. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1151. /*
  1152. * detail: type-erased storage used by UserData.
  1153. * ABI-stable regardless of C++ standard — always uses this custom
  1154. * implementation instead of std::any.
  1155. */
  1156. namespace detail {
  1157. using any_type_id = const void *;
  1158. template <typename T> any_type_id any_typeid() noexcept {
  1159. static const char id = 0;
  1160. return &id;
  1161. }
  1162. struct any_storage {
  1163. virtual ~any_storage() = default;
  1164. virtual std::unique_ptr<any_storage> clone() const = 0;
  1165. virtual any_type_id type_id() const noexcept = 0;
  1166. };
  1167. template <typename T> struct any_value final : any_storage {
  1168. T value;
  1169. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1170. std::unique_ptr<any_storage> clone() const override {
  1171. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1172. }
  1173. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1174. };
  1175. } // namespace detail
  1176. class UserData {
  1177. public:
  1178. UserData() = default;
  1179. UserData(UserData &&) noexcept = default;
  1180. UserData &operator=(UserData &&) noexcept = default;
  1181. UserData(const UserData &o) {
  1182. for (const auto &e : o.entries_) {
  1183. if (e.second) { entries_[e.first] = e.second->clone(); }
  1184. }
  1185. }
  1186. UserData &operator=(const UserData &o) {
  1187. if (this != &o) {
  1188. entries_.clear();
  1189. for (const auto &e : o.entries_) {
  1190. if (e.second) { entries_[e.first] = e.second->clone(); }
  1191. }
  1192. }
  1193. return *this;
  1194. }
  1195. template <typename T> void set(const std::string &key, T &&value) {
  1196. using D = typename std::decay<T>::type;
  1197. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1198. }
  1199. template <typename T> T *get(const std::string &key) noexcept {
  1200. auto it = entries_.find(key);
  1201. if (it == entries_.end() || !it->second) { return nullptr; }
  1202. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1203. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1204. }
  1205. template <typename T> const T *get(const std::string &key) const noexcept {
  1206. auto it = entries_.find(key);
  1207. if (it == entries_.end() || !it->second) { return nullptr; }
  1208. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1209. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1210. }
  1211. bool has(const std::string &key) const noexcept {
  1212. return entries_.find(key) != entries_.end();
  1213. }
  1214. void erase(const std::string &key) { entries_.erase(key); }
  1215. void clear() noexcept { entries_.clear(); }
  1216. private:
  1217. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1218. entries_;
  1219. };
  1220. struct Response;
  1221. using ResponseHandler = std::function<bool(const Response &response)>;
  1222. struct FormData {
  1223. std::string name;
  1224. std::string content;
  1225. std::string filename;
  1226. std::string content_type;
  1227. Headers headers;
  1228. };
  1229. struct FormField {
  1230. std::string name;
  1231. std::string content;
  1232. Headers headers;
  1233. };
  1234. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1235. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1236. // should see the parts as they were sent. A std::multimap sorts by field name
  1237. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1238. // than the case-insensitive predicate Headers uses.
  1239. using FormFields =
  1240. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1241. using FormFiles =
  1242. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1243. struct MultipartFormData {
  1244. FormFields fields; // Text fields from multipart
  1245. FormFiles files; // Files from multipart
  1246. // Text field access
  1247. std::string get_field(const std::string &key, size_t id = 0) const;
  1248. std::vector<std::string> get_fields(const std::string &key) const;
  1249. bool has_field(const std::string &key) const;
  1250. size_t get_field_count(const std::string &key) const;
  1251. // File access
  1252. FormData get_file(const std::string &key, size_t id = 0) const;
  1253. std::vector<FormData> get_files(const std::string &key) const;
  1254. bool has_file(const std::string &key) const;
  1255. size_t get_file_count(const std::string &key) const;
  1256. };
  1257. struct UploadFormData {
  1258. std::string name;
  1259. std::string content;
  1260. std::string filename;
  1261. std::string content_type;
  1262. };
  1263. using UploadFormDataItems = std::vector<UploadFormData>;
  1264. class DataSink {
  1265. public:
  1266. DataSink() : os(&sb_), sb_(*this) {}
  1267. DataSink(const DataSink &) = delete;
  1268. DataSink &operator=(const DataSink &) = delete;
  1269. DataSink(DataSink &&) = delete;
  1270. DataSink &operator=(DataSink &&) = delete;
  1271. std::function<bool(const char *data, size_t data_len)> write;
  1272. // Only `write` is mandatory. The rest are defaulted so that a provider
  1273. // calling one on a writer that does not set it gets sensible behaviour
  1274. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1275. // `this` is safe: DataSink is neither copyable nor movable.
  1276. std::function<bool()> is_writable = []() { return true; };
  1277. std::function<void()> done = []() {};
  1278. std::function<void(const Headers &trailer)> done_with_trailer =
  1279. [this](const Headers & /*trailer*/) { done(); };
  1280. std::ostream os;
  1281. private:
  1282. class data_sink_streambuf final : public std::streambuf {
  1283. public:
  1284. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1285. protected:
  1286. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1287. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1288. return 0;
  1289. }
  1290. private:
  1291. DataSink &sink_;
  1292. };
  1293. data_sink_streambuf sb_;
  1294. };
  1295. using ContentProvider =
  1296. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1297. using ContentProviderWithoutLength =
  1298. std::function<bool(size_t offset, DataSink &sink)>;
  1299. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1300. struct FormDataProvider {
  1301. std::string name;
  1302. ContentProviderWithoutLength provider;
  1303. std::string filename;
  1304. std::string content_type;
  1305. };
  1306. using FormDataProviderItems = std::vector<FormDataProvider>;
  1307. inline FormDataProvider
  1308. make_file_provider(const std::string &name, const std::string &filepath,
  1309. const std::string &filename = std::string(),
  1310. const std::string &content_type = std::string()) {
  1311. FormDataProvider fdp;
  1312. fdp.name = name;
  1313. fdp.filename = filename.empty() ? filepath : filename;
  1314. fdp.content_type = content_type;
  1315. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1316. std::ifstream f(filepath, std::ios::binary);
  1317. if (!f) { return false; }
  1318. if (offset > 0) {
  1319. f.seekg(static_cast<std::streamoff>(offset));
  1320. if (!f.good()) {
  1321. sink.done();
  1322. return true;
  1323. }
  1324. }
  1325. char buf[8192];
  1326. f.read(buf, sizeof(buf));
  1327. auto n = static_cast<size_t>(f.gcount());
  1328. if (n > 0) { return sink.write(buf, n); }
  1329. sink.done(); // EOF
  1330. return true;
  1331. };
  1332. return fdp;
  1333. }
  1334. inline std::pair<size_t, ContentProvider>
  1335. make_file_body(const std::string &filepath) {
  1336. size_t size = 0;
  1337. {
  1338. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1339. if (!f) { return {0, ContentProvider{}}; }
  1340. size = static_cast<size_t>(f.tellg());
  1341. }
  1342. ContentProvider provider = [filepath](size_t offset, size_t length,
  1343. DataSink &sink) -> bool {
  1344. std::ifstream f(filepath, std::ios::binary);
  1345. if (!f) { return false; }
  1346. f.seekg(static_cast<std::streamoff>(offset));
  1347. if (!f.good()) { return false; }
  1348. char buf[8192];
  1349. while (length > 0) {
  1350. auto to_read = (std::min)(sizeof(buf), length);
  1351. f.read(buf, static_cast<std::streamsize>(to_read));
  1352. auto n = static_cast<size_t>(f.gcount());
  1353. // The file is shorter than the size make_file_body() measured, which the
  1354. // caller has already committed to as Content-Length. The body cannot be
  1355. // completed, so fail as every other error here does.
  1356. if (n == 0) { return false; }
  1357. if (!sink.write(buf, n)) { return false; }
  1358. length -= n;
  1359. }
  1360. return true;
  1361. };
  1362. return {size, std::move(provider)};
  1363. }
  1364. using ContentReceiverWithProgress = std::function<bool(
  1365. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1366. using ContentReceiver =
  1367. std::function<bool(const char *data, size_t data_length)>;
  1368. using FormDataHeader = std::function<bool(const FormData &file)>;
  1369. class ContentReader {
  1370. public:
  1371. using Reader = std::function<bool(ContentReceiver receiver)>;
  1372. using FormDataReader =
  1373. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1374. ContentReader(Reader reader, FormDataReader multipart_reader)
  1375. : reader_(std::move(reader)),
  1376. formdata_reader_(std::move(multipart_reader)) {}
  1377. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1378. return formdata_reader_(std::move(header), std::move(receiver));
  1379. }
  1380. bool operator()(ContentReceiver receiver) const {
  1381. return reader_(std::move(receiver));
  1382. }
  1383. Reader reader_;
  1384. FormDataReader formdata_reader_;
  1385. };
  1386. using Range = std::pair<ssize_t, ssize_t>;
  1387. using Ranges = std::vector<Range>;
  1388. #ifdef CPPHTTPLIB_SSL_ENABLED
  1389. // TLS abstraction layer - public type definitions and API
  1390. namespace tls {
  1391. // Opaque handles (defined as void* for abstraction)
  1392. using ctx_t = void *;
  1393. using session_t = void *;
  1394. using const_session_t = const void *; // For read-only session access
  1395. using cert_t = void *;
  1396. using ca_store_t = void *;
  1397. // TLS versions
  1398. enum class Version {
  1399. TLS1_2 = 0x0303,
  1400. TLS1_3 = 0x0304,
  1401. };
  1402. // Subject Alternative Names (SAN) entry types
  1403. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1404. // SAN entry structure
  1405. struct SanEntry {
  1406. SanType type;
  1407. std::string value;
  1408. };
  1409. // Verification context for certificate verification callback
  1410. struct VerifyContext {
  1411. session_t session; // TLS session handle
  1412. cert_t cert; // Current certificate being verified
  1413. int depth; // Certificate chain depth (0 = leaf)
  1414. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1415. long error_code; // Backend-specific error code (0 = no error)
  1416. const char *error_string; // Human-readable error description
  1417. // Certificate introspection methods
  1418. std::string subject_cn() const;
  1419. std::string issuer_name() const;
  1420. bool check_hostname(const char *hostname) const;
  1421. std::vector<SanEntry> sans() const;
  1422. bool validity(time_t &not_before, time_t &not_after) const;
  1423. std::string serial() const;
  1424. };
  1425. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1426. // TlsError codes for TLS operations (backend-independent)
  1427. enum class ErrorCode : int {
  1428. Success = 0,
  1429. WantRead, // Non-blocking: need to wait for read
  1430. WantWrite, // Non-blocking: need to wait for write
  1431. PeerClosed, // Peer closed the connection
  1432. Fatal, // Unrecoverable error
  1433. SyscallError, // System call error (check sys_errno)
  1434. CertVerifyFailed, // Certificate verification failed
  1435. HostnameMismatch, // Hostname verification failed
  1436. };
  1437. // TLS error information
  1438. struct TlsError {
  1439. ErrorCode code = ErrorCode::Fatal;
  1440. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1441. int sys_errno = 0; // errno when SyscallError
  1442. // Convert verification error code to human-readable string
  1443. static std::string verify_error_to_string(long error_code);
  1444. };
  1445. // RAII wrapper for peer certificate
  1446. class PeerCert {
  1447. public:
  1448. PeerCert();
  1449. PeerCert(PeerCert &&other) noexcept;
  1450. PeerCert &operator=(PeerCert &&other) noexcept;
  1451. ~PeerCert();
  1452. PeerCert(const PeerCert &) = delete;
  1453. PeerCert &operator=(const PeerCert &) = delete;
  1454. explicit operator bool() const;
  1455. std::string subject_cn() const;
  1456. std::string issuer_name() const;
  1457. bool check_hostname(const char *hostname) const;
  1458. std::vector<SanEntry> sans() const;
  1459. bool validity(time_t &not_before, time_t &not_after) const;
  1460. std::string serial() const;
  1461. private:
  1462. explicit PeerCert(cert_t cert);
  1463. cert_t cert_ = nullptr;
  1464. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1465. };
  1466. // Callback for TLS context setup (used by SSLServer constructor)
  1467. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1468. } // namespace tls
  1469. #endif
  1470. struct Request {
  1471. std::string method;
  1472. std::string path;
  1473. std::string matched_route;
  1474. Params params;
  1475. Headers headers;
  1476. Headers trailers;
  1477. std::string body;
  1478. std::string remote_addr;
  1479. int remote_port = -1;
  1480. std::string local_addr;
  1481. int local_port = -1;
  1482. // for server
  1483. std::string version;
  1484. std::string target;
  1485. MultipartFormData form;
  1486. Ranges ranges;
  1487. Match matches;
  1488. std::unordered_map<std::string, std::string> path_params;
  1489. std::function<bool()> is_connection_closed = []() { return true; };
  1490. // for client
  1491. std::vector<std::string> accept_content_types;
  1492. ResponseHandler response_handler;
  1493. ContentReceiverWithProgress content_receiver;
  1494. DownloadProgress download_progress;
  1495. UploadProgress upload_progress;
  1496. bool has_header(const std::string &key) const;
  1497. std::string get_header_value(const std::string &key, const char *def = "",
  1498. size_t id = 0) const;
  1499. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1500. size_t id = 0) const;
  1501. size_t get_header_value_count(const std::string &key) const;
  1502. void set_header(const std::string &key, const std::string &val);
  1503. bool has_trailer(const std::string &key) const;
  1504. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1505. size_t get_trailer_value_count(const std::string &key) const;
  1506. bool has_param(const std::string &key) const;
  1507. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1508. std::vector<std::string> get_param_values(const std::string &key) const;
  1509. size_t get_param_value_count(const std::string &key) const;
  1510. bool is_multipart_form_data() const;
  1511. // private members...
  1512. bool body_consumed_ = false;
  1513. bool expect_100_continue_pending_ = false;
  1514. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1515. size_t content_length_ = 0;
  1516. ContentProvider content_provider_;
  1517. bool is_chunked_content_provider_ = false;
  1518. size_t authorization_count_ = 0;
  1519. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1520. (std::chrono::steady_clock::time_point::min)();
  1521. #ifdef CPPHTTPLIB_SSL_ENABLED
  1522. tls::const_session_t ssl = nullptr;
  1523. tls::PeerCert peer_cert() const;
  1524. std::string sni() const;
  1525. #endif
  1526. };
  1527. namespace detail {
  1528. // Declared up here, away from the rest of the compression helpers, because
  1529. // `Response` stores one.
  1530. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1531. } // namespace detail
  1532. struct Response {
  1533. std::string version;
  1534. int status = -1;
  1535. std::string reason;
  1536. Headers headers;
  1537. Headers trailers;
  1538. std::string body;
  1539. std::string location; // Redirect location
  1540. // User-defined context — set by pre-routing/pre-request handlers and read
  1541. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1542. UserData user_data;
  1543. bool has_header(const std::string &key) const;
  1544. std::string get_header_value(const std::string &key, const char *def = "",
  1545. size_t id = 0) const;
  1546. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1547. size_t id = 0) const;
  1548. size_t get_header_value_count(const std::string &key) const;
  1549. void set_header(const std::string &key, const std::string &val);
  1550. bool has_trailer(const std::string &key) const;
  1551. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1552. size_t get_trailer_value_count(const std::string &key) const;
  1553. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1554. void set_content(const char *s, size_t n, const std::string &content_type);
  1555. void set_content(const std::string &s, const std::string &content_type);
  1556. void set_content(std::string &&s, const std::string &content_type);
  1557. void set_content_provider(
  1558. size_t length, const std::string &content_type, ContentProvider provider,
  1559. ContentProviderResourceReleaser resource_releaser = nullptr);
  1560. void set_content_provider(
  1561. const std::string &content_type, ContentProviderWithoutLength provider,
  1562. ContentProviderResourceReleaser resource_releaser = nullptr);
  1563. void set_chunked_content_provider(
  1564. const std::string &content_type, ContentProviderWithoutLength provider,
  1565. ContentProviderResourceReleaser resource_releaser = nullptr);
  1566. void set_file_content(const std::string &path,
  1567. const std::string &content_type);
  1568. void set_file_content(const std::string &path);
  1569. Response() = default;
  1570. Response(const Response &) = default;
  1571. Response &operator=(const Response &) = default;
  1572. Response(Response &&) = default;
  1573. Response &operator=(Response &&) = default;
  1574. ~Response() {
  1575. if (content_provider_resource_releaser_) {
  1576. content_provider_resource_releaser_(content_provider_success_);
  1577. }
  1578. }
  1579. // private members...
  1580. size_t content_length_ = 0;
  1581. ContentProvider content_provider_;
  1582. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1583. bool is_chunked_content_provider_ = false;
  1584. bool is_file_content_provider_ = false;
  1585. bool content_provider_success_ = false;
  1586. std::string file_content_path_;
  1587. std::string file_content_content_type_;
  1588. // Content coding chosen for the response body, decided once so that the
  1589. // headers and the body cannot disagree: where the file is opened for a
  1590. // file-backed content provider (keeping the ETag honest), and in
  1591. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1592. // for every other kind of response.
  1593. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1594. };
  1595. enum class Error {
  1596. Success = 0,
  1597. Unknown,
  1598. Connection,
  1599. BindIPAddress,
  1600. Read,
  1601. Write,
  1602. ExceedRedirectCount,
  1603. Canceled,
  1604. SSLConnection,
  1605. SSLLoadingCerts,
  1606. SSLServerVerification,
  1607. SSLServerHostnameVerification,
  1608. UnsupportedMultipartBoundaryChars,
  1609. Compression,
  1610. ConnectionTimeout,
  1611. ProxyConnection,
  1612. ConnectionClosed,
  1613. Timeout,
  1614. ResourceExhaustion,
  1615. TooManyFormDataFiles,
  1616. ExceedMaxPayloadSize,
  1617. ExceedUriMaxLength,
  1618. ExceedMaxSocketDescriptorCount,
  1619. InvalidRequestLine,
  1620. InvalidHTTPMethod,
  1621. InvalidHTTPVersion,
  1622. InvalidHeaders,
  1623. MultipartParsing,
  1624. OpenFile,
  1625. Listen,
  1626. GetSockName,
  1627. UnsupportedAddressFamily,
  1628. HTTPParsing,
  1629. InvalidRangeHeader,
  1630. UnsupportedContentEncoding,
  1631. WebSocketHandshake,
  1632. UserCallbackException,
  1633. // For internal use only
  1634. SSLPeerCouldBeClosed_,
  1635. };
  1636. std::string to_string(Error error);
  1637. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1638. class Stream {
  1639. public:
  1640. virtual ~Stream() = default;
  1641. virtual bool is_readable() const = 0;
  1642. virtual bool wait_readable() const = 0;
  1643. virtual bool wait_writable() const = 0;
  1644. virtual bool is_peer_alive() const { return wait_writable(); }
  1645. virtual ssize_t read(char *ptr, size_t size) = 0;
  1646. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1647. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1648. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1649. virtual socket_t socket() const = 0;
  1650. virtual time_t duration() const = 0;
  1651. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1652. (void)sec;
  1653. (void)usec;
  1654. }
  1655. // Bytes already pulled off the socket and sitting in this stream's own
  1656. // buffer. Exposing them lets a line reader scan for a terminator in one
  1657. // pass instead of asking for a byte at a time. A stream that does no
  1658. // buffering of its own reports none, and readers fall back to read().
  1659. virtual const char *buffered_data(size_t &size) const {
  1660. size = 0;
  1661. return nullptr;
  1662. }
  1663. // Discards `size` bytes previously returned by buffered_data().
  1664. virtual void consume_buffered(size_t size) { (void)size; }
  1665. ssize_t write(const char *ptr);
  1666. ssize_t write(const std::string &s);
  1667. Error get_error() const { return error_; }
  1668. protected:
  1669. Error error_ = Error::Success;
  1670. };
  1671. class TaskQueue {
  1672. public:
  1673. TaskQueue() = default;
  1674. virtual ~TaskQueue() = default;
  1675. virtual bool enqueue(std::function<void()> fn) = 0;
  1676. virtual void shutdown() = 0;
  1677. virtual void on_idle() {}
  1678. };
  1679. class ThreadPool final : public TaskQueue {
  1680. public:
  1681. explicit ThreadPool(
  1682. size_t n, size_t max_n = 0, size_t mqr = 0,
  1683. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1684. ThreadPool(const ThreadPool &) = delete;
  1685. ~ThreadPool() override = default;
  1686. bool enqueue(std::function<void()> fn) override;
  1687. void shutdown() override;
  1688. private:
  1689. void worker(bool is_dynamic);
  1690. void move_to_finished(std::thread::id id);
  1691. void cleanup_finished_threads();
  1692. size_t base_thread_count_;
  1693. size_t max_thread_count_;
  1694. size_t max_queued_requests_;
  1695. time_t idle_timeout_sec_;
  1696. size_t idle_thread_count_;
  1697. bool shutdown_;
  1698. std::list<std::function<void()>> jobs_;
  1699. std::vector<std::thread> threads_; // base threads
  1700. std::list<std::thread> dynamic_threads_; // dynamic threads
  1701. std::vector<std::thread>
  1702. finished_threads_; // exited dynamic threads awaiting join
  1703. std::condition_variable cond_;
  1704. std::mutex mutex_;
  1705. };
  1706. using Logger = std::function<void(const Request &, const Response &)>;
  1707. // Forward declaration for Error type
  1708. enum class Error;
  1709. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1710. using SocketOptions = std::function<void(socket_t sock)>;
  1711. void default_socket_options(socket_t sock);
  1712. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1713. const char *status_message(int status);
  1714. std::string to_string(Error error);
  1715. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1716. std::string get_bearer_token_auth(const Request &req);
  1717. namespace detail {
  1718. class MatcherBase {
  1719. public:
  1720. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1721. virtual ~MatcherBase() = default;
  1722. const std::string &pattern() const { return pattern_; }
  1723. // Match request path and populate its matches and
  1724. virtual bool match(Request &request) const = 0;
  1725. private:
  1726. std::string pattern_;
  1727. };
  1728. /**
  1729. * Captures parameters in request path and stores them in Request::path_params
  1730. *
  1731. * Capture name is a substring of a pattern from : to /.
  1732. * The rest of the pattern is matched against the request path directly
  1733. * Parameters are captured starting from the next character after
  1734. * the end of the last matched static pattern fragment until the next /.
  1735. *
  1736. * Example pattern:
  1737. * "/path/fragments/:capture/more/fragments/:second_capture"
  1738. * Static fragments:
  1739. * "/path/fragments/", "more/fragments/"
  1740. *
  1741. * Given the following request path:
  1742. * "/path/fragments/:1/more/fragments/:2"
  1743. * the resulting capture will be
  1744. * {{"capture", "1"}, {"second_capture", "2"}}
  1745. */
  1746. class PathParamsMatcher final : public MatcherBase {
  1747. public:
  1748. PathParamsMatcher(const std::string &pattern);
  1749. bool match(Request &request) const override;
  1750. private:
  1751. // Treat segment separators as the end of path parameter capture
  1752. // Does not need to handle query parameters as they are parsed before path
  1753. // matching
  1754. static constexpr char separator = '/';
  1755. // Contains static path fragments to match against, excluding the '/' after
  1756. // path params
  1757. // Fragments are separated by path params
  1758. std::vector<std::string> static_fragments_;
  1759. // Stores the names of the path parameters to be used as keys in the
  1760. // Request::path_params map
  1761. std::vector<std::string> param_names_;
  1762. };
  1763. /**
  1764. * Performs std::regex_match on request path
  1765. * and stores the result in Request::matches
  1766. *
  1767. * Note that regex match is performed directly on the whole request.
  1768. * This means that wildcard patterns may match multiple path segments with /:
  1769. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1770. */
  1771. class RegexMatcher final : public MatcherBase {
  1772. public:
  1773. RegexMatcher(const std::string &pattern)
  1774. : MatcherBase(pattern), regex_(pattern) {}
  1775. bool match(Request &request) const override;
  1776. private:
  1777. std::regex regex_;
  1778. };
  1779. int close_socket(socket_t sock) noexcept;
  1780. bool is_accept_resource_error();
  1781. bool is_accept_transient_error();
  1782. ssize_t write_headers(Stream &strm, const Headers &headers);
  1783. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1784. time_t usec);
  1785. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1786. const std::string &boundary);
  1787. ContentProvider
  1788. make_multipart_content_provider(const UploadFormDataItems &items,
  1789. const std::string &boundary);
  1790. } // namespace detail
  1791. bool is_valid_multipart_boundary(const std::string &boundary);
  1792. // Serializer for multipart/form-data request bodies. The boundary is owned
  1793. // by the writer so that per-part framing and the final terminator always
  1794. // agree. Field names and filenames are escaped following the WHATWG HTML
  1795. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1796. // in content types.
  1797. class MultipartFormDataWriter {
  1798. public:
  1799. MultipartFormDataWriter();
  1800. // precondition: is_valid_multipart_boundary(boundary)
  1801. explicit MultipartFormDataWriter(std::string boundary);
  1802. const std::string &boundary() const;
  1803. std::string content_type() const;
  1804. // In-memory items -> whole body (known length)
  1805. std::string serialize(const UploadFormDataItems &items) const;
  1806. size_t content_length(const UploadFormDataItems &items) const;
  1807. // Per-part framing for streaming via a content provider
  1808. std::string item_begin(const UploadFormData &item) const;
  1809. static std::string item_end();
  1810. std::string finish() const;
  1811. private:
  1812. std::string boundary_;
  1813. };
  1814. class Server {
  1815. public:
  1816. using Handler = std::function<void(const Request &, Response &)>;
  1817. using ExceptionHandler =
  1818. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1819. enum class HandlerResponse {
  1820. Handled,
  1821. Unhandled,
  1822. };
  1823. using HandlerWithResponse =
  1824. std::function<HandlerResponse(const Request &, Response &)>;
  1825. using HandlerWithContentReader = std::function<void(
  1826. const Request &, Response &, const ContentReader &content_reader)>;
  1827. using Expect100ContinueHandler =
  1828. std::function<int(const Request &, Response &)>;
  1829. using StartHandler = std::function<void()>;
  1830. using WebSocketHandler =
  1831. std::function<void(const Request &, ws::WebSocket &)>;
  1832. using SubProtocolSelector =
  1833. std::function<std::string(const std::vector<std::string> &protocols)>;
  1834. Server();
  1835. virtual ~Server();
  1836. virtual bool is_valid() const;
  1837. Server &Get(const std::string &pattern, Handler handler);
  1838. Server &Post(const std::string &pattern, Handler handler);
  1839. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1840. Server &Put(const std::string &pattern, Handler handler);
  1841. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1842. Server &Patch(const std::string &pattern, Handler handler);
  1843. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1844. Server &Delete(const std::string &pattern, Handler handler);
  1845. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1846. Server &Options(const std::string &pattern, Handler handler);
  1847. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1848. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1849. // server accept it; an unregistered method is still rejected with 400.
  1850. // `method` must be a valid HTTP method token and must not be one of the
  1851. // built-in methods, which have their own registration functions above. A
  1852. // rejected registration makes is_valid() return false, so listen() fails.
  1853. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1854. Handler handler);
  1855. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1856. HandlerWithContentReader handler);
  1857. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1858. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1859. SubProtocolSelector sub_protocol_selector);
  1860. bool set_base_dir(const std::string &dir,
  1861. const std::string &mount_point = std::string());
  1862. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1863. Headers headers = Headers());
  1864. bool remove_mount_point(const std::string &mount_point);
  1865. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1866. const std::string &mime);
  1867. Server &set_default_file_mimetype(const std::string &mime);
  1868. Server &set_file_request_handler(Handler handler);
  1869. template <class ErrorHandlerFunc>
  1870. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1871. return set_error_handler_core(
  1872. std::forward<ErrorHandlerFunc>(handler),
  1873. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1874. }
  1875. Server &set_exception_handler(ExceptionHandler handler);
  1876. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1877. Server &set_post_routing_handler(Handler handler);
  1878. Server &set_pre_request_handler(HandlerWithResponse handler);
  1879. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1880. Server &set_start_handler(StartHandler handler);
  1881. Server &set_logger(Logger logger);
  1882. Server &set_pre_compression_logger(Logger logger);
  1883. Server &set_error_logger(ErrorLogger error_logger);
  1884. Server &set_address_family(int family);
  1885. Server &set_tcp_nodelay(bool on);
  1886. Server &set_ipv6_v6only(bool on);
  1887. Server &set_socket_options(SocketOptions socket_options);
  1888. Server &set_default_headers(Headers headers);
  1889. Server &
  1890. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1891. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1892. Server &set_keep_alive_max_count(size_t count);
  1893. Server &set_keep_alive_timeout(time_t sec);
  1894. template <class Rep, class Period>
  1895. Server &
  1896. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1897. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1898. template <class Rep, class Period>
  1899. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1900. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1901. template <class Rep, class Period>
  1902. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1903. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1904. template <class Rep, class Period>
  1905. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1906. Server &set_payload_max_length(size_t length);
  1907. Server &set_static_file_compression(bool on);
  1908. Server &set_static_file_compression_min_length(size_t length);
  1909. Server &set_static_file_compression_max_length(size_t length);
  1910. Server &set_websocket_ping_interval(time_t sec);
  1911. template <class Rep, class Period>
  1912. Server &set_websocket_ping_interval(
  1913. const std::chrono::duration<Rep, Period> &duration);
  1914. Server &set_websocket_max_missed_pongs(int count);
  1915. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1916. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1917. bool listen_after_bind();
  1918. bool listen(const std::string &host, int port, int socket_flags = 0);
  1919. bool is_running() const;
  1920. void wait_until_ready() const;
  1921. void stop() noexcept;
  1922. void decommission();
  1923. std::function<TaskQueue *(void)> new_task_queue;
  1924. protected:
  1925. bool process_request(Stream &strm, const std::string &remote_addr,
  1926. int remote_port, const std::string &local_addr,
  1927. int local_port, bool close_connection,
  1928. bool &connection_closed,
  1929. const std::function<void(Request &)> &setup_request,
  1930. bool *websocket_upgraded = nullptr);
  1931. // Runs the per-connection serving loop and stops an exception thrown by a
  1932. // user callback from escaping the worker thread.
  1933. //
  1934. // process_request() wraps only routing() in a try/catch. Content providers,
  1935. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1936. // handlers all run outside it, and the task queue calls the job without a
  1937. // catch, so an exception from any of those would terminate the process.
  1938. //
  1939. // No 500 is possible here: by the time a content provider runs, the status
  1940. // line and headers are already on the wire. Report it through the error
  1941. // logger and drop the connection, which is what the peer observes either
  1942. // way. Other connections are unaffected.
  1943. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1944. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1945. return serve();
  1946. #else
  1947. try {
  1948. return serve();
  1949. } catch (...) {
  1950. // The error logger is a user callback too, so it must not be able to
  1951. // throw the guard back open.
  1952. try {
  1953. output_error_log(Error::UserCallbackException, nullptr);
  1954. } catch (...) {}
  1955. return false;
  1956. }
  1957. #endif
  1958. }
  1959. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1960. std::vector<std::string> trusted_proxies_;
  1961. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1962. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1963. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1964. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1965. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1966. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1967. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1968. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1969. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1970. bool static_file_compression_ = false;
  1971. size_t static_file_compression_min_length_ =
  1972. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1973. size_t static_file_compression_max_length_ =
  1974. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1975. time_t websocket_ping_interval_sec_ =
  1976. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1977. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1978. private:
  1979. using Handlers =
  1980. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1981. using HandlersForContentReader =
  1982. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1983. HandlerWithContentReader>>;
  1984. // Both handler tables for one custom method live in a single entry, so that
  1985. // routing() needs only one map lookup per request to reach either of them.
  1986. struct CustomHandlerEntry {
  1987. Handlers handlers;
  1988. HandlersForContentReader handlers_for_content_reader;
  1989. };
  1990. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1991. static std::unique_ptr<detail::MatcherBase>
  1992. make_matcher(const std::string &pattern);
  1993. static const std::set<std::string> &builtin_methods();
  1994. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1995. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1996. template <typename H>
  1997. Server &add_handler(
  1998. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1999. const std::string &pattern, H handler) {
  2000. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2001. return *this;
  2002. }
  2003. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2004. Server &set_error_handler_core(Handler handler, std::false_type);
  2005. socket_t create_server_socket(const std::string &host, int port,
  2006. int socket_flags,
  2007. SocketOptions socket_options) const;
  2008. int bind_internal(const std::string &host, int port, int socket_flags);
  2009. bool listen_internal();
  2010. bool routing(Request &req, Response &res, Stream &strm);
  2011. bool handle_file_request(Request &req, Response &res);
  2012. bool check_if_not_modified(const Request &req, Response &res,
  2013. const std::string &etag, time_t mtime) const;
  2014. bool check_if_range(Request &req, const std::string &etag,
  2015. time_t mtime) const;
  2016. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2017. Stream &strm);
  2018. bool dispatch_request_for_content_reader(
  2019. Request &req, Response &res, ContentReader content_reader,
  2020. const HandlersForContentReader &handlers) const;
  2021. bool parse_request_line(const char *s, Request &req) const;
  2022. detail::EncodingType static_file_encoding(const Request &req,
  2023. const Response &res,
  2024. const std::string &content_type,
  2025. size_t length) const;
  2026. bool apply_static_file_compression(const Request &req, Response &res) const;
  2027. void apply_ranges(const Request &req, Response &res,
  2028. std::string &content_type, std::string &boundary) const;
  2029. bool write_response(Stream &strm, bool close_connection, Request &req,
  2030. Response &res);
  2031. bool write_response_with_content(Stream &strm, bool close_connection,
  2032. const Request &req, Response &res);
  2033. bool write_response_core(Stream &strm, bool close_connection,
  2034. const Request &req, Response &res,
  2035. bool need_apply_ranges);
  2036. bool write_content_with_provider(Stream &strm, const Request &req,
  2037. Response &res, const std::string &boundary,
  2038. const std::string &content_type);
  2039. bool read_content(Stream &strm, Request &req, Response &res);
  2040. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2041. Response &res,
  2042. ContentReceiver receiver,
  2043. FormDataHeader multipart_header,
  2044. ContentReceiver multipart_receiver);
  2045. bool read_content_core(Stream &strm, Request &req, Response &res,
  2046. ContentReceiver receiver,
  2047. FormDataHeader multipart_header,
  2048. ContentReceiver multipart_receiver) const;
  2049. virtual bool process_and_close_socket(socket_t sock);
  2050. void output_log(const Request &req, const Response &res) const;
  2051. void output_pre_compression_log(const Request &req,
  2052. const Response &res) const;
  2053. void output_error_log(const Error &err, const Request *req) const;
  2054. std::atomic<bool> is_running_{false};
  2055. std::atomic<bool> is_decommissioned{false};
  2056. // Set when CustomRoute() refuses a registration. Written before listen(),
  2057. // read by is_valid() on the same thread, so it needs no synchronization.
  2058. bool has_invalid_registration_ = false;
  2059. struct MountPointEntry {
  2060. std::string mount_point;
  2061. std::string base_dir;
  2062. std::string resolved_base_dir;
  2063. Headers headers;
  2064. };
  2065. std::vector<MountPointEntry> base_dirs_;
  2066. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2067. std::string default_file_mimetype_ = "application/octet-stream";
  2068. Handler file_request_handler_;
  2069. Handlers get_handlers_;
  2070. Handlers post_handlers_;
  2071. HandlersForContentReader post_handlers_for_content_reader_;
  2072. Handlers put_handlers_;
  2073. HandlersForContentReader put_handlers_for_content_reader_;
  2074. Handlers patch_handlers_;
  2075. HandlersForContentReader patch_handlers_for_content_reader_;
  2076. Handlers delete_handlers_;
  2077. HandlersForContentReader delete_handlers_for_content_reader_;
  2078. Handlers options_handlers_;
  2079. CustomHandlers custom_handlers_;
  2080. struct WebSocketHandlerEntry {
  2081. std::unique_ptr<detail::MatcherBase> matcher;
  2082. WebSocketHandler handler;
  2083. SubProtocolSelector sub_protocol_selector;
  2084. };
  2085. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2086. WebSocketHandlers websocket_handlers_;
  2087. HandlerWithResponse error_handler_;
  2088. ExceptionHandler exception_handler_;
  2089. HandlerWithResponse pre_routing_handler_;
  2090. Handler post_routing_handler_;
  2091. HandlerWithResponse pre_request_handler_;
  2092. Expect100ContinueHandler expect_100_continue_handler_;
  2093. StartHandler start_handler_;
  2094. mutable std::mutex logger_mutex_;
  2095. Logger logger_;
  2096. Logger pre_compression_logger_;
  2097. ErrorLogger error_logger_;
  2098. int address_family_ = AF_UNSPEC;
  2099. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2100. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2101. SocketOptions socket_options_ = default_socket_options;
  2102. Headers default_headers_;
  2103. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2104. detail::write_headers;
  2105. };
  2106. class Result {
  2107. public:
  2108. Result() = default;
  2109. Result(std::unique_ptr<Response> &&res, Error err,
  2110. Headers &&request_headers = Headers{})
  2111. : res_(std::move(res)), err_(err),
  2112. request_headers_(std::move(request_headers)) {}
  2113. // Response
  2114. operator bool() const { return res_ != nullptr; }
  2115. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2116. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2117. const Response &value() const { return *res_; }
  2118. Response &value() { return *res_; }
  2119. const Response &operator*() const { return *res_; }
  2120. Response &operator*() { return *res_; }
  2121. const Response *operator->() const { return res_.get(); }
  2122. Response *operator->() { return res_.get(); }
  2123. // Error
  2124. Error error() const { return err_; }
  2125. // Request Headers
  2126. bool has_request_header(const std::string &key) const;
  2127. std::string get_request_header_value(const std::string &key,
  2128. const char *def = "",
  2129. size_t id = 0) const;
  2130. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2131. size_t id = 0) const;
  2132. size_t get_request_header_value_count(const std::string &key) const;
  2133. private:
  2134. std::unique_ptr<Response> res_;
  2135. Error err_ = Error::Unknown;
  2136. Headers request_headers_;
  2137. #ifdef CPPHTTPLIB_SSL_ENABLED
  2138. public:
  2139. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2140. int ssl_error)
  2141. : res_(std::move(res)), err_(err),
  2142. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2143. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2144. int ssl_error, uint64_t ssl_backend_error)
  2145. : res_(std::move(res)), err_(err),
  2146. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2147. ssl_backend_error_(ssl_backend_error) {}
  2148. int ssl_error() const { return ssl_error_; }
  2149. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2150. private:
  2151. int ssl_error_ = 0;
  2152. uint64_t ssl_backend_error_ = 0;
  2153. #endif
  2154. };
  2155. struct ClientConnection {
  2156. socket_t sock = INVALID_SOCKET;
  2157. bool is_open() const { return sock != INVALID_SOCKET; }
  2158. ClientConnection() = default;
  2159. ~ClientConnection();
  2160. ClientConnection(const ClientConnection &) = delete;
  2161. ClientConnection &operator=(const ClientConnection &) = delete;
  2162. ClientConnection(ClientConnection &&other) noexcept
  2163. : sock(other.sock)
  2164. #ifdef CPPHTTPLIB_SSL_ENABLED
  2165. ,
  2166. session(other.session)
  2167. #endif
  2168. {
  2169. other.sock = INVALID_SOCKET;
  2170. #ifdef CPPHTTPLIB_SSL_ENABLED
  2171. other.session = nullptr;
  2172. #endif
  2173. }
  2174. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2175. if (this != &other) {
  2176. sock = other.sock;
  2177. other.sock = INVALID_SOCKET;
  2178. #ifdef CPPHTTPLIB_SSL_ENABLED
  2179. session = other.session;
  2180. other.session = nullptr;
  2181. #endif
  2182. }
  2183. return *this;
  2184. }
  2185. #ifdef CPPHTTPLIB_SSL_ENABLED
  2186. tls::session_t session = nullptr;
  2187. #endif
  2188. };
  2189. namespace detail {
  2190. struct ChunkedDecoder;
  2191. struct BodyReader {
  2192. Stream *stream = nullptr;
  2193. bool has_content_length = false;
  2194. size_t content_length = 0;
  2195. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2196. size_t bytes_read = 0;
  2197. bool chunked = false;
  2198. bool eof = false;
  2199. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2200. Error last_error = Error::Success;
  2201. ssize_t read(char *buf, size_t len);
  2202. bool has_error() const { return last_error != Error::Success; }
  2203. };
  2204. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2205. size_t len) {
  2206. (void)stream;
  2207. return br.read(buf, len);
  2208. }
  2209. class decompressor;
  2210. enum class NoProxyKind {
  2211. Wildcard, // "*"
  2212. HostnameSuffix, // "example.com" or ".example.com"
  2213. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2214. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2215. };
  2216. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2217. // Lets one CIDR matcher cover both families.
  2218. using IPBytes = std::array<uint8_t, 16>;
  2219. struct NoProxyEntry {
  2220. NoProxyKind kind = NoProxyKind::Wildcard;
  2221. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2222. IPBytes net{};
  2223. int prefix_bits = 0;
  2224. };
  2225. struct NormalizedTarget {
  2226. std::string hostname; // lowercase; brackets and trailing dot removed
  2227. bool is_ipv4 = false;
  2228. bool is_ipv6 = false;
  2229. IPBytes ip{};
  2230. };
  2231. } // namespace detail
  2232. class ClientImpl {
  2233. public:
  2234. explicit ClientImpl(const std::string &host);
  2235. explicit ClientImpl(const std::string &host, int port);
  2236. explicit ClientImpl(const std::string &host, int port,
  2237. const std::string &client_cert_path,
  2238. const std::string &client_key_path);
  2239. virtual ~ClientImpl();
  2240. virtual bool is_valid() const;
  2241. struct StreamHandle {
  2242. std::unique_ptr<Response> response;
  2243. Error error = Error::Success;
  2244. StreamHandle() = default;
  2245. StreamHandle(const StreamHandle &) = delete;
  2246. StreamHandle &operator=(const StreamHandle &) = delete;
  2247. StreamHandle(StreamHandle &&) = default;
  2248. StreamHandle &operator=(StreamHandle &&) = default;
  2249. ~StreamHandle() = default;
  2250. bool is_valid() const {
  2251. return response != nullptr && error == Error::Success;
  2252. }
  2253. ssize_t read(char *buf, size_t len);
  2254. void parse_trailers_if_needed();
  2255. Error get_read_error() const { return body_reader_.last_error; }
  2256. bool has_read_error() const { return body_reader_.has_error(); }
  2257. bool trailers_parsed_ = false;
  2258. private:
  2259. friend class ClientImpl;
  2260. ssize_t read_with_decompression(char *buf, size_t len);
  2261. std::unique_ptr<ClientConnection> connection_;
  2262. std::unique_ptr<Stream> socket_stream_;
  2263. Stream *stream_ = nullptr;
  2264. detail::BodyReader body_reader_;
  2265. std::unique_ptr<detail::decompressor> decompressor_;
  2266. std::string decompress_buffer_;
  2267. size_t decompress_offset_ = 0;
  2268. size_t decompressed_bytes_read_ = 0;
  2269. };
  2270. // clang-format off
  2271. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2272. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2273. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2274. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2275. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2276. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2277. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2278. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2279. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2280. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2281. Result Head(const std::string &path);
  2282. Result Head(const std::string &path, const Headers &headers);
  2283. Result Post(const std::string &path);
  2284. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2285. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2286. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2287. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2288. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2289. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2290. Result Post(const std::string &path, const Params &params);
  2291. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2292. Result Post(const std::string &path, const Headers &headers);
  2293. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2294. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2295. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2296. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2297. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2299. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2300. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2301. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2302. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2303. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2304. Result Put(const std::string &path);
  2305. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2306. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2307. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2308. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2309. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2310. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2311. Result Put(const std::string &path, const Params &params);
  2312. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2313. Result Put(const std::string &path, const Headers &headers);
  2314. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2315. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2317. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2318. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2320. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2321. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2322. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2323. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2324. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2325. Result Patch(const std::string &path);
  2326. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2327. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2329. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2330. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2331. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2332. Result Patch(const std::string &path, const Params &params);
  2333. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2334. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2335. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2338. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2339. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2342. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2343. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2344. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2346. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2347. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2348. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2349. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2350. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2351. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2352. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2353. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2354. Result Options(const std::string &path);
  2355. Result Options(const std::string &path, const Headers &headers);
  2356. // clang-format on
  2357. // Streaming API: Open a stream for reading response body incrementally
  2358. // Socket ownership is transferred to StreamHandle for true streaming
  2359. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2360. StreamHandle open_stream(const std::string &method, const std::string &path,
  2361. const Params &params = {},
  2362. const Headers &headers = {},
  2363. const std::string &body = {},
  2364. const std::string &content_type = {});
  2365. bool send(Request &req, Response &res, Error &error);
  2366. Result send(const Request &req);
  2367. void stop();
  2368. std::string host() const;
  2369. int port() const;
  2370. size_t is_socket_open() const;
  2371. socket_t socket() const;
  2372. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2373. void set_default_headers(Headers headers);
  2374. void
  2375. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2376. void set_address_family(int family);
  2377. void set_tcp_nodelay(bool on);
  2378. void set_ipv6_v6only(bool on);
  2379. void set_socket_options(SocketOptions socket_options);
  2380. void set_connection_timeout(time_t sec, time_t usec = 0);
  2381. template <class Rep, class Period>
  2382. void
  2383. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2384. void set_read_timeout(time_t sec, time_t usec = 0);
  2385. template <class Rep, class Period>
  2386. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2387. void set_write_timeout(time_t sec, time_t usec = 0);
  2388. template <class Rep, class Period>
  2389. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2390. void set_max_timeout(time_t msec);
  2391. template <class Rep, class Period>
  2392. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2393. void set_basic_auth(const std::string &username, const std::string &password);
  2394. void set_bearer_token_auth(const std::string &token);
  2395. void set_keep_alive(bool on);
  2396. void set_follow_location(bool on);
  2397. void set_path_encode(bool on);
  2398. void set_compress(bool on);
  2399. void set_decompress(bool on);
  2400. void set_payload_max_length(size_t length);
  2401. void set_interface(const std::string &intf);
  2402. void set_proxy(const std::string &host, int port);
  2403. void set_proxy_basic_auth(const std::string &username,
  2404. const std::string &password);
  2405. void set_proxy_bearer_token_auth(const std::string &token);
  2406. void set_no_proxy(const std::vector<std::string> &patterns);
  2407. void set_logger(Logger logger);
  2408. void set_error_logger(ErrorLogger error_logger);
  2409. protected:
  2410. struct Socket {
  2411. socket_t sock = INVALID_SOCKET;
  2412. // For Mbed TLS compatibility: start_time for request timeout tracking
  2413. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2414. bool is_open() const { return sock != INVALID_SOCKET; }
  2415. #ifdef CPPHTTPLIB_SSL_ENABLED
  2416. tls::session_t ssl = nullptr;
  2417. #endif
  2418. };
  2419. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2420. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2421. virtual bool setup_proxy_connection(
  2422. Socket &socket,
  2423. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2424. Response &res, bool &success, Error &error);
  2425. bool is_proxy_enabled_for_host(const std::string &host) const;
  2426. // All of:
  2427. // shutdown_ssl
  2428. // shutdown_socket
  2429. // close_socket
  2430. // disconnect
  2431. // should ONLY be called when socket_mutex_ is locked, and only when
  2432. // no other thread is using the socket.
  2433. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2434. void shutdown_socket(Socket &socket) const;
  2435. void close_socket(Socket &socket);
  2436. void disconnect(bool gracefully);
  2437. bool process_request(Stream &strm, Request &req, Response &res,
  2438. bool close_connection, Error &error);
  2439. bool write_content_with_provider(Stream &strm, const Request &req,
  2440. Error &error) const;
  2441. void copy_settings(const ClientImpl &rhs);
  2442. void output_log(const Request &req, const Response &res) const;
  2443. void output_error_log(const Error &err, const Request *req) const;
  2444. // Socket endpoint information
  2445. const std::string host_;
  2446. const int port_;
  2447. // Current open socket
  2448. Socket socket_;
  2449. mutable std::mutex socket_mutex_;
  2450. std::recursive_mutex request_mutex_;
  2451. // These are all protected under socket_mutex
  2452. size_t socket_requests_in_flight_ = 0;
  2453. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2454. bool socket_should_be_closed_when_request_is_done_ = false;
  2455. // Hostname to connection target map. The value is an IP literal or another
  2456. // hostname; only the connection target changes, never the identity.
  2457. std::map<std::string, std::string> addr_map_;
  2458. // Default headers
  2459. Headers default_headers_;
  2460. // Header writer
  2461. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2462. detail::write_headers;
  2463. // Settings
  2464. std::string client_cert_path_;
  2465. std::string client_key_path_;
  2466. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2467. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2468. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2469. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2470. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2471. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2472. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2473. std::string basic_auth_username_;
  2474. std::string basic_auth_password_;
  2475. std::string bearer_token_auth_token_;
  2476. bool keep_alive_ = false;
  2477. bool follow_location_ = false;
  2478. bool path_encode_ = true;
  2479. int address_family_ = AF_UNSPEC;
  2480. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2481. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2482. SocketOptions socket_options_ = nullptr;
  2483. bool compress_ = false;
  2484. bool decompress_ = true;
  2485. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2486. bool has_payload_max_length_ = false;
  2487. std::string interface_;
  2488. std::string proxy_host_;
  2489. int proxy_port_ = -1;
  2490. std::string proxy_basic_auth_username_;
  2491. std::string proxy_basic_auth_password_;
  2492. std::string proxy_bearer_token_auth_token_;
  2493. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2494. mutable detail::NormalizedTarget host_normalized_;
  2495. mutable bool host_normalized_valid_ = false;
  2496. mutable std::mutex logger_mutex_;
  2497. Logger logger_;
  2498. ErrorLogger error_logger_;
  2499. private:
  2500. bool send_(Request &req, Response &res, Error &error);
  2501. Result send_(Request &&req);
  2502. socket_t create_client_socket(Error &error) const;
  2503. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2504. bool skip_100_continue = true) const;
  2505. bool write_request(Stream &strm, Request &req, bool close_connection,
  2506. Error &error, bool skip_body, bool &rejected_locally);
  2507. bool write_request_body(Stream &strm, Request &req, Error &error);
  2508. void prepare_default_headers(Request &r, bool for_stream,
  2509. const std::string &ct);
  2510. bool redirect(Request &req, Response &res, Error &error);
  2511. bool create_redirect_client(const std::string &scheme,
  2512. const std::string &host, int port, Request &req,
  2513. Response &res, const std::string &path,
  2514. const std::string &location, Error &error);
  2515. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2516. bool handle_request(Stream &strm, Request &req, Response &res,
  2517. bool close_connection, Error &error);
  2518. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2519. Request &req, const char *body, size_t content_length,
  2520. ContentProvider content_provider,
  2521. ContentProviderWithoutLength content_provider_without_length,
  2522. const std::string &content_type, ContentReceiver content_receiver,
  2523. Error &error);
  2524. Result send_with_content_provider_and_receiver(
  2525. const std::string &method, const std::string &path,
  2526. const Headers &headers, const char *body, size_t content_length,
  2527. ContentProvider content_provider,
  2528. ContentProviderWithoutLength content_provider_without_length,
  2529. const std::string &content_type, ContentReceiver content_receiver,
  2530. UploadProgress progress);
  2531. ContentProviderWithoutLength get_multipart_content_provider(
  2532. const std::string &boundary, const UploadFormDataItems &items,
  2533. const FormDataProviderItems &provider_items) const;
  2534. virtual bool
  2535. process_socket(const Socket &socket,
  2536. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2537. std::function<bool(Stream &strm)> callback);
  2538. virtual bool is_ssl() const;
  2539. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2540. #ifdef CPPHTTPLIB_SSL_ENABLED
  2541. public:
  2542. void set_digest_auth(const std::string &username,
  2543. const std::string &password);
  2544. void set_proxy_digest_auth(const std::string &username,
  2545. const std::string &password);
  2546. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2547. const std::string &ca_cert_dir_path = std::string());
  2548. void enable_server_certificate_verification(bool enabled);
  2549. void enable_server_hostname_verification(bool enabled);
  2550. void enable_system_ca(bool enabled);
  2551. protected:
  2552. std::string digest_auth_username_;
  2553. std::string digest_auth_password_;
  2554. std::string proxy_digest_auth_username_;
  2555. std::string proxy_digest_auth_password_;
  2556. std::string ca_cert_file_path_;
  2557. std::string ca_cert_dir_path_;
  2558. bool server_certificate_verification_ = true;
  2559. bool server_hostname_verification_ = true;
  2560. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2561. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2562. int last_ssl_error_ = 0;
  2563. uint64_t last_backend_error_ = 0;
  2564. #endif
  2565. };
  2566. class Client {
  2567. public:
  2568. // Universal interface
  2569. explicit Client(const std::string &scheme_host_port);
  2570. explicit Client(const std::string &scheme_host_port,
  2571. const std::string &client_cert_path,
  2572. const std::string &client_key_path);
  2573. // HTTP only interface
  2574. explicit Client(const std::string &host, int port);
  2575. explicit Client(const std::string &host, int port,
  2576. const std::string &client_cert_path,
  2577. const std::string &client_key_path);
  2578. Client(Client &&) = default;
  2579. Client &operator=(Client &&) = default;
  2580. ~Client();
  2581. bool is_valid() const;
  2582. // clang-format off
  2583. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2584. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2585. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2586. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2587. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2588. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2589. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2590. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2591. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2592. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2593. Result Head(const std::string &path);
  2594. Result Head(const std::string &path, const Headers &headers);
  2595. Result Post(const std::string &path);
  2596. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2597. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2598. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2599. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2600. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2601. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2602. Result Post(const std::string &path, const Params &params);
  2603. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2604. Result Post(const std::string &path, const Headers &headers);
  2605. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2606. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2607. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2608. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2609. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2611. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2612. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2614. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2615. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2616. Result Put(const std::string &path);
  2617. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2618. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2619. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2620. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2621. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2622. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2623. Result Put(const std::string &path, const Params &params);
  2624. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2625. Result Put(const std::string &path, const Headers &headers);
  2626. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2627. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2628. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2629. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2630. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2632. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2633. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2635. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2636. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2637. Result Patch(const std::string &path);
  2638. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2639. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2642. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2643. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2644. Result Patch(const std::string &path, const Params &params);
  2645. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2646. Result Patch(const std::string &path, const Headers &headers);
  2647. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2648. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2650. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2651. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2653. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2654. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2656. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2657. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2658. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2659. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2660. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2661. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2662. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2663. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2664. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2665. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2666. Result Options(const std::string &path);
  2667. Result Options(const std::string &path, const Headers &headers);
  2668. // clang-format on
  2669. // Streaming API: Open a stream for reading response body incrementally
  2670. // Socket ownership is transferred to StreamHandle for true streaming
  2671. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2672. ClientImpl::StreamHandle open_stream(const std::string &method,
  2673. const std::string &path,
  2674. const Params &params = {},
  2675. const Headers &headers = {},
  2676. const std::string &body = {},
  2677. const std::string &content_type = {});
  2678. bool send(Request &req, Response &res, Error &error);
  2679. Result send(const Request &req);
  2680. void stop();
  2681. std::string host() const;
  2682. int port() const;
  2683. size_t is_socket_open() const;
  2684. socket_t socket() const;
  2685. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2686. void set_default_headers(Headers headers);
  2687. void
  2688. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2689. void set_address_family(int family);
  2690. void set_tcp_nodelay(bool on);
  2691. void set_socket_options(SocketOptions socket_options);
  2692. void set_connection_timeout(time_t sec, time_t usec = 0);
  2693. template <class Rep, class Period>
  2694. void
  2695. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2696. void set_read_timeout(time_t sec, time_t usec = 0);
  2697. template <class Rep, class Period>
  2698. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2699. void set_write_timeout(time_t sec, time_t usec = 0);
  2700. template <class Rep, class Period>
  2701. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2702. void set_max_timeout(time_t msec);
  2703. template <class Rep, class Period>
  2704. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2705. void set_basic_auth(const std::string &username, const std::string &password);
  2706. void set_bearer_token_auth(const std::string &token);
  2707. void set_keep_alive(bool on);
  2708. void set_follow_location(bool on);
  2709. void set_path_encode(bool on);
  2710. void set_compress(bool on);
  2711. void set_decompress(bool on);
  2712. void set_payload_max_length(size_t length);
  2713. void set_interface(const std::string &intf);
  2714. void set_proxy(const std::string &host, int port);
  2715. void set_proxy_basic_auth(const std::string &username,
  2716. const std::string &password);
  2717. void set_proxy_bearer_token_auth(const std::string &token);
  2718. void set_no_proxy(const std::vector<std::string> &patterns);
  2719. void set_logger(Logger logger);
  2720. void set_error_logger(ErrorLogger error_logger);
  2721. private:
  2722. std::unique_ptr<ClientImpl> cli_;
  2723. #ifdef CPPHTTPLIB_SSL_ENABLED
  2724. public:
  2725. void set_digest_auth(const std::string &username,
  2726. const std::string &password);
  2727. void set_proxy_digest_auth(const std::string &username,
  2728. const std::string &password);
  2729. void enable_server_certificate_verification(bool enabled);
  2730. void enable_server_hostname_verification(bool enabled);
  2731. void enable_system_ca(bool enabled);
  2732. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2733. const std::string &ca_cert_dir_path = std::string());
  2734. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2735. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2736. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2737. void set_session_verifier(
  2738. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2739. tls::ctx_t tls_context() const;
  2740. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2741. void enable_windows_certificate_verification(bool enabled);
  2742. #endif
  2743. private:
  2744. bool is_ssl_ = false;
  2745. #endif
  2746. };
  2747. #ifdef CPPHTTPLIB_SSL_ENABLED
  2748. class SSLServer : public Server {
  2749. public:
  2750. SSLServer(const char *cert_path, const char *private_key_path,
  2751. const char *client_ca_cert_file_path = nullptr,
  2752. const char *client_ca_cert_dir_path = nullptr,
  2753. const char *private_key_password = nullptr);
  2754. struct PemMemory {
  2755. const char *cert_pem;
  2756. size_t cert_pem_len;
  2757. const char *key_pem;
  2758. size_t key_pem_len;
  2759. const char *client_ca_pem;
  2760. size_t client_ca_pem_len;
  2761. const char *private_key_password;
  2762. };
  2763. explicit SSLServer(const PemMemory &pem);
  2764. // The callback receives the ctx_t handle which can be cast to the
  2765. // appropriate backend type (SSL_CTX* for OpenSSL,
  2766. // tls::impl::MbedTlsContext* for Mbed TLS)
  2767. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2768. ~SSLServer() override;
  2769. bool is_valid() const override;
  2770. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2771. const char *client_ca_pem = nullptr,
  2772. const char *password = nullptr);
  2773. tls::ctx_t tls_context() const { return ctx_; }
  2774. int ssl_last_error() const { return last_ssl_error_; }
  2775. private:
  2776. bool process_and_close_socket(socket_t sock) override;
  2777. tls::ctx_t ctx_ = nullptr;
  2778. std::mutex ctx_mutex_;
  2779. int last_ssl_error_ = 0;
  2780. };
  2781. class SSLClient final : public ClientImpl {
  2782. public:
  2783. explicit SSLClient(const std::string &host);
  2784. explicit SSLClient(const std::string &host, int port);
  2785. explicit SSLClient(const std::string &host, int port,
  2786. const std::string &client_cert_path,
  2787. const std::string &client_key_path,
  2788. const std::string &private_key_password = std::string());
  2789. struct PemMemory {
  2790. const char *cert_pem;
  2791. size_t cert_pem_len;
  2792. const char *key_pem;
  2793. size_t key_pem_len;
  2794. const char *private_key_password;
  2795. };
  2796. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2797. ~SSLClient() override;
  2798. bool is_valid() const override;
  2799. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2800. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2801. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2802. // Post-handshake session verifier (backend-independent)
  2803. void set_session_verifier(
  2804. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2805. tls::ctx_t tls_context() const { return ctx_; }
  2806. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2807. void enable_windows_certificate_verification(bool enabled);
  2808. #endif
  2809. private:
  2810. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2811. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2812. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2813. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2814. bool
  2815. process_socket(const Socket &socket,
  2816. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2817. std::function<bool(Stream &strm)> callback) override;
  2818. bool is_ssl() const override;
  2819. bool setup_proxy_connection(
  2820. Socket &socket,
  2821. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2822. Response &res, bool &success, Error &error) override;
  2823. bool connect_with_proxy(
  2824. Socket &sock,
  2825. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2826. Response &res, bool &success, Error &error);
  2827. bool initialize_ssl(Socket &socket, Error &error);
  2828. void init_ctx();
  2829. void reset_ctx_on_error();
  2830. bool load_certs();
  2831. tls::ctx_t ctx_ = nullptr;
  2832. std::mutex ctx_mutex_;
  2833. std::once_flag initialize_cert_;
  2834. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2835. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2836. // Used to keep custom CA configuration exclusive with system CA loading.
  2837. bool ca_cert_store_set_ = false;
  2838. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2839. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2840. bool enable_windows_cert_verification_ = true;
  2841. #endif
  2842. friend class ClientImpl;
  2843. };
  2844. #endif // CPPHTTPLIB_SSL_ENABLED
  2845. namespace detail {
  2846. template <typename T, typename U>
  2847. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2848. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2849. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2850. duration - std::chrono::seconds(sec))
  2851. .count();
  2852. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2853. }
  2854. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2855. return N - 1;
  2856. }
  2857. inline bool is_numeric(const std::string &str) {
  2858. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2859. }
  2860. inline size_t get_header_value_u64(const Headers &headers,
  2861. const std::string &key, size_t def,
  2862. size_t id, bool &is_invalid_value) {
  2863. is_invalid_value = false;
  2864. auto rng = headers.equal_range(key);
  2865. auto it = rng.first;
  2866. std::advance(it, static_cast<ssize_t>(id));
  2867. if (it != rng.second) {
  2868. if (is_numeric(it->second)) {
  2869. // Parse at size_t width so an out-of-range Content-Length is reported
  2870. // rather than silently saturated/truncated (a value above 2^32 would
  2871. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2872. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2873. size_t val = 0;
  2874. const auto &s = it->second;
  2875. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2876. if (r.ec == std::errc::result_out_of_range) {
  2877. is_invalid_value = true;
  2878. return (std::numeric_limits<size_t>::max)();
  2879. }
  2880. return val;
  2881. } else {
  2882. is_invalid_value = true;
  2883. }
  2884. }
  2885. return def;
  2886. }
  2887. inline size_t get_header_value_u64(const Headers &headers,
  2888. const std::string &key, size_t def,
  2889. size_t id) {
  2890. auto dummy = false;
  2891. return get_header_value_u64(headers, key, def, id, dummy);
  2892. }
  2893. } // namespace detail
  2894. template <class Rep, class Period>
  2895. inline Server &
  2896. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2897. detail::duration_to_sec_and_usec(
  2898. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2899. return *this;
  2900. }
  2901. template <class Rep, class Period>
  2902. inline Server &
  2903. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2904. detail::duration_to_sec_and_usec(
  2905. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2906. return *this;
  2907. }
  2908. template <class Rep, class Period>
  2909. inline Server &
  2910. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2911. detail::duration_to_sec_and_usec(
  2912. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2913. return *this;
  2914. }
  2915. template <class Rep, class Period>
  2916. inline void ClientImpl::set_connection_timeout(
  2917. const std::chrono::duration<Rep, Period> &duration) {
  2918. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2919. set_connection_timeout(sec, usec);
  2920. });
  2921. }
  2922. template <class Rep, class Period>
  2923. inline void ClientImpl::set_read_timeout(
  2924. const std::chrono::duration<Rep, Period> &duration) {
  2925. detail::duration_to_sec_and_usec(
  2926. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2927. }
  2928. template <class Rep, class Period>
  2929. inline void ClientImpl::set_write_timeout(
  2930. const std::chrono::duration<Rep, Period> &duration) {
  2931. detail::duration_to_sec_and_usec(
  2932. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2933. }
  2934. template <class Rep, class Period>
  2935. inline void ClientImpl::set_max_timeout(
  2936. const std::chrono::duration<Rep, Period> &duration) {
  2937. auto msec =
  2938. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2939. set_max_timeout(msec);
  2940. }
  2941. template <class Rep, class Period>
  2942. inline void Client::set_connection_timeout(
  2943. const std::chrono::duration<Rep, Period> &duration) {
  2944. cli_->set_connection_timeout(duration);
  2945. }
  2946. template <class Rep, class Period>
  2947. inline void
  2948. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2949. cli_->set_read_timeout(duration);
  2950. }
  2951. template <class Rep, class Period>
  2952. inline void
  2953. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2954. cli_->set_write_timeout(duration);
  2955. }
  2956. inline void Client::set_max_timeout(time_t msec) {
  2957. cli_->set_max_timeout(msec);
  2958. }
  2959. template <class Rep, class Period>
  2960. inline void
  2961. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2962. cli_->set_max_timeout(duration);
  2963. }
  2964. /*
  2965. * Forward declarations and types that will be part of the .h file if split into
  2966. * .h + .cc.
  2967. */
  2968. std::string hosted_at(const std::string &hostname);
  2969. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2970. // JavaScript-style URL encoding/decoding functions
  2971. std::string encode_uri_component(const std::string &value);
  2972. std::string encode_uri(const std::string &value);
  2973. std::string decode_uri_component(const std::string &value);
  2974. std::string decode_uri(const std::string &value);
  2975. // RFC 3986 compliant URL component encoding/decoding functions
  2976. std::string encode_path_component(const std::string &component);
  2977. std::string decode_path_component(const std::string &component);
  2978. std::string encode_query_component(const std::string &component,
  2979. bool space_as_plus = true);
  2980. std::string decode_query_component(const std::string &component,
  2981. bool plus_as_space = true);
  2982. std::string sanitize_filename(const std::string &filename);
  2983. std::string append_query_params(const std::string &path, const Params &params);
  2984. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2985. std::pair<std::string, std::string>
  2986. make_basic_authentication_header(const std::string &username,
  2987. const std::string &password,
  2988. bool is_proxy = false);
  2989. namespace detail {
  2990. #if defined(_WIN32)
  2991. inline std::wstring u8string_to_wstring(const char *s) {
  2992. if (!s) { return std::wstring(); }
  2993. auto len = static_cast<int>(strlen(s));
  2994. if (!len) { return std::wstring(); }
  2995. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2996. if (!wlen) { return std::wstring(); }
  2997. std::wstring ws;
  2998. ws.resize(wlen);
  2999. wlen = ::MultiByteToWideChar(
  3000. CP_UTF8, 0, s, len,
  3001. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3002. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3003. return ws;
  3004. }
  3005. #endif
  3006. struct FileStat {
  3007. FileStat(const std::string &path);
  3008. bool is_file() const;
  3009. bool is_dir() const;
  3010. time_t mtime() const;
  3011. size_t size() const;
  3012. private:
  3013. #if defined(_WIN32)
  3014. struct _stat st_;
  3015. #else
  3016. struct stat st_;
  3017. #endif
  3018. int ret_ = -1;
  3019. };
  3020. std::string make_host_and_port_string(const std::string &host, int port,
  3021. bool is_ssl);
  3022. template <typename T>
  3023. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3024. Error &error);
  3025. std::string trim_copy(const std::string &s);
  3026. void divide(
  3027. const char *data, std::size_t size, char d,
  3028. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3029. fn);
  3030. void divide(
  3031. const std::string &str, char d,
  3032. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3033. fn);
  3034. void split(const char *b, const char *e, char d,
  3035. std::function<void(const char *, const char *)> fn);
  3036. void split(const char *b, const char *e, char d, size_t m,
  3037. std::function<void(const char *, const char *)> fn);
  3038. bool split_find(const char *b, const char *e, char d,
  3039. std::function<bool(const char *, const char *)> fn);
  3040. bool has_header_token(const Headers &headers, const std::string &key,
  3041. const std::string &token);
  3042. std::string websocket_accept_key(const std::string &client_key);
  3043. bool is_websocket_upgrade(const Request &req);
  3044. bool process_client_socket(
  3045. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3046. time_t write_timeout_sec, time_t write_timeout_usec,
  3047. time_t max_timeout_msec,
  3048. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3049. std::function<bool(Stream &)> callback);
  3050. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3051. int port, int address_family, bool tcp_nodelay,
  3052. bool ipv6_v6only, SocketOptions socket_options,
  3053. time_t connection_timeout_sec,
  3054. time_t connection_timeout_usec,
  3055. time_t read_timeout_sec, time_t read_timeout_usec,
  3056. time_t write_timeout_sec,
  3057. time_t write_timeout_usec,
  3058. const std::string &intf, Error &error);
  3059. const char *get_header_value(const Headers &headers, const std::string &key,
  3060. const char *def, size_t id);
  3061. std::string get_combined_header_value(const Headers &headers,
  3062. const std::string &key);
  3063. std::string params_to_query_str(const Params &params);
  3064. void parse_query_text(const char *data, std::size_t size, Params &params);
  3065. void parse_query_text(const std::string &s, Params &params);
  3066. bool parse_multipart_boundary(const std::string &content_type,
  3067. std::string &boundary);
  3068. bool parse_range_header(const std::string &s, Ranges &ranges);
  3069. bool parse_accept_header(const std::string &s,
  3070. std::vector<std::string> &content_types);
  3071. void parse_disposition_params(const std::string &s, Params &params);
  3072. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3073. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3074. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3075. EncodingType encoding_type(const Request &req, const Response &res,
  3076. const std::string &content_type);
  3077. EncodingType encoding_type(const Request &req, const Response &res);
  3078. class BufferStream final : public Stream {
  3079. public:
  3080. BufferStream() = default;
  3081. ~BufferStream() override = default;
  3082. bool is_readable() const override;
  3083. bool wait_readable() const override;
  3084. bool wait_writable() const override;
  3085. ssize_t read(char *ptr, size_t size) override;
  3086. ssize_t write(const char *ptr, size_t size) override;
  3087. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3088. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3089. socket_t socket() const override;
  3090. time_t duration() const override;
  3091. const std::string &get_buffer() const;
  3092. private:
  3093. std::string buffer;
  3094. size_t position = 0;
  3095. };
  3096. class compressor {
  3097. public:
  3098. virtual ~compressor() = default;
  3099. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3100. virtual bool compress(const char *data, size_t data_length, bool last,
  3101. Callback callback) = 0;
  3102. };
  3103. class decompressor {
  3104. public:
  3105. virtual ~decompressor() = default;
  3106. virtual bool is_valid() const = 0;
  3107. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3108. virtual bool decompress(const char *data, size_t data_length,
  3109. Callback callback) = 0;
  3110. };
  3111. class nocompressor final : public compressor {
  3112. public:
  3113. ~nocompressor() override = default;
  3114. bool compress(const char *data, size_t data_length, bool /*last*/,
  3115. Callback callback) override;
  3116. };
  3117. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3118. class gzip_compressor final : public compressor {
  3119. public:
  3120. gzip_compressor();
  3121. ~gzip_compressor() override;
  3122. bool compress(const char *data, size_t data_length, bool last,
  3123. Callback callback) override;
  3124. private:
  3125. bool is_valid_ = false;
  3126. z_stream strm_;
  3127. };
  3128. class gzip_decompressor final : public decompressor {
  3129. public:
  3130. gzip_decompressor();
  3131. ~gzip_decompressor() override;
  3132. bool is_valid() const override;
  3133. bool decompress(const char *data, size_t data_length,
  3134. Callback callback) override;
  3135. private:
  3136. bool is_valid_ = false;
  3137. z_stream strm_;
  3138. };
  3139. #endif
  3140. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3141. class brotli_compressor final : public compressor {
  3142. public:
  3143. brotli_compressor();
  3144. ~brotli_compressor();
  3145. bool compress(const char *data, size_t data_length, bool last,
  3146. Callback callback) override;
  3147. private:
  3148. BrotliEncoderState *state_ = nullptr;
  3149. };
  3150. class brotli_decompressor final : public decompressor {
  3151. public:
  3152. brotli_decompressor();
  3153. ~brotli_decompressor();
  3154. bool is_valid() const override;
  3155. bool decompress(const char *data, size_t data_length,
  3156. Callback callback) override;
  3157. private:
  3158. BrotliDecoderResult decoder_r;
  3159. BrotliDecoderState *decoder_s = nullptr;
  3160. };
  3161. #endif
  3162. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3163. class zstd_compressor : public compressor {
  3164. public:
  3165. zstd_compressor();
  3166. ~zstd_compressor();
  3167. bool compress(const char *data, size_t data_length, bool last,
  3168. Callback callback) override;
  3169. private:
  3170. ZSTD_CCtx *ctx_ = nullptr;
  3171. };
  3172. class zstd_decompressor : public decompressor {
  3173. public:
  3174. zstd_decompressor();
  3175. ~zstd_decompressor();
  3176. bool is_valid() const override;
  3177. bool decompress(const char *data, size_t data_length,
  3178. Callback callback) override;
  3179. private:
  3180. ZSTD_DCtx *ctx_ = nullptr;
  3181. };
  3182. #endif
  3183. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3184. // to store data. The call can set memory on stack for performance.
  3185. class stream_line_reader {
  3186. public:
  3187. stream_line_reader(Stream &strm, char *fixed_buffer,
  3188. size_t fixed_buffer_size);
  3189. const char *ptr() const;
  3190. size_t size() const;
  3191. bool end_with_crlf() const;
  3192. bool getline();
  3193. private:
  3194. void append(char c);
  3195. void append(const char *data, size_t size);
  3196. Stream &strm_;
  3197. char *fixed_buffer_;
  3198. const size_t fixed_buffer_size_;
  3199. size_t fixed_buffer_used_size_ = 0;
  3200. std::string growable_buffer_;
  3201. };
  3202. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3203. const Headers &src_headers);
  3204. struct ChunkedDecoder {
  3205. Stream &strm;
  3206. size_t chunk_remaining = 0;
  3207. bool finished = false;
  3208. char line_buf[64];
  3209. size_t last_chunk_total = 0;
  3210. size_t last_chunk_offset = 0;
  3211. explicit ChunkedDecoder(Stream &s);
  3212. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3213. size_t &out_chunk_total);
  3214. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3215. };
  3216. class mmap {
  3217. public:
  3218. mmap(const char *path);
  3219. ~mmap();
  3220. bool open(const char *path);
  3221. void close();
  3222. bool is_open() const;
  3223. size_t size() const;
  3224. const char *data() const;
  3225. private:
  3226. #if defined(_WIN32)
  3227. HANDLE hFile_ = NULL;
  3228. HANDLE hMapping_ = NULL;
  3229. #else
  3230. int fd_ = -1;
  3231. #endif
  3232. size_t size_ = 0;
  3233. void *addr_ = nullptr;
  3234. bool is_open_empty_file = false;
  3235. };
  3236. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3237. namespace fields {
  3238. bool is_token_char(char c);
  3239. bool is_token(const std::string &s);
  3240. bool is_field_name(const std::string &s);
  3241. bool is_vchar(char c);
  3242. bool is_obs_text(char c);
  3243. bool is_field_vchar(char c);
  3244. bool is_field_content(const std::string &s);
  3245. bool is_field_value(const std::string &s);
  3246. bool is_field_valid(const std::string &name, const std::string &value);
  3247. bool is_request_target(const std::string &s);
  3248. } // namespace fields
  3249. } // namespace detail
  3250. /*
  3251. * TLS Abstraction Layer Declarations
  3252. */
  3253. #ifdef CPPHTTPLIB_SSL_ENABLED
  3254. // TLS abstraction layer - backend-specific type declarations
  3255. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3256. namespace tls {
  3257. namespace impl {
  3258. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3259. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3260. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3261. struct MbedTlsContext {
  3262. mbedtls_ssl_config conf;
  3263. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3264. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3265. mbedtls_entropy_context entropy;
  3266. mbedtls_ctr_drbg_context ctr_drbg;
  3267. #endif
  3268. mbedtls_x509_crt ca_chain;
  3269. mbedtls_x509_crt own_cert;
  3270. mbedtls_pk_context own_key;
  3271. bool is_server = false;
  3272. bool verify_client = false;
  3273. bool has_verify_callback = false;
  3274. MbedTlsContext();
  3275. ~MbedTlsContext();
  3276. MbedTlsContext(const MbedTlsContext &) = delete;
  3277. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3278. };
  3279. } // namespace impl
  3280. } // namespace tls
  3281. #endif
  3282. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3283. namespace tls {
  3284. namespace impl {
  3285. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3286. // This struct is accessible via tls::impl for use in SSL context
  3287. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3288. struct WolfSSLContext {
  3289. WOLFSSL_CTX *ctx = nullptr;
  3290. bool is_server = false;
  3291. bool verify_client = false;
  3292. bool has_verify_callback = false;
  3293. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3294. WolfSSLContext();
  3295. ~WolfSSLContext();
  3296. WolfSSLContext(const WolfSSLContext &) = delete;
  3297. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3298. };
  3299. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3300. struct WolfSSLCAStore {
  3301. std::string pem_data;
  3302. };
  3303. } // namespace impl
  3304. } // namespace tls
  3305. #endif
  3306. #endif // CPPHTTPLIB_SSL_ENABLED
  3307. namespace stream {
  3308. class Result {
  3309. public:
  3310. Result();
  3311. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3312. Result(Result &&other) noexcept;
  3313. Result &operator=(Result &&other) noexcept;
  3314. Result(const Result &) = delete;
  3315. Result &operator=(const Result &) = delete;
  3316. // Response info
  3317. bool is_valid() const;
  3318. explicit operator bool() const;
  3319. int status() const;
  3320. const Headers &headers() const;
  3321. std::string get_header_value(const std::string &key,
  3322. const char *def = "") const;
  3323. bool has_header(const std::string &key) const;
  3324. Error error() const;
  3325. Error read_error() const;
  3326. bool has_read_error() const;
  3327. // Stream reading
  3328. bool next();
  3329. const char *data() const;
  3330. size_t size() const;
  3331. std::string read_all();
  3332. private:
  3333. ClientImpl::StreamHandle handle_;
  3334. std::string buffer_;
  3335. size_t current_size_ = 0;
  3336. size_t chunk_size_;
  3337. bool finished_ = false;
  3338. };
  3339. // GET
  3340. template <typename ClientType>
  3341. inline Result Get(ClientType &cli, const std::string &path,
  3342. size_t chunk_size = 8192) {
  3343. return Result{cli.open_stream("GET", path), chunk_size};
  3344. }
  3345. template <typename ClientType>
  3346. inline Result Get(ClientType &cli, const std::string &path,
  3347. const Headers &headers, size_t chunk_size = 8192) {
  3348. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3349. }
  3350. template <typename ClientType>
  3351. inline Result Get(ClientType &cli, const std::string &path,
  3352. const Params &params, size_t chunk_size = 8192) {
  3353. return Result{cli.open_stream("GET", path, params), chunk_size};
  3354. }
  3355. template <typename ClientType>
  3356. inline Result Get(ClientType &cli, const std::string &path,
  3357. const Params &params, const Headers &headers,
  3358. size_t chunk_size = 8192) {
  3359. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3360. }
  3361. // POST
  3362. template <typename ClientType>
  3363. inline Result Post(ClientType &cli, const std::string &path,
  3364. const std::string &body, const std::string &content_type,
  3365. size_t chunk_size = 8192) {
  3366. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3367. chunk_size};
  3368. }
  3369. template <typename ClientType>
  3370. inline Result Post(ClientType &cli, const std::string &path,
  3371. const Headers &headers, const std::string &body,
  3372. const std::string &content_type, size_t chunk_size = 8192) {
  3373. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3374. chunk_size};
  3375. }
  3376. template <typename ClientType>
  3377. inline Result Post(ClientType &cli, const std::string &path,
  3378. const Params &params, const std::string &body,
  3379. const std::string &content_type, size_t chunk_size = 8192) {
  3380. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3381. chunk_size};
  3382. }
  3383. template <typename ClientType>
  3384. inline Result Post(ClientType &cli, const std::string &path,
  3385. const Params &params, const Headers &headers,
  3386. const std::string &body, const std::string &content_type,
  3387. size_t chunk_size = 8192) {
  3388. return Result{
  3389. cli.open_stream("POST", path, params, headers, body, content_type),
  3390. chunk_size};
  3391. }
  3392. // PUT
  3393. template <typename ClientType>
  3394. inline Result Put(ClientType &cli, const std::string &path,
  3395. const std::string &body, const std::string &content_type,
  3396. size_t chunk_size = 8192) {
  3397. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3398. chunk_size};
  3399. }
  3400. template <typename ClientType>
  3401. inline Result Put(ClientType &cli, const std::string &path,
  3402. const Headers &headers, const std::string &body,
  3403. const std::string &content_type, size_t chunk_size = 8192) {
  3404. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3405. chunk_size};
  3406. }
  3407. template <typename ClientType>
  3408. inline Result Put(ClientType &cli, const std::string &path,
  3409. const Params &params, const std::string &body,
  3410. const std::string &content_type, size_t chunk_size = 8192) {
  3411. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3412. chunk_size};
  3413. }
  3414. template <typename ClientType>
  3415. inline Result Put(ClientType &cli, const std::string &path,
  3416. const Params &params, const Headers &headers,
  3417. const std::string &body, const std::string &content_type,
  3418. size_t chunk_size = 8192) {
  3419. return Result{
  3420. cli.open_stream("PUT", path, params, headers, body, content_type),
  3421. chunk_size};
  3422. }
  3423. // PATCH
  3424. template <typename ClientType>
  3425. inline Result Patch(ClientType &cli, const std::string &path,
  3426. const std::string &body, const std::string &content_type,
  3427. size_t chunk_size = 8192) {
  3428. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3429. chunk_size};
  3430. }
  3431. template <typename ClientType>
  3432. inline Result Patch(ClientType &cli, const std::string &path,
  3433. const Headers &headers, const std::string &body,
  3434. const std::string &content_type, size_t chunk_size = 8192) {
  3435. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3436. chunk_size};
  3437. }
  3438. template <typename ClientType>
  3439. inline Result Patch(ClientType &cli, const std::string &path,
  3440. const Params &params, const std::string &body,
  3441. const std::string &content_type, size_t chunk_size = 8192) {
  3442. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3443. chunk_size};
  3444. }
  3445. template <typename ClientType>
  3446. inline Result Patch(ClientType &cli, const std::string &path,
  3447. const Params &params, const Headers &headers,
  3448. const std::string &body, const std::string &content_type,
  3449. size_t chunk_size = 8192) {
  3450. return Result{
  3451. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3452. chunk_size};
  3453. }
  3454. // DELETE
  3455. template <typename ClientType>
  3456. inline Result Delete(ClientType &cli, const std::string &path,
  3457. size_t chunk_size = 8192) {
  3458. return Result{cli.open_stream("DELETE", path), chunk_size};
  3459. }
  3460. template <typename ClientType>
  3461. inline Result Delete(ClientType &cli, const std::string &path,
  3462. const Headers &headers, size_t chunk_size = 8192) {
  3463. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3464. }
  3465. template <typename ClientType>
  3466. inline Result Delete(ClientType &cli, const std::string &path,
  3467. const std::string &body, const std::string &content_type,
  3468. size_t chunk_size = 8192) {
  3469. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3470. chunk_size};
  3471. }
  3472. template <typename ClientType>
  3473. inline Result Delete(ClientType &cli, const std::string &path,
  3474. const Headers &headers, const std::string &body,
  3475. const std::string &content_type,
  3476. size_t chunk_size = 8192) {
  3477. return Result{
  3478. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3479. chunk_size};
  3480. }
  3481. template <typename ClientType>
  3482. inline Result Delete(ClientType &cli, const std::string &path,
  3483. const Params &params, size_t chunk_size = 8192) {
  3484. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3485. }
  3486. template <typename ClientType>
  3487. inline Result Delete(ClientType &cli, const std::string &path,
  3488. const Params &params, const Headers &headers,
  3489. size_t chunk_size = 8192) {
  3490. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3491. }
  3492. template <typename ClientType>
  3493. inline Result Delete(ClientType &cli, const std::string &path,
  3494. const Params &params, const std::string &body,
  3495. const std::string &content_type,
  3496. size_t chunk_size = 8192) {
  3497. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3498. chunk_size};
  3499. }
  3500. template <typename ClientType>
  3501. inline Result Delete(ClientType &cli, const std::string &path,
  3502. const Params &params, const Headers &headers,
  3503. const std::string &body, const std::string &content_type,
  3504. size_t chunk_size = 8192) {
  3505. return Result{
  3506. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3507. chunk_size};
  3508. }
  3509. // HEAD
  3510. template <typename ClientType>
  3511. inline Result Head(ClientType &cli, const std::string &path,
  3512. size_t chunk_size = 8192) {
  3513. return Result{cli.open_stream("HEAD", path), chunk_size};
  3514. }
  3515. template <typename ClientType>
  3516. inline Result Head(ClientType &cli, const std::string &path,
  3517. const Headers &headers, size_t chunk_size = 8192) {
  3518. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3519. }
  3520. template <typename ClientType>
  3521. inline Result Head(ClientType &cli, const std::string &path,
  3522. const Params &params, size_t chunk_size = 8192) {
  3523. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3524. }
  3525. template <typename ClientType>
  3526. inline Result Head(ClientType &cli, const std::string &path,
  3527. const Params &params, const Headers &headers,
  3528. size_t chunk_size = 8192) {
  3529. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3530. }
  3531. // OPTIONS
  3532. template <typename ClientType>
  3533. inline Result Options(ClientType &cli, const std::string &path,
  3534. size_t chunk_size = 8192) {
  3535. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3536. }
  3537. template <typename ClientType>
  3538. inline Result Options(ClientType &cli, const std::string &path,
  3539. const Headers &headers, size_t chunk_size = 8192) {
  3540. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3541. }
  3542. template <typename ClientType>
  3543. inline Result Options(ClientType &cli, const std::string &path,
  3544. const Params &params, size_t chunk_size = 8192) {
  3545. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3546. }
  3547. template <typename ClientType>
  3548. inline Result Options(ClientType &cli, const std::string &path,
  3549. const Params &params, const Headers &headers,
  3550. size_t chunk_size = 8192) {
  3551. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3552. }
  3553. } // namespace stream
  3554. namespace sse {
  3555. struct SSEMessage {
  3556. std::string event; // Event type (default: "message")
  3557. std::string data; // Event payload
  3558. std::string id; // Event ID for Last-Event-ID header
  3559. SSEMessage();
  3560. void clear();
  3561. };
  3562. class SSEClient {
  3563. public:
  3564. using MessageHandler = std::function<void(const SSEMessage &)>;
  3565. using ErrorHandler = std::function<void(Error)>;
  3566. using OpenHandler = std::function<void()>;
  3567. SSEClient(Client &client, const std::string &path);
  3568. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3569. ~SSEClient();
  3570. SSEClient(const SSEClient &) = delete;
  3571. SSEClient &operator=(const SSEClient &) = delete;
  3572. // Event handlers
  3573. SSEClient &on_message(MessageHandler handler);
  3574. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3575. SSEClient &on_open(OpenHandler handler);
  3576. SSEClient &on_error(ErrorHandler handler);
  3577. SSEClient &set_reconnect_interval(int ms);
  3578. SSEClient &set_max_reconnect_attempts(int n);
  3579. // Update headers (thread-safe)
  3580. SSEClient &set_headers(const Headers &headers);
  3581. // State accessors
  3582. bool is_connected() const;
  3583. const std::string &last_event_id() const;
  3584. // Blocking start - runs event loop with auto-reconnect
  3585. void start();
  3586. // Non-blocking start - runs in background thread
  3587. void start_async();
  3588. // Stop the client (thread-safe)
  3589. void stop();
  3590. private:
  3591. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3592. void run_event_loop();
  3593. void dispatch_event(const SSEMessage &msg);
  3594. bool should_reconnect(int count) const;
  3595. void wait_for_reconnect();
  3596. // Client and path
  3597. Client &client_;
  3598. std::string path_;
  3599. Headers headers_;
  3600. mutable std::mutex headers_mutex_;
  3601. // Callbacks
  3602. MessageHandler on_message_;
  3603. std::map<std::string, MessageHandler> event_handlers_;
  3604. OpenHandler on_open_;
  3605. ErrorHandler on_error_;
  3606. // Configuration
  3607. int reconnect_interval_ms_ = 3000;
  3608. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3609. // State
  3610. std::atomic<bool> running_{false};
  3611. std::atomic<bool> connected_{false};
  3612. std::string last_event_id_;
  3613. // Async support
  3614. std::thread async_thread_;
  3615. };
  3616. } // namespace sse
  3617. namespace ws {
  3618. enum class Opcode : uint8_t {
  3619. Continuation = 0x0,
  3620. Text = 0x1,
  3621. Binary = 0x2,
  3622. Close = 0x8,
  3623. Ping = 0x9,
  3624. Pong = 0xA,
  3625. };
  3626. enum class CloseStatus : uint16_t {
  3627. Normal = 1000,
  3628. GoingAway = 1001,
  3629. ProtocolError = 1002,
  3630. UnsupportedData = 1003,
  3631. NoStatus = 1005,
  3632. Abnormal = 1006,
  3633. InvalidPayload = 1007,
  3634. PolicyViolation = 1008,
  3635. MessageTooBig = 1009,
  3636. MandatoryExtension = 1010,
  3637. InternalError = 1011,
  3638. };
  3639. // Timeout is returned only when a read timeout was set and it elapsed before
  3640. // any byte of a frame arrived: nothing was consumed and the connection is
  3641. // still open, so the caller can send on it and read again. `msg` is left
  3642. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3643. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3644. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3645. // upgrade handshake fully succeeded. On failure error() identifies the
  3646. // failing layer; status()/headers() expose the server's upgrade response
  3647. // when one was received (status() is -1 otherwise).
  3648. class Result {
  3649. public:
  3650. Result() = default;
  3651. Result(Error err, int status, Headers &&headers)
  3652. : err_(err), status_(status), headers_(std::move(headers)) {}
  3653. explicit operator bool() const { return err_ == Error::Success; }
  3654. Error error() const { return err_; }
  3655. // Upgrade response info
  3656. int status() const { return status_; }
  3657. const Headers &headers() const { return headers_; }
  3658. std::string get_header_value(const std::string &key,
  3659. const char *def = "") const {
  3660. return detail::get_header_value(headers_, key, def, 0);
  3661. }
  3662. bool has_header(const std::string &key) const {
  3663. return headers_.find(key) != headers_.end();
  3664. }
  3665. #ifdef CPPHTTPLIB_SSL_ENABLED
  3666. Result(Error err, int status, Headers &&headers, int ssl_error,
  3667. uint64_t ssl_backend_error)
  3668. : err_(err), status_(status), headers_(std::move(headers)),
  3669. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3670. int ssl_error() const { return ssl_error_; }
  3671. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3672. #endif
  3673. private:
  3674. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3675. int status_ = -1;
  3676. Headers headers_;
  3677. #ifdef CPPHTTPLIB_SSL_ENABLED
  3678. int ssl_error_ = 0;
  3679. uint64_t ssl_backend_error_ = 0;
  3680. #endif
  3681. };
  3682. class WebSocket {
  3683. public:
  3684. WebSocket(const WebSocket &) = delete;
  3685. WebSocket &operator=(const WebSocket &) = delete;
  3686. ~WebSocket();
  3687. ReadResult read(std::string &msg);
  3688. bool send(const std::string &data);
  3689. bool send(const char *data, size_t len);
  3690. void close(CloseStatus status = CloseStatus::Normal,
  3691. const std::string &reason = "");
  3692. const Request &request() const;
  3693. bool is_open() const;
  3694. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3695. // A server handler owns its connection's timeout this way; a client sets it
  3696. // through WebSocketClient. Safe to call while another thread is in read().
  3697. //
  3698. // Only a timeout set here is reported as Timeout. The compile-time default
  3699. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3700. // than a request for control, so when it elapses read() returns Fail and
  3701. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3702. void set_read_timeout(time_t sec, time_t usec = 0);
  3703. template <class Rep, class Period>
  3704. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3705. private:
  3706. friend class httplib::Server;
  3707. friend class WebSocketClient;
  3708. WebSocket(
  3709. Stream &strm, const Request &req, bool is_server,
  3710. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3711. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3712. : strm_(strm), req_(req), is_server_(is_server),
  3713. ping_interval_sec_(ping_interval_sec),
  3714. max_missed_pongs_(max_missed_pongs) {
  3715. start_heartbeat();
  3716. }
  3717. WebSocket(
  3718. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3719. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3720. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3721. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3722. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3723. max_missed_pongs_(max_missed_pongs) {
  3724. start_heartbeat();
  3725. }
  3726. void start_heartbeat();
  3727. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3728. Stream &strm_;
  3729. std::unique_ptr<Stream> owned_strm_;
  3730. Request req_;
  3731. bool is_server_;
  3732. time_t ping_interval_sec_;
  3733. int max_missed_pongs_;
  3734. int unacked_pings_ = 0;
  3735. std::atomic<bool> closed_{false};
  3736. // Set once the caller has bounded read() through set_read_timeout(). Until
  3737. // then the timeout in effect is the compile-time default, and elapsing it
  3738. // is a failure that closes the connection, not a Timeout.
  3739. std::atomic<bool> read_timeout_set_{false};
  3740. std::mutex write_mutex_;
  3741. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3742. // may do so: read_websocket_frame() reads a payload until it has the whole
  3743. // declared length, so a second parser stealing bytes silently corrupts the
  3744. // message the first one is assembling.
  3745. std::mutex read_mutex_;
  3746. std::thread ping_thread_;
  3747. std::mutex ping_mutex_;
  3748. std::condition_variable ping_cv_;
  3749. };
  3750. class WebSocketClient {
  3751. public:
  3752. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3753. const Headers &headers = {});
  3754. ~WebSocketClient();
  3755. WebSocketClient(const WebSocketClient &) = delete;
  3756. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3757. bool is_valid() const;
  3758. Result connect();
  3759. ReadResult read(std::string &msg);
  3760. bool send(const std::string &data);
  3761. bool send(const char *data, size_t len);
  3762. void close(CloseStatus status = CloseStatus::Normal,
  3763. const std::string &reason = "");
  3764. bool is_open() const;
  3765. const std::string &subprotocol() const;
  3766. void set_read_timeout(time_t sec, time_t usec = 0);
  3767. template <class Rep, class Period>
  3768. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3769. void set_write_timeout(time_t sec, time_t usec = 0);
  3770. template <class Rep, class Period>
  3771. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3772. void set_websocket_ping_interval(time_t sec);
  3773. void set_websocket_max_missed_pongs(int count);
  3774. void set_tcp_nodelay(bool on);
  3775. void set_address_family(int family);
  3776. void set_ipv6_v6only(bool on);
  3777. void set_socket_options(SocketOptions socket_options);
  3778. void set_connection_timeout(time_t sec, time_t usec = 0);
  3779. template <class Rep, class Period>
  3780. void
  3781. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3782. void set_interface(const std::string &intf);
  3783. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3784. #ifdef CPPHTTPLIB_SSL_ENABLED
  3785. struct PemMemory {
  3786. const char *cert_pem;
  3787. size_t cert_pem_len;
  3788. const char *key_pem;
  3789. size_t key_pem_len;
  3790. const char *private_key_password;
  3791. };
  3792. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3793. const PemMemory &pem, const Headers &headers = {});
  3794. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3795. const std::string &ca_cert_dir_path = std::string());
  3796. void set_ca_cert_store(tls::ca_store_t store);
  3797. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3798. void enable_server_certificate_verification(bool enabled);
  3799. void enable_server_hostname_verification(bool enabled);
  3800. void enable_system_ca(bool enabled);
  3801. #endif
  3802. private:
  3803. void shutdown_and_close();
  3804. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3805. int &ssl_error, uint64_t &ssl_backend_error);
  3806. void prepare_default_headers(Request &req);
  3807. std::string host_;
  3808. int port_;
  3809. std::string path_;
  3810. Headers headers_;
  3811. std::string subprotocol_;
  3812. bool is_valid_ = false;
  3813. socket_t sock_ = INVALID_SOCKET;
  3814. std::unique_ptr<WebSocket> ws_;
  3815. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3816. time_t read_timeout_usec_ = 0;
  3817. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3818. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3819. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3820. time_t websocket_ping_interval_sec_ =
  3821. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3822. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3823. int address_family_ = AF_UNSPEC;
  3824. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3825. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3826. SocketOptions socket_options_ = nullptr;
  3827. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3828. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3829. std::string interface_;
  3830. // Hostname to connection target map. The value is an IP literal or another
  3831. // hostname; only the connection target changes, never the identity.
  3832. std::map<std::string, std::string> addr_map_;
  3833. #ifdef CPPHTTPLIB_SSL_ENABLED
  3834. bool is_ssl_ = false;
  3835. tls::ctx_t tls_ctx_ = nullptr;
  3836. tls::session_t tls_session_ = nullptr;
  3837. std::string ca_cert_file_path_;
  3838. std::string ca_cert_dir_path_;
  3839. bool custom_ca_loaded_ = false;
  3840. bool certs_loaded_ = false;
  3841. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3842. bool server_certificate_verification_ = true;
  3843. bool server_hostname_verification_ = true;
  3844. #endif
  3845. };
  3846. template <class Rep, class Period>
  3847. inline void WebSocket::set_read_timeout(
  3848. const std::chrono::duration<Rep, Period> &duration) {
  3849. detail::duration_to_sec_and_usec(
  3850. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3851. }
  3852. template <class Rep, class Period>
  3853. inline void WebSocketClient::set_read_timeout(
  3854. const std::chrono::duration<Rep, Period> &duration) {
  3855. detail::duration_to_sec_and_usec(
  3856. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3857. }
  3858. template <class Rep, class Period>
  3859. inline void WebSocketClient::set_write_timeout(
  3860. const std::chrono::duration<Rep, Period> &duration) {
  3861. detail::duration_to_sec_and_usec(
  3862. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3863. }
  3864. template <class Rep, class Period>
  3865. inline void WebSocketClient::set_connection_timeout(
  3866. const std::chrono::duration<Rep, Period> &duration) {
  3867. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3868. set_connection_timeout(sec, usec);
  3869. });
  3870. }
  3871. namespace impl {
  3872. bool is_valid_utf8(const std::string &s);
  3873. // Three states, because a failure that consumed bytes and one that consumed
  3874. // none are not the same thing: the first has left the stream in the middle of
  3875. // a frame and the connection cannot be reused, the second can just be retried.
  3876. enum class FrameRead { Ok, Fail, Timeout };
  3877. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3878. std::string &payload, bool &fin,
  3879. bool expect_masked, size_t max_len);
  3880. } // namespace impl
  3881. } // namespace ws
  3882. // ----------------------------------------------------------------------------
  3883. /*
  3884. * Implementation that will be part of the .cc file if split into .h + .cc.
  3885. */
  3886. namespace stream {
  3887. // stream::Result implementations
  3888. inline Result::Result() : chunk_size_(8192) {}
  3889. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3890. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3891. inline Result::Result(Result &&other) noexcept
  3892. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3893. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3894. finished_(other.finished_) {
  3895. other.current_size_ = 0;
  3896. other.finished_ = true;
  3897. }
  3898. inline Result &Result::operator=(Result &&other) noexcept {
  3899. if (this != &other) {
  3900. handle_ = std::move(other.handle_);
  3901. buffer_ = std::move(other.buffer_);
  3902. current_size_ = other.current_size_;
  3903. chunk_size_ = other.chunk_size_;
  3904. finished_ = other.finished_;
  3905. other.current_size_ = 0;
  3906. other.finished_ = true;
  3907. }
  3908. return *this;
  3909. }
  3910. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3911. inline Result::operator bool() const { return is_valid(); }
  3912. inline int Result::status() const {
  3913. return handle_.response ? handle_.response->status : -1;
  3914. }
  3915. inline const Headers &Result::headers() const {
  3916. static const Headers empty_headers;
  3917. return handle_.response ? handle_.response->headers : empty_headers;
  3918. }
  3919. inline std::string Result::get_header_value(const std::string &key,
  3920. const char *def) const {
  3921. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3922. }
  3923. inline bool Result::has_header(const std::string &key) const {
  3924. return handle_.response ? handle_.response->has_header(key) : false;
  3925. }
  3926. inline Error Result::error() const { return handle_.error; }
  3927. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3928. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3929. inline bool Result::next() {
  3930. if (!handle_.is_valid() || finished_) { return false; }
  3931. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3932. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3933. if (n > 0) {
  3934. current_size_ = static_cast<size_t>(n);
  3935. return true;
  3936. }
  3937. current_size_ = 0;
  3938. finished_ = true;
  3939. return false;
  3940. }
  3941. inline const char *Result::data() const { return buffer_.data(); }
  3942. inline size_t Result::size() const { return current_size_; }
  3943. inline std::string Result::read_all() {
  3944. std::string result;
  3945. while (next()) {
  3946. result.append(data(), size());
  3947. }
  3948. return result;
  3949. }
  3950. } // namespace stream
  3951. namespace sse {
  3952. // SSEMessage implementations
  3953. inline SSEMessage::SSEMessage() : event("message") {}
  3954. inline void SSEMessage::clear() {
  3955. event = "message";
  3956. data.clear();
  3957. id.clear();
  3958. }
  3959. // SSEClient implementations
  3960. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3961. : client_(client), path_(path) {}
  3962. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3963. const Headers &headers)
  3964. : client_(client), path_(path), headers_(headers) {}
  3965. inline SSEClient::~SSEClient() { stop(); }
  3966. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3967. on_message_ = std::move(handler);
  3968. return *this;
  3969. }
  3970. inline SSEClient &SSEClient::on_event(const std::string &type,
  3971. MessageHandler handler) {
  3972. event_handlers_[type] = std::move(handler);
  3973. return *this;
  3974. }
  3975. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3976. on_open_ = std::move(handler);
  3977. return *this;
  3978. }
  3979. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3980. on_error_ = std::move(handler);
  3981. return *this;
  3982. }
  3983. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3984. reconnect_interval_ms_ = ms;
  3985. return *this;
  3986. }
  3987. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3988. max_reconnect_attempts_ = n;
  3989. return *this;
  3990. }
  3991. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3992. std::lock_guard<std::mutex> lock(headers_mutex_);
  3993. headers_ = headers;
  3994. return *this;
  3995. }
  3996. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3997. inline const std::string &SSEClient::last_event_id() const {
  3998. return last_event_id_;
  3999. }
  4000. inline void SSEClient::start() {
  4001. running_.store(true);
  4002. run_event_loop();
  4003. }
  4004. inline void SSEClient::start_async() {
  4005. running_.store(true);
  4006. async_thread_ = std::thread([this]() { run_event_loop(); });
  4007. }
  4008. inline void SSEClient::stop() {
  4009. running_.store(false);
  4010. client_.stop(); // Cancel any pending operations
  4011. if (async_thread_.joinable()) { async_thread_.join(); }
  4012. }
  4013. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4014. int &retry_ms) {
  4015. // Blank line signals end of event
  4016. if (line.empty() || line == "\r") { return true; }
  4017. // Lines starting with ':' are comments (ignored)
  4018. if (!line.empty() && line[0] == ':') { return false; }
  4019. // Find the colon separator
  4020. auto colon_pos = line.find(':');
  4021. if (colon_pos == std::string::npos) {
  4022. // Line with no colon is treated as field name with empty value
  4023. return false;
  4024. }
  4025. auto field = line.substr(0, colon_pos);
  4026. std::string value;
  4027. // Value starts after colon, skip optional single space
  4028. if (colon_pos + 1 < line.size()) {
  4029. auto value_start = colon_pos + 1;
  4030. if (line[value_start] == ' ') { value_start++; }
  4031. value = line.substr(value_start);
  4032. // Remove trailing \r if present
  4033. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  4034. }
  4035. // Handle known fields
  4036. if (field == "event") {
  4037. msg.event = value;
  4038. } else if (field == "data") {
  4039. // Multiple data lines are concatenated with newlines
  4040. if (!msg.data.empty()) { msg.data += "\n"; }
  4041. msg.data += value;
  4042. } else if (field == "id") {
  4043. // Empty id is valid (clears the last event ID)
  4044. msg.id = value;
  4045. } else if (field == "retry") {
  4046. // Parse retry interval in milliseconds
  4047. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4048. if (detail::is_numeric(value)) {
  4049. int v = 0;
  4050. auto res =
  4051. detail::from_chars(value.data(), value.data() + value.size(), v);
  4052. if (res.ec == std::errc{}) { retry_ms = v; }
  4053. }
  4054. }
  4055. // Unknown fields are ignored per SSE spec
  4056. return false;
  4057. }
  4058. inline void SSEClient::run_event_loop() {
  4059. auto reconnect_count = 0;
  4060. while (running_.load()) {
  4061. // Build headers, including Last-Event-ID if we have one
  4062. Headers request_headers;
  4063. {
  4064. std::lock_guard<std::mutex> lock(headers_mutex_);
  4065. request_headers = headers_;
  4066. }
  4067. if (!last_event_id_.empty()) {
  4068. request_headers.emplace("Last-Event-ID", last_event_id_);
  4069. }
  4070. // Open streaming connection
  4071. auto result = stream::Get(client_, path_, request_headers);
  4072. // Connection error handling
  4073. if (!result) {
  4074. connected_.store(false);
  4075. if (on_error_) { on_error_(result.error()); }
  4076. if (!should_reconnect(reconnect_count)) { break; }
  4077. wait_for_reconnect();
  4078. reconnect_count++;
  4079. continue;
  4080. }
  4081. if (result.status() != StatusCode::OK_200) {
  4082. connected_.store(false);
  4083. if (on_error_) { on_error_(Error::Connection); }
  4084. // For certain errors, don't reconnect.
  4085. // Note: 401 is intentionally absent so that handlers can refresh
  4086. // credentials via set_headers() and let the client reconnect.
  4087. if (result.status() == StatusCode::NoContent_204 ||
  4088. result.status() == StatusCode::NotFound_404 ||
  4089. result.status() == StatusCode::Forbidden_403) {
  4090. break;
  4091. }
  4092. if (!should_reconnect(reconnect_count)) { break; }
  4093. wait_for_reconnect();
  4094. reconnect_count++;
  4095. continue;
  4096. }
  4097. // Connection successful
  4098. connected_.store(true);
  4099. reconnect_count = 0;
  4100. if (on_open_) { on_open_(); }
  4101. // Event receiving loop
  4102. std::string buffer;
  4103. SSEMessage current_msg;
  4104. while (running_.load() && result.next()) {
  4105. buffer.append(result.data(), result.size());
  4106. // Process complete lines in the buffer
  4107. size_t line_start = 0;
  4108. size_t newline_pos;
  4109. while ((newline_pos = buffer.find('\n', line_start)) !=
  4110. std::string::npos) {
  4111. auto line = buffer.substr(line_start, newline_pos - line_start);
  4112. line_start = newline_pos + 1;
  4113. // Parse the line and check if event is complete
  4114. auto event_complete =
  4115. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4116. if (event_complete && !current_msg.data.empty()) {
  4117. // Update last_event_id for reconnection
  4118. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4119. // Dispatch event to appropriate handler
  4120. dispatch_event(current_msg);
  4121. current_msg.clear();
  4122. }
  4123. }
  4124. // Keep unprocessed data in buffer
  4125. buffer.erase(0, line_start);
  4126. }
  4127. // Connection ended
  4128. connected_.store(false);
  4129. if (!running_.load()) { break; }
  4130. // Check for read errors
  4131. if (result.has_read_error()) {
  4132. if (on_error_) { on_error_(result.read_error()); }
  4133. }
  4134. if (!should_reconnect(reconnect_count)) { break; }
  4135. wait_for_reconnect();
  4136. reconnect_count++;
  4137. }
  4138. connected_.store(false);
  4139. }
  4140. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4141. // Check for specific event type handler first
  4142. auto it = event_handlers_.find(msg.event);
  4143. if (it != event_handlers_.end()) {
  4144. it->second(msg);
  4145. return;
  4146. }
  4147. // Fall back to generic message handler
  4148. if (on_message_) { on_message_(msg); }
  4149. }
  4150. inline bool SSEClient::should_reconnect(int count) const {
  4151. if (!running_.load()) { return false; }
  4152. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4153. return count < max_reconnect_attempts_;
  4154. }
  4155. inline void SSEClient::wait_for_reconnect() {
  4156. // Use small increments to check running_ flag frequently.
  4157. // Always wait at least one increment, so that a zero interval (e.g.
  4158. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4159. const auto step_ms = 100;
  4160. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4161. auto waited = 0;
  4162. while (running_.load() && waited < interval_ms) {
  4163. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4164. waited += step_ms;
  4165. }
  4166. }
  4167. } // namespace sse
  4168. #ifdef CPPHTTPLIB_SSL_ENABLED
  4169. /*
  4170. * TLS abstraction layer - internal function declarations
  4171. * These are implementation details and not part of the public API.
  4172. */
  4173. namespace tls {
  4174. // Client context
  4175. ctx_t create_client_context();
  4176. void free_context(ctx_t ctx);
  4177. bool set_min_version(ctx_t ctx, Version version);
  4178. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4179. bool load_ca_file(ctx_t ctx, const char *file_path);
  4180. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4181. bool load_system_certs(ctx_t ctx);
  4182. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4183. const char *password);
  4184. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4185. const char *key_path, const char *password);
  4186. // Server context
  4187. ctx_t create_server_context();
  4188. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4189. const char *password);
  4190. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4191. const char *key_path, const char *password);
  4192. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4193. void set_verify_client(ctx_t ctx, bool require);
  4194. // Session management
  4195. session_t create_session(ctx_t ctx, socket_t sock);
  4196. void free_session(session_t session);
  4197. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4198. // Handshake (non-blocking capable)
  4199. TlsError connect(session_t session);
  4200. TlsError accept(session_t session);
  4201. // Handshake with timeout (blocking until timeout)
  4202. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4203. time_t timeout_usec, TlsError *err);
  4204. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4205. time_t timeout_usec, TlsError *err);
  4206. // I/O (non-blocking capable)
  4207. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4208. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4209. int pending(const_session_t session);
  4210. void shutdown(session_t session, bool graceful);
  4211. // Connection state
  4212. bool is_peer_closed(session_t session, socket_t sock);
  4213. // Certificate verification
  4214. cert_t get_peer_cert(const_session_t session);
  4215. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4216. // do not use them after free_session(), as with get_peer_cert().
  4217. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4218. void free_cert(cert_t cert);
  4219. bool verify_hostname(cert_t cert, const char *hostname);
  4220. uint64_t hostname_mismatch_code();
  4221. long get_verify_result(const_session_t session);
  4222. // Certificate introspection
  4223. std::string get_cert_subject_cn(cert_t cert);
  4224. std::string get_cert_issuer_name(cert_t cert);
  4225. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4226. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4227. std::string get_cert_serial(cert_t cert);
  4228. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4229. const char *get_sni(const_session_t session);
  4230. // CA store management
  4231. ca_store_t create_ca_store(const char *pem, size_t len);
  4232. void free_ca_store(ca_store_t store);
  4233. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4234. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4235. std::vector<std::string> get_ca_names(ctx_t ctx);
  4236. // Dynamic certificate update (for servers)
  4237. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4238. const char *password);
  4239. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4240. // Certificate verification callback
  4241. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4242. long get_verify_error(const_session_t session);
  4243. std::string verify_error_string(long error_code);
  4244. // TlsError information
  4245. uint64_t peek_error();
  4246. uint64_t get_error();
  4247. std::string error_string(uint64_t code);
  4248. } // namespace tls
  4249. #endif // CPPHTTPLIB_SSL_ENABLED
  4250. /*
  4251. * Group 1: detail namespace - Non-SSL utilities
  4252. */
  4253. namespace detail {
  4254. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4255. const void *optval, socklen_t optlen) {
  4256. return setsockopt(sock, level, optname,
  4257. #ifdef _WIN32
  4258. reinterpret_cast<const char *>(optval),
  4259. #else
  4260. optval,
  4261. #endif
  4262. optlen) == 0;
  4263. }
  4264. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4265. time_t sec, time_t usec) {
  4266. #ifdef _WIN32
  4267. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4268. #else
  4269. timeval timeout;
  4270. timeout.tv_sec = static_cast<long>(sec);
  4271. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4272. #endif
  4273. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4274. }
  4275. inline bool is_hex(char c, int &v) {
  4276. if (is_ascii_digit(c)) {
  4277. v = c - '0';
  4278. return true;
  4279. } else if ('A' <= c && c <= 'F') {
  4280. v = c - 'A' + 10;
  4281. return true;
  4282. } else if ('a' <= c && c <= 'f') {
  4283. v = c - 'a' + 10;
  4284. return true;
  4285. }
  4286. return false;
  4287. }
  4288. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4289. int &val) {
  4290. if (i >= s.size()) { return false; }
  4291. val = 0;
  4292. for (; cnt; i++, cnt--) {
  4293. if (!s[i]) { return false; }
  4294. auto v = 0;
  4295. if (is_hex(s[i], v)) {
  4296. val = val * 16 + v;
  4297. } else {
  4298. return false;
  4299. }
  4300. }
  4301. return true;
  4302. }
  4303. inline std::string from_i_to_hex(size_t n) {
  4304. static const auto charset = "0123456789abcdef";
  4305. std::string ret;
  4306. do {
  4307. ret = charset[n & 15] + ret;
  4308. n >>= 4;
  4309. } while (n > 0);
  4310. return ret;
  4311. }
  4312. inline std::string compute_etag(const FileStat &fs,
  4313. const std::string &suffix = std::string()) {
  4314. if (!fs.is_file()) { return std::string(); }
  4315. // If mtime cannot be determined (negative value indicates an error
  4316. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4317. // value like 0 could collide with a real file that legitimately has
  4318. // mtime == 0 (epoch) and lead to misleading validators.
  4319. auto mtime_raw = fs.mtime();
  4320. if (mtime_raw < 0) { return std::string(); }
  4321. auto mtime = static_cast<size_t>(mtime_raw);
  4322. auto size = fs.size();
  4323. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4324. from_i_to_hex(size) + suffix + "\"";
  4325. }
  4326. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4327. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4328. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4329. inline std::string file_mtime_to_http_date(time_t mtime) {
  4330. if (mtime < 0) { return std::string(); }
  4331. struct tm tm_buf;
  4332. #ifdef _WIN32
  4333. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4334. #else
  4335. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4336. #endif
  4337. char buf[64];
  4338. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4339. return std::string();
  4340. }
  4341. return std::string(buf);
  4342. }
  4343. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4344. inline time_t parse_http_date(const std::string &date_str) {
  4345. struct tm tm_buf;
  4346. // Create a classic locale object once for all parsing attempts
  4347. const std::locale classic_locale = std::locale::classic();
  4348. // Try to parse using std::get_time (C++11, cross-platform)
  4349. auto try_parse = [&](const char *fmt) -> bool {
  4350. std::istringstream ss(date_str);
  4351. ss.imbue(classic_locale);
  4352. memset(&tm_buf, 0, sizeof(tm_buf));
  4353. ss >> std::get_time(&tm_buf, fmt);
  4354. return !ss.fail();
  4355. };
  4356. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4357. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4358. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4359. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4360. // asctime format: "Sun Nov 6 08:49:37 1994"
  4361. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4362. return static_cast<time_t>(-1);
  4363. }
  4364. }
  4365. }
  4366. #ifdef _WIN32
  4367. return _mkgmtime(&tm_buf);
  4368. #elif defined _AIX
  4369. return mktime(&tm_buf);
  4370. #else
  4371. return timegm(&tm_buf);
  4372. #endif
  4373. }
  4374. inline bool is_weak_etag(const std::string &s) {
  4375. // Check if the string is a weak ETag (starts with 'W/"')
  4376. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4377. }
  4378. inline bool is_strong_etag(const std::string &s) {
  4379. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4380. // chars)
  4381. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4382. }
  4383. inline size_t to_utf8(int code, char *buff) {
  4384. if (code < 0x0080) {
  4385. buff[0] = static_cast<char>(code & 0x7F);
  4386. return 1;
  4387. } else if (code < 0x0800) {
  4388. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4389. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4390. return 2;
  4391. } else if (code < 0xD800) {
  4392. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4393. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4394. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4395. return 3;
  4396. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4397. return 0;
  4398. } else if (code < 0x10000) {
  4399. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4400. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4401. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4402. return 3;
  4403. } else if (code < 0x110000) {
  4404. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4405. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4406. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4407. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4408. return 4;
  4409. }
  4410. // NOTREACHED
  4411. return 0;
  4412. }
  4413. } // namespace detail
  4414. namespace ws {
  4415. namespace impl {
  4416. inline bool is_valid_utf8(const std::string &s) {
  4417. size_t i = 0;
  4418. auto n = s.size();
  4419. while (i < n) {
  4420. auto c = static_cast<unsigned char>(s[i]);
  4421. size_t len;
  4422. uint32_t cp;
  4423. if (c < 0x80) {
  4424. i++;
  4425. continue;
  4426. } else if ((c & 0xE0) == 0xC0) {
  4427. len = 2;
  4428. cp = c & 0x1F;
  4429. } else if ((c & 0xF0) == 0xE0) {
  4430. len = 3;
  4431. cp = c & 0x0F;
  4432. } else if ((c & 0xF8) == 0xF0) {
  4433. len = 4;
  4434. cp = c & 0x07;
  4435. } else {
  4436. return false;
  4437. }
  4438. if (i + len > n) { return false; }
  4439. for (size_t j = 1; j < len; j++) {
  4440. auto b = static_cast<unsigned char>(s[i + j]);
  4441. if ((b & 0xC0) != 0x80) { return false; }
  4442. cp = (cp << 6) | (b & 0x3F);
  4443. }
  4444. // Overlong encoding check
  4445. if (len == 2 && cp < 0x80) { return false; }
  4446. if (len == 3 && cp < 0x800) { return false; }
  4447. if (len == 4 && cp < 0x10000) { return false; }
  4448. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4449. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4450. if (cp > 0x10FFFF) { return false; }
  4451. i += len;
  4452. }
  4453. return true;
  4454. }
  4455. } // namespace impl
  4456. } // namespace ws
  4457. namespace detail {
  4458. // NOTE: This code came up with the following stackoverflow post:
  4459. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4460. inline std::string base64_encode(const std::string &in) {
  4461. static const auto lookup =
  4462. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4463. std::string out;
  4464. out.reserve(in.size());
  4465. // Unsigned: the accumulator is never masked, so with a signed int the
  4466. // `val << 8` below overflows once enough bytes are folded in (undefined
  4467. // behaviour before C++20). Only the low bits are ever emitted, so the
  4468. // wrap-around of an unsigned accumulator does not affect the output.
  4469. uint32_t val = 0;
  4470. auto valb = -6;
  4471. for (auto c : in) {
  4472. val = (val << 8) + static_cast<uint8_t>(c);
  4473. valb += 8;
  4474. while (valb >= 0) {
  4475. out.push_back(lookup[(val >> valb) & 0x3F]);
  4476. valb -= 6;
  4477. }
  4478. }
  4479. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4480. while (out.size() % 4) {
  4481. out.push_back('=');
  4482. }
  4483. return out;
  4484. }
  4485. inline std::string sha1(const std::string &input) {
  4486. // RFC 3174 SHA-1 implementation
  4487. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4488. return (x << n) | (x >> (32 - n));
  4489. };
  4490. uint32_t h0 = 0x67452301;
  4491. uint32_t h1 = 0xEFCDAB89;
  4492. uint32_t h2 = 0x98BADCFE;
  4493. uint32_t h3 = 0x10325476;
  4494. uint32_t h4 = 0xC3D2E1F0;
  4495. // Pre-processing: adding padding bits
  4496. std::string msg = input;
  4497. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4498. msg.push_back(static_cast<char>(0x80u));
  4499. while (msg.size() % 64 != 56) {
  4500. msg.push_back(0);
  4501. }
  4502. // Append original length in bits as 64-bit big-endian
  4503. for (int i = 56; i >= 0; i -= 8) {
  4504. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4505. }
  4506. // Process each 512-bit chunk
  4507. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4508. uint32_t w[80];
  4509. for (size_t i = 0; i < 16; i++) {
  4510. w[i] =
  4511. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4512. << 24) |
  4513. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4514. << 16) |
  4515. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4516. << 8) |
  4517. (static_cast<uint32_t>(
  4518. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4519. }
  4520. for (int i = 16; i < 80; i++) {
  4521. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4522. }
  4523. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4524. for (int i = 0; i < 80; i++) {
  4525. uint32_t f, k;
  4526. if (i < 20) {
  4527. f = (b & c) | ((~b) & d);
  4528. k = 0x5A827999;
  4529. } else if (i < 40) {
  4530. f = b ^ c ^ d;
  4531. k = 0x6ED9EBA1;
  4532. } else if (i < 60) {
  4533. f = (b & c) | (b & d) | (c & d);
  4534. k = 0x8F1BBCDC;
  4535. } else {
  4536. f = b ^ c ^ d;
  4537. k = 0xCA62C1D6;
  4538. }
  4539. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4540. e = d;
  4541. d = c;
  4542. c = left_rotate(b, 30);
  4543. b = a;
  4544. a = temp;
  4545. }
  4546. h0 += a;
  4547. h1 += b;
  4548. h2 += c;
  4549. h3 += d;
  4550. h4 += e;
  4551. }
  4552. // Produce the final hash as a 20-byte binary string
  4553. std::string hash(20, '\0');
  4554. for (size_t i = 0; i < 4; i++) {
  4555. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4556. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4557. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4558. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4559. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4560. }
  4561. return hash;
  4562. }
  4563. inline std::string websocket_accept_key(const std::string &client_key) {
  4564. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4565. return base64_encode(sha1(client_key + magic));
  4566. }
  4567. inline bool is_websocket_upgrade(const Request &req) {
  4568. if (req.method != "GET") { return false; }
  4569. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4570. // list of protocols and asks recipients to match each name
  4571. // case-insensitively, so look for the token rather than compare the whole
  4572. // field value.
  4573. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4574. // Check Connection: Upgrade
  4575. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4576. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4577. // RFC 6455 Section 4.2.1
  4578. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4579. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4580. return false;
  4581. }
  4582. static const std::string b64chars =
  4583. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4584. for (size_t i = 0; i < 22; i++) {
  4585. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4586. }
  4587. // Check Sec-WebSocket-Version: 13
  4588. auto version = req.get_header_value("Sec-WebSocket-Version");
  4589. if (version != "13") { return false; }
  4590. return true;
  4591. }
  4592. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4593. const char *data, size_t len, bool fin,
  4594. bool mask) {
  4595. // First byte: FIN + opcode
  4596. uint8_t header[2];
  4597. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4598. (static_cast<uint8_t>(opcode) & 0x0F));
  4599. // Second byte: MASK + payload length
  4600. if (len < 126) {
  4601. header[1] = static_cast<uint8_t>(len);
  4602. if (mask) { header[1] |= 0x80; }
  4603. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4604. } else if (len <= 0xFFFF) {
  4605. header[1] = 126;
  4606. if (mask) { header[1] |= 0x80; }
  4607. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4608. uint8_t ext[2];
  4609. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4610. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4611. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4612. } else {
  4613. header[1] = 127;
  4614. if (mask) { header[1] |= 0x80; }
  4615. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4616. uint8_t ext[8];
  4617. for (int i = 7; i >= 0; i--) {
  4618. ext[7 - i] =
  4619. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4620. }
  4621. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4622. }
  4623. if (mask) {
  4624. // Generate random mask key
  4625. thread_local std::mt19937 rng(std::random_device{}());
  4626. uint8_t mask_key[4];
  4627. auto r = rng();
  4628. std::memcpy(mask_key, &r, 4);
  4629. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4630. // Write masked payload in chunks
  4631. const size_t chunk_size = 4096;
  4632. std::vector<char> buf((std::min)(len, chunk_size));
  4633. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4634. size_t n = (std::min)(chunk_size, len - offset);
  4635. for (size_t i = 0; i < n; i++) {
  4636. buf[i] =
  4637. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4638. }
  4639. if (strm.write(buf.data(), n) < 0) { return false; }
  4640. }
  4641. } else {
  4642. if (len > 0) {
  4643. if (strm.write(data, len) < 0) { return false; }
  4644. }
  4645. }
  4646. return true;
  4647. }
  4648. } // namespace detail
  4649. namespace ws {
  4650. namespace impl {
  4651. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4652. // hands back whatever its buffer already holds -- so every multi-byte field has
  4653. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4654. // header straddles the read buffer's boundary.
  4655. //
  4656. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4657. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4658. // there is a failure like any other. (When read() fails it always records why,
  4659. // so the error belongs to this call and not to an earlier one.)
  4660. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4661. auto p = static_cast<char *>(buf);
  4662. size_t total = 0;
  4663. while (total < size) {
  4664. auto n = strm.read(p + total, size - total);
  4665. if (n <= 0) {
  4666. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4667. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4668. }
  4669. total += static_cast<size_t>(n);
  4670. }
  4671. return FrameRead::Ok;
  4672. }
  4673. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4674. std::string &payload, bool &fin,
  4675. bool expect_masked, size_t max_len) {
  4676. // Read first 2 bytes. This is the only read that may report a timeout: it
  4677. // sits on a frame boundary, where nothing has been consumed yet.
  4678. uint8_t header[2];
  4679. FrameRead first = read_exact(strm, header, 2);
  4680. if (first != FrameRead::Ok) { return first; }
  4681. fin = (header[0] & 0x80) != 0;
  4682. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4683. if (header[0] & 0x70) { return FrameRead::Fail; }
  4684. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4685. bool masked = (header[1] & 0x80) != 0;
  4686. uint64_t payload_len = header[1] & 0x7F;
  4687. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4688. // MUST have a payload length of 125 bytes or less
  4689. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4690. if (is_control) {
  4691. if (!fin) { return FrameRead::Fail; }
  4692. if (payload_len > 125) { return FrameRead::Fail; }
  4693. }
  4694. if (masked != expect_masked) { return FrameRead::Fail; }
  4695. // Extended payload length
  4696. if (payload_len == 126) {
  4697. uint8_t ext[2];
  4698. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4699. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4700. } else if (payload_len == 127) {
  4701. uint8_t ext[8];
  4702. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4703. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4704. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4705. payload_len = 0;
  4706. for (int i = 0; i < 8; i++) {
  4707. payload_len = (payload_len << 8) | ext[i];
  4708. }
  4709. }
  4710. if (payload_len > max_len) { return FrameRead::Fail; }
  4711. // Read mask key if present
  4712. uint8_t mask_key[4] = {0};
  4713. if (masked) {
  4714. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4715. return FrameRead::Fail;
  4716. }
  4717. }
  4718. // Read payload
  4719. payload.resize(static_cast<size_t>(payload_len));
  4720. if (payload_len > 0 &&
  4721. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4722. FrameRead::Ok) {
  4723. return FrameRead::Fail;
  4724. }
  4725. // Unmask if needed
  4726. if (masked) {
  4727. for (size_t i = 0; i < payload.size(); i++) {
  4728. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4729. }
  4730. }
  4731. return FrameRead::Ok;
  4732. }
  4733. } // namespace impl
  4734. } // namespace ws
  4735. namespace detail {
  4736. inline bool is_valid_path(const std::string &path) {
  4737. size_t level = 0;
  4738. size_t i = 0;
  4739. // Skip slash
  4740. while (i < path.size() && path[i] == '/') {
  4741. i++;
  4742. }
  4743. while (i < path.size()) {
  4744. // Read component
  4745. auto beg = i;
  4746. while (i < path.size() && path[i] != '/') {
  4747. if (path[i] == '\0') {
  4748. return false;
  4749. } else if (path[i] == '\\') {
  4750. return false;
  4751. }
  4752. i++;
  4753. }
  4754. auto len = i - beg;
  4755. assert(len > 0);
  4756. if (!path.compare(beg, len, ".")) {
  4757. ;
  4758. } else if (!path.compare(beg, len, "..")) {
  4759. if (level == 0) { return false; }
  4760. level--;
  4761. } else {
  4762. level++;
  4763. }
  4764. // Skip slash
  4765. while (i < path.size() && path[i] == '/') {
  4766. i++;
  4767. }
  4768. }
  4769. return true;
  4770. }
  4771. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4772. #if defined(_WIN32)
  4773. char buf[_MAX_PATH];
  4774. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4775. resolved = buf;
  4776. #elif defined(PATH_MAX)
  4777. char buf[PATH_MAX];
  4778. if (realpath(path, buf) == nullptr) { return false; }
  4779. resolved = buf;
  4780. #else
  4781. auto buf = realpath(path, nullptr);
  4782. auto guard = scope_exit([&]() { std::free(buf); });
  4783. if (buf == nullptr) { return false; }
  4784. resolved = buf;
  4785. #endif
  4786. return true;
  4787. }
  4788. inline bool is_path_within_base(const std::string &resolved_path,
  4789. const std::string &resolved_base) {
  4790. #if defined(_WIN32)
  4791. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4792. resolved_base.size()) == 0;
  4793. #else
  4794. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4795. resolved_base.size()) == 0;
  4796. #endif
  4797. }
  4798. inline FileStat::FileStat(const std::string &path) {
  4799. #if defined(_WIN32)
  4800. auto wpath = u8string_to_wstring(path.c_str());
  4801. ret_ = _wstat(wpath.c_str(), &st_);
  4802. #else
  4803. ret_ = stat(path.c_str(), &st_);
  4804. #endif
  4805. }
  4806. inline bool FileStat::is_file() const {
  4807. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4808. }
  4809. inline bool FileStat::is_dir() const {
  4810. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4811. }
  4812. inline time_t FileStat::mtime() const {
  4813. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4814. : static_cast<time_t>(-1);
  4815. }
  4816. inline size_t FileStat::size() const {
  4817. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4818. }
  4819. inline std::string encode_path(const std::string &s) {
  4820. std::string result;
  4821. result.reserve(s.size());
  4822. for (size_t i = 0; s[i]; i++) {
  4823. switch (s[i]) {
  4824. case ' ': result += "%20"; break;
  4825. case '+': result += "%2B"; break;
  4826. case '\'': result += "%27"; break;
  4827. case ',': result += "%2C"; break;
  4828. // case ':': result += "%3A"; break; // ok? probably...
  4829. case ';': result += "%3B"; break;
  4830. default:
  4831. auto c = static_cast<uint8_t>(s[i]);
  4832. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4833. // in a request-target as-is.
  4834. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4835. result += '%';
  4836. char hex[4];
  4837. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4838. assert(len == 2);
  4839. result.append(hex, static_cast<size_t>(len));
  4840. } else {
  4841. result += s[i];
  4842. }
  4843. break;
  4844. }
  4845. }
  4846. return result;
  4847. }
  4848. inline std::string file_extension(const std::string &path) {
  4849. std::smatch m;
  4850. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4851. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4852. return std::string();
  4853. }
  4854. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4855. template <typename T>
  4856. inline bool parse_header(const char *beg, const char *end, T fn);
  4857. template <typename T>
  4858. inline bool parse_header(const char *beg, const char *end, T fn) {
  4859. // Skip trailing spaces and tabs.
  4860. while (beg < end && is_space_or_tab(end[-1])) {
  4861. end--;
  4862. }
  4863. auto p = beg;
  4864. while (p < end && *p != ':') {
  4865. p++;
  4866. }
  4867. auto name = std::string(beg, p);
  4868. if (!detail::fields::is_field_name(name)) { return false; }
  4869. if (p == end) { return false; }
  4870. auto key_end = p;
  4871. if (*p++ != ':') { return false; }
  4872. while (p < end && is_space_or_tab(*p)) {
  4873. p++;
  4874. }
  4875. if (p <= end) {
  4876. auto key_len = key_end - beg;
  4877. if (!key_len) { return false; }
  4878. auto key = std::string(beg, key_end);
  4879. auto val = std::string(p, end);
  4880. if (!detail::fields::is_field_value(val)) { return false; }
  4881. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4882. // percent-decoded by the recipient. Applications that need to interpret a
  4883. // value as a URI component should call httplib::decode_uri_component()
  4884. // (or decode_path_component()) explicitly.
  4885. fn(key, val);
  4886. return true;
  4887. }
  4888. return false;
  4889. }
  4890. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4891. const Headers &src_headers) {
  4892. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4893. // transfer coding is complete when a chunk with a chunk-size of zero is
  4894. // received, possibly followed by a trailer section, and finally terminated by
  4895. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4896. //
  4897. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4898. // doesn't care for the existence of the final CRLF. In other words, it seems
  4899. // to be ok whether the final CRLF exists or not in the chunked data.
  4900. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4901. //
  4902. // According to the reference code in RFC 9112, cpp-httplib now allows
  4903. // chunked transfer coding data without the final CRLF.
  4904. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4905. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4906. "transfer-encoding",
  4907. "content-length",
  4908. "host",
  4909. "authorization",
  4910. "www-authenticate",
  4911. "proxy-authenticate",
  4912. "proxy-authorization",
  4913. "cookie",
  4914. "set-cookie",
  4915. "cache-control",
  4916. "expect",
  4917. "max-forwards",
  4918. "pragma",
  4919. "range",
  4920. "te",
  4921. "age",
  4922. "expires",
  4923. "date",
  4924. "location",
  4925. "retry-after",
  4926. "vary",
  4927. "warning",
  4928. "content-encoding",
  4929. "content-type",
  4930. "content-range",
  4931. "trailer"};
  4932. case_ignore::unordered_set<std::string> declared_trailers;
  4933. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4934. if (!trailer_header.empty()) {
  4935. // split() trims each token and skips empty ones, so the name arrives ready
  4936. // to look up.
  4937. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4938. ',', [&](const char *b, const char *e) {
  4939. // A legitimate message declares only a handful of trailers. Cap the
  4940. // set so a peer cannot grow it without bound: an oversized set only
  4941. // arises from an attempt to force many colliding names into
  4942. // quadratic lookups (case_ignore::hash is unkeyed).
  4943. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4944. return;
  4945. }
  4946. std::string key(b, e);
  4947. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4948. declared_trailers.insert(key);
  4949. }
  4950. });
  4951. }
  4952. size_t trailer_header_count = 0;
  4953. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4954. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4955. // Count every received trailer field, not only the declared ones stored in
  4956. // dest, so undeclared fields cannot keep this loop running past the limit.
  4957. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4958. constexpr auto line_terminator_len = 2;
  4959. auto line_beg = line_reader.ptr();
  4960. auto line_end =
  4961. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4962. if (!parse_header(line_beg, line_end,
  4963. [&](const std::string &key, const std::string &val) {
  4964. if (declared_trailers.find(key) !=
  4965. declared_trailers.end()) {
  4966. dest.emplace(key, val);
  4967. }
  4968. })) {
  4969. return false;
  4970. }
  4971. trailer_header_count++;
  4972. if (!line_reader.getline()) { return false; }
  4973. }
  4974. return true;
  4975. }
  4976. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4977. size_t right) {
  4978. while (b + left < e && is_space_or_tab(b[left])) {
  4979. left++;
  4980. }
  4981. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4982. right--;
  4983. }
  4984. return std::make_pair(left, right);
  4985. }
  4986. inline std::string trim_copy(const std::string &s) {
  4987. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4988. return s.substr(r.first, r.second - r.first);
  4989. }
  4990. inline std::string trim_double_quotes_copy(const std::string &s) {
  4991. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4992. return s.substr(1, s.size() - 2);
  4993. }
  4994. return s;
  4995. }
  4996. inline void
  4997. divide(const char *data, std::size_t size, char d,
  4998. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4999. fn) {
  5000. const auto it = std::find(data, data + size, d);
  5001. const auto found = static_cast<std::size_t>(it != data + size);
  5002. const auto lhs_data = data;
  5003. const auto lhs_size = static_cast<std::size_t>(it - data);
  5004. const auto rhs_data = it + found;
  5005. const auto rhs_size = size - lhs_size - found;
  5006. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5007. }
  5008. inline void
  5009. divide(const std::string &str, char d,
  5010. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5011. fn) {
  5012. divide(str.data(), str.size(), d, std::move(fn));
  5013. }
  5014. inline void split(const char *b, const char *e, char d,
  5015. std::function<void(const char *, const char *)> fn) {
  5016. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5017. }
  5018. inline void split(const char *b, const char *e, char d, size_t m,
  5019. std::function<void(const char *, const char *)> fn) {
  5020. size_t i = 0;
  5021. size_t beg = 0;
  5022. size_t count = 1;
  5023. while (e ? (b + i < e) : (b[i] != '\0')) {
  5024. if (b[i] == d && count < m) {
  5025. auto r = trim(b, e, beg, i);
  5026. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5027. beg = i + 1;
  5028. count++;
  5029. }
  5030. i++;
  5031. }
  5032. if (i) {
  5033. auto r = trim(b, e, beg, i);
  5034. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5035. }
  5036. }
  5037. // Same contract as split(), except that a delimiter inside a quoted-string is
  5038. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5039. // quoted-string, and ';' and '=' are legal characters inside one.
  5040. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5041. std::function<void(const char *, const char *)> fn) {
  5042. size_t i = 0;
  5043. size_t beg = 0;
  5044. size_t count = 1;
  5045. auto in_quotes = false;
  5046. while (e ? (b + i < e) : (b[i] != '\0')) {
  5047. if (b[i] == '"') {
  5048. in_quotes = !in_quotes;
  5049. } else if (b[i] == d && !in_quotes && count < m) {
  5050. auto r = trim(b, e, beg, i);
  5051. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5052. beg = i + 1;
  5053. count++;
  5054. }
  5055. i++;
  5056. }
  5057. if (i) {
  5058. auto r = trim(b, e, beg, i);
  5059. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5060. }
  5061. }
  5062. inline void split_unquoted(const char *b, const char *e, char d,
  5063. std::function<void(const char *, const char *)> fn) {
  5064. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5065. std::move(fn));
  5066. }
  5067. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5068. // key a token, so the first '=' is the separator even when the value is a
  5069. // quoted-string carrying more of them.
  5070. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5071. std::string &val) {
  5072. divide(
  5073. b, static_cast<std::size_t>(e - b), '=',
  5074. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5075. const auto kr = trim(kb, kb + klen, 0, klen);
  5076. key.assign(kb + kr.first, kb + kr.second);
  5077. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5078. val.assign(vb + vr.first, vb + vr.second);
  5079. });
  5080. }
  5081. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5082. std::function<bool(const char *, const char *)> fn) {
  5083. size_t i = 0;
  5084. size_t beg = 0;
  5085. size_t count = 1;
  5086. while (e ? (b + i < e) : (b[i] != '\0')) {
  5087. if (b[i] == d && count < m) {
  5088. auto r = trim(b, e, beg, i);
  5089. if (r.first < r.second) {
  5090. auto found = fn(&b[r.first], &b[r.second]);
  5091. if (found) { return true; }
  5092. }
  5093. beg = i + 1;
  5094. count++;
  5095. }
  5096. i++;
  5097. }
  5098. if (i) {
  5099. auto r = trim(b, e, beg, i);
  5100. if (r.first < r.second) {
  5101. auto found = fn(&b[r.first], &b[r.second]);
  5102. if (found) { return true; }
  5103. }
  5104. }
  5105. return false;
  5106. }
  5107. inline bool split_find(const char *b, const char *e, char d,
  5108. std::function<bool(const char *, const char *)> fn) {
  5109. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5110. std::move(fn));
  5111. }
  5112. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5113. size_t fixed_buffer_size)
  5114. : strm_(strm), fixed_buffer_(fixed_buffer),
  5115. fixed_buffer_size_(fixed_buffer_size) {}
  5116. inline const char *stream_line_reader::ptr() const {
  5117. if (growable_buffer_.empty()) {
  5118. return fixed_buffer_;
  5119. } else {
  5120. return growable_buffer_.data();
  5121. }
  5122. }
  5123. inline size_t stream_line_reader::size() const {
  5124. if (growable_buffer_.empty()) {
  5125. return fixed_buffer_used_size_;
  5126. } else {
  5127. return growable_buffer_.size();
  5128. }
  5129. }
  5130. inline bool stream_line_reader::end_with_crlf() const {
  5131. auto end = ptr() + size();
  5132. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5133. }
  5134. inline bool stream_line_reader::getline() {
  5135. fixed_buffer_used_size_ = 0;
  5136. growable_buffer_.clear();
  5137. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5138. char prev_byte = 0;
  5139. #endif
  5140. for (size_t i = 0;; i++) {
  5141. // Fast path: whatever the stream has already buffered can be scanned for
  5142. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5143. // call, a bounds check and a one-byte copy per character of the request.
  5144. size_t buffered_size = 0;
  5145. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5146. auto take = buffered_size;
  5147. auto terminated = false;
  5148. for (size_t at = 0; at < buffered_size;) {
  5149. auto nl = static_cast<const char *>(
  5150. memchr(buffered + at, '\n', buffered_size - at));
  5151. if (!nl) { break; }
  5152. auto pos = static_cast<size_t>(nl - buffered);
  5153. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5154. take = pos + 1;
  5155. terminated = true;
  5156. break;
  5157. #else
  5158. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5159. // be the last byte of an earlier chunk, hence prev_byte.
  5160. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5161. take = pos + 1;
  5162. terminated = true;
  5163. break;
  5164. }
  5165. at = pos + 1;
  5166. #endif
  5167. }
  5168. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5169. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5170. prev_byte = buffered[take - 1];
  5171. #endif
  5172. append(buffered, take);
  5173. strm_.consume_buffered(take);
  5174. i += take;
  5175. if (terminated) { return true; }
  5176. continue;
  5177. }
  5178. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5179. // Treat exceptionally long lines as an error to
  5180. // prevent infinite loops/memory exhaustion
  5181. return false;
  5182. }
  5183. char byte;
  5184. auto n = strm_.read(&byte, 1);
  5185. if (n < 0) {
  5186. return false;
  5187. } else if (n == 0) {
  5188. if (i == 0) {
  5189. return false;
  5190. } else {
  5191. break;
  5192. }
  5193. }
  5194. append(byte);
  5195. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5196. if (byte == '\n') { break; }
  5197. #else
  5198. if (prev_byte == '\r' && byte == '\n') { break; }
  5199. prev_byte = byte;
  5200. #endif
  5201. }
  5202. return true;
  5203. }
  5204. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5205. inline void stream_line_reader::append(const char *data, size_t size) {
  5206. // Once the line has outgrown the fixed buffer everything must keep going to
  5207. // the growable one, even if a later chunk would have fit. Without the
  5208. // emptiness check a short append after a long one would land in the fixed
  5209. // buffer, which ptr() and size() no longer look at, and be lost.
  5210. if (growable_buffer_.empty() &&
  5211. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5212. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5213. fixed_buffer_used_size_ += size;
  5214. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5215. } else {
  5216. // Unlike the per-character overload, this can be the very first append of
  5217. // the line, so the fixed buffer may hold nothing and carry no terminator
  5218. // yet. assign() takes an explicit length and does not need one.
  5219. if (growable_buffer_.empty()) {
  5220. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5221. }
  5222. growable_buffer_.append(data, size);
  5223. }
  5224. }
  5225. inline mmap::mmap(const char *path) { open(path); }
  5226. inline mmap::~mmap() { close(); }
  5227. inline bool mmap::open(const char *path) {
  5228. close();
  5229. #if defined(_WIN32)
  5230. auto wpath = u8string_to_wstring(path);
  5231. if (wpath.empty()) { return false; }
  5232. hFile_ =
  5233. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5234. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5235. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5236. LARGE_INTEGER size{};
  5237. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5238. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5239. // See:
  5240. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5241. if (static_cast<ULONGLONG>(size.QuadPart) >
  5242. (std::numeric_limits<decltype(size_)>::max)()) {
  5243. // `size_t` might be 32-bits, on 32-bits Windows.
  5244. return false;
  5245. }
  5246. size_ = static_cast<size_t>(size.QuadPart);
  5247. hMapping_ =
  5248. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5249. // Special treatment for an empty file...
  5250. if (hMapping_ == NULL && size_ == 0) {
  5251. close();
  5252. is_open_empty_file = true;
  5253. return true;
  5254. }
  5255. if (hMapping_ == NULL) {
  5256. close();
  5257. return false;
  5258. }
  5259. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5260. if (addr_ == nullptr) {
  5261. close();
  5262. return false;
  5263. }
  5264. #else
  5265. fd_ = ::open(path, O_RDONLY);
  5266. if (fd_ == -1) { return false; }
  5267. struct stat sb;
  5268. if (fstat(fd_, &sb) == -1) {
  5269. close();
  5270. return false;
  5271. }
  5272. size_ = static_cast<size_t>(sb.st_size);
  5273. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5274. // Special treatment for an empty file...
  5275. if (addr_ == MAP_FAILED && size_ == 0) {
  5276. close();
  5277. is_open_empty_file = true;
  5278. return false;
  5279. }
  5280. if (addr_ == MAP_FAILED) {
  5281. // Clear the sentinel before `close()`, since `is_open()` only checks
  5282. // `addr_` against nullptr and `munmap()` must not be called with it.
  5283. addr_ = nullptr;
  5284. close();
  5285. return false;
  5286. }
  5287. #endif
  5288. return true;
  5289. }
  5290. inline bool mmap::is_open() const {
  5291. return is_open_empty_file ? true : addr_ != nullptr;
  5292. }
  5293. inline size_t mmap::size() const { return size_; }
  5294. inline const char *mmap::data() const {
  5295. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5296. }
  5297. inline void mmap::close() {
  5298. #if defined(_WIN32)
  5299. if (addr_) {
  5300. ::UnmapViewOfFile(addr_);
  5301. addr_ = nullptr;
  5302. }
  5303. if (hMapping_) {
  5304. ::CloseHandle(hMapping_);
  5305. hMapping_ = NULL;
  5306. }
  5307. if (hFile_ != INVALID_HANDLE_VALUE) {
  5308. ::CloseHandle(hFile_);
  5309. hFile_ = INVALID_HANDLE_VALUE;
  5310. }
  5311. is_open_empty_file = false;
  5312. #else
  5313. if (addr_ != nullptr) {
  5314. munmap(addr_, size_);
  5315. addr_ = nullptr;
  5316. }
  5317. if (fd_ != -1) {
  5318. ::close(fd_);
  5319. fd_ = -1;
  5320. }
  5321. #endif
  5322. size_ = 0;
  5323. }
  5324. inline int close_socket(socket_t sock) noexcept {
  5325. #ifdef _WIN32
  5326. return closesocket(sock);
  5327. #else
  5328. return close(sock);
  5329. #endif
  5330. }
  5331. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5332. ssize_t res = 0;
  5333. while (true) {
  5334. res = fn();
  5335. if (res < 0 && errno == EINTR) {
  5336. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5337. continue;
  5338. }
  5339. break;
  5340. }
  5341. return res;
  5342. }
  5343. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5344. return handle_EINTR([&]() {
  5345. return recv(sock,
  5346. #ifdef _WIN32
  5347. static_cast<char *>(ptr), static_cast<int>(size),
  5348. #else
  5349. ptr, size,
  5350. #endif
  5351. flags);
  5352. });
  5353. }
  5354. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5355. int flags) {
  5356. return handle_EINTR([&]() {
  5357. return send(sock,
  5358. #ifdef _WIN32
  5359. static_cast<const char *>(ptr), static_cast<int>(size),
  5360. #else
  5361. ptr, size,
  5362. #endif
  5363. flags);
  5364. });
  5365. }
  5366. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5367. #ifdef _WIN32
  5368. return ::WSAPoll(fds, nfds, timeout);
  5369. #else
  5370. return ::poll(fds, nfds, timeout);
  5371. #endif
  5372. }
  5373. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5374. time_t usec) {
  5375. struct pollfd pfd;
  5376. pfd.fd = sock;
  5377. pfd.events = events;
  5378. pfd.revents = 0;
  5379. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5380. // "return immediately", which callers here rely on to probe a socket.
  5381. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5382. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5383. }
  5384. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5385. return select_impl(sock, POLLIN, sec, usec);
  5386. }
  5387. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5388. return select_impl(sock, POLLOUT, sec, usec);
  5389. }
  5390. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5391. time_t usec) {
  5392. struct pollfd pfd_read;
  5393. pfd_read.fd = sock;
  5394. pfd_read.events = POLLIN | POLLOUT;
  5395. pfd_read.revents = 0;
  5396. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5397. auto poll_res =
  5398. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5399. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5400. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5401. auto error = 0;
  5402. socklen_t len = sizeof(error);
  5403. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5404. reinterpret_cast<char *>(&error), &len);
  5405. auto successful = res >= 0 && !error;
  5406. return successful ? Error::Success : Error::Connection;
  5407. }
  5408. return Error::Connection;
  5409. }
  5410. inline bool is_socket_alive(socket_t sock) {
  5411. const auto val = detail::select_read(sock, 0, 0);
  5412. if (val == 0) {
  5413. return true;
  5414. } else if (val < 0 && errno == EBADF) {
  5415. return false;
  5416. }
  5417. char buf[1];
  5418. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5419. }
  5420. class SocketStream final : public Stream {
  5421. public:
  5422. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5423. time_t write_timeout_sec, time_t write_timeout_usec,
  5424. time_t max_timeout_msec = 0,
  5425. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5426. (std::chrono::steady_clock::time_point::min)());
  5427. ~SocketStream() override;
  5428. bool is_readable() const override;
  5429. bool wait_readable() const override;
  5430. bool wait_writable() const override;
  5431. bool is_peer_alive() const override;
  5432. ssize_t read(char *ptr, size_t size) override;
  5433. ssize_t write(const char *ptr, size_t size) override;
  5434. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5435. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5436. socket_t socket() const override;
  5437. time_t duration() const override;
  5438. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5439. const char *buffered_data(size_t &size) const override;
  5440. void consume_buffered(size_t size) override;
  5441. // The caller has just seen this socket become readable. Lets the next read
  5442. // skip its own readiness wait, which would otherwise ask the kernel a
  5443. // question that was answered a moment ago. Consumed by that read.
  5444. void set_readable_hint() { readable_hint_ = true; }
  5445. private:
  5446. bool ensure_readable();
  5447. socket_t sock_;
  5448. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5449. // thread while a read is in flight -- that is the point of it, for a caller
  5450. // holding one connection and wanting control back to send on it.
  5451. std::atomic<time_t> read_timeout_sec_;
  5452. std::atomic<time_t> read_timeout_usec_;
  5453. time_t write_timeout_sec_;
  5454. time_t write_timeout_usec_;
  5455. time_t max_timeout_msec_;
  5456. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5457. std::vector<char> read_buff_;
  5458. size_t read_buff_off_ = 0;
  5459. size_t read_buff_content_size_ = 0;
  5460. bool readable_hint_ = false;
  5461. static const size_t read_buff_size_ = 1024l * 4;
  5462. };
  5463. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5464. time_t keep_alive_timeout_sec) {
  5465. using namespace std::chrono;
  5466. const auto interval_usec =
  5467. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5468. // Avoid expensive `steady_clock::now()` call for the first time
  5469. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5470. const auto start = steady_clock::now() - microseconds{interval_usec};
  5471. const auto timeout = seconds{keep_alive_timeout_sec};
  5472. while (true) {
  5473. if (svr_sock == INVALID_SOCKET) {
  5474. break; // Server socket is closed
  5475. }
  5476. auto val = select_read(sock, 0, interval_usec);
  5477. if (val < 0) {
  5478. break; // Ssocket error
  5479. } else if (val == 0) {
  5480. if (steady_clock::now() - start > timeout) {
  5481. break; // Timeout
  5482. }
  5483. } else {
  5484. return true; // Ready for read
  5485. }
  5486. }
  5487. return false;
  5488. }
  5489. template <typename T>
  5490. inline bool
  5491. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5492. size_t keep_alive_max_count,
  5493. time_t keep_alive_timeout_sec, T callback) {
  5494. assert(keep_alive_max_count > 0);
  5495. auto ret = false;
  5496. auto count = keep_alive_max_count;
  5497. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5498. auto close_connection = count == 1;
  5499. auto connection_closed = false;
  5500. ret = callback(close_connection, connection_closed);
  5501. if (!ret || connection_closed) { break; }
  5502. count--;
  5503. }
  5504. return ret;
  5505. }
  5506. template <typename T>
  5507. inline bool
  5508. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5509. size_t keep_alive_max_count,
  5510. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5511. time_t read_timeout_usec, time_t write_timeout_sec,
  5512. time_t write_timeout_usec, T callback) {
  5513. return process_server_socket_core(
  5514. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5515. [&](bool close_connection, bool &connection_closed) {
  5516. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5517. write_timeout_sec, write_timeout_usec);
  5518. // process_server_socket_core() only gets here once keep_alive() has
  5519. // seen the socket go readable.
  5520. strm.set_readable_hint();
  5521. return callback(strm, close_connection, connection_closed);
  5522. });
  5523. }
  5524. inline bool process_client_socket(
  5525. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5526. time_t write_timeout_sec, time_t write_timeout_usec,
  5527. time_t max_timeout_msec,
  5528. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5529. std::function<bool(Stream &)> callback) {
  5530. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5531. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5532. start_time);
  5533. return callback(strm);
  5534. }
  5535. inline int shutdown_socket(socket_t sock) noexcept {
  5536. #ifdef _WIN32
  5537. return shutdown(sock, SD_BOTH);
  5538. #else
  5539. return shutdown(sock, SHUT_RDWR);
  5540. #endif
  5541. }
  5542. // Half-closes the write side and drains any in-flight/queued bytes before
  5543. // the final shutdown+close. Closing with unread data in the receive queue
  5544. // (or bytes arriving after the receive side is closed) makes the stack send
  5545. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5546. // response as a failed read even though it was fully written.
  5547. inline void drain_and_close_socket(socket_t sock) noexcept {
  5548. #ifdef _WIN32
  5549. shutdown(sock, SD_SEND);
  5550. #else
  5551. shutdown(sock, SHUT_WR);
  5552. #endif
  5553. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5554. size_t total = 0;
  5555. const auto deadline = std::chrono::steady_clock::now() +
  5556. std::chrono::milliseconds(100); // bound #1
  5557. while (total < size_t(1024u * 1024u)) { // bound #2
  5558. const auto remaining =
  5559. std::chrono::duration_cast<std::chrono::microseconds>(
  5560. deadline - std::chrono::steady_clock::now())
  5561. .count();
  5562. if (remaining <= 0) { break; }
  5563. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5564. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5565. if (n <= 0) { break; }
  5566. total += static_cast<size_t>(n);
  5567. }
  5568. shutdown_socket(sock);
  5569. close_socket(sock);
  5570. }
  5571. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5572. if (s.size() > 1 && s[0] == '\0') {
  5573. auto ret = s;
  5574. ret[0] = '@';
  5575. return ret;
  5576. }
  5577. return s;
  5578. }
  5579. inline std::string
  5580. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5581. if (s.size() > 1 && s[0] == '@') {
  5582. auto ret = s;
  5583. ret[0] = '\0';
  5584. return ret;
  5585. }
  5586. return s;
  5587. }
  5588. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5589. const struct addrinfo *hints,
  5590. struct addrinfo **res, time_t timeout_sec) {
  5591. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5592. if (timeout_sec <= 0) {
  5593. // No timeout specified, use standard getaddrinfo
  5594. return getaddrinfo(node, service, hints, res);
  5595. }
  5596. #ifdef _WIN32
  5597. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5598. OVERLAPPED overlapped = {};
  5599. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5600. if (!event) { return EAI_FAIL; }
  5601. overlapped.hEvent = event;
  5602. PADDRINFOEXW result_addrinfo = nullptr;
  5603. HANDLE cancel_handle = nullptr;
  5604. ADDRINFOEXW hints_ex = {};
  5605. if (hints) {
  5606. hints_ex.ai_flags = hints->ai_flags;
  5607. hints_ex.ai_family = hints->ai_family;
  5608. hints_ex.ai_socktype = hints->ai_socktype;
  5609. hints_ex.ai_protocol = hints->ai_protocol;
  5610. }
  5611. auto wnode = u8string_to_wstring(node);
  5612. auto wservice = u8string_to_wstring(service);
  5613. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5614. hints ? &hints_ex : nullptr, &result_addrinfo,
  5615. nullptr, &overlapped, nullptr, &cancel_handle);
  5616. if (ret == WSA_IO_PENDING) {
  5617. auto wait_result =
  5618. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5619. if (wait_result == WAIT_TIMEOUT) {
  5620. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5621. ::CloseHandle(event);
  5622. return EAI_AGAIN;
  5623. }
  5624. DWORD bytes_returned;
  5625. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5626. &bytes_returned, FALSE)) {
  5627. ::CloseHandle(event);
  5628. return ::WSAGetLastError();
  5629. }
  5630. }
  5631. ::CloseHandle(event);
  5632. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5633. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5634. return 0;
  5635. }
  5636. return ret;
  5637. #elif TARGET_OS_MAC && defined(__clang__)
  5638. if (!node) { return EAI_NONAME; }
  5639. // macOS implementation using CFHost API for asynchronous DNS resolution
  5640. CFStringRef hostname_ref = CFStringCreateWithCString(
  5641. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5642. if (!hostname_ref) { return EAI_MEMORY; }
  5643. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5644. CFRelease(hostname_ref);
  5645. if (!host_ref) { return EAI_MEMORY; }
  5646. // Set up context for callback
  5647. struct CFHostContext {
  5648. bool completed = false;
  5649. bool success = false;
  5650. CFArrayRef addresses = nullptr;
  5651. std::mutex mutex;
  5652. std::condition_variable cv;
  5653. } context;
  5654. CFHostClientContext client_context;
  5655. memset(&client_context, 0, sizeof(client_context));
  5656. client_context.info = &context;
  5657. // Set callback
  5658. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5659. const CFStreamError *error, void *info) {
  5660. auto ctx = static_cast<CFHostContext *>(info);
  5661. std::lock_guard<std::mutex> lock(ctx->mutex);
  5662. if (error && error->error != 0) {
  5663. ctx->success = false;
  5664. } else {
  5665. Boolean hasBeenResolved;
  5666. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5667. if (ctx->addresses && hasBeenResolved) {
  5668. CFRetain(ctx->addresses);
  5669. ctx->success = true;
  5670. } else {
  5671. ctx->success = false;
  5672. }
  5673. }
  5674. ctx->completed = true;
  5675. ctx->cv.notify_one();
  5676. };
  5677. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5678. CFRelease(host_ref);
  5679. return EAI_SYSTEM;
  5680. }
  5681. // Schedule on run loop
  5682. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5683. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5684. // Start resolution
  5685. CFStreamError stream_error;
  5686. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5687. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5688. CFRelease(host_ref);
  5689. return EAI_FAIL;
  5690. }
  5691. // Wait for completion with timeout
  5692. auto timeout_time =
  5693. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5694. bool timed_out = false;
  5695. {
  5696. std::unique_lock<std::mutex> lock(context.mutex);
  5697. while (!context.completed) {
  5698. auto now = std::chrono::steady_clock::now();
  5699. if (now >= timeout_time) {
  5700. timed_out = true;
  5701. break;
  5702. }
  5703. // Run the runloop for a short time
  5704. lock.unlock();
  5705. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5706. lock.lock();
  5707. }
  5708. }
  5709. // Clean up
  5710. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5711. CFHostSetClient(host_ref, nullptr, nullptr);
  5712. if (timed_out || !context.completed) {
  5713. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5714. CFRelease(host_ref);
  5715. return EAI_AGAIN;
  5716. }
  5717. if (!context.success || !context.addresses) {
  5718. CFRelease(host_ref);
  5719. return EAI_NODATA;
  5720. }
  5721. // Convert CFArray to addrinfo
  5722. CFIndex count = CFArrayGetCount(context.addresses);
  5723. if (count == 0) {
  5724. CFRelease(context.addresses);
  5725. CFRelease(host_ref);
  5726. return EAI_NODATA;
  5727. }
  5728. struct addrinfo *result_addrinfo = nullptr;
  5729. struct addrinfo **current = &result_addrinfo;
  5730. for (CFIndex i = 0; i < count; i++) {
  5731. CFDataRef addr_data =
  5732. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5733. if (!addr_data) continue;
  5734. const struct sockaddr *sockaddr_ptr =
  5735. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5736. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5737. // Allocate addrinfo structure
  5738. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5739. if (!*current) {
  5740. freeaddrinfo(result_addrinfo);
  5741. CFRelease(context.addresses);
  5742. CFRelease(host_ref);
  5743. return EAI_MEMORY;
  5744. }
  5745. memset(*current, 0, sizeof(struct addrinfo));
  5746. // Set up addrinfo fields
  5747. (*current)->ai_family = sockaddr_ptr->sa_family;
  5748. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5749. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5750. (*current)->ai_addrlen = sockaddr_len;
  5751. // Copy sockaddr
  5752. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5753. if (!(*current)->ai_addr) {
  5754. freeaddrinfo(result_addrinfo);
  5755. CFRelease(context.addresses);
  5756. CFRelease(host_ref);
  5757. return EAI_MEMORY;
  5758. }
  5759. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5760. // Set port if service is specified
  5761. if (service && *service) {
  5762. int port = 0;
  5763. if (parse_port(service, strlen(service), port)) {
  5764. if (sockaddr_ptr->sa_family == AF_INET) {
  5765. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5766. ->sin_port = htons(static_cast<uint16_t>(port));
  5767. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5768. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5769. ->sin6_port = htons(static_cast<uint16_t>(port));
  5770. }
  5771. }
  5772. }
  5773. current = &((*current)->ai_next);
  5774. }
  5775. CFRelease(context.addresses);
  5776. CFRelease(host_ref);
  5777. *res = result_addrinfo;
  5778. return 0;
  5779. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5780. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5781. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5782. // the resolver worker still references the stack-local gaicb. The cancel
  5783. // path therefore waits (gai_suspend with no timeout) for the worker to
  5784. // actually finish before letting the stack frame go. The trade-off is that
  5785. // a wedged DNS server can hold this thread for the system resolver timeout
  5786. // (~30s by default) past the caller's connection timeout.
  5787. struct gaicb request{};
  5788. struct gaicb *requests[1] = {&request};
  5789. struct sigevent sevp{};
  5790. struct timespec timeout{timeout_sec, 0};
  5791. request.ar_name = node;
  5792. request.ar_service = service;
  5793. request.ar_request = hints;
  5794. sevp.sigev_notify = SIGEV_NONE;
  5795. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5796. if (rc != 0) { return rc; }
  5797. auto cleanup = scope_exit([&] {
  5798. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5799. });
  5800. int wait_result = gai_suspend(requests, 1, &timeout);
  5801. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5802. int gai_result = gai_error(&request);
  5803. if (gai_result == 0) {
  5804. *res = request.ar_result;
  5805. request.ar_result = nullptr;
  5806. return 0;
  5807. }
  5808. return gai_result;
  5809. }
  5810. gai_cancel(&request);
  5811. while (gai_error(&request) == EAI_INPROGRESS) {
  5812. gai_suspend(requests, 1, nullptr);
  5813. }
  5814. return wait_result;
  5815. #else
  5816. // Fallback implementation using thread-based timeout for other Unix systems.
  5817. struct GetAddrInfoState {
  5818. ~GetAddrInfoState() {
  5819. if (info) { freeaddrinfo(info); }
  5820. }
  5821. std::mutex mutex;
  5822. std::condition_variable result_cv;
  5823. bool completed = false;
  5824. int result = EAI_SYSTEM;
  5825. std::string node;
  5826. std::string service;
  5827. struct addrinfo hints;
  5828. struct addrinfo *info = nullptr;
  5829. };
  5830. // Allocate on the heap, so the resolver thread can keep using the data.
  5831. auto state = std::make_shared<GetAddrInfoState>();
  5832. if (node) { state->node = node; }
  5833. state->service = service;
  5834. state->hints = *hints;
  5835. std::thread resolve_thread([state]() {
  5836. auto thread_result =
  5837. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5838. &state->info);
  5839. std::lock_guard<std::mutex> lock(state->mutex);
  5840. state->result = thread_result;
  5841. state->completed = true;
  5842. state->result_cv.notify_one();
  5843. });
  5844. // Wait for completion or timeout
  5845. std::unique_lock<std::mutex> lock(state->mutex);
  5846. auto finished =
  5847. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5848. [&] { return state->completed; });
  5849. if (finished) {
  5850. // Operation completed within timeout
  5851. resolve_thread.join();
  5852. *res = state->info;
  5853. state->info = nullptr; // Pass ownership to caller
  5854. return state->result;
  5855. } else {
  5856. // Timeout occurred
  5857. resolve_thread.detach(); // Let the thread finish in background
  5858. return EAI_AGAIN; // Return timeout error
  5859. }
  5860. #endif
  5861. #else
  5862. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5863. return getaddrinfo(node, service, hints, res);
  5864. #endif
  5865. }
  5866. template <typename BindOrConnect>
  5867. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5868. int address_family, int socket_flags, bool tcp_nodelay,
  5869. bool ipv6_v6only, SocketOptions socket_options,
  5870. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5871. // Get address info
  5872. const char *node = nullptr;
  5873. struct addrinfo hints;
  5874. struct addrinfo *result;
  5875. memset(&hints, 0, sizeof(struct addrinfo));
  5876. hints.ai_socktype = SOCK_STREAM;
  5877. hints.ai_protocol = IPPROTO_IP;
  5878. if (!ip.empty()) {
  5879. node = ip.c_str();
  5880. // Ask getaddrinfo to convert IP in c-string to address
  5881. hints.ai_family = AF_UNSPEC;
  5882. hints.ai_flags = AI_NUMERICHOST;
  5883. } else {
  5884. if (!host.empty()) { node = host.c_str(); }
  5885. hints.ai_family = address_family;
  5886. hints.ai_flags = socket_flags;
  5887. }
  5888. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5889. if (hints.ai_family == AF_UNIX) {
  5890. const auto addrlen = host.length();
  5891. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5892. #ifdef SOCK_CLOEXEC
  5893. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5894. hints.ai_protocol);
  5895. #else
  5896. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5897. #endif
  5898. if (sock != INVALID_SOCKET) {
  5899. sockaddr_un addr{};
  5900. addr.sun_family = AF_UNIX;
  5901. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5902. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5903. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5904. hints.ai_addrlen = static_cast<socklen_t>(
  5905. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5906. #ifndef SOCK_CLOEXEC
  5907. #ifndef _WIN32
  5908. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5909. #endif
  5910. #endif
  5911. if (socket_options) { socket_options(sock); }
  5912. #ifdef _WIN32
  5913. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5914. // remove the option.
  5915. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5916. #endif
  5917. bool dummy;
  5918. if (!bind_or_connect(sock, hints, dummy)) {
  5919. close_socket(sock);
  5920. sock = INVALID_SOCKET;
  5921. }
  5922. }
  5923. return sock;
  5924. }
  5925. #endif
  5926. auto service = std::to_string(port);
  5927. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5928. timeout_sec)) {
  5929. #if defined __linux__ && !defined __ANDROID__
  5930. res_init();
  5931. #endif
  5932. return INVALID_SOCKET;
  5933. }
  5934. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5935. for (auto rp = result; rp; rp = rp->ai_next) {
  5936. // Create a socket
  5937. #ifdef _WIN32
  5938. auto sock =
  5939. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5940. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5941. /**
  5942. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5943. * and above the socket creation fails on older Windows Systems.
  5944. *
  5945. * Let's try to create a socket the old way in this case.
  5946. *
  5947. * Reference:
  5948. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5949. *
  5950. * WSA_FLAG_NO_HANDLE_INHERIT:
  5951. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5952. * SP1, and later
  5953. *
  5954. */
  5955. if (sock == INVALID_SOCKET) {
  5956. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5957. }
  5958. #else
  5959. #ifdef SOCK_CLOEXEC
  5960. auto sock =
  5961. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5962. #else
  5963. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5964. #endif
  5965. #endif
  5966. if (sock == INVALID_SOCKET) { continue; }
  5967. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5968. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5969. close_socket(sock);
  5970. continue;
  5971. }
  5972. #endif
  5973. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5974. if (rp->ai_family == AF_INET6) {
  5975. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5976. }
  5977. if (socket_options) { socket_options(sock); }
  5978. // bind or connect
  5979. auto quit = false;
  5980. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5981. close_socket(sock);
  5982. if (quit) { break; }
  5983. }
  5984. return INVALID_SOCKET;
  5985. }
  5986. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5987. #ifdef _WIN32
  5988. auto flags = nonblocking ? 1UL : 0UL;
  5989. ioctlsocket(sock, FIONBIO, &flags);
  5990. #else
  5991. auto flags = fcntl(sock, F_GETFL, 0);
  5992. fcntl(sock, F_SETFL,
  5993. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5994. #endif
  5995. }
  5996. inline bool is_connection_error() {
  5997. #ifdef _WIN32
  5998. return WSAGetLastError() != WSAEWOULDBLOCK;
  5999. #else
  6000. return errno != EINPROGRESS;
  6001. #endif
  6002. }
  6003. // accept() failed because the process or the network stack is temporarily out
  6004. // of resources. The listening socket is still usable, so back off briefly and
  6005. // try again.
  6006. inline bool is_accept_resource_error() {
  6007. #ifdef _WIN32
  6008. auto err = WSAGetLastError();
  6009. return err == WSAEMFILE || err == WSAENOBUFS;
  6010. #else
  6011. auto err = errno;
  6012. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6013. #endif
  6014. }
  6015. // accept() failed for a reason that says nothing about the listening socket:
  6016. // the pending connection went away before it could be accepted, or the call
  6017. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6018. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6019. // connection that way.
  6020. inline bool is_accept_transient_error() {
  6021. #ifdef _WIN32
  6022. auto err = WSAGetLastError();
  6023. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6024. err == WSAECONNABORTED;
  6025. #else
  6026. auto err = errno;
  6027. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6028. err == ECONNABORTED;
  6029. #endif
  6030. }
  6031. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6032. struct addrinfo hints;
  6033. struct addrinfo *result;
  6034. memset(&hints, 0, sizeof(struct addrinfo));
  6035. hints.ai_family = AF_UNSPEC;
  6036. hints.ai_socktype = SOCK_STREAM;
  6037. hints.ai_protocol = 0;
  6038. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6039. return false;
  6040. }
  6041. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6042. auto ret = false;
  6043. for (auto rp = result; rp; rp = rp->ai_next) {
  6044. const auto &ai = *rp;
  6045. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6046. ret = true;
  6047. break;
  6048. }
  6049. }
  6050. return ret;
  6051. }
  6052. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6053. #define USE_IF2IP
  6054. #endif
  6055. #ifdef USE_IF2IP
  6056. inline std::string if2ip(int address_family, const std::string &ifn) {
  6057. struct ifaddrs *ifap;
  6058. getifaddrs(&ifap);
  6059. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6060. std::string addr_candidate;
  6061. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6062. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6063. (AF_UNSPEC == address_family ||
  6064. ifa->ifa_addr->sa_family == address_family)) {
  6065. if (ifa->ifa_addr->sa_family == AF_INET) {
  6066. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6067. char buf[INET_ADDRSTRLEN];
  6068. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6069. return std::string(buf, INET_ADDRSTRLEN);
  6070. }
  6071. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6072. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6073. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6074. char buf[INET6_ADDRSTRLEN] = {};
  6075. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6076. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6077. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6078. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6079. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6080. } else {
  6081. return std::string(buf, INET6_ADDRSTRLEN);
  6082. }
  6083. }
  6084. }
  6085. }
  6086. }
  6087. }
  6088. return addr_candidate;
  6089. }
  6090. #endif
  6091. inline socket_t create_client_socket(
  6092. const std::string &host, const std::string &ip, int port,
  6093. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6094. SocketOptions socket_options, time_t connection_timeout_sec,
  6095. time_t connection_timeout_usec, time_t read_timeout_sec,
  6096. time_t read_timeout_usec, time_t write_timeout_sec,
  6097. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6098. auto sock = create_socket(
  6099. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6100. std::move(socket_options),
  6101. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6102. if (!intf.empty()) {
  6103. #ifdef USE_IF2IP
  6104. auto ip_from_if = if2ip(address_family, intf);
  6105. if (ip_from_if.empty()) { ip_from_if = intf; }
  6106. if (!bind_ip_address(sock2, ip_from_if)) {
  6107. error = Error::BindIPAddress;
  6108. return false;
  6109. }
  6110. #endif
  6111. }
  6112. set_nonblocking(sock2, true);
  6113. auto ret =
  6114. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6115. if (ret < 0) {
  6116. if (is_connection_error()) {
  6117. error = Error::Connection;
  6118. return false;
  6119. }
  6120. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6121. connection_timeout_usec);
  6122. if (error != Error::Success) {
  6123. if (error == Error::ConnectionTimeout) { quit = true; }
  6124. return false;
  6125. }
  6126. }
  6127. set_nonblocking(sock2, false);
  6128. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6129. read_timeout_usec);
  6130. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6131. write_timeout_usec);
  6132. error = Error::Success;
  6133. return true;
  6134. },
  6135. connection_timeout_sec); // Pass DNS timeout
  6136. if (sock != INVALID_SOCKET) {
  6137. error = Error::Success;
  6138. } else {
  6139. if (error == Error::Success) { error = Error::Connection; }
  6140. }
  6141. return sock;
  6142. }
  6143. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6144. socklen_t addr_len, std::string &ip, int &port) {
  6145. if (addr.ss_family == AF_INET) {
  6146. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6147. } else if (addr.ss_family == AF_INET6) {
  6148. port =
  6149. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6150. } else {
  6151. return false;
  6152. }
  6153. std::array<char, NI_MAXHOST> ipstr{};
  6154. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6155. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6156. 0, NI_NUMERICHOST)) {
  6157. return false;
  6158. }
  6159. ip = ipstr.data();
  6160. return true;
  6161. }
  6162. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6163. struct sockaddr_storage addr;
  6164. socklen_t addr_len = sizeof(addr);
  6165. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6166. &addr_len)) {
  6167. get_ip_and_port(addr, addr_len, ip, port);
  6168. }
  6169. }
  6170. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6171. struct sockaddr_storage addr;
  6172. socklen_t addr_len = sizeof(addr);
  6173. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6174. &addr_len)) {
  6175. #ifndef _WIN32
  6176. if (addr.ss_family == AF_UNIX) {
  6177. #if defined(__linux__)
  6178. struct ucred ucred;
  6179. socklen_t len = sizeof(ucred);
  6180. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6181. port = ucred.pid;
  6182. }
  6183. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6184. pid_t pid;
  6185. socklen_t len = sizeof(pid);
  6186. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6187. port = pid;
  6188. }
  6189. #endif
  6190. return;
  6191. }
  6192. #endif
  6193. get_ip_and_port(addr, addr_len, ip, port);
  6194. }
  6195. }
  6196. // Recursive form retained so operator""_t below can compute hashes for
  6197. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6198. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6199. // instead, which is iterative and stack-safe.
  6200. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6201. unsigned int h) {
  6202. return (l == 0)
  6203. ? h
  6204. : str2tag_core(
  6205. s + 1, l - 1,
  6206. // Unsets the 6 high bits of h, therefore no overflow happens
  6207. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6208. h * 33) ^
  6209. static_cast<unsigned char>(*s));
  6210. }
  6211. inline unsigned int str2tag(const std::string &s) {
  6212. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6213. // for compile-time UDL evaluation of short string literals, but at runtime
  6214. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6215. // would blow the stack with one frame per character.
  6216. unsigned int h = 0;
  6217. for (auto c : s) {
  6218. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6219. static_cast<unsigned char>(c);
  6220. }
  6221. return h;
  6222. }
  6223. namespace udl {
  6224. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6225. return str2tag_core(s, l, 0);
  6226. }
  6227. } // namespace udl
  6228. inline std::string
  6229. find_content_type(const std::string &path,
  6230. const std::map<std::string, std::string> &user_data,
  6231. const std::string &default_content_type) {
  6232. auto ext = file_extension(path);
  6233. auto it = user_data.find(ext);
  6234. if (it != user_data.end()) { return it->second; }
  6235. using udl::operator""_t;
  6236. switch (str2tag(ext)) {
  6237. default: return default_content_type;
  6238. case "css"_t: return "text/css";
  6239. case "csv"_t: return "text/csv";
  6240. case "htm"_t:
  6241. case "html"_t: return "text/html";
  6242. case "js"_t:
  6243. case "mjs"_t: return "text/javascript";
  6244. case "txt"_t: return "text/plain";
  6245. case "vtt"_t: return "text/vtt";
  6246. case "apng"_t: return "image/apng";
  6247. case "avif"_t: return "image/avif";
  6248. case "bmp"_t: return "image/bmp";
  6249. case "gif"_t: return "image/gif";
  6250. case "png"_t: return "image/png";
  6251. case "svg"_t: return "image/svg+xml";
  6252. case "webp"_t: return "image/webp";
  6253. case "ico"_t: return "image/x-icon";
  6254. case "tif"_t: return "image/tiff";
  6255. case "tiff"_t: return "image/tiff";
  6256. case "jpg"_t:
  6257. case "jpeg"_t: return "image/jpeg";
  6258. case "mp4"_t: return "video/mp4";
  6259. case "mpeg"_t: return "video/mpeg";
  6260. case "webm"_t: return "video/webm";
  6261. case "mp3"_t: return "audio/mp3";
  6262. case "mpga"_t: return "audio/mpeg";
  6263. case "weba"_t: return "audio/webm";
  6264. case "wav"_t: return "audio/wave";
  6265. case "otf"_t: return "font/otf";
  6266. case "ttf"_t: return "font/ttf";
  6267. case "woff"_t: return "font/woff";
  6268. case "woff2"_t: return "font/woff2";
  6269. case "7z"_t: return "application/x-7z-compressed";
  6270. case "atom"_t: return "application/atom+xml";
  6271. case "pdf"_t: return "application/pdf";
  6272. case "json"_t: return "application/json";
  6273. case "rss"_t: return "application/rss+xml";
  6274. case "tar"_t: return "application/x-tar";
  6275. case "xht"_t:
  6276. case "xhtml"_t: return "application/xhtml+xml";
  6277. case "xslt"_t: return "application/xslt+xml";
  6278. case "xml"_t: return "application/xml";
  6279. case "gz"_t: return "application/gzip";
  6280. case "zip"_t: return "application/zip";
  6281. case "wasm"_t: return "application/wasm";
  6282. }
  6283. }
  6284. inline std::string
  6285. extract_media_type(const std::string &content_type,
  6286. std::map<std::string, std::string> *params = nullptr) {
  6287. // Extract type/subtype from Content-Type value (RFC 2045)
  6288. // e.g. "application/json; charset=utf-8" -> "application/json"
  6289. auto media_type = content_type;
  6290. auto semicolon_pos = media_type.find(';');
  6291. if (semicolon_pos != std::string::npos) {
  6292. auto param_str = media_type.substr(semicolon_pos + 1);
  6293. media_type = media_type.substr(0, semicolon_pos);
  6294. if (params) {
  6295. // Parse parameters: key=value pairs separated by ';'
  6296. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6297. [&](const char *b, const char *e) {
  6298. std::string key;
  6299. std::string val;
  6300. divide_param_pair(b, e, key, val);
  6301. if (!key.empty()) {
  6302. params->emplace(trim_copy(key),
  6303. trim_double_quotes_copy(val));
  6304. }
  6305. });
  6306. }
  6307. }
  6308. // Trim whitespace from media type
  6309. return trim_copy(media_type);
  6310. }
  6311. inline bool can_compress_content_type(const std::string &content_type) {
  6312. using udl::operator""_t;
  6313. auto mime_type = extract_media_type(content_type);
  6314. auto tag = str2tag(mime_type);
  6315. switch (tag) {
  6316. case "image/svg+xml"_t:
  6317. case "application/javascript"_t:
  6318. case "application/x-javascript"_t:
  6319. case "application/json"_t:
  6320. case "application/ld+json"_t:
  6321. case "application/xml"_t:
  6322. case "application/xhtml+xml"_t:
  6323. case "application/rss+xml"_t:
  6324. case "application/atom+xml"_t:
  6325. case "application/xslt+xml"_t:
  6326. case "application/protobuf"_t: return true;
  6327. case "text/event-stream"_t: return false;
  6328. default: return !mime_type.rfind("text/", 0);
  6329. }
  6330. }
  6331. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6332. double &quality) {
  6333. quality = 1.0;
  6334. token.clear();
  6335. // Split on first ';': left = token name, right = parameters
  6336. const char *params_b = nullptr;
  6337. std::size_t params_len = 0;
  6338. divide(
  6339. b, static_cast<std::size_t>(e - b), ';',
  6340. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6341. auto r = trim(lb, lb + llen, 0, llen);
  6342. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6343. params_b = rb;
  6344. params_len = rlen;
  6345. });
  6346. if (token.empty()) { return false; }
  6347. if (params_len == 0) { return true; }
  6348. // Scan parameters for q= (stops on first match)
  6349. bool invalid = false;
  6350. split_find(params_b, params_b + params_len, ';',
  6351. (std::numeric_limits<size_t>::max)(),
  6352. [&](const char *pb, const char *pe) -> bool {
  6353. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6354. auto len = static_cast<size_t>(pe - pb);
  6355. if (len < 2) { return false; }
  6356. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6357. return false;
  6358. }
  6359. // Trim the value portion
  6360. auto r = trim(pb, pe, 2, len);
  6361. if (r.first >= r.second) {
  6362. invalid = true;
  6363. return true;
  6364. }
  6365. double v = 0.0;
  6366. auto res = from_chars(pb + r.first, pb + r.second, v);
  6367. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6368. v < 0.0 || v > 1.0) {
  6369. invalid = true;
  6370. return true;
  6371. }
  6372. quality = v;
  6373. return true;
  6374. });
  6375. return !invalid;
  6376. }
  6377. inline EncodingType encoding_type(const Request &req,
  6378. const std::string &content_type) {
  6379. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6380. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6381. if (s.empty()) { return EncodingType::None; }
  6382. // Single-pass: iterate tokens and track the best supported encoding.
  6383. // Server preference breaks ties (br > gzip > zstd).
  6384. EncodingType best = EncodingType::None;
  6385. double best_q = 0.0; // q=0 means "not acceptable"
  6386. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6387. auto priority = [](EncodingType t) -> int {
  6388. switch (t) {
  6389. case EncodingType::Brotli: return 0;
  6390. case EncodingType::Gzip: return 1;
  6391. case EncodingType::Zstd: return 2;
  6392. default: return 3;
  6393. }
  6394. };
  6395. std::string name;
  6396. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6397. double quality = 1.0;
  6398. if (!parse_quality(b, e, name, quality)) { return; }
  6399. if (quality <= 0.0) { return; }
  6400. EncodingType type = EncodingType::None;
  6401. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6402. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6403. #endif
  6404. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6405. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6406. type = EncodingType::Gzip;
  6407. }
  6408. #endif
  6409. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6410. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6411. type = EncodingType::Zstd;
  6412. }
  6413. #endif
  6414. if (type == EncodingType::None) { return; }
  6415. // Higher q-value wins; for equal q, server preference breaks ties
  6416. if (quality > best_q ||
  6417. (quality == best_q && priority(type) < priority(best))) {
  6418. best_q = quality;
  6419. best = type;
  6420. }
  6421. });
  6422. return best;
  6423. }
  6424. // `content_type` is taken separately because a file-backed response has not
  6425. // been given one yet when its coding has to be decided.
  6426. inline EncodingType encoding_type(const Request &req, const Response &res,
  6427. const std::string &content_type) {
  6428. // The response already names a content coding of its own: a handler serving
  6429. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6430. // point whose headers name the coding its files are stored in. Applying one
  6431. // on top of that would double-encode the body and append a second
  6432. // `Content-Encoding` field line.
  6433. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6434. return encoding_type(req, content_type);
  6435. }
  6436. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6437. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6438. }
  6439. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6440. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6441. if (type == EncodingType::Gzip) {
  6442. return detail::make_unique<gzip_compressor>();
  6443. }
  6444. #endif
  6445. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6446. if (type == EncodingType::Brotli) {
  6447. return detail::make_unique<brotli_compressor>();
  6448. }
  6449. #endif
  6450. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6451. if (type == EncodingType::Zstd) {
  6452. return detail::make_unique<zstd_compressor>();
  6453. }
  6454. #endif
  6455. (void)type;
  6456. return nullptr;
  6457. }
  6458. inline const char *encoding_name(EncodingType type) {
  6459. switch (type) {
  6460. case EncodingType::Gzip: return "gzip";
  6461. case EncodingType::Brotli: return "br";
  6462. case EncodingType::Zstd: return "zstd";
  6463. default: return "";
  6464. }
  6465. }
  6466. inline bool nocompressor::compress(const char *data, size_t data_length,
  6467. bool /*last*/, Callback callback) {
  6468. if (!data_length) { return true; }
  6469. return callback(data, data_length);
  6470. }
  6471. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6472. inline gzip_compressor::gzip_compressor() {
  6473. std::memset(&strm_, 0, sizeof(strm_));
  6474. strm_.zalloc = Z_NULL;
  6475. strm_.zfree = Z_NULL;
  6476. strm_.opaque = Z_NULL;
  6477. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6478. Z_DEFAULT_STRATEGY) == Z_OK;
  6479. }
  6480. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6481. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6482. bool last, Callback callback) {
  6483. assert(is_valid_);
  6484. do {
  6485. constexpr size_t max_avail_in =
  6486. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6487. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6488. (std::min)(data_length, max_avail_in));
  6489. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6490. data_length -= strm_.avail_in;
  6491. data += strm_.avail_in;
  6492. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6493. auto ret = Z_OK;
  6494. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6495. do {
  6496. strm_.avail_out = static_cast<uInt>(buff.size());
  6497. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6498. ret = deflate(&strm_, flush);
  6499. if (ret == Z_STREAM_ERROR) { return false; }
  6500. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6501. return false;
  6502. }
  6503. } while (strm_.avail_out == 0);
  6504. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6505. (flush == Z_NO_FLUSH && ret == Z_OK));
  6506. assert(strm_.avail_in == 0);
  6507. } while (data_length > 0);
  6508. return true;
  6509. }
  6510. inline gzip_decompressor::gzip_decompressor() {
  6511. std::memset(&strm_, 0, sizeof(strm_));
  6512. strm_.zalloc = Z_NULL;
  6513. strm_.zfree = Z_NULL;
  6514. strm_.opaque = Z_NULL;
  6515. // 15 is the value of wbits, which should be at the maximum possible value
  6516. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6517. // that the stream type should be automatically detected either gzip or
  6518. // deflate.
  6519. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6520. }
  6521. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6522. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6523. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6524. Callback callback) {
  6525. assert(is_valid_);
  6526. auto ret = Z_OK;
  6527. do {
  6528. constexpr size_t max_avail_in =
  6529. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6530. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6531. (std::min)(data_length, max_avail_in));
  6532. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6533. data_length -= strm_.avail_in;
  6534. data += strm_.avail_in;
  6535. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6536. while (strm_.avail_in > 0 && ret == Z_OK) {
  6537. strm_.avail_out = static_cast<uInt>(buff.size());
  6538. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6539. ret = inflate(&strm_, Z_NO_FLUSH);
  6540. assert(ret != Z_STREAM_ERROR);
  6541. switch (ret) {
  6542. case Z_NEED_DICT:
  6543. case Z_DATA_ERROR:
  6544. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6545. }
  6546. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6547. return false;
  6548. }
  6549. }
  6550. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6551. } while (data_length > 0);
  6552. return true;
  6553. }
  6554. #endif
  6555. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6556. inline brotli_compressor::brotli_compressor() {
  6557. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6558. }
  6559. inline brotli_compressor::~brotli_compressor() {
  6560. BrotliEncoderDestroyInstance(state_);
  6561. }
  6562. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6563. bool last, Callback callback) {
  6564. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6565. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6566. auto available_in = data_length;
  6567. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6568. for (;;) {
  6569. if (last) {
  6570. if (BrotliEncoderIsFinished(state_)) { break; }
  6571. } else {
  6572. if (!available_in) { break; }
  6573. }
  6574. auto available_out = buff.size();
  6575. auto next_out = buff.data();
  6576. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6577. &available_out, &next_out, nullptr)) {
  6578. return false;
  6579. }
  6580. auto output_bytes = buff.size() - available_out;
  6581. if (output_bytes) {
  6582. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6583. }
  6584. }
  6585. return true;
  6586. }
  6587. inline brotli_decompressor::brotli_decompressor() {
  6588. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6589. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6590. : BROTLI_DECODER_RESULT_ERROR;
  6591. }
  6592. inline brotli_decompressor::~brotli_decompressor() {
  6593. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6594. }
  6595. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6596. inline bool brotli_decompressor::decompress(const char *data,
  6597. size_t data_length,
  6598. Callback callback) {
  6599. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6600. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6601. return 0;
  6602. }
  6603. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6604. size_t avail_in = data_length;
  6605. size_t total_out;
  6606. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6607. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6608. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6609. char *next_out = buff.data();
  6610. size_t avail_out = buff.size();
  6611. decoder_r = BrotliDecoderDecompressStream(
  6612. decoder_s, &avail_in, &next_in, &avail_out,
  6613. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6614. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6615. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6616. }
  6617. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6618. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6619. }
  6620. #endif
  6621. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6622. inline zstd_compressor::zstd_compressor() {
  6623. ctx_ = ZSTD_createCCtx();
  6624. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6625. }
  6626. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6627. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6628. bool last, Callback callback) {
  6629. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6630. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6631. ZSTD_inBuffer input = {data, data_length, 0};
  6632. bool finished;
  6633. do {
  6634. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6635. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6636. if (ZSTD_isError(remaining)) { return false; }
  6637. if (!callback(buff.data(), output.pos)) { return false; }
  6638. finished = last ? (remaining == 0) : (input.pos == input.size);
  6639. } while (!finished);
  6640. return true;
  6641. }
  6642. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6643. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6644. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6645. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6646. Callback callback) {
  6647. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6648. ZSTD_inBuffer input = {data, data_length, 0};
  6649. while (input.pos < input.size) {
  6650. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6651. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6652. if (ZSTD_isError(remaining)) { return false; }
  6653. if (!callback(buff.data(), output.pos)) { return false; }
  6654. }
  6655. return true;
  6656. }
  6657. #endif
  6658. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6659. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6660. // unknown coding, and its payload would be handed back still compressed.
  6661. inline bool is_zlib_encoding(const std::string &encoding) {
  6662. return case_ignore::equal(encoding, "gzip") ||
  6663. case_ignore::equal(encoding, "deflate");
  6664. }
  6665. inline bool is_brotli_encoding(const std::string &encoding) {
  6666. return case_ignore::equal(encoding, "br");
  6667. }
  6668. inline bool is_zstd_encoding(const std::string &encoding) {
  6669. return case_ignore::equal(encoding, "zstd");
  6670. }
  6671. // Returns true if the content coding is one cpp-httplib is able to decompress
  6672. // when the corresponding support is compiled in.
  6673. inline bool is_known_content_encoding(const std::string &encoding) {
  6674. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6675. is_zstd_encoding(encoding);
  6676. }
  6677. inline std::unique_ptr<decompressor>
  6678. create_decompressor(const std::string &encoding) {
  6679. std::unique_ptr<decompressor> decompressor;
  6680. if (is_zlib_encoding(encoding)) {
  6681. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6682. decompressor = detail::make_unique<gzip_decompressor>();
  6683. #endif
  6684. } else if (is_brotli_encoding(encoding)) {
  6685. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6686. decompressor = detail::make_unique<brotli_decompressor>();
  6687. #endif
  6688. } else if (is_zstd_encoding(encoding)) {
  6689. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6690. decompressor = detail::make_unique<zstd_decompressor>();
  6691. #endif
  6692. }
  6693. return decompressor;
  6694. }
  6695. // Returns the best available compressor and its Content-Encoding name.
  6696. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6697. inline std::pair<std::unique_ptr<compressor>, const char *>
  6698. create_compressor() {
  6699. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6700. return {detail::make_unique<brotli_compressor>(), "br"};
  6701. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6702. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6703. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6704. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6705. #else
  6706. return {nullptr, nullptr};
  6707. #endif
  6708. }
  6709. inline bool is_prohibited_header_name(const std::string &name) {
  6710. using udl::operator""_t;
  6711. switch (str2tag(name)) {
  6712. case "REMOTE_ADDR"_t:
  6713. case "REMOTE_PORT"_t:
  6714. case "LOCAL_ADDR"_t:
  6715. case "LOCAL_PORT"_t: return true;
  6716. default: return false;
  6717. }
  6718. }
  6719. inline bool has_header(const Headers &headers, const std::string &key) {
  6720. if (is_prohibited_header_name(key)) { return false; }
  6721. return headers.find(key) != headers.end();
  6722. }
  6723. inline const char *get_header_value(const Headers &headers,
  6724. const std::string &key, const char *def,
  6725. size_t id) {
  6726. if (is_prohibited_header_name(key)) {
  6727. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6728. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6729. throw std::invalid_argument(msg);
  6730. #else
  6731. return "";
  6732. #endif
  6733. }
  6734. auto rng = headers.equal_range(key);
  6735. auto it = rng.first;
  6736. std::advance(it, static_cast<ssize_t>(id));
  6737. if (it != rng.second) { return it->second.c_str(); }
  6738. return def;
  6739. }
  6740. inline size_t get_header_value_count(const Headers &headers,
  6741. const std::string &key) {
  6742. return headers.count(key);
  6743. }
  6744. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6745. // list may be sent as several field lines, and the combined field value is
  6746. // those values joined by commas in the order they were received. Callers that
  6747. // parse such a list must work on the combined value; reading only the first
  6748. // occurrence silently drops whatever the later field lines carry.
  6749. inline std::string get_combined_header_value(const Headers &headers,
  6750. const std::string &key) {
  6751. std::string combined;
  6752. auto rng = headers.equal_range(key);
  6753. for (auto it = rng.first; it != rng.second; ++it) {
  6754. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6755. // elements, so an empty field line must not contribute a bare comma to the
  6756. // combined value.
  6757. if (it->second.empty()) { continue; }
  6758. if (!combined.empty()) { combined += ", "; }
  6759. combined += it->second;
  6760. }
  6761. return combined;
  6762. }
  6763. inline bool has_header_token(const Headers &headers, const std::string &key,
  6764. const std::string &token) {
  6765. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6766. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6767. // several lines. Match complete tokens rather than searching the raw value,
  6768. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6769. auto rng = headers.equal_range(key);
  6770. for (auto it = rng.first; it != rng.second; ++it) {
  6771. const auto &value = it->second;
  6772. if (split_find(value.data(), value.data() + value.size(), ',',
  6773. [&](const char *b, const char *e) {
  6774. return case_ignore::equal(std::string(b, e), token);
  6775. })) {
  6776. return true;
  6777. }
  6778. }
  6779. return false;
  6780. }
  6781. template <typename Map>
  6782. inline typename Map::mapped_type
  6783. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6784. auto rng = m.equal_range(key);
  6785. auto it = rng.first;
  6786. std::advance(it, static_cast<ssize_t>(id));
  6787. if (it != rng.second) { return it->second; }
  6788. return typename Map::mapped_type();
  6789. }
  6790. inline void set_header(Headers &headers, const std::string &key,
  6791. const std::string &val) {
  6792. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6793. }
  6794. inline bool read_headers(Stream &strm, Headers &headers) {
  6795. const auto bufsiz = 2048;
  6796. char buf[bufsiz];
  6797. stream_line_reader line_reader(strm, buf, bufsiz);
  6798. size_t header_count = 0;
  6799. for (;;) {
  6800. if (!line_reader.getline()) { return false; }
  6801. // Check if the line ends with CRLF.
  6802. auto line_terminator_len = 2;
  6803. if (line_reader.end_with_crlf()) {
  6804. // Blank line indicates end of headers.
  6805. if (line_reader.size() == 2) { break; }
  6806. } else {
  6807. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6808. // Blank line indicates end of headers.
  6809. if (line_reader.size() == 1) { break; }
  6810. line_terminator_len = 1;
  6811. #else
  6812. continue; // Skip invalid line.
  6813. #endif
  6814. }
  6815. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6816. // Check header count limit
  6817. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6818. // Exclude line terminator
  6819. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6820. if (!parse_header(line_reader.ptr(), end,
  6821. [&](const std::string &key, const std::string &val) {
  6822. headers.emplace(key, val);
  6823. })) {
  6824. return false;
  6825. }
  6826. header_count++;
  6827. }
  6828. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6829. // headers that have different values to prevent request smuggling.
  6830. auto cl_range = headers.equal_range("Content-Length");
  6831. if (cl_range.first != cl_range.second) {
  6832. const auto &first_val = cl_range.first->second;
  6833. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6834. if (it->second != first_val) { return false; }
  6835. }
  6836. }
  6837. return true;
  6838. }
  6839. inline bool parse_status_line(const char *line, std::string &version,
  6840. int &status, std::string &reason) {
  6841. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6842. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6843. #else
  6844. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6845. #endif
  6846. std::cmatch m;
  6847. if (!std::regex_match(line, m, re)) { return false; }
  6848. version = std::string(m[1]);
  6849. status = std::stoi(std::string(m[2]));
  6850. reason = std::string(m[3]);
  6851. return true;
  6852. }
  6853. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6854. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6855. struct WebSocketUpgradeResponse {
  6856. Error error = Error::Success;
  6857. int status = -1;
  6858. Headers headers;
  6859. std::string selected_subprotocol;
  6860. };
  6861. inline bool read_websocket_upgrade_response(Stream &strm,
  6862. const std::string &expected_accept,
  6863. WebSocketUpgradeResponse &upgrade) {
  6864. // Read status line
  6865. const auto bufsiz = 2048;
  6866. char buf[bufsiz];
  6867. stream_line_reader line_reader(strm, buf, bufsiz);
  6868. if (!line_reader.getline()) {
  6869. upgrade.error = Error::Read;
  6870. return false;
  6871. }
  6872. std::string version;
  6873. std::string reason;
  6874. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6875. upgrade.error = Error::WebSocketHandshake;
  6876. return false;
  6877. }
  6878. // Read the headers even for a rejection so the caller can see why the
  6879. // server refused the upgrade. A non-101 response may carry a body; it is
  6880. // deliberately left unread since the caller closes the socket right away.
  6881. if (!read_headers(strm, upgrade.headers)) {
  6882. upgrade.error = Error::Read;
  6883. return false;
  6884. }
  6885. const auto &headers = upgrade.headers;
  6886. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6887. upgrade.error = Error::WebSocketHandshake;
  6888. return false;
  6889. }
  6890. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6891. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6892. upgrade.error = Error::WebSocketHandshake;
  6893. return false;
  6894. }
  6895. // Verify Connection: Upgrade
  6896. if (!has_header_token(headers, "Connection", "upgrade")) {
  6897. upgrade.error = Error::WebSocketHandshake;
  6898. return false;
  6899. }
  6900. // Verify Sec-WebSocket-Accept header value
  6901. auto it = headers.find("Sec-WebSocket-Accept");
  6902. if (it == headers.end() || it->second != expected_accept) {
  6903. upgrade.error = Error::WebSocketHandshake;
  6904. return false;
  6905. }
  6906. // Extract negotiated subprotocol
  6907. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6908. if (proto_it != headers.end()) {
  6909. upgrade.selected_subprotocol = proto_it->second;
  6910. }
  6911. return true;
  6912. }
  6913. enum class ReadContentResult {
  6914. Success, // Successfully read the content
  6915. PayloadTooLarge, // The content exceeds the specified payload limit
  6916. Error // An error occurred while reading the content
  6917. };
  6918. inline ReadContentResult read_content_with_length(
  6919. Stream &strm, size_t len, DownloadProgress progress,
  6920. ContentReceiverWithProgress out,
  6921. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6922. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6923. detail::BodyReader br;
  6924. br.stream = &strm;
  6925. br.has_content_length = true;
  6926. br.content_length = len;
  6927. br.payload_max_length = payload_max_length;
  6928. br.chunked = false;
  6929. br.bytes_read = 0;
  6930. br.last_error = Error::Success;
  6931. size_t r = 0;
  6932. while (r < len) {
  6933. auto read_len = static_cast<size_t>(len - r);
  6934. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6935. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6936. if (n <= 0) {
  6937. // Check if it was a payload size error
  6938. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6939. return ReadContentResult::PayloadTooLarge;
  6940. }
  6941. return ReadContentResult::Error;
  6942. }
  6943. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6944. return ReadContentResult::Error;
  6945. }
  6946. r += static_cast<size_t>(n);
  6947. if (progress) {
  6948. if (!progress(r, len)) { return ReadContentResult::Error; }
  6949. }
  6950. }
  6951. return ReadContentResult::Success;
  6952. }
  6953. inline ReadContentResult
  6954. read_content_without_length(Stream &strm, size_t payload_max_length,
  6955. ContentReceiverWithProgress out) {
  6956. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6957. size_t r = 0;
  6958. for (;;) {
  6959. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6960. if (n == 0) { return ReadContentResult::Success; }
  6961. if (n < 0) { return ReadContentResult::Error; }
  6962. // Check if adding this data would exceed the payload limit
  6963. if (r > payload_max_length ||
  6964. payload_max_length - r < static_cast<size_t>(n)) {
  6965. return ReadContentResult::PayloadTooLarge;
  6966. }
  6967. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6968. return ReadContentResult::Error;
  6969. }
  6970. r += static_cast<size_t>(n);
  6971. }
  6972. return ReadContentResult::Success;
  6973. }
  6974. template <typename T>
  6975. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6976. size_t payload_max_length,
  6977. ContentReceiverWithProgress out) {
  6978. detail::ChunkedDecoder dec(strm);
  6979. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6980. size_t total_len = 0;
  6981. for (;;) {
  6982. size_t chunk_offset = 0;
  6983. size_t chunk_total = 0;
  6984. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6985. if (n < 0) { return ReadContentResult::Error; }
  6986. if (n == 0) {
  6987. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6988. return ReadContentResult::Error;
  6989. }
  6990. return ReadContentResult::Success;
  6991. }
  6992. if (total_len > payload_max_length ||
  6993. payload_max_length - total_len < static_cast<size_t>(n)) {
  6994. return ReadContentResult::PayloadTooLarge;
  6995. }
  6996. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6997. return ReadContentResult::Error;
  6998. }
  6999. total_len += static_cast<size_t>(n);
  7000. }
  7001. }
  7002. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7003. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7004. // is the final transfer coding. A single field value may list several
  7005. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7006. // several Transfer-Encoding lines, which combine into one comma-separated
  7007. // list in the order the lines were received. Headers preserves that order,
  7008. // so the final coding is the last token of the last line. Match it
  7009. // case-insensitively rather than comparing the whole value against
  7010. // "chunked".
  7011. //
  7012. // Security: reading a chunked message as unframed leaves its body in the
  7013. // socket, where a keep-alive connection parses it as a smuggled request.
  7014. // Server::process_request() answers 400 and closes when the final coding is
  7015. // not chunked, so a request whose framing cannot be determined never
  7016. // reaches the "no body" path.
  7017. auto rng = headers.equal_range("Transfer-Encoding");
  7018. if (rng.first == rng.second) { return false; }
  7019. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7020. // combined list ending in nothing rather than inheriting the line before it.
  7021. std::string last_coding;
  7022. for (auto it = rng.first; it != rng.second; ++it) {
  7023. const auto &value = it->second;
  7024. last_coding.clear();
  7025. split(value.data(), value.data() + value.size(), ',',
  7026. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7027. }
  7028. return case_ignore::equal(last_coding, "chunked");
  7029. }
  7030. inline bool has_conflicting_content_length(const Headers &headers) {
  7031. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7032. // Content-Length is framed ambiguously. The body readers here delimit it by
  7033. // the transfer coding and drop Content-Length, while an intermediary may do
  7034. // the reverse, so the two disagree on where the body ends and a reused
  7035. // connection is desynchronised (request/response smuggling). Content-Length:
  7036. // 0 is tolerated for compatibility with existing peers.
  7037. return has_header(headers, "Transfer-Encoding") &&
  7038. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7039. }
  7040. template <typename T, typename U>
  7041. bool prepare_content_receiver(T &x, int &status,
  7042. ContentReceiverWithProgress receiver,
  7043. bool decompress, size_t payload_max_length,
  7044. bool &exceed_payload_max_length, U callback) {
  7045. if (decompress) {
  7046. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7047. std::unique_ptr<decompressor> decompressor;
  7048. if (!encoding.empty()) {
  7049. // A coding we know about but were not built with is an error. An
  7050. // unrecognized coding (including "identity") is left alone and the
  7051. // payload is passed through as-is, since some servers misuse the header,
  7052. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7053. decompressor = detail::create_decompressor(encoding);
  7054. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7055. status = StatusCode::UnsupportedMediaType_415;
  7056. return false;
  7057. }
  7058. }
  7059. if (decompressor) {
  7060. if (decompressor->is_valid()) {
  7061. size_t decompressed_size = 0;
  7062. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7063. size_t off, size_t len) {
  7064. return decompressor->decompress(
  7065. buf, n, [&](const char *buf2, size_t n2) {
  7066. // Guard against zip-bomb: check
  7067. // decompressed size against limit.
  7068. if (payload_max_length > 0 &&
  7069. (decompressed_size >= payload_max_length ||
  7070. n2 > payload_max_length - decompressed_size)) {
  7071. exceed_payload_max_length = true;
  7072. return false;
  7073. }
  7074. decompressed_size += n2;
  7075. return receiver(buf2, n2, off, len);
  7076. });
  7077. };
  7078. return callback(std::move(out));
  7079. } else {
  7080. status = StatusCode::InternalServerError_500;
  7081. return false;
  7082. }
  7083. }
  7084. }
  7085. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7086. size_t len) {
  7087. return receiver(buf, n, off, len);
  7088. };
  7089. return callback(std::move(out));
  7090. }
  7091. template <typename T>
  7092. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7093. DownloadProgress progress,
  7094. ContentReceiverWithProgress receiver, bool decompress) {
  7095. bool exceed_payload_max_length = false;
  7096. return prepare_content_receiver(
  7097. x, status, std::move(receiver), decompress, payload_max_length,
  7098. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7099. auto ret = true;
  7100. // Note: exceed_payload_max_length may also be set by the decompressor
  7101. // wrapper in prepare_content_receiver when the decompressed payload
  7102. // size exceeds the limit.
  7103. if (is_chunked_transfer_encoding(x.headers)) {
  7104. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7105. if (result == ReadContentResult::Success) {
  7106. ret = true;
  7107. } else if (result == ReadContentResult::PayloadTooLarge) {
  7108. exceed_payload_max_length = true;
  7109. ret = false;
  7110. } else {
  7111. ret = false;
  7112. }
  7113. } else if (!has_header(x.headers, "Content-Length")) {
  7114. auto result =
  7115. read_content_without_length(strm, payload_max_length, out);
  7116. if (result == ReadContentResult::Success) {
  7117. ret = true;
  7118. } else if (result == ReadContentResult::PayloadTooLarge) {
  7119. exceed_payload_max_length = true;
  7120. ret = false;
  7121. } else {
  7122. ret = false;
  7123. }
  7124. } else {
  7125. auto is_invalid_value = false;
  7126. auto len = get_header_value_u64(x.headers, "Content-Length",
  7127. (std::numeric_limits<size_t>::max)(),
  7128. 0, is_invalid_value);
  7129. if (is_invalid_value) {
  7130. ret = false;
  7131. } else if (len > 0) {
  7132. auto result = read_content_with_length(
  7133. strm, len, std::move(progress), out, payload_max_length);
  7134. ret = (result == ReadContentResult::Success);
  7135. if (result == ReadContentResult::PayloadTooLarge) {
  7136. exceed_payload_max_length = true;
  7137. }
  7138. }
  7139. }
  7140. if (!ret) {
  7141. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7142. : StatusCode::BadRequest_400;
  7143. }
  7144. return ret;
  7145. });
  7146. }
  7147. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7148. const std::string &path) {
  7149. // Neither the method nor the request target may carry CR/LF, SP or other
  7150. // control octets; otherwise a value smuggled into either splits the request
  7151. // line and injects headers or a whole request.
  7152. if (!fields::is_token(method)) { return -1; }
  7153. if (!fields::is_request_target(path)) { return -1; }
  7154. std::string s = method;
  7155. s += ' ';
  7156. s += path;
  7157. s += " HTTP/1.1\r\n";
  7158. return strm.write(s.data(), s.size());
  7159. }
  7160. inline ssize_t write_response_line(Stream &strm, int status) {
  7161. std::string s = "HTTP/1.1 ";
  7162. s += std::to_string(status);
  7163. s += ' ';
  7164. s += httplib::status_message(status);
  7165. s += "\r\n";
  7166. return strm.write(s.data(), s.size());
  7167. }
  7168. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7169. ssize_t write_len = 0;
  7170. for (const auto &x : headers) {
  7171. // Skip fields with invalid names or values to prevent response splitting
  7172. // via CR/LF injection, matching set_header(). The client validates request
  7173. // headers up front in check_and_write_headers, but the server passes
  7174. // res.headers straight to this writer, and res.headers is a public field
  7175. // an application can populate directly with request-derived values.
  7176. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7177. std::string s;
  7178. s = x.first;
  7179. s += ": ";
  7180. s += x.second;
  7181. s += "\r\n";
  7182. auto len = strm.write(s.data(), s.size());
  7183. if (len < 0) { return len; }
  7184. write_len += len;
  7185. }
  7186. auto len = strm.write("\r\n");
  7187. if (len < 0) { return len; }
  7188. write_len += len;
  7189. return write_len;
  7190. }
  7191. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7192. size_t offset = 0;
  7193. while (offset < l) {
  7194. auto length = strm.write(d + offset, l - offset);
  7195. if (length < 0) { return false; }
  7196. offset += static_cast<size_t>(length);
  7197. }
  7198. return true;
  7199. }
  7200. template <typename T>
  7201. inline bool write_content_with_progress(Stream &strm,
  7202. const ContentProvider &content_provider,
  7203. size_t offset, size_t length,
  7204. T is_shutting_down,
  7205. const UploadProgress &upload_progress,
  7206. Error &error) {
  7207. size_t end_offset = offset + length;
  7208. size_t start_offset = offset;
  7209. auto ok = true;
  7210. auto finished = false;
  7211. DataSink data_sink;
  7212. data_sink.write = [&](const char *d, size_t l) -> bool {
  7213. if (ok) {
  7214. if (write_data(strm, d, l)) {
  7215. offset += l;
  7216. if (upload_progress && length > 0) {
  7217. size_t current_written = offset - start_offset;
  7218. if (!upload_progress(current_written, length)) {
  7219. ok = false;
  7220. return false;
  7221. }
  7222. }
  7223. } else {
  7224. ok = false;
  7225. }
  7226. }
  7227. return ok;
  7228. };
  7229. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7230. // The body is framed by `length`, so a provider that reports itself done
  7231. // early has truncated it. Record that and let the short-body check below
  7232. // fail the write, rather than calling the provider again forever.
  7233. data_sink.done = [&]() { finished = true; };
  7234. while (offset < end_offset && !finished && !is_shutting_down()) {
  7235. auto last_offset = offset;
  7236. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7237. error = Error::Write;
  7238. return false;
  7239. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7240. error = Error::Canceled;
  7241. return false;
  7242. } else if (!ok) {
  7243. error = Error::Write;
  7244. return false;
  7245. }
  7246. // A provider that reports success without writing anything and without
  7247. // reporting itself done gets handed the same offset and length again on
  7248. // the next pass, so it would spin here for as long as the peer stays
  7249. // connected. Treat making no progress as a short body, like done() early.
  7250. if (!finished && offset == last_offset) {
  7251. error = Error::Write;
  7252. return false;
  7253. }
  7254. }
  7255. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7256. error = Error::Write;
  7257. return false;
  7258. }
  7259. error = Error::Success;
  7260. return true;
  7261. }
  7262. template <typename T>
  7263. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7264. size_t offset, size_t length, T is_shutting_down,
  7265. Error &error) {
  7266. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7267. is_shutting_down, nullptr, error);
  7268. }
  7269. template <typename T>
  7270. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7271. size_t offset, size_t length,
  7272. const T &is_shutting_down) {
  7273. auto error = Error::Success;
  7274. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7275. error);
  7276. }
  7277. template <typename T>
  7278. inline bool
  7279. write_content_without_length(Stream &strm,
  7280. const ContentProvider &content_provider,
  7281. const T &is_shutting_down) {
  7282. size_t offset = 0;
  7283. auto data_available = true;
  7284. auto ok = true;
  7285. DataSink data_sink;
  7286. data_sink.write = [&](const char *d, size_t l) -> bool {
  7287. if (ok) {
  7288. offset += l;
  7289. if (!write_data(strm, d, l)) { ok = false; }
  7290. }
  7291. return ok;
  7292. };
  7293. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7294. data_sink.done = [&](void) { data_available = false; };
  7295. while (data_available && !is_shutting_down()) {
  7296. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7297. return false;
  7298. } else if (!content_provider(offset, 0, data_sink)) {
  7299. return false;
  7300. } else if (!ok) {
  7301. return false;
  7302. }
  7303. }
  7304. return !data_available; // true only if done() was called, false if shutting
  7305. // down
  7306. }
  7307. // Runs a known-length content provider to completion and compresses what it
  7308. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7309. // by an mmap hands the compressor a pointer straight into the mapping.
  7310. inline bool compress_content_provider(const ContentProvider &content_provider,
  7311. size_t length, compressor &cmp,
  7312. std::string &out) {
  7313. size_t offset = 0;
  7314. auto ok = true;
  7315. auto finished = false;
  7316. DataSink data_sink;
  7317. auto append = [&](const char *data, size_t data_len) {
  7318. out.append(data, data_len);
  7319. return true;
  7320. };
  7321. data_sink.write = [&](const char *d, size_t l) -> bool {
  7322. if (!ok) { return false; }
  7323. offset += l;
  7324. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7325. return ok;
  7326. };
  7327. // The body is framed by `length`, so a provider that reports itself done
  7328. // early has truncated it; the short-body check below turns that into a
  7329. // failure rather than calling the provider again forever.
  7330. data_sink.done = [&]() { finished = true; };
  7331. while (offset < length && !finished) {
  7332. auto prev_offset = offset;
  7333. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7334. return false;
  7335. }
  7336. // No Stream to block on here, so a provider that keeps returning true
  7337. // without writing would spin. Treat a pass that made no progress as a
  7338. // failure.
  7339. if (offset == prev_offset) { return false; }
  7340. }
  7341. if (offset != length) { return false; }
  7342. return cmp.compress(nullptr, 0, true, append);
  7343. }
  7344. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7345. // and the file flag, so recording them has to come after; keeping all of it
  7346. // here means a third file-serving path cannot get that order wrong.
  7347. inline void set_file_content_provider(Response &res,
  7348. const std::shared_ptr<mmap> &m,
  7349. const std::string &content_type,
  7350. EncodingType encoding) {
  7351. res.set_content_provider(
  7352. m->size(), content_type,
  7353. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7354. sink.write(m->data() + offset, length);
  7355. return true;
  7356. });
  7357. res.is_file_content_provider_ = true;
  7358. res.content_coding_ = encoding;
  7359. }
  7360. template <typename T, typename U>
  7361. inline bool
  7362. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7363. const T &is_shutting_down, U &compressor, Error &error) {
  7364. size_t offset = 0;
  7365. auto data_available = true;
  7366. auto ok = true;
  7367. DataSink data_sink;
  7368. data_sink.write = [&](const char *d, size_t l) -> bool {
  7369. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7370. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7371. // zero-length chunk is the terminator, so it must not be emitted here.
  7372. if (ok && l > 0) {
  7373. offset += l;
  7374. std::string payload;
  7375. if (compressor.compress(d, l, false,
  7376. [&](const char *data, size_t data_len) {
  7377. payload.append(data, data_len);
  7378. return true;
  7379. })) {
  7380. if (!payload.empty()) {
  7381. // Emit chunked response header and footer for each chunk
  7382. auto chunk =
  7383. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7384. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7385. }
  7386. } else {
  7387. ok = false;
  7388. }
  7389. }
  7390. return ok;
  7391. };
  7392. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7393. auto done_with_trailer = [&](const Headers *trailer) {
  7394. if (!ok) { return; }
  7395. data_available = false;
  7396. std::string payload;
  7397. if (!compressor.compress(nullptr, 0, true,
  7398. [&](const char *data, size_t data_len) {
  7399. payload.append(data, data_len);
  7400. return true;
  7401. })) {
  7402. ok = false;
  7403. return;
  7404. }
  7405. if (!payload.empty()) {
  7406. // Emit chunked response header and footer for each chunk
  7407. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7408. if (!write_data(strm, chunk.data(), chunk.size())) {
  7409. ok = false;
  7410. return;
  7411. }
  7412. }
  7413. constexpr const char done_marker[] = "0\r\n";
  7414. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7415. // Trailer
  7416. if (trailer) {
  7417. for (const auto &kv : *trailer) {
  7418. // Skip fields with invalid names or values to prevent response
  7419. // splitting via CR/LF injection, matching set_header().
  7420. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7421. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7422. if (!write_data(strm, field_line.data(), field_line.size())) {
  7423. ok = false;
  7424. }
  7425. }
  7426. }
  7427. constexpr const char crlf[] = "\r\n";
  7428. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7429. };
  7430. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7431. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7432. done_with_trailer(&trailer);
  7433. };
  7434. while (data_available && !is_shutting_down()) {
  7435. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7436. error = Error::Write;
  7437. return false;
  7438. } else if (!content_provider(offset, 0, data_sink)) {
  7439. error = Error::Canceled;
  7440. return false;
  7441. } else if (!ok) {
  7442. error = Error::Write;
  7443. return false;
  7444. }
  7445. }
  7446. if (data_available) { // exited due to is_shutting_down(), not done()
  7447. error = Error::Write;
  7448. return false;
  7449. }
  7450. error = Error::Success;
  7451. return true;
  7452. }
  7453. template <typename T, typename U>
  7454. inline bool write_content_chunked(Stream &strm,
  7455. const ContentProvider &content_provider,
  7456. const T &is_shutting_down, U &compressor) {
  7457. auto error = Error::Success;
  7458. return write_content_chunked(strm, content_provider, is_shutting_down,
  7459. compressor, error);
  7460. }
  7461. template <typename T>
  7462. inline bool redirect(T &cli, Request &req, Response &res,
  7463. const std::string &path, const std::string &location,
  7464. Error &error) {
  7465. Request new_req = req;
  7466. new_req.path = path;
  7467. new_req.redirect_count_ -= 1;
  7468. if (res.status == StatusCode::SeeOther_303 &&
  7469. (req.method != "GET" && req.method != "HEAD")) {
  7470. new_req.method = "GET";
  7471. new_req.body.clear();
  7472. new_req.headers.clear();
  7473. }
  7474. Response new_res;
  7475. auto ret = cli.send(new_req, new_res, error);
  7476. if (ret) {
  7477. req = std::move(new_req);
  7478. res = std::move(new_res);
  7479. if (res.location.empty()) { res.location = location; }
  7480. }
  7481. return ret;
  7482. }
  7483. inline std::string params_to_query_str(const Params &params) {
  7484. std::string query;
  7485. for (auto it = params.begin(); it != params.end(); ++it) {
  7486. if (it != params.begin()) { query += '&'; }
  7487. query += encode_query_component(it->first);
  7488. query += '=';
  7489. query += encode_query_component(it->second);
  7490. }
  7491. return query;
  7492. }
  7493. // Splits one "key=value" span of a query string at its first '='. A span with
  7494. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7495. // "?flag" keeps its name.
  7496. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7497. std::string &val) {
  7498. divide(b, static_cast<std::size_t>(e - b), '=',
  7499. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7500. std::size_t rhs_size) {
  7501. key.assign(lhs_data, lhs_size);
  7502. val.assign(rhs_data, rhs_size);
  7503. });
  7504. }
  7505. inline void parse_query_text(const char *data, std::size_t size,
  7506. Params &params) {
  7507. std::set<std::string> cache;
  7508. split(data, data + size, '&', [&](const char *b, const char *e) {
  7509. std::string kv(b, e);
  7510. if (cache.find(kv) != cache.end()) { return; }
  7511. cache.insert(std::move(kv));
  7512. std::string key;
  7513. std::string val;
  7514. divide_query_pair(b, e, key, val);
  7515. if (!key.empty()) {
  7516. params.emplace(decode_query_component(key), decode_query_component(val));
  7517. }
  7518. });
  7519. }
  7520. inline void parse_query_text(const std::string &s, Params &params) {
  7521. parse_query_text(s.data(), s.size(), params);
  7522. }
  7523. // Normalize a query string by decoding and re-encoding each key/value pair
  7524. // while preserving the original parameter order. This avoids double-encoding
  7525. // and ensures consistent encoding. It works on the raw string rather than
  7526. // parsing into Params and re-serializing, because that round trip cannot
  7527. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7528. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7529. // duplicated pairs.
  7530. inline std::string normalize_query_string(const std::string &query) {
  7531. std::string result;
  7532. split(query.data(), query.data() + query.size(), '&',
  7533. [&](const char *b, const char *e) {
  7534. std::string key;
  7535. std::string val;
  7536. divide_query_pair(b, e, key, val);
  7537. if (!key.empty()) {
  7538. auto dec_key = decode_query_component(key);
  7539. auto dec_val = decode_query_component(val);
  7540. if (!result.empty()) { result += '&'; }
  7541. result += encode_query_component(dec_key);
  7542. if (!val.empty() || std::find(b, e, '=') != e) {
  7543. result += '=';
  7544. result += encode_query_component(dec_val);
  7545. }
  7546. }
  7547. });
  7548. return result;
  7549. }
  7550. // Build the request target that goes on the wire from a caller-supplied path.
  7551. // Shared by the buffered send path and the streaming API so that both put the
  7552. // same bytes in the request line for the same input.
  7553. inline std::string encode_request_target(const std::string &target,
  7554. bool path_encode) {
  7555. // `substr(0, npos)` yields the whole string, which is what the no-query
  7556. // case needs.
  7557. auto query_pos = target.find('?');
  7558. auto path_part = target.substr(0, query_pos);
  7559. std::string query_part;
  7560. if (query_pos != std::string::npos) {
  7561. query_part = target.substr(query_pos + 1);
  7562. }
  7563. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7564. if (!query_part.empty()) {
  7565. // When path encoding is disabled the caller has supplied an already-encoded
  7566. // target and expects the exact bytes to be sent on the wire, so skip
  7567. // normalization for the query too. Normalizing would decode-then-re-encode
  7568. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7569. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7570. if (path_encode) {
  7571. auto normalized = normalize_query_string(query_part);
  7572. if (!normalized.empty()) {
  7573. result += '?';
  7574. result += normalized;
  7575. }
  7576. } else {
  7577. result += '?';
  7578. result += query_part;
  7579. }
  7580. }
  7581. return result;
  7582. }
  7583. inline bool parse_multipart_boundary(const std::string &content_type,
  7584. std::string &boundary) {
  7585. std::map<std::string, std::string> params;
  7586. extract_media_type(content_type, &params);
  7587. auto it = params.find("boundary");
  7588. if (it == params.end()) { return false; }
  7589. boundary = it->second;
  7590. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7591. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7592. // bytes costs a nearly full comparison at nearly every position: the
  7593. // boundary's length multiplies the worst-case cost of scanning a body.
  7594. return !boundary.empty() && boundary.size() <= 70;
  7595. }
  7596. inline void parse_disposition_params(const std::string &s, Params &params) {
  7597. std::set<std::string> cache;
  7598. split_unquoted(s.data(), s.data() + s.size(), ';',
  7599. [&](const char *b, const char *e) {
  7600. std::string kv(b, e);
  7601. if (cache.find(kv) != cache.end()) { return; }
  7602. cache.insert(kv);
  7603. std::string key;
  7604. std::string val;
  7605. divide_param_pair(b, e, key, val);
  7606. if (!key.empty()) {
  7607. params.emplace(trim_double_quotes_copy(key),
  7608. trim_double_quotes_copy(val));
  7609. }
  7610. });
  7611. }
  7612. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7613. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7614. #else
  7615. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7616. #endif
  7617. auto is_valid = [](const std::string &str) {
  7618. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7619. };
  7620. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7621. const auto pos = static_cast<size_t>(6);
  7622. const auto len = static_cast<size_t>(s.size() - 6);
  7623. auto all_valid_ranges = true;
  7624. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7625. if (!all_valid_ranges) { return; }
  7626. const auto it = std::find(b, e, '-');
  7627. if (it == e) {
  7628. all_valid_ranges = false;
  7629. return;
  7630. }
  7631. const auto lhs = std::string(b, it);
  7632. const auto rhs = std::string(it + 1, e);
  7633. if (!is_valid(lhs) || !is_valid(rhs)) {
  7634. all_valid_ranges = false;
  7635. return;
  7636. }
  7637. ssize_t first = -1;
  7638. if (!lhs.empty()) {
  7639. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7640. // would turn the range into a suffix range.
  7641. auto res =
  7642. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7643. if (res.ec != std::errc{}) {
  7644. all_valid_ranges = false;
  7645. return;
  7646. }
  7647. }
  7648. ssize_t last = -1;
  7649. if (!rhs.empty()) {
  7650. // An overflowing last-byte-pos is past any content length, so keeping
  7651. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7652. ssize_t v;
  7653. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7654. if (res.ec == std::errc{}) { last = v; }
  7655. }
  7656. if ((first == -1 && last == -1) ||
  7657. (first != -1 && last != -1 && first > last)) {
  7658. all_valid_ranges = false;
  7659. return;
  7660. }
  7661. ranges.emplace_back(first, last);
  7662. });
  7663. return all_valid_ranges && !ranges.empty();
  7664. }
  7665. return false;
  7666. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7667. }
  7668. #else
  7669. } catch (...) { return false; }
  7670. #endif
  7671. inline bool parse_accept_header(const std::string &s,
  7672. std::vector<std::string> &content_types) {
  7673. content_types.clear();
  7674. // Empty string is considered valid (no preference)
  7675. if (s.empty()) { return true; }
  7676. struct AcceptEntry {
  7677. std::string media_type;
  7678. double quality;
  7679. int order;
  7680. };
  7681. std::vector<AcceptEntry> entries;
  7682. int order = 0;
  7683. bool has_invalid_entry = false;
  7684. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7685. // has to parse and ignore empty list elements, so a leading, trailing or
  7686. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7687. // split() skips them, and the header length limit bounds how many a sender
  7688. // can send, so ignoring all of them cannot be used as a denial-of-service
  7689. // vector.
  7690. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7691. std::string entry(b, e);
  7692. entry = trim_copy(entry);
  7693. AcceptEntry accept_entry;
  7694. accept_entry.order = order++;
  7695. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7696. accept_entry.media_type, accept_entry.quality)) {
  7697. has_invalid_entry = true;
  7698. return;
  7699. }
  7700. // Remove additional parameters from media type
  7701. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7702. // Basic validation of media type format
  7703. if (accept_entry.media_type.empty()) {
  7704. has_invalid_entry = true;
  7705. return;
  7706. }
  7707. // Check for basic media type format (should contain '/' or be '*')
  7708. if (accept_entry.media_type != "*" &&
  7709. accept_entry.media_type.find('/') == std::string::npos) {
  7710. has_invalid_entry = true;
  7711. return;
  7712. }
  7713. entries.push_back(std::move(accept_entry));
  7714. });
  7715. // Return false if any invalid entry was found
  7716. if (has_invalid_entry) { return false; }
  7717. // Sort by quality (descending), then by original order (ascending)
  7718. std::sort(entries.begin(), entries.end(),
  7719. [](const AcceptEntry &a, const AcceptEntry &b) {
  7720. if (a.quality != b.quality) {
  7721. return a.quality > b.quality; // Higher quality first
  7722. }
  7723. return a.order < b.order; // Earlier order first for same quality
  7724. });
  7725. // Extract sorted media types
  7726. content_types.reserve(entries.size());
  7727. for (auto &entry : entries) {
  7728. content_types.push_back(std::move(entry.media_type));
  7729. }
  7730. return true;
  7731. }
  7732. class FormDataParser {
  7733. public:
  7734. FormDataParser() = default;
  7735. void set_boundary(std::string &&boundary) {
  7736. boundary_ = std::move(boundary);
  7737. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7738. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7739. }
  7740. bool is_valid() const { return is_valid_; }
  7741. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7742. const ContentReceiver &content_callback) {
  7743. // Once the close delimiter has been seen the rest of the body is epilogue
  7744. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7745. // spread across reads is not copied in only to be erased right away.
  7746. if (state_ == 5) { return true; }
  7747. buf_append(buf, n);
  7748. while (buf_size() > 0) {
  7749. switch (state_) {
  7750. case 0: { // Initial boundary
  7751. auto pos = buf_find(dash_boundary_crlf_);
  7752. if (pos == buf_size()) {
  7753. // Not found yet: keep only a possible partial boundary at the tail so
  7754. // that a body which never contains the boundary cannot grow the
  7755. // buffer (and get rescanned from the start) without bound.
  7756. auto keep = dash_boundary_crlf_.size() - 1;
  7757. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7758. return true;
  7759. }
  7760. buf_erase(pos + dash_boundary_crlf_.size());
  7761. state_ = 1;
  7762. break;
  7763. }
  7764. case 1: { // New entry
  7765. clear_file_info();
  7766. state_ = 2;
  7767. break;
  7768. }
  7769. case 2: { // Headers
  7770. auto pos = buf_find(crlf_);
  7771. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7772. while (pos < buf_size()) {
  7773. // Empty line
  7774. if (pos == 0) {
  7775. if (!header_callback(file_)) {
  7776. is_valid_ = false;
  7777. return false;
  7778. }
  7779. buf_erase(crlf_.size());
  7780. state_ = 3;
  7781. break;
  7782. }
  7783. // Check header count limit
  7784. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7785. is_valid_ = false;
  7786. return false;
  7787. }
  7788. header_count_++;
  7789. const auto header = buf_head(pos);
  7790. if (!parse_header(header.data(), header.data() + header.size(),
  7791. [&](const std::string &, const std::string &) {})) {
  7792. is_valid_ = false;
  7793. return false;
  7794. }
  7795. // Parse and emplace space trimmed headers into a map
  7796. if (!parse_header(
  7797. header.data(), header.data() + header.size(),
  7798. [&](const std::string &key, const std::string &val) {
  7799. file_.headers.emplace(key, val);
  7800. })) {
  7801. is_valid_ = false;
  7802. return false;
  7803. }
  7804. constexpr const char header_content_type[] = "Content-Type:";
  7805. if (start_with_case_ignore(header, header_content_type)) {
  7806. file_.content_type =
  7807. trim_copy(header.substr(str_len(header_content_type)));
  7808. } else {
  7809. std::string disposition_params;
  7810. if (parse_content_disposition(header, disposition_params)) {
  7811. Params params;
  7812. parse_disposition_params(disposition_params, params);
  7813. auto it = params.find("name");
  7814. if (it != params.end()) {
  7815. file_.name = it->second;
  7816. } else {
  7817. is_valid_ = false;
  7818. return false;
  7819. }
  7820. it = params.find("filename");
  7821. if (it != params.end()) { file_.filename = it->second; }
  7822. it = params.find("filename*");
  7823. if (it != params.end()) {
  7824. // RFC 5987: only UTF-8 encoding is allowed
  7825. const auto &val = it->second;
  7826. constexpr const char utf8_prefix[] = "UTF-8''";
  7827. constexpr size_t prefix_len = str_len(utf8_prefix);
  7828. if (val.size() > prefix_len &&
  7829. start_with_case_ignore(val, utf8_prefix)) {
  7830. file_.filename = decode_path_component(
  7831. val.substr(prefix_len)); // override...
  7832. } else {
  7833. is_valid_ = false;
  7834. return false;
  7835. }
  7836. }
  7837. }
  7838. }
  7839. buf_erase(pos + crlf_.size());
  7840. pos = buf_find(crlf_);
  7841. }
  7842. if (state_ != 3) { return true; }
  7843. break;
  7844. }
  7845. case 3: { // Body
  7846. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7847. auto pos = buf_find(crlf_dash_boundary_);
  7848. if (pos < buf_size()) {
  7849. if (!content_callback(buf_data(), pos)) {
  7850. is_valid_ = false;
  7851. return false;
  7852. }
  7853. buf_erase(pos + crlf_dash_boundary_.size());
  7854. state_ = 4;
  7855. } else {
  7856. auto len = buf_size() - crlf_dash_boundary_.size();
  7857. if (len > 0) {
  7858. if (!content_callback(buf_data(), len)) {
  7859. is_valid_ = false;
  7860. return false;
  7861. }
  7862. buf_erase(len);
  7863. }
  7864. return true;
  7865. }
  7866. break;
  7867. }
  7868. case 4: { // Boundary
  7869. if (crlf_.size() > buf_size()) { return true; }
  7870. if (buf_start_with(crlf_)) {
  7871. buf_erase(crlf_.size());
  7872. state_ = 1;
  7873. } else if (buf_start_with(dash_)) {
  7874. buf_erase(dash_.size());
  7875. is_valid_ = true;
  7876. state_ = 5;
  7877. } else {
  7878. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7879. // accepted after a boundary; RFC 2046 allows transport-padding in
  7880. // between, but this parser has never supported it. Either way the
  7881. // body is already destined to be rejected, so fail now instead of
  7882. // buffering the rest of it. Both are two bytes, so the check above
  7883. // already guarantees enough buffered data to decide.
  7884. is_valid_ = false;
  7885. return false;
  7886. }
  7887. break;
  7888. }
  7889. case 5: { // Epilogue
  7890. buf_erase(buf_size());
  7891. break;
  7892. }
  7893. }
  7894. }
  7895. return true;
  7896. }
  7897. private:
  7898. void clear_file_info() {
  7899. file_.name.clear();
  7900. file_.filename.clear();
  7901. file_.content_type.clear();
  7902. file_.headers.clear();
  7903. header_count_ = 0;
  7904. }
  7905. bool start_with_case_ignore(const std::string &a, const char *b,
  7906. size_t offset = 0) const {
  7907. const auto b_len = strlen(b);
  7908. if (a.size() < offset + b_len) { return false; }
  7909. for (size_t i = 0; i < b_len; i++) {
  7910. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7911. return false;
  7912. }
  7913. }
  7914. return true;
  7915. }
  7916. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7917. // Returns true if header matches, with the params portion in `params_out`.
  7918. bool parse_content_disposition(const std::string &header,
  7919. std::string &params_out) const {
  7920. constexpr const char prefix[] = "Content-Disposition:";
  7921. constexpr size_t prefix_len = str_len(prefix);
  7922. if (!start_with_case_ignore(header, prefix)) { return false; }
  7923. // Skip whitespace after "Content-Disposition:"
  7924. auto pos = prefix_len;
  7925. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7926. pos++;
  7927. }
  7928. // Match "form-data;" (case-insensitive)
  7929. constexpr const char form_data[] = "form-data;";
  7930. constexpr size_t form_data_len = str_len(form_data);
  7931. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7932. pos += form_data_len;
  7933. // Skip whitespace after "form-data;"
  7934. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7935. pos++;
  7936. }
  7937. params_out = header.substr(pos);
  7938. return true;
  7939. }
  7940. const std::string dash_ = "--";
  7941. const std::string crlf_ = "\r\n";
  7942. std::string boundary_;
  7943. std::string dash_boundary_crlf_;
  7944. std::string crlf_dash_boundary_;
  7945. size_t state_ = 0;
  7946. bool is_valid_ = false;
  7947. FormData file_;
  7948. size_t header_count_ = 0;
  7949. // Buffer
  7950. bool start_with(const std::string &a, size_t spos, size_t epos,
  7951. const std::string &b) const {
  7952. if (epos - spos < b.size()) { return false; }
  7953. for (size_t i = 0; i < b.size(); i++) {
  7954. if (a[i + spos] != b[i]) { return false; }
  7955. }
  7956. return true;
  7957. }
  7958. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7959. const char *buf_data() const { return &buf_[buf_spos_]; }
  7960. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7961. bool buf_start_with(const std::string &s) const {
  7962. return start_with(buf_, buf_spos_, buf_epos_, s);
  7963. }
  7964. size_t buf_find(const std::string &s) const {
  7965. auto c = s.front();
  7966. size_t off = buf_spos_;
  7967. while (off < buf_epos_) {
  7968. auto pos = off;
  7969. while (true) {
  7970. if (pos == buf_epos_) { return buf_size(); }
  7971. if (buf_[pos] == c) { break; }
  7972. pos++;
  7973. }
  7974. auto remaining_size = buf_epos_ - pos;
  7975. if (s.size() > remaining_size) { return buf_size(); }
  7976. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7977. off = pos + 1;
  7978. }
  7979. return buf_size();
  7980. }
  7981. void buf_append(const char *data, size_t n) {
  7982. auto remaining_size = buf_size();
  7983. if (remaining_size > 0 && buf_spos_ > 0) {
  7984. for (size_t i = 0; i < remaining_size; i++) {
  7985. buf_[i] = buf_[buf_spos_ + i];
  7986. }
  7987. }
  7988. buf_spos_ = 0;
  7989. buf_epos_ = remaining_size;
  7990. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7991. for (size_t i = 0; i < n; i++) {
  7992. buf_[buf_epos_ + i] = data[i];
  7993. }
  7994. buf_epos_ += n;
  7995. }
  7996. void buf_erase(size_t size) { buf_spos_ += size; }
  7997. std::string buf_;
  7998. size_t buf_spos_ = 0;
  7999. size_t buf_epos_ = 0;
  8000. };
  8001. inline std::string random_string(size_t length) {
  8002. constexpr const char data[] =
  8003. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8004. thread_local auto engine([]() {
  8005. // std::random_device might actually be deterministic on some
  8006. // platforms, but due to lack of support in the c++ standard library,
  8007. // doing better requires either some ugly hacks or breaking portability.
  8008. std::random_device seed_gen;
  8009. // Request 128 bits of entropy for initialization
  8010. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8011. return std::mt19937(seed_sequence);
  8012. }());
  8013. std::string result;
  8014. for (size_t i = 0; i < length; i++) {
  8015. result += data[engine() % (sizeof(data) - 1)];
  8016. }
  8017. return result;
  8018. }
  8019. inline std::string make_multipart_data_boundary() {
  8020. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8021. }
  8022. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8023. auto valid = true;
  8024. for (size_t i = 0; i < boundary.size(); i++) {
  8025. auto c = boundary[i];
  8026. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8027. valid = false;
  8028. break;
  8029. }
  8030. }
  8031. return valid;
  8032. }
  8033. // Escape a multipart field name/filename following the WHATWG HTML standard
  8034. // ("escape a multipart form-data name"), which is what browsers send:
  8035. // '"' -> %22, CR -> %0D, LF -> %0A
  8036. // With escape_quote = false, only CR and LF are escaped; this is for header
  8037. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8038. inline std::string escape_multipart_field(const std::string &s,
  8039. bool escape_quote = true) {
  8040. std::string result;
  8041. result.reserve(s.size());
  8042. for (auto c : s) {
  8043. switch (c) {
  8044. case '"':
  8045. if (escape_quote) {
  8046. result += "%22";
  8047. } else {
  8048. result += c;
  8049. }
  8050. break;
  8051. case '\r': result += "%0D"; break;
  8052. case '\n': result += "%0A"; break;
  8053. default: result += c; break;
  8054. }
  8055. }
  8056. return result;
  8057. }
  8058. template <typename T>
  8059. inline std::string
  8060. serialize_multipart_formdata_item_begin(const T &item,
  8061. const std::string &boundary) {
  8062. std::string body = "--" + boundary + "\r\n";
  8063. body += "Content-Disposition: form-data; name=\"" +
  8064. escape_multipart_field(item.name) + "\"";
  8065. if (!item.filename.empty()) {
  8066. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8067. }
  8068. body += "\r\n";
  8069. if (!item.content_type.empty()) {
  8070. body +=
  8071. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8072. "\r\n";
  8073. }
  8074. body += "\r\n";
  8075. return body;
  8076. }
  8077. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8078. inline std::string
  8079. serialize_multipart_formdata_finish(const std::string &boundary) {
  8080. return "--" + boundary + "--\r\n";
  8081. }
  8082. inline std::string
  8083. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8084. return "multipart/form-data; boundary=" + boundary;
  8085. }
  8086. inline std::string
  8087. serialize_multipart_formdata(const UploadFormDataItems &items,
  8088. const std::string &boundary, bool finish = true) {
  8089. std::string body;
  8090. for (const auto &item : items) {
  8091. body += serialize_multipart_formdata_item_begin(item, boundary);
  8092. body += item.content + serialize_multipart_formdata_item_end();
  8093. }
  8094. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8095. return body;
  8096. }
  8097. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8098. const std::string &boundary) {
  8099. size_t total = 0;
  8100. for (const auto &item : items) {
  8101. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8102. total += item.content.size();
  8103. total += serialize_multipart_formdata_item_end().size();
  8104. }
  8105. total += serialize_multipart_formdata_finish(boundary).size();
  8106. return total;
  8107. }
  8108. struct MultipartSegment {
  8109. const char *data;
  8110. size_t size;
  8111. };
  8112. // NOTE: items must outlive the returned ContentProvider
  8113. // (safe for synchronous use inside Post/Put/Patch)
  8114. inline ContentProvider
  8115. make_multipart_content_provider(const UploadFormDataItems &items,
  8116. const std::string &boundary) {
  8117. // Own the per-item header strings and the finish string
  8118. std::vector<std::string> owned;
  8119. owned.reserve(items.size() + 1);
  8120. for (const auto &item : items)
  8121. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8122. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8123. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8124. std::vector<MultipartSegment> segs;
  8125. segs.reserve(items.size() * 3 + 1);
  8126. static const char crlf[] = "\r\n";
  8127. for (size_t i = 0; i < items.size(); i++) {
  8128. segs.push_back({owned[i].data(), owned[i].size()});
  8129. segs.push_back({items[i].content.data(), items[i].content.size()});
  8130. segs.push_back({crlf, 2});
  8131. }
  8132. segs.push_back({owned.back().data(), owned.back().size()});
  8133. struct MultipartState {
  8134. std::vector<std::string> owned;
  8135. std::vector<MultipartSegment> segs;
  8136. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8137. };
  8138. auto state = std::make_shared<MultipartState>();
  8139. state->owned = std::move(owned);
  8140. // `segs` holds raw pointers into owned strings; std::string move preserves
  8141. // the data pointer, so these pointers remain valid after the move above.
  8142. state->segs = std::move(segs);
  8143. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8144. // Buffer multiple small segments into fewer, larger writes to avoid
  8145. // excessive TCP packets when there are many form data items (#2410)
  8146. auto &buf = state->buf;
  8147. auto buf_size = buf.size();
  8148. size_t buf_len = 0;
  8149. size_t remaining = length;
  8150. // Find the first segment containing 'offset'
  8151. size_t pos = 0;
  8152. size_t seg_idx = 0;
  8153. for (; seg_idx < state->segs.size(); seg_idx++) {
  8154. const auto &seg = state->segs[seg_idx];
  8155. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8156. pos += seg.size;
  8157. }
  8158. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8159. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8160. const auto &seg = state->segs[seg_idx];
  8161. size_t available = seg.size - seg_offset;
  8162. size_t to_copy = (std::min)(available, remaining);
  8163. const char *src = seg.data + seg_offset;
  8164. seg_offset = 0; // only the first segment has a non-zero offset
  8165. while (to_copy > 0) {
  8166. size_t space = buf_size - buf_len;
  8167. size_t chunk = (std::min)(to_copy, space);
  8168. std::memcpy(buf.data() + buf_len, src, chunk);
  8169. buf_len += chunk;
  8170. src += chunk;
  8171. to_copy -= chunk;
  8172. remaining -= chunk;
  8173. if (buf_len == buf_size) {
  8174. if (!sink.write(buf.data(), buf_len)) { return false; }
  8175. buf_len = 0;
  8176. }
  8177. }
  8178. }
  8179. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8180. return true;
  8181. };
  8182. }
  8183. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8184. if (ranges.size() <= 1) return;
  8185. // Sort ranges by start position
  8186. std::sort(ranges.begin(), ranges.end(),
  8187. [](const Range &a, const Range &b) { return a.first < b.first; });
  8188. Ranges coalesced;
  8189. coalesced.reserve(ranges.size());
  8190. for (auto &r : ranges) {
  8191. auto first_pos = r.first;
  8192. auto last_pos = r.second;
  8193. // Handle special cases like in range_error
  8194. if (first_pos == -1 && last_pos == -1) {
  8195. first_pos = 0;
  8196. last_pos = static_cast<ssize_t>(content_length);
  8197. }
  8198. if (first_pos == -1) {
  8199. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8200. last_pos = static_cast<ssize_t>(content_length) - 1;
  8201. }
  8202. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8203. last_pos = static_cast<ssize_t>(content_length) - 1;
  8204. }
  8205. // Skip invalid ranges
  8206. if (!(0 <= first_pos && first_pos <= last_pos &&
  8207. last_pos < static_cast<ssize_t>(content_length))) {
  8208. continue;
  8209. }
  8210. // Coalesce with previous range if overlapping or adjacent (but not
  8211. // identical)
  8212. if (!coalesced.empty()) {
  8213. auto &prev = coalesced.back();
  8214. // Check if current range overlaps or is adjacent to previous range
  8215. // but don't coalesce identical ranges (allow duplicates)
  8216. if (first_pos <= prev.second + 1 &&
  8217. !(first_pos == prev.first && last_pos == prev.second)) {
  8218. // Extend the previous range
  8219. prev.second = (std::max)(prev.second, last_pos);
  8220. continue;
  8221. }
  8222. }
  8223. // Add new range
  8224. coalesced.emplace_back(first_pos, last_pos);
  8225. }
  8226. ranges = std::move(coalesced);
  8227. }
  8228. inline bool range_error(Request &req, Response &res) {
  8229. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8230. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8231. req.ranges.clear();
  8232. if (res.status == StatusCode::PartialContent_206) {
  8233. res.status = StatusCode::OK_200;
  8234. }
  8235. return false;
  8236. }
  8237. ssize_t content_len = static_cast<ssize_t>(
  8238. res.content_length_ ? res.content_length_ : res.body.size());
  8239. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8240. size_t overwrapping_count = 0;
  8241. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8242. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8243. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8244. // Too many ranges
  8245. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8246. for (auto &r : req.ranges) {
  8247. auto &first_pos = r.first;
  8248. auto &last_pos = r.second;
  8249. if (first_pos == -1 && last_pos == -1) {
  8250. first_pos = 0;
  8251. last_pos = content_len;
  8252. }
  8253. if (first_pos == -1) {
  8254. first_pos = content_len - last_pos;
  8255. last_pos = content_len - 1;
  8256. }
  8257. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8258. // A client can limit the number of bytes requested without knowing the
  8259. // size of the selected representation. If the last-pos value is absent,
  8260. // or if the value is greater than or equal to the current length of the
  8261. // representation data, the byte range is interpreted as the remainder of
  8262. // the representation (i.e., the server replaces the value of last-pos
  8263. // with a value that is one less than the current length of the selected
  8264. // representation).
  8265. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8266. if (last_pos == -1 || last_pos >= content_len) {
  8267. last_pos = content_len - 1;
  8268. }
  8269. // Range must be within content length
  8270. if (!(0 <= first_pos && first_pos <= last_pos &&
  8271. last_pos <= content_len - 1)) {
  8272. return true;
  8273. }
  8274. // Request must not have more than two overlapping ranges
  8275. for (const auto &processed_range : processed_ranges) {
  8276. if (!(last_pos < processed_range.first ||
  8277. first_pos > processed_range.second)) {
  8278. overwrapping_count++;
  8279. if (overwrapping_count > 2) { return true; }
  8280. break; // Only count once per range
  8281. }
  8282. }
  8283. processed_ranges.emplace_back(first_pos, last_pos);
  8284. }
  8285. // After validation, coalesce overlapping ranges as per RFC 9110
  8286. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8287. }
  8288. return false;
  8289. }
  8290. inline std::pair<size_t, size_t>
  8291. get_range_offset_and_length(Range r, size_t content_length) {
  8292. assert(r.first != -1 && r.second != -1);
  8293. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8294. assert(r.first <= r.second &&
  8295. r.second < static_cast<ssize_t>(content_length));
  8296. (void)(content_length);
  8297. return std::make_pair(static_cast<size_t>(r.first),
  8298. static_cast<size_t>(r.second - r.first) + 1);
  8299. }
  8300. inline std::string make_content_range_header_field(
  8301. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8302. auto st = offset_and_length.first;
  8303. auto ed = st + offset_and_length.second - 1;
  8304. std::string field = "bytes ";
  8305. field += std::to_string(st);
  8306. field += '-';
  8307. field += std::to_string(ed);
  8308. field += '/';
  8309. field += std::to_string(content_length);
  8310. return field;
  8311. }
  8312. template <typename SToken, typename CToken, typename Content>
  8313. bool process_multipart_ranges_data(const Request &req,
  8314. const std::string &boundary,
  8315. const std::string &content_type,
  8316. size_t content_length, SToken stoken,
  8317. CToken ctoken, Content content) {
  8318. for (size_t i = 0; i < req.ranges.size(); i++) {
  8319. ctoken("--");
  8320. stoken(boundary);
  8321. ctoken("\r\n");
  8322. if (!content_type.empty()) {
  8323. ctoken("Content-Type: ");
  8324. stoken(content_type);
  8325. ctoken("\r\n");
  8326. }
  8327. auto offset_and_length =
  8328. get_range_offset_and_length(req.ranges[i], content_length);
  8329. ctoken("Content-Range: ");
  8330. stoken(make_content_range_header_field(offset_and_length, content_length));
  8331. ctoken("\r\n");
  8332. ctoken("\r\n");
  8333. if (!content(offset_and_length.first, offset_and_length.second)) {
  8334. return false;
  8335. }
  8336. ctoken("\r\n");
  8337. }
  8338. ctoken("--");
  8339. stoken(boundary);
  8340. ctoken("--");
  8341. return true;
  8342. }
  8343. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8344. const std::string &boundary,
  8345. const std::string &content_type,
  8346. size_t content_length,
  8347. std::string &data) {
  8348. process_multipart_ranges_data(
  8349. req, boundary, content_type, content_length,
  8350. [&](const std::string &token) { data += token; },
  8351. [&](const std::string &token) { data += token; },
  8352. [&](size_t offset, size_t length) {
  8353. assert(offset + length <= content_length);
  8354. data += res.body.substr(offset, length);
  8355. return true;
  8356. });
  8357. }
  8358. inline size_t get_multipart_ranges_data_length(const Request &req,
  8359. const std::string &boundary,
  8360. const std::string &content_type,
  8361. size_t content_length) {
  8362. size_t data_length = 0;
  8363. process_multipart_ranges_data(
  8364. req, boundary, content_type, content_length,
  8365. [&](const std::string &token) { data_length += token.size(); },
  8366. [&](const std::string &token) { data_length += token.size(); },
  8367. [&](size_t /*offset*/, size_t length) {
  8368. data_length += length;
  8369. return true;
  8370. });
  8371. return data_length;
  8372. }
  8373. template <typename T>
  8374. inline bool
  8375. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8376. const std::string &boundary,
  8377. const std::string &content_type,
  8378. size_t content_length, const T &is_shutting_down) {
  8379. return process_multipart_ranges_data(
  8380. req, boundary, content_type, content_length,
  8381. [&](const std::string &token) { strm.write(token); },
  8382. [&](const std::string &token) { strm.write(token); },
  8383. [&](size_t offset, size_t length) {
  8384. return write_content(strm, res.content_provider_, offset, length,
  8385. is_shutting_down);
  8386. });
  8387. }
  8388. inline bool has_framed_body(const Request &req) {
  8389. return is_chunked_transfer_encoding(req.headers) ||
  8390. req.get_header_value_u64("Content-Length") > 0;
  8391. }
  8392. inline bool is_connection_persistent(const Request &req) {
  8393. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8394. if (req.version == "HTTP/1.0" &&
  8395. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8396. return false;
  8397. }
  8398. return true;
  8399. }
  8400. inline bool expect_content(const Request &req) {
  8401. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8402. req.method == "DELETE") {
  8403. return true;
  8404. }
  8405. return has_framed_body(req);
  8406. }
  8407. #ifdef _WIN32
  8408. class WSInit {
  8409. public:
  8410. WSInit() {
  8411. WSADATA wsaData;
  8412. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8413. }
  8414. ~WSInit() {
  8415. if (is_valid_) WSACleanup();
  8416. }
  8417. bool is_valid_ = false;
  8418. };
  8419. static WSInit wsinit_;
  8420. #endif
  8421. // RFC 9110 Section 11.6.1 defines a challenge list as
  8422. // WWW-Authenticate = #challenge
  8423. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8424. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8425. // so a server may offer several schemes, each with its own comma-separated
  8426. // auth-param list, in either order and either as separate field lines or
  8427. // packed into one. Splitting on every comma would break apart a challenge's
  8428. // own param list; splitting only on the first space would miss a Digest
  8429. // challenge that isn't first. Split on commas that aren't inside a
  8430. // quoted-string instead, then track which scheme each resulting segment
  8431. // belongs to: a segment whose text before "=" contains whitespace (or that
  8432. // has no "=" at all) starts a new challenge named by its leading token.
  8433. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8434. std::vector<std::string> segments;
  8435. size_t start = 0;
  8436. auto in_quotes = false;
  8437. for (size_t i = 0; i < s.size(); i++) {
  8438. auto c = s[i];
  8439. if (in_quotes) {
  8440. if (c == '\\' && i + 1 < s.size()) {
  8441. i++;
  8442. } else if (c == '"') {
  8443. in_quotes = false;
  8444. }
  8445. } else if (c == '"') {
  8446. in_quotes = true;
  8447. } else if (c == ',') {
  8448. segments.push_back(s.substr(start, i - start));
  8449. start = i + 1;
  8450. }
  8451. }
  8452. segments.push_back(s.substr(start));
  8453. return segments;
  8454. }
  8455. inline std::string unescape_quoted_pairs(const std::string &s) {
  8456. std::string out;
  8457. out.reserve(s.size());
  8458. for (size_t i = 0; i < s.size(); i++) {
  8459. if (s[i] == '\\' && i + 1 < s.size()) {
  8460. out += s[++i];
  8461. } else {
  8462. out += s[i];
  8463. }
  8464. }
  8465. return out;
  8466. }
  8467. inline bool parse_www_authenticate(const Response &res,
  8468. std::map<std::string, std::string> &auth,
  8469. bool is_proxy) {
  8470. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8471. auto combined = get_combined_header_value(res.headers, auth_key);
  8472. if (combined.empty()) { return false; }
  8473. auto found_digest = false;
  8474. auto in_digest_challenge = false;
  8475. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8476. auto segment = trim_copy(raw_segment);
  8477. if (segment.empty()) { continue; }
  8478. auto eq_pos = segment.find('=');
  8479. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8480. // for the first segment of a challenge, "<scheme> <key>") must be
  8481. // trimmed before its boundaries are inspected.
  8482. auto key_part = trim_copy(
  8483. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8484. auto space_pos = key_part.find_last_of(" \t");
  8485. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8486. // "<scheme>[ <key>]" starts a new challenge.
  8487. auto scheme_end =
  8488. space_pos == std::string::npos ? key_part.size() : space_pos;
  8489. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8490. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8491. // from one challenge is never paired with another's algorithm.
  8492. in_digest_challenge =
  8493. !found_digest &&
  8494. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8495. if (in_digest_challenge) { found_digest = true; }
  8496. if (space_pos == std::string::npos) {
  8497. // Bare scheme (or a token68), no auth-param on this segment.
  8498. continue;
  8499. }
  8500. key_part = key_part.substr(space_pos + 1);
  8501. }
  8502. if (!in_digest_challenge) { continue; }
  8503. auto val = trim_copy(segment.substr(eq_pos + 1));
  8504. auto unquoted = trim_double_quotes_copy(val);
  8505. if (unquoted.size() != val.size()) {
  8506. unquoted = unescape_quoted_pairs(unquoted);
  8507. }
  8508. auth[std::move(key_part)] = std::move(unquoted);
  8509. }
  8510. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8511. // make_digest_authentication_header() dereferences both unconditionally, so
  8512. // a challenge missing either can't produce a usable Authorization header.
  8513. // Treat it the same as no Digest challenge at all.
  8514. return found_digest && auth.find("realm") != auth.end() &&
  8515. auth.find("nonce") != auth.end();
  8516. }
  8517. class ContentProviderAdapter {
  8518. public:
  8519. explicit ContentProviderAdapter(
  8520. ContentProviderWithoutLength &&content_provider)
  8521. : content_provider_(std::move(content_provider)) {}
  8522. bool operator()(size_t offset, size_t, DataSink &sink) {
  8523. return content_provider_(offset, sink);
  8524. }
  8525. private:
  8526. ContentProviderWithoutLength content_provider_;
  8527. };
  8528. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8529. namespace fields {
  8530. inline bool is_token_char(char c) {
  8531. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8532. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8533. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8534. }
  8535. inline bool is_token(const std::string &s) {
  8536. if (s.empty()) { return false; }
  8537. for (auto c : s) {
  8538. if (!is_token_char(c)) { return false; }
  8539. }
  8540. return true;
  8541. }
  8542. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8543. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8544. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8545. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8546. inline bool is_field_content(const std::string &s) {
  8547. if (s.empty()) { return true; }
  8548. if (s.size() == 1) {
  8549. return is_field_vchar(s[0]);
  8550. } else if (s.size() == 2) {
  8551. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8552. } else {
  8553. size_t i = 0;
  8554. if (!is_field_vchar(s[i])) { return false; }
  8555. i++;
  8556. while (i < s.size() - 1) {
  8557. auto c = s[i++];
  8558. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8559. } else {
  8560. return false;
  8561. }
  8562. }
  8563. return is_field_vchar(s[i]);
  8564. }
  8565. }
  8566. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8567. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8568. return is_field_name(name) && is_field_value(value);
  8569. }
  8570. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8571. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8572. inline bool is_request_target(const std::string &s) {
  8573. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8574. }
  8575. } // namespace fields
  8576. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8577. WebSocketUpgradeResponse &upgrade) {
  8578. // Generate random Sec-WebSocket-Key
  8579. thread_local std::mt19937 rng(std::random_device{}());
  8580. std::string key_bytes(16, '\0');
  8581. for (size_t i = 0; i < 16; i += 4) {
  8582. auto r = rng();
  8583. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8584. }
  8585. auto client_key = base64_encode(key_bytes);
  8586. req.headers.erase("Upgrade");
  8587. req.headers.erase("Connection");
  8588. req.headers.erase("Sec-WebSocket-Key");
  8589. req.headers.erase("Sec-WebSocket-Version");
  8590. req.headers.emplace("Upgrade", "websocket");
  8591. req.headers.emplace("Connection", "Upgrade");
  8592. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8593. req.headers.emplace("Sec-WebSocket-Version", "13");
  8594. // Build the request in memory first, like ClientImpl::write_request does.
  8595. // Writing straight to the socket would leak a request line onto the wire
  8596. // before check_and_write_headers gets a chance to reject an invalid header,
  8597. // and would emit one small write per header.
  8598. BufferStream bstrm;
  8599. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8600. upgrade.error = Error::Write;
  8601. return false;
  8602. }
  8603. auto error = Error::Success;
  8604. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8605. upgrade.error = error;
  8606. return false;
  8607. }
  8608. const auto &data = bstrm.get_buffer();
  8609. if (!write_data(strm, data.data(), data.size())) {
  8610. upgrade.error = Error::Write;
  8611. return false;
  8612. }
  8613. // Verify 101 response and Sec-WebSocket-Accept header
  8614. auto expected_accept = websocket_accept_key(client_key);
  8615. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8616. }
  8617. inline bool is_ip_address(const std::string &host) {
  8618. struct in_addr addr4;
  8619. struct in6_addr addr6;
  8620. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8621. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8622. }
  8623. // Resolve where a client should connect for `host`, honoring a user-supplied
  8624. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8625. // supplying the Host header and SNI; only the connection target changes.
  8626. //
  8627. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8628. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8629. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8630. // absent or empty mapping leaves `host` as the connection target; without the
  8631. // empty check the value would reach getaddrinfo as a null node and silently
  8632. // resolve to loopback.
  8633. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8634. const std::string &host, std::string &connect_host,
  8635. std::string &ip) {
  8636. connect_host = host;
  8637. ip.clear();
  8638. auto it = addr_map.find(host);
  8639. if (it == addr_map.end() || it->second.empty()) { return; }
  8640. if (is_ip_address(it->second)) {
  8641. ip = it->second;
  8642. } else {
  8643. connect_host = it->second;
  8644. }
  8645. }
  8646. } // namespace detail
  8647. /*
  8648. * Group 2: detail namespace - SSL common utilities
  8649. */
  8650. #ifdef CPPHTTPLIB_SSL_ENABLED
  8651. namespace detail {
  8652. class SSLSocketStream final : public Stream {
  8653. public:
  8654. SSLSocketStream(
  8655. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8656. time_t read_timeout_usec, time_t write_timeout_sec,
  8657. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8658. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8659. (std::chrono::steady_clock::time_point::min)());
  8660. ~SSLSocketStream() override;
  8661. bool is_readable() const override;
  8662. bool wait_readable() const override;
  8663. bool wait_writable() const override;
  8664. bool is_peer_alive() const override;
  8665. ssize_t read(char *ptr, size_t size) override;
  8666. ssize_t write(const char *ptr, size_t size) override;
  8667. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8668. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8669. socket_t socket() const override;
  8670. time_t duration() const override;
  8671. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8672. // See SocketStream::set_readable_hint().
  8673. void set_readable_hint() { readable_hint_ = true; }
  8674. private:
  8675. bool ensure_readable();
  8676. socket_t sock_;
  8677. tls::session_t session_;
  8678. time_t read_timeout_sec_;
  8679. time_t read_timeout_usec_;
  8680. time_t write_timeout_sec_;
  8681. time_t write_timeout_usec_;
  8682. time_t max_timeout_msec_;
  8683. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8684. bool readable_hint_ = false;
  8685. };
  8686. // A TLS stream for WebSocket connections, where the receive path and the
  8687. // send path (application send() plus the heartbeat ping thread) run on
  8688. // different threads. A single TLS session must never be entered
  8689. // concurrently, so every call into the session is serialized by one mutex.
  8690. //
  8691. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8692. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8693. // call under the lock, then waits for readiness with select() outside the
  8694. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8695. // blocked waiting for data never stalls a concurrent sender.
  8696. //
  8697. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8698. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8699. class WebSocketSSLStream final : public Stream {
  8700. public:
  8701. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8702. time_t read_timeout_sec, time_t read_timeout_usec,
  8703. time_t write_timeout_sec, time_t write_timeout_usec);
  8704. ~WebSocketSSLStream() override;
  8705. bool is_readable() const override;
  8706. bool wait_readable() const override;
  8707. bool wait_writable() const override;
  8708. ssize_t read(char *ptr, size_t size) override;
  8709. ssize_t write(const char *ptr, size_t size) override;
  8710. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8711. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8712. socket_t socket() const override;
  8713. time_t duration() const override;
  8714. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8715. private:
  8716. mutable std::mutex session_mutex_;
  8717. socket_t sock_;
  8718. tls::session_t session_;
  8719. // WebSocket::close() shortens the read timeout from the closing thread
  8720. // while the receive thread is inside wait_readable(), so these two are read
  8721. // and written concurrently. The write timeouts are never mutated.
  8722. std::atomic<time_t> read_timeout_sec_;
  8723. std::atomic<time_t> read_timeout_usec_;
  8724. time_t write_timeout_sec_;
  8725. time_t write_timeout_usec_;
  8726. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8727. };
  8728. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8729. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8730. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8731. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8732. unsigned int hash_length = 0;
  8733. unsigned char hash[EVP_MAX_MD_SIZE];
  8734. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8735. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8736. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8737. std::stringstream ss;
  8738. for (auto i = 0u; i < hash_length; ++i) {
  8739. ss << std::hex << std::setw(2) << std::setfill('0')
  8740. << static_cast<unsigned int>(hash[i]);
  8741. }
  8742. return ss.str();
  8743. }
  8744. inline std::string MD5(const std::string &s) {
  8745. return message_digest(s, EVP_md5());
  8746. }
  8747. inline std::string SHA_256(const std::string &s) {
  8748. return message_digest(s, EVP_sha256());
  8749. }
  8750. inline std::string SHA_512(const std::string &s) {
  8751. return message_digest(s, EVP_sha512());
  8752. }
  8753. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8754. namespace {
  8755. template <size_t N>
  8756. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8757. std::stringstream ss;
  8758. for (size_t i = 0; i < N; ++i) {
  8759. ss << std::hex << std::setw(2) << std::setfill('0')
  8760. << static_cast<unsigned int>(hash[i]);
  8761. }
  8762. return ss.str();
  8763. }
  8764. } // namespace
  8765. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8766. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8767. // initialized once. PSA state is process-global; do not free it.
  8768. inline bool ensure_mbedtls_psa_crypto() {
  8769. static std::once_flag once;
  8770. static bool ok = false;
  8771. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8772. return ok;
  8773. }
  8774. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8775. unsigned char *out, size_t out_size) {
  8776. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8777. size_t olen = 0;
  8778. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8779. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8780. olen == out_size;
  8781. }
  8782. #endif
  8783. inline std::string MD5(const std::string &s) {
  8784. unsigned char hash[16];
  8785. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8786. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8787. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8788. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8789. hash);
  8790. #else
  8791. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8792. hash);
  8793. #endif
  8794. return hash_to_hex(hash);
  8795. }
  8796. inline std::string SHA_256(const std::string &s) {
  8797. unsigned char hash[32];
  8798. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8799. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8800. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8801. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8802. hash, 0);
  8803. #else
  8804. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8805. s.size(), hash, 0);
  8806. #endif
  8807. return hash_to_hex(hash);
  8808. }
  8809. inline std::string SHA_512(const std::string &s) {
  8810. unsigned char hash[64];
  8811. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8812. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8813. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8814. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8815. hash, 0);
  8816. #else
  8817. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8818. s.size(), hash, 0);
  8819. #endif
  8820. return hash_to_hex(hash);
  8821. }
  8822. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8823. namespace {
  8824. template <size_t N>
  8825. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8826. std::stringstream ss;
  8827. for (size_t i = 0; i < N; ++i) {
  8828. ss << std::hex << std::setw(2) << std::setfill('0')
  8829. << static_cast<unsigned int>(hash[i]);
  8830. }
  8831. return ss.str();
  8832. }
  8833. } // namespace
  8834. inline std::string MD5(const std::string &s) {
  8835. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8836. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8837. static_cast<word32>(s.size()), hash);
  8838. return hash_to_hex(hash);
  8839. }
  8840. inline std::string SHA_256(const std::string &s) {
  8841. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8842. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8843. static_cast<word32>(s.size()), hash);
  8844. return hash_to_hex(hash);
  8845. }
  8846. inline std::string SHA_512(const std::string &s) {
  8847. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8848. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8849. static_cast<word32>(s.size()), hash);
  8850. return hash_to_hex(hash);
  8851. }
  8852. #endif
  8853. template <typename T>
  8854. inline bool process_server_socket_ssl(
  8855. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8856. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8857. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8858. time_t write_timeout_usec, T callback) {
  8859. return process_server_socket_core(
  8860. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8861. [&](bool close_connection, bool &connection_closed) {
  8862. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8863. write_timeout_sec, write_timeout_usec);
  8864. // See the non-TLS path in process_server_socket().
  8865. strm.set_readable_hint();
  8866. return callback(strm, close_connection, connection_closed);
  8867. });
  8868. }
  8869. template <typename T>
  8870. inline bool process_client_socket_ssl(
  8871. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8872. time_t read_timeout_usec, time_t write_timeout_sec,
  8873. time_t write_timeout_usec, time_t max_timeout_msec,
  8874. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8875. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8876. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8877. start_time);
  8878. return callback(strm);
  8879. }
  8880. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8881. const Request &req, const std::map<std::string, std::string> &auth,
  8882. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8883. const std::string &password, bool is_proxy = false) {
  8884. std::string nc;
  8885. {
  8886. std::stringstream ss;
  8887. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8888. nc = ss.str();
  8889. }
  8890. std::string qop;
  8891. if (auth.find("qop") != auth.end()) {
  8892. qop = auth.at("qop");
  8893. if (qop.find("auth-int") != std::string::npos) {
  8894. qop = "auth-int";
  8895. } else if (qop.find("auth") != std::string::npos) {
  8896. qop = "auth";
  8897. } else {
  8898. qop.clear();
  8899. }
  8900. }
  8901. std::string algo = "MD5";
  8902. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8903. std::string response;
  8904. {
  8905. auto H = algo == "SHA-256" ? detail::SHA_256
  8906. : algo == "SHA-512" ? detail::SHA_512
  8907. : detail::MD5;
  8908. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8909. auto A2 = req.method + ":" + req.path;
  8910. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8911. if (qop.empty()) {
  8912. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8913. } else {
  8914. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8915. ":" + qop + ":" + H(A2));
  8916. }
  8917. }
  8918. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8919. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8920. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8921. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8922. (qop.empty() ? ", response=\""
  8923. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8924. cnonce + "\", response=\"") +
  8925. response + "\"" +
  8926. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8927. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8928. return std::make_pair(key, field);
  8929. }
  8930. inline bool match_hostname(const std::string &pattern,
  8931. const std::string &hostname) {
  8932. // Exact match (case-insensitive)
  8933. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8934. // Split both pattern and hostname into components by '.'
  8935. std::vector<std::string> pattern_components;
  8936. if (!pattern.empty()) {
  8937. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8938. [&](const char *b, const char *e) {
  8939. pattern_components.emplace_back(b, e);
  8940. });
  8941. }
  8942. std::vector<std::string> host_components;
  8943. if (!hostname.empty()) {
  8944. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8945. [&](const char *b, const char *e) {
  8946. host_components.emplace_back(b, e);
  8947. });
  8948. }
  8949. // Component count must match
  8950. if (host_components.size() != pattern_components.size()) { return false; }
  8951. // Compare each component with wildcard support
  8952. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8953. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8954. auto itr = pattern_components.begin();
  8955. for (const auto &h : host_components) {
  8956. auto &p = *itr;
  8957. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8958. bool partial_match = false;
  8959. if (!p.empty() && p[p.size() - 1] == '*') {
  8960. const auto prefix_length = p.size() - 1;
  8961. if (prefix_length == 0) {
  8962. partial_match = true;
  8963. } else if (h.size() >= prefix_length) {
  8964. partial_match =
  8965. std::equal(p.begin(),
  8966. p.begin() + static_cast<std::string::difference_type>(
  8967. prefix_length),
  8968. h.begin(), [](const char ca, const char cb) {
  8969. return detail::case_ignore::to_lower(ca) ==
  8970. detail::case_ignore::to_lower(cb);
  8971. });
  8972. }
  8973. }
  8974. if (!partial_match) { return false; }
  8975. }
  8976. ++itr;
  8977. }
  8978. return true;
  8979. }
  8980. #ifdef _WIN32
  8981. // Verify certificate using Windows CertGetCertificateChain API.
  8982. // This provides real-time certificate validation with Windows Update
  8983. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8984. inline bool verify_cert_with_windows_schannel(
  8985. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  8986. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  8987. if (der_cert.empty()) { return false; }
  8988. out_error = 0;
  8989. // Create Windows certificate context from DER data
  8990. auto cert_context = CertCreateCertificateContext(
  8991. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8992. static_cast<DWORD>(der_cert.size()));
  8993. if (!cert_context) {
  8994. out_error = GetLastError();
  8995. return false;
  8996. }
  8997. auto cert_guard =
  8998. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8999. // Give CryptoAPI the certificates the server sent. Without them it follows
  9000. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9001. std::vector<tls::cert_t> peer_certs;
  9002. tls::get_peer_certs(session, peer_certs);
  9003. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9004. auto store_guard = scope_exit([&] {
  9005. for (auto cert : peer_certs) {
  9006. tls::free_cert(cert);
  9007. }
  9008. if (store) { CertCloseStore(store, 0); }
  9009. });
  9010. for (auto cert : peer_certs) {
  9011. std::vector<unsigned char> der;
  9012. if (store && tls::get_cert_der(cert, der)) {
  9013. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9014. static_cast<DWORD>(der.size()),
  9015. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9016. }
  9017. }
  9018. // Setup chain parameters
  9019. CERT_CHAIN_PARA chain_para = {};
  9020. chain_para.cbSize = sizeof(chain_para);
  9021. // Build certificate chain with revocation checking
  9022. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9023. auto chain_result = CertGetCertificateChain(
  9024. nullptr, cert_context, nullptr, store, &chain_para,
  9025. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9026. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9027. nullptr, &chain_context);
  9028. if (!chain_result || !chain_context) {
  9029. out_error = GetLastError();
  9030. return false;
  9031. }
  9032. auto chain_guard =
  9033. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9034. // Check if chain has errors
  9035. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  9036. out_error = chain_context->TrustStatus.dwErrorStatus;
  9037. return false;
  9038. }
  9039. // Verify SSL policy
  9040. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9041. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9042. #ifdef AUTHTYPE_SERVER
  9043. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9044. #endif
  9045. std::wstring whost;
  9046. if (verify_hostname) {
  9047. whost = u8string_to_wstring(hostname.c_str());
  9048. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9049. }
  9050. CERT_CHAIN_POLICY_PARA policy_para = {};
  9051. policy_para.cbSize = sizeof(policy_para);
  9052. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9053. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9054. #else
  9055. policy_para.dwFlags = 0;
  9056. #endif
  9057. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9058. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9059. policy_status.cbSize = sizeof(policy_status);
  9060. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9061. &policy_para, &policy_status)) {
  9062. out_error = GetLastError();
  9063. return false;
  9064. }
  9065. if (policy_status.dwError != 0) {
  9066. out_error = policy_status.dwError;
  9067. return false;
  9068. }
  9069. return true;
  9070. }
  9071. #endif // _WIN32
  9072. // Loads CA file/dir configuration and applies the system CA policy to a
  9073. // client TLS context. PEM data and native stores are applied to the context
  9074. // directly at set time; has_custom_store reflects them for the Auto policy
  9075. // decision.
  9076. inline bool load_client_ca_config(tls::ctx_t ctx,
  9077. const std::string &ca_cert_file_path,
  9078. const std::string &ca_cert_dir_path,
  9079. bool has_custom_store, SystemCAMode mode,
  9080. uint64_t &backend_error) {
  9081. auto ret = true;
  9082. if (!ca_cert_file_path.empty()) {
  9083. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9084. backend_error = tls::get_error();
  9085. ret = false;
  9086. }
  9087. } else if (!ca_cert_dir_path.empty()) {
  9088. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9089. backend_error = tls::get_error();
  9090. ret = false;
  9091. }
  9092. }
  9093. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9094. !ca_cert_dir_path.empty() || has_custom_store;
  9095. if (mode == SystemCAMode::Enabled ||
  9096. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9097. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9098. }
  9099. return ret;
  9100. }
  9101. // The parts of session setup that only SSLClient needs, plus the handful
  9102. // WebSocketClient also exposes; everything else takes the defaults, which is
  9103. // what keeps the two clients on one implementation.
  9104. struct ClientTlsSessionOptions {
  9105. // Both SSLClient and WebSocketClient expose this independently of
  9106. // certificate verification.
  9107. bool server_hostname_verification = true;
  9108. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9109. // When non-null, guards session creation against concurrent use of the
  9110. // context. A WebSocketClient is not safe to use from several threads to
  9111. // begin with, so it passes nothing.
  9112. std::mutex *ctx_mutex = nullptr;
  9113. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9114. // The caller decides whether Schannel has anything to say about this
  9115. // connection; see SSLClient::initialize_ssl().
  9116. bool windows_cert_verification = false;
  9117. #endif
  9118. };
  9119. // Filled in on failure for callers that report error details.
  9120. struct ClientTlsSessionError {
  9121. Error error = Error::Success;
  9122. int ssl_error = 0;
  9123. uint64_t backend_error = 0;
  9124. };
  9125. // Establishes a client TLS session on an already connected socket. On failure
  9126. // the session is left for the caller to free: SSLClient frees it right away,
  9127. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9128. inline bool setup_client_tls_session(
  9129. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9130. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9131. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9132. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9133. using namespace tls;
  9134. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9135. if (out_error) {
  9136. out_error->error = error;
  9137. out_error->ssl_error = ssl_error;
  9138. out_error->backend_error = backend_error;
  9139. }
  9140. return false;
  9141. };
  9142. if (!ctx) {
  9143. session = nullptr;
  9144. return fail(Error::SSLConnection, 0, 0);
  9145. }
  9146. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9147. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9148. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9149. // verification happens during the handshake even for IP hosts; the
  9150. // certificate identity is verified post-handshake via verify_hostname().
  9151. set_verify_client(ctx, server_certificate_verification);
  9152. #endif
  9153. {
  9154. std::unique_lock<std::mutex> guard;
  9155. if (options.ctx_mutex) {
  9156. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9157. }
  9158. session = create_session(ctx, sock);
  9159. }
  9160. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9161. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9162. // their identity is checked post-handshake below instead. On Mbed TLS and
  9163. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9164. // options.server_hostname_verification is threaded through here.
  9165. if (!is_ip_address(host)) {
  9166. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9167. return fail(Error::SSLConnection, 0, get_error());
  9168. }
  9169. }
  9170. TlsError tls_err;
  9171. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9172. &tls_err)) {
  9173. auto error = Error::SSLConnection;
  9174. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9175. error = Error::SSLServerVerification;
  9176. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9177. error = Error::SSLServerHostnameVerification;
  9178. }
  9179. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9180. }
  9181. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9182. if (options.session_verifier) {
  9183. verification_status = options.session_verifier(session);
  9184. }
  9185. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9186. return fail(Error::SSLServerVerification, 0, get_error());
  9187. }
  9188. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9189. server_certificate_verification) {
  9190. auto verify_result = get_verify_result(session);
  9191. if (verify_result != 0) {
  9192. return fail(Error::SSLServerVerification, 0,
  9193. static_cast<uint64_t>(verify_result));
  9194. }
  9195. auto server_cert = get_peer_cert(session);
  9196. if (!server_cert) {
  9197. return fail(Error::SSLServerVerification, 0, get_error());
  9198. }
  9199. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9200. // Identity check against the peer certificate, post-handshake for all
  9201. // backends. For IP hosts this is the only identity verification, since no
  9202. // hostname is bound during the handshake.
  9203. if (options.server_hostname_verification) {
  9204. if (!verify_hostname(server_cert, host.c_str())) {
  9205. return fail(Error::SSLServerHostnameVerification, 0,
  9206. hostname_mismatch_code());
  9207. }
  9208. }
  9209. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9210. // Additional Windows Schannel verification.
  9211. // This provides real-time certificate validation with Windows Update
  9212. // integration, working with both OpenSSL and MbedTLS backends.
  9213. if (options.windows_cert_verification) {
  9214. std::vector<unsigned char> der;
  9215. if (get_cert_der(server_cert, der)) {
  9216. uint64_t wincrypt_error = 0;
  9217. if (!verify_cert_with_windows_schannel(
  9218. der, host, options.server_hostname_verification, wincrypt_error,
  9219. session)) {
  9220. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9221. }
  9222. }
  9223. }
  9224. #endif
  9225. }
  9226. return true;
  9227. }
  9228. } // namespace detail
  9229. #endif // CPPHTTPLIB_SSL_ENABLED
  9230. /*
  9231. * Group 3: httplib namespace - Non-SSL public API implementations
  9232. */
  9233. inline void default_socket_options(socket_t sock) {
  9234. set_socket_opt(sock, SOL_SOCKET,
  9235. #ifdef SO_REUSEPORT
  9236. SO_REUSEPORT,
  9237. #else
  9238. SO_REUSEADDR,
  9239. #endif
  9240. 1);
  9241. }
  9242. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9243. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9244. sizeof(optval));
  9245. }
  9246. inline std::string get_bearer_token_auth(const Request &req) {
  9247. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9248. // than the prefix carries no token.
  9249. constexpr const char bearer_prefix[] = "Bearer ";
  9250. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9251. auto value = req.get_header_value("Authorization");
  9252. if (value.size() >= bearer_prefix_len &&
  9253. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9254. bearer_prefix)) {
  9255. return value.substr(bearer_prefix_len);
  9256. }
  9257. return "";
  9258. }
  9259. inline const char *status_message(int status) {
  9260. switch (status) {
  9261. case StatusCode::Continue_100: return "Continue";
  9262. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9263. case StatusCode::Processing_102: return "Processing";
  9264. case StatusCode::EarlyHints_103: return "Early Hints";
  9265. case StatusCode::OK_200: return "OK";
  9266. case StatusCode::Created_201: return "Created";
  9267. case StatusCode::Accepted_202: return "Accepted";
  9268. case StatusCode::NonAuthoritativeInformation_203:
  9269. return "Non-Authoritative Information";
  9270. case StatusCode::NoContent_204: return "No Content";
  9271. case StatusCode::ResetContent_205: return "Reset Content";
  9272. case StatusCode::PartialContent_206: return "Partial Content";
  9273. case StatusCode::MultiStatus_207: return "Multi-Status";
  9274. case StatusCode::AlreadyReported_208: return "Already Reported";
  9275. case StatusCode::IMUsed_226: return "IM Used";
  9276. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9277. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9278. case StatusCode::Found_302: return "Found";
  9279. case StatusCode::SeeOther_303: return "See Other";
  9280. case StatusCode::NotModified_304: return "Not Modified";
  9281. case StatusCode::UseProxy_305: return "Use Proxy";
  9282. case StatusCode::unused_306: return "unused";
  9283. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9284. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9285. case StatusCode::BadRequest_400: return "Bad Request";
  9286. case StatusCode::Unauthorized_401: return "Unauthorized";
  9287. case StatusCode::PaymentRequired_402: return "Payment Required";
  9288. case StatusCode::Forbidden_403: return "Forbidden";
  9289. case StatusCode::NotFound_404: return "Not Found";
  9290. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9291. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9292. case StatusCode::ProxyAuthenticationRequired_407:
  9293. return "Proxy Authentication Required";
  9294. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9295. case StatusCode::Conflict_409: return "Conflict";
  9296. case StatusCode::Gone_410: return "Gone";
  9297. case StatusCode::LengthRequired_411: return "Length Required";
  9298. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9299. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9300. case StatusCode::UriTooLong_414: return "URI Too Long";
  9301. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9302. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9303. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9304. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9305. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9306. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9307. case StatusCode::Locked_423: return "Locked";
  9308. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9309. case StatusCode::TooEarly_425: return "Too Early";
  9310. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9311. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9312. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9313. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9314. return "Request Header Fields Too Large";
  9315. case StatusCode::UnavailableForLegalReasons_451:
  9316. return "Unavailable For Legal Reasons";
  9317. case StatusCode::NotImplemented_501: return "Not Implemented";
  9318. case StatusCode::BadGateway_502: return "Bad Gateway";
  9319. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9320. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9321. case StatusCode::HttpVersionNotSupported_505:
  9322. return "HTTP Version Not Supported";
  9323. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9324. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9325. case StatusCode::LoopDetected_508: return "Loop Detected";
  9326. case StatusCode::NotExtended_510: return "Not Extended";
  9327. case StatusCode::NetworkAuthenticationRequired_511:
  9328. return "Network Authentication Required";
  9329. default:
  9330. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9331. }
  9332. }
  9333. inline std::string to_string(const Error error) {
  9334. switch (error) {
  9335. case Error::Success: return "Success (no error)";
  9336. case Error::Unknown: return "Unknown";
  9337. case Error::Connection: return "Could not establish connection";
  9338. case Error::BindIPAddress: return "Failed to bind IP address";
  9339. case Error::Read: return "Failed to read connection";
  9340. case Error::Write: return "Failed to write connection";
  9341. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9342. case Error::Canceled: return "Connection handling canceled";
  9343. case Error::SSLConnection: return "SSL connection failed";
  9344. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9345. case Error::SSLServerVerification: return "SSL server verification failed";
  9346. case Error::SSLServerHostnameVerification:
  9347. return "SSL server hostname verification failed";
  9348. case Error::UnsupportedMultipartBoundaryChars:
  9349. return "Unsupported HTTP multipart boundary characters";
  9350. case Error::Compression: return "Compression failed";
  9351. case Error::ConnectionTimeout: return "Connection timed out";
  9352. case Error::ProxyConnection: return "Proxy connection failed";
  9353. case Error::ConnectionClosed: return "Connection closed by server";
  9354. case Error::Timeout: return "Read timeout";
  9355. case Error::ResourceExhaustion: return "Resource exhaustion";
  9356. case Error::TooManyFormDataFiles: return "Too many form data files";
  9357. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9358. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9359. case Error::ExceedMaxSocketDescriptorCount:
  9360. return "Exceeded maximum socket descriptor count";
  9361. case Error::InvalidRequestLine: return "Invalid request line";
  9362. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9363. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9364. case Error::InvalidHeaders: return "Invalid headers";
  9365. case Error::MultipartParsing: return "Multipart parsing failed";
  9366. case Error::OpenFile: return "Failed to open file";
  9367. case Error::Listen: return "Failed to listen on socket";
  9368. case Error::GetSockName: return "Failed to get socket name";
  9369. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9370. case Error::HTTPParsing: return "HTTP parsing failed";
  9371. case Error::InvalidRangeHeader: return "Invalid Range header";
  9372. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9373. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9374. case Error::UserCallbackException: return "User callback threw an exception";
  9375. default: break;
  9376. }
  9377. return "Invalid";
  9378. }
  9379. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9380. os << to_string(obj);
  9381. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9382. return os;
  9383. }
  9384. inline std::string hosted_at(const std::string &hostname) {
  9385. std::vector<std::string> addrs;
  9386. hosted_at(hostname, addrs);
  9387. if (addrs.empty()) { return std::string(); }
  9388. return addrs[0];
  9389. }
  9390. inline void hosted_at(const std::string &hostname,
  9391. std::vector<std::string> &addrs) {
  9392. struct addrinfo hints;
  9393. struct addrinfo *result;
  9394. memset(&hints, 0, sizeof(struct addrinfo));
  9395. hints.ai_family = AF_UNSPEC;
  9396. hints.ai_socktype = SOCK_STREAM;
  9397. hints.ai_protocol = 0;
  9398. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9399. &result, 0)) {
  9400. #if defined __linux__ && !defined __ANDROID__
  9401. res_init();
  9402. #endif
  9403. return;
  9404. }
  9405. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9406. for (auto rp = result; rp; rp = rp->ai_next) {
  9407. const auto &addr =
  9408. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9409. std::string ip;
  9410. auto dummy = -1;
  9411. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9412. dummy)) {
  9413. addrs.emplace_back(std::move(ip));
  9414. }
  9415. }
  9416. }
  9417. inline std::string encode_uri_component(const std::string &value) {
  9418. std::ostringstream escaped;
  9419. escaped.fill('0');
  9420. escaped << std::hex;
  9421. for (auto c : value) {
  9422. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9423. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9424. escaped << c;
  9425. } else {
  9426. escaped << std::uppercase;
  9427. escaped << '%' << std::setw(2)
  9428. << static_cast<int>(static_cast<unsigned char>(c));
  9429. escaped << std::nouppercase;
  9430. }
  9431. }
  9432. return escaped.str();
  9433. }
  9434. inline std::string encode_uri(const std::string &value) {
  9435. std::ostringstream escaped;
  9436. escaped.fill('0');
  9437. escaped << std::hex;
  9438. for (auto c : value) {
  9439. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9440. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9441. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9442. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9443. escaped << c;
  9444. } else {
  9445. escaped << std::uppercase;
  9446. escaped << '%' << std::setw(2)
  9447. << static_cast<int>(static_cast<unsigned char>(c));
  9448. escaped << std::nouppercase;
  9449. }
  9450. }
  9451. return escaped.str();
  9452. }
  9453. inline std::string decode_uri_component(const std::string &value) {
  9454. std::string result;
  9455. for (size_t i = 0; i < value.size(); i++) {
  9456. if (value[i] == '%' && i + 2 < value.size()) {
  9457. auto val = 0;
  9458. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9459. result += static_cast<char>(val);
  9460. i += 2;
  9461. } else {
  9462. result += value[i];
  9463. }
  9464. } else {
  9465. result += value[i];
  9466. }
  9467. }
  9468. return result;
  9469. }
  9470. inline std::string decode_uri(const std::string &value) {
  9471. std::string result;
  9472. for (size_t i = 0; i < value.size(); i++) {
  9473. if (value[i] == '%' && i + 2 < value.size()) {
  9474. auto val = 0;
  9475. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9476. auto c = static_cast<char>(val);
  9477. // Keep escapes of the reserved characters that encode_uri leaves
  9478. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9479. // delimiter is not promoted into a real one (as with JS decodeURI).
  9480. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9481. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9482. c == '#') {
  9483. result += value[i];
  9484. result += value[i + 1];
  9485. result += value[i + 2];
  9486. } else {
  9487. result += c;
  9488. }
  9489. i += 2;
  9490. } else {
  9491. result += value[i];
  9492. }
  9493. } else {
  9494. result += value[i];
  9495. }
  9496. }
  9497. return result;
  9498. }
  9499. inline std::string encode_path_component(const std::string &component) {
  9500. std::string result;
  9501. result.reserve(component.size() * 3);
  9502. for (size_t i = 0; i < component.size(); i++) {
  9503. auto c = static_cast<unsigned char>(component[i]);
  9504. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9505. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9506. c == '_' || c == '~') {
  9507. result += static_cast<char>(c);
  9508. }
  9509. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9510. // "," / ";" / "="
  9511. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9512. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9513. c == '=') {
  9514. result += static_cast<char>(c);
  9515. }
  9516. // Colon is allowed in path segments except first segment
  9517. else if (c == ':') {
  9518. result += static_cast<char>(c);
  9519. }
  9520. // @ is allowed in path
  9521. else if (c == '@') {
  9522. result += static_cast<char>(c);
  9523. } else {
  9524. result += '%';
  9525. char hex[3];
  9526. snprintf(hex, sizeof(hex), "%02X", c);
  9527. result.append(hex, 2);
  9528. }
  9529. }
  9530. return result;
  9531. }
  9532. inline std::string decode_path_component(const std::string &component) {
  9533. std::string result;
  9534. result.reserve(component.size());
  9535. for (size_t i = 0; i < component.size(); i++) {
  9536. if (component[i] == '%' && i + 1 < component.size()) {
  9537. if (component[i + 1] == 'u') {
  9538. // Unicode %uXXXX encoding
  9539. auto val = 0;
  9540. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9541. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9542. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9543. char buff[4];
  9544. size_t len = detail::to_utf8(val, buff);
  9545. if (len > 0) { result.append(buff, len); }
  9546. i += 5; // 'u0000'
  9547. } else {
  9548. result += component[i];
  9549. }
  9550. } else {
  9551. // Standard %XX encoding
  9552. auto val = 0;
  9553. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9554. // 2 digits hex codes
  9555. result += static_cast<char>(val);
  9556. i += 2; // 'XX'
  9557. } else {
  9558. result += component[i];
  9559. }
  9560. }
  9561. } else {
  9562. result += component[i];
  9563. }
  9564. }
  9565. return result;
  9566. }
  9567. inline std::string encode_query_component(const std::string &component,
  9568. bool space_as_plus) {
  9569. std::string result;
  9570. result.reserve(component.size() * 3);
  9571. for (size_t i = 0; i < component.size(); i++) {
  9572. auto c = static_cast<unsigned char>(component[i]);
  9573. // Unreserved characters per RFC 3986
  9574. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9575. c == '_' || c == '~') {
  9576. result += static_cast<char>(c);
  9577. }
  9578. // Space handling
  9579. else if (c == ' ') {
  9580. if (space_as_plus) {
  9581. result += '+';
  9582. } else {
  9583. result += "%20";
  9584. }
  9585. }
  9586. // Plus sign handling
  9587. else if (c == '+') {
  9588. if (space_as_plus) {
  9589. result += "%2B";
  9590. } else {
  9591. result += static_cast<char>(c);
  9592. }
  9593. }
  9594. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9595. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9596. c == '*' || c == ',' || c == ';') {
  9597. result += static_cast<char>(c);
  9598. }
  9599. // Colon and @ are allowed in query
  9600. else if (c == ':' || c == '@') {
  9601. result += static_cast<char>(c);
  9602. }
  9603. // Forward slash is allowed in query values
  9604. else if (c == '/') {
  9605. result += static_cast<char>(c);
  9606. }
  9607. // Question mark is allowed in query values (after first ?)
  9608. else if (c == '?') {
  9609. result += static_cast<char>(c);
  9610. } else {
  9611. result += '%';
  9612. char hex[3];
  9613. snprintf(hex, sizeof(hex), "%02X", c);
  9614. result.append(hex, 2);
  9615. }
  9616. }
  9617. return result;
  9618. }
  9619. inline std::string decode_query_component(const std::string &component,
  9620. bool plus_as_space) {
  9621. std::string result;
  9622. result.reserve(component.size());
  9623. for (size_t i = 0; i < component.size(); i++) {
  9624. if (component[i] == '%' && i + 2 < component.size()) {
  9625. auto val = 0;
  9626. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9627. result += static_cast<char>(val);
  9628. i += 2;
  9629. } else {
  9630. result += component[i];
  9631. }
  9632. } else if (component[i] == '+' && plus_as_space) {
  9633. result += ' '; // + becomes space in form-urlencoded
  9634. } else {
  9635. result += component[i];
  9636. }
  9637. }
  9638. return result;
  9639. }
  9640. inline std::string sanitize_filename(const std::string &filename) {
  9641. // Extract basename: find the last path separator (/ or \)
  9642. auto pos = filename.find_last_of("/\\");
  9643. auto result =
  9644. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9645. // Strip null bytes
  9646. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9647. // Trim whitespace
  9648. {
  9649. auto start = result.find_first_not_of(" \t");
  9650. auto end = result.find_last_not_of(" \t");
  9651. result = (start == std::string::npos)
  9652. ? ""
  9653. : result.substr(start, end - start + 1);
  9654. }
  9655. // Reject . and ..
  9656. if (result == "." || result == "..") { return ""; }
  9657. return result;
  9658. }
  9659. inline std::string append_query_params(const std::string &path,
  9660. const Params &params) {
  9661. std::string path_with_query = path;
  9662. thread_local const std::regex re("[^?]+\\?.*");
  9663. auto delm = std::regex_match(path, re) ? '&' : '?';
  9664. path_with_query += delm + detail::params_to_query_str(params);
  9665. return path_with_query;
  9666. }
  9667. // Header utilities
  9668. inline std::pair<std::string, std::string>
  9669. make_range_header(const Ranges &ranges) {
  9670. std::string field = "bytes=";
  9671. auto i = 0;
  9672. for (const auto &r : ranges) {
  9673. if (i != 0) { field += ", "; }
  9674. if (r.first != -1) { field += std::to_string(r.first); }
  9675. field += '-';
  9676. if (r.second != -1) { field += std::to_string(r.second); }
  9677. i++;
  9678. }
  9679. return std::make_pair("Range", std::move(field));
  9680. }
  9681. inline std::pair<std::string, std::string>
  9682. make_basic_authentication_header(const std::string &username,
  9683. const std::string &password, bool is_proxy) {
  9684. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9685. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9686. return std::make_pair(key, std::move(field));
  9687. }
  9688. inline std::pair<std::string, std::string>
  9689. make_bearer_token_authentication_header(const std::string &token,
  9690. bool is_proxy = false) {
  9691. auto field = "Bearer " + token;
  9692. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9693. return std::make_pair(key, std::move(field));
  9694. }
  9695. // Request implementation
  9696. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9697. size_t id) const {
  9698. return detail::get_header_value_u64(headers, key, def, id);
  9699. }
  9700. inline bool Request::has_header(const std::string &key) const {
  9701. return detail::has_header(headers, key);
  9702. }
  9703. inline std::string Request::get_header_value(const std::string &key,
  9704. const char *def, size_t id) const {
  9705. return detail::get_header_value(headers, key, def, id);
  9706. }
  9707. inline size_t Request::get_header_value_count(const std::string &key) const {
  9708. return detail::get_header_value_count(headers, key);
  9709. }
  9710. inline void Request::set_header(const std::string &key,
  9711. const std::string &val) {
  9712. detail::set_header(headers, key, val);
  9713. }
  9714. inline bool Request::has_trailer(const std::string &key) const {
  9715. return trailers.find(key) != trailers.end();
  9716. }
  9717. inline std::string Request::get_trailer_value(const std::string &key,
  9718. size_t id) const {
  9719. return detail::get_multimap_value(trailers, key, id);
  9720. }
  9721. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9722. return trailers.count(key);
  9723. }
  9724. inline bool Request::has_param(const std::string &key) const {
  9725. return params.find(key) != params.end();
  9726. }
  9727. inline std::string Request::get_param_value(const std::string &key,
  9728. size_t id) const {
  9729. return detail::get_multimap_value(params, key, id);
  9730. }
  9731. inline std::vector<std::string>
  9732. Request::get_param_values(const std::string &key) const {
  9733. auto rng = params.equal_range(key);
  9734. std::vector<std::string> values;
  9735. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9736. for (auto it = rng.first; it != rng.second; ++it) {
  9737. values.push_back(it->second);
  9738. }
  9739. return values;
  9740. }
  9741. inline size_t Request::get_param_value_count(const std::string &key) const {
  9742. return params.count(key);
  9743. }
  9744. inline bool Request::is_multipart_form_data() const {
  9745. const auto &content_type = get_header_value("Content-Type");
  9746. return detail::extract_media_type(content_type) == "multipart/form-data";
  9747. }
  9748. // Multipart FormData implementation
  9749. inline std::string MultipartFormData::get_field(const std::string &key,
  9750. size_t id) const {
  9751. auto rng = fields.equal_range(key);
  9752. auto it = rng.first;
  9753. std::advance(it, static_cast<ssize_t>(id));
  9754. if (it != rng.second) { return it->second.content; }
  9755. return std::string();
  9756. }
  9757. inline std::vector<std::string>
  9758. MultipartFormData::get_fields(const std::string &key) const {
  9759. std::vector<std::string> values;
  9760. auto rng = fields.equal_range(key);
  9761. for (auto it = rng.first; it != rng.second; it++) {
  9762. values.push_back(it->second.content);
  9763. }
  9764. return values;
  9765. }
  9766. inline bool MultipartFormData::has_field(const std::string &key) const {
  9767. return fields.find(key) != fields.end();
  9768. }
  9769. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9770. return fields.count(key);
  9771. }
  9772. inline FormData MultipartFormData::get_file(const std::string &key,
  9773. size_t id) const {
  9774. return detail::get_multimap_value(files, key, id);
  9775. }
  9776. inline std::vector<FormData>
  9777. MultipartFormData::get_files(const std::string &key) const {
  9778. std::vector<FormData> values;
  9779. auto rng = files.equal_range(key);
  9780. for (auto it = rng.first; it != rng.second; it++) {
  9781. values.push_back(it->second);
  9782. }
  9783. return values;
  9784. }
  9785. inline bool MultipartFormData::has_file(const std::string &key) const {
  9786. return files.find(key) != files.end();
  9787. }
  9788. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9789. return files.count(key);
  9790. }
  9791. // Multipart FormData writer implementation
  9792. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9793. return detail::is_multipart_boundary_chars_valid(boundary);
  9794. }
  9795. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9796. : boundary_(detail::make_multipart_data_boundary()) {}
  9797. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9798. : boundary_(std::move(boundary)) {}
  9799. inline const std::string &MultipartFormDataWriter::boundary() const {
  9800. return boundary_;
  9801. }
  9802. inline std::string MultipartFormDataWriter::content_type() const {
  9803. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9804. }
  9805. inline std::string
  9806. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9807. return detail::serialize_multipart_formdata(items, boundary_);
  9808. }
  9809. inline size_t MultipartFormDataWriter::content_length(
  9810. const UploadFormDataItems &items) const {
  9811. return detail::get_multipart_content_length(items, boundary_);
  9812. }
  9813. inline std::string
  9814. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9815. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9816. }
  9817. inline std::string MultipartFormDataWriter::item_end() {
  9818. return detail::serialize_multipart_formdata_item_end();
  9819. }
  9820. inline std::string MultipartFormDataWriter::finish() const {
  9821. return detail::serialize_multipart_formdata_finish(boundary_);
  9822. }
  9823. // Response implementation
  9824. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9825. size_t id) const {
  9826. return detail::get_header_value_u64(headers, key, def, id);
  9827. }
  9828. inline bool Response::has_header(const std::string &key) const {
  9829. return headers.find(key) != headers.end();
  9830. }
  9831. inline std::string Response::get_header_value(const std::string &key,
  9832. const char *def,
  9833. size_t id) const {
  9834. return detail::get_header_value(headers, key, def, id);
  9835. }
  9836. inline size_t Response::get_header_value_count(const std::string &key) const {
  9837. return detail::get_header_value_count(headers, key);
  9838. }
  9839. inline void Response::set_header(const std::string &key,
  9840. const std::string &val) {
  9841. detail::set_header(headers, key, val);
  9842. }
  9843. inline bool Response::has_trailer(const std::string &key) const {
  9844. return trailers.find(key) != trailers.end();
  9845. }
  9846. inline std::string Response::get_trailer_value(const std::string &key,
  9847. size_t id) const {
  9848. return detail::get_multimap_value(trailers, key, id);
  9849. }
  9850. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9851. return trailers.count(key);
  9852. }
  9853. inline void Response::set_redirect(const std::string &url, int stat) {
  9854. if (detail::fields::is_field_value(url)) {
  9855. set_header("Location", url);
  9856. if (300 <= stat && stat < 400) {
  9857. this->status = stat;
  9858. } else {
  9859. this->status = StatusCode::Found_302;
  9860. }
  9861. }
  9862. }
  9863. inline void Response::set_content(const char *s, size_t n,
  9864. const std::string &content_type) {
  9865. body.assign(s, n);
  9866. auto rng = headers.equal_range("Content-Type");
  9867. headers.erase(rng.first, rng.second);
  9868. set_header("Content-Type", content_type);
  9869. content_coding_ = detail::EncodingType::None;
  9870. }
  9871. inline void Response::set_content(const std::string &s,
  9872. const std::string &content_type) {
  9873. set_content(s.data(), s.size(), content_type);
  9874. }
  9875. inline void Response::set_content(std::string &&s,
  9876. const std::string &content_type) {
  9877. body = std::move(s);
  9878. auto rng = headers.equal_range("Content-Type");
  9879. headers.erase(rng.first, rng.second);
  9880. set_header("Content-Type", content_type);
  9881. content_coding_ = detail::EncodingType::None;
  9882. }
  9883. inline void Response::set_content_provider(
  9884. size_t in_length, const std::string &content_type, ContentProvider provider,
  9885. ContentProviderResourceReleaser resource_releaser) {
  9886. set_header("Content-Type", content_type);
  9887. content_length_ = in_length;
  9888. if (in_length > 0) { content_provider_ = std::move(provider); }
  9889. content_provider_resource_releaser_ = std::move(resource_releaser);
  9890. is_chunked_content_provider_ = false;
  9891. is_file_content_provider_ = false;
  9892. content_coding_ = detail::EncodingType::None;
  9893. }
  9894. inline void Response::set_content_provider(
  9895. const std::string &content_type, ContentProviderWithoutLength provider,
  9896. ContentProviderResourceReleaser resource_releaser) {
  9897. set_header("Content-Type", content_type);
  9898. content_length_ = 0;
  9899. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9900. content_provider_resource_releaser_ = std::move(resource_releaser);
  9901. is_chunked_content_provider_ = false;
  9902. is_file_content_provider_ = false;
  9903. content_coding_ = detail::EncodingType::None;
  9904. }
  9905. inline void Response::set_chunked_content_provider(
  9906. const std::string &content_type, ContentProviderWithoutLength provider,
  9907. ContentProviderResourceReleaser resource_releaser) {
  9908. set_header("Content-Type", content_type);
  9909. content_length_ = 0;
  9910. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9911. content_provider_resource_releaser_ = std::move(resource_releaser);
  9912. is_chunked_content_provider_ = true;
  9913. is_file_content_provider_ = false;
  9914. content_coding_ = detail::EncodingType::None;
  9915. }
  9916. inline void Response::set_file_content(const std::string &path,
  9917. const std::string &content_type) {
  9918. file_content_path_ = path;
  9919. file_content_content_type_ = content_type;
  9920. }
  9921. inline void Response::set_file_content(const std::string &path) {
  9922. file_content_path_ = path;
  9923. }
  9924. // Result implementation
  9925. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9926. size_t def,
  9927. size_t id) const {
  9928. return detail::get_header_value_u64(request_headers_, key, def, id);
  9929. }
  9930. inline bool Result::has_request_header(const std::string &key) const {
  9931. return request_headers_.find(key) != request_headers_.end();
  9932. }
  9933. inline std::string Result::get_request_header_value(const std::string &key,
  9934. const char *def,
  9935. size_t id) const {
  9936. return detail::get_header_value(request_headers_, key, def, id);
  9937. }
  9938. inline size_t
  9939. Result::get_request_header_value_count(const std::string &key) const {
  9940. return request_headers_.count(key);
  9941. }
  9942. // Stream implementation
  9943. inline ssize_t Stream::write(const char *ptr) {
  9944. return write(ptr, strlen(ptr));
  9945. }
  9946. inline ssize_t Stream::write(const std::string &s) {
  9947. return write(s.data(), s.size());
  9948. }
  9949. // BodyReader implementation
  9950. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9951. if (!stream) {
  9952. last_error = Error::Connection;
  9953. return -1;
  9954. }
  9955. if (eof) { return 0; }
  9956. if (!chunked) {
  9957. // Content-Length based reading
  9958. if (has_content_length && bytes_read >= content_length) {
  9959. eof = true;
  9960. return 0;
  9961. }
  9962. auto to_read = len;
  9963. if (has_content_length) {
  9964. auto remaining = content_length - bytes_read;
  9965. to_read = (std::min)(len, remaining);
  9966. }
  9967. auto n = stream->read(buf, to_read);
  9968. if (n < 0) {
  9969. last_error = stream->get_error();
  9970. if (last_error == Error::Success) { last_error = Error::Read; }
  9971. eof = true;
  9972. return n;
  9973. }
  9974. if (n == 0) {
  9975. // Unexpected EOF before content_length
  9976. last_error = stream->get_error();
  9977. if (last_error == Error::Success) { last_error = Error::Read; }
  9978. eof = true;
  9979. return 0;
  9980. }
  9981. bytes_read += static_cast<size_t>(n);
  9982. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9983. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9984. last_error = Error::ExceedMaxPayloadSize;
  9985. eof = true;
  9986. return -1;
  9987. }
  9988. return n;
  9989. }
  9990. // Chunked transfer encoding: delegate to shared decoder instance.
  9991. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9992. size_t chunk_offset = 0;
  9993. size_t chunk_total = 0;
  9994. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9995. if (n < 0) {
  9996. last_error = stream->get_error();
  9997. if (last_error == Error::Success) { last_error = Error::Read; }
  9998. eof = true;
  9999. return n;
  10000. }
  10001. if (n == 0) {
  10002. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10003. eof = true;
  10004. return 0;
  10005. }
  10006. bytes_read += static_cast<size_t>(n);
  10007. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10008. last_error = Error::ExceedMaxPayloadSize;
  10009. eof = true;
  10010. return -1;
  10011. }
  10012. return n;
  10013. }
  10014. // ThreadPool implementation
  10015. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10016. time_t idle_timeout_sec)
  10017. : base_thread_count_(n), max_queued_requests_(mqr),
  10018. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10019. shutdown_(false) {
  10020. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10021. if (max_n != 0 && max_n < n) {
  10022. std::string msg = "max_threads must be >= base_threads";
  10023. throw std::invalid_argument(msg);
  10024. }
  10025. #endif
  10026. max_thread_count_ = max_n == 0 ? n : max_n;
  10027. threads_.reserve(base_thread_count_);
  10028. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10029. try {
  10030. #endif
  10031. for (size_t i = 0; i < base_thread_count_; i++) {
  10032. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10033. }
  10034. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10035. } catch (...) {
  10036. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10037. // signal the workers we already spawned to exit and join them so the
  10038. // vector destructor does not see joinable threads (which would call
  10039. // std::terminate). Then rethrow so the caller learns of the failure.
  10040. {
  10041. std::unique_lock<std::mutex> lock(mutex_);
  10042. shutdown_ = true;
  10043. }
  10044. cond_.notify_all();
  10045. for (auto &t : threads_) {
  10046. if (t.joinable()) { t.join(); }
  10047. }
  10048. throw;
  10049. }
  10050. #endif
  10051. }
  10052. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10053. {
  10054. std::unique_lock<std::mutex> lock(mutex_);
  10055. if (shutdown_) { return false; }
  10056. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10057. return false;
  10058. }
  10059. jobs_.push_back(std::move(fn));
  10060. // Spawn a dynamic thread if no idle threads and under max
  10061. if (idle_thread_count_ == 0 &&
  10062. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10063. cleanup_finished_threads();
  10064. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10065. }
  10066. }
  10067. cond_.notify_one();
  10068. return true;
  10069. }
  10070. inline void ThreadPool::shutdown() {
  10071. {
  10072. std::unique_lock<std::mutex> lock(mutex_);
  10073. shutdown_ = true;
  10074. }
  10075. cond_.notify_all();
  10076. for (auto &t : threads_) {
  10077. if (t.joinable()) { t.join(); }
  10078. }
  10079. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10080. // with worker threads that call move_to_finished() concurrently.
  10081. std::list<std::thread> remaining_dynamic;
  10082. {
  10083. std::unique_lock<std::mutex> lock(mutex_);
  10084. remaining_dynamic = std::move(dynamic_threads_);
  10085. }
  10086. for (auto &t : remaining_dynamic) {
  10087. if (t.joinable()) { t.join(); }
  10088. }
  10089. std::unique_lock<std::mutex> lock(mutex_);
  10090. cleanup_finished_threads();
  10091. }
  10092. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10093. // Must be called with mutex_ held
  10094. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10095. if (it->get_id() == id) {
  10096. finished_threads_.push_back(std::move(*it));
  10097. dynamic_threads_.erase(it);
  10098. return;
  10099. }
  10100. }
  10101. }
  10102. inline void ThreadPool::cleanup_finished_threads() {
  10103. // Must be called with mutex_ held
  10104. for (auto &t : finished_threads_) {
  10105. if (t.joinable()) { t.join(); }
  10106. }
  10107. finished_threads_.clear();
  10108. }
  10109. inline void ThreadPool::worker(bool is_dynamic) {
  10110. for (;;) {
  10111. std::function<void()> fn;
  10112. {
  10113. std::unique_lock<std::mutex> lock(mutex_);
  10114. idle_thread_count_++;
  10115. if (is_dynamic) {
  10116. auto has_work =
  10117. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10118. [&] { return !jobs_.empty() || shutdown_; });
  10119. if (!has_work) {
  10120. // Timed out with no work - exit this dynamic thread
  10121. idle_thread_count_--;
  10122. move_to_finished(std::this_thread::get_id());
  10123. break;
  10124. }
  10125. } else {
  10126. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10127. }
  10128. idle_thread_count_--;
  10129. if (shutdown_ && jobs_.empty()) { break; }
  10130. fn = std::move(jobs_.front());
  10131. jobs_.pop_front();
  10132. }
  10133. assert(true == static_cast<bool>(fn));
  10134. fn();
  10135. }
  10136. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10137. !defined(LIBRESSL_VERSION_NUMBER)
  10138. OPENSSL_thread_stop();
  10139. #endif
  10140. }
  10141. /*
  10142. * Group 1 (continued): detail namespace - Stream implementations
  10143. */
  10144. namespace detail {
  10145. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10146. time_t timeout_sec, time_t timeout_usec,
  10147. time_t &actual_timeout_sec,
  10148. time_t &actual_timeout_usec) {
  10149. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10150. auto actual_timeout_msec =
  10151. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10152. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10153. actual_timeout_sec = actual_timeout_msec / 1000;
  10154. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10155. }
  10156. // Socket stream implementation
  10157. inline SocketStream::SocketStream(
  10158. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10159. time_t write_timeout_sec, time_t write_timeout_usec,
  10160. time_t max_timeout_msec,
  10161. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10162. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10163. read_timeout_usec_(read_timeout_usec),
  10164. write_timeout_sec_(write_timeout_sec),
  10165. write_timeout_usec_(write_timeout_usec),
  10166. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10167. read_buff_(read_buff_size_, 0) {}
  10168. inline SocketStream::~SocketStream() = default;
  10169. inline bool SocketStream::is_readable() const {
  10170. return read_buff_off_ < read_buff_content_size_;
  10171. }
  10172. inline bool SocketStream::wait_readable() const {
  10173. if (max_timeout_msec_ <= 0) {
  10174. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10175. }
  10176. time_t read_timeout_sec;
  10177. time_t read_timeout_usec;
  10178. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10179. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10180. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10181. }
  10182. inline bool SocketStream::wait_writable() const {
  10183. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10184. }
  10185. inline bool SocketStream::ensure_readable() {
  10186. if (readable_hint_) {
  10187. readable_hint_ = false;
  10188. return true;
  10189. }
  10190. return wait_readable();
  10191. }
  10192. inline const char *SocketStream::buffered_data(size_t &size) const {
  10193. size = read_buff_content_size_ - read_buff_off_;
  10194. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10195. }
  10196. inline void SocketStream::consume_buffered(size_t size) {
  10197. assert(size <= read_buff_content_size_ - read_buff_off_);
  10198. read_buff_off_ += size;
  10199. }
  10200. inline bool SocketStream::is_peer_alive() const {
  10201. return detail::is_socket_alive(sock_);
  10202. }
  10203. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10204. #ifdef _WIN32
  10205. size =
  10206. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10207. #else
  10208. size = (std::min)(size,
  10209. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10210. #endif
  10211. if (read_buff_off_ < read_buff_content_size_) {
  10212. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10213. if (size <= remaining_size) {
  10214. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10215. read_buff_off_ += size;
  10216. return static_cast<ssize_t>(size);
  10217. } else {
  10218. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10219. read_buff_off_ += remaining_size;
  10220. return static_cast<ssize_t>(remaining_size);
  10221. }
  10222. }
  10223. if (!ensure_readable()) {
  10224. error_ = Error::Timeout;
  10225. return -1;
  10226. }
  10227. read_buff_off_ = 0;
  10228. read_buff_content_size_ = 0;
  10229. if (size < read_buff_size_) {
  10230. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10231. CPPHTTPLIB_RECV_FLAGS);
  10232. if (n <= 0) {
  10233. if (n == 0) {
  10234. error_ = Error::ConnectionClosed;
  10235. } else {
  10236. error_ = Error::Read;
  10237. }
  10238. return n;
  10239. } else if (n <= static_cast<ssize_t>(size)) {
  10240. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10241. return n;
  10242. } else {
  10243. memcpy(ptr, read_buff_.data(), size);
  10244. read_buff_off_ = size;
  10245. read_buff_content_size_ = static_cast<size_t>(n);
  10246. return static_cast<ssize_t>(size);
  10247. }
  10248. } else {
  10249. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10250. if (n <= 0) {
  10251. if (n == 0) {
  10252. error_ = Error::ConnectionClosed;
  10253. } else {
  10254. error_ = Error::Read;
  10255. }
  10256. }
  10257. return n;
  10258. }
  10259. }
  10260. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10261. if (!wait_writable()) { return -1; }
  10262. #if defined(_WIN32) && !defined(_WIN64)
  10263. size =
  10264. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10265. #endif
  10266. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10267. }
  10268. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10269. int &port) const {
  10270. return detail::get_remote_ip_and_port(sock_, ip, port);
  10271. }
  10272. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10273. int &port) const {
  10274. return detail::get_local_ip_and_port(sock_, ip, port);
  10275. }
  10276. inline socket_t SocketStream::socket() const { return sock_; }
  10277. inline time_t SocketStream::duration() const {
  10278. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10279. std::chrono::steady_clock::now() - start_time_)
  10280. .count();
  10281. }
  10282. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10283. read_timeout_sec_ = sec;
  10284. read_timeout_usec_ = usec;
  10285. }
  10286. // Buffer stream implementation
  10287. inline bool BufferStream::is_readable() const { return true; }
  10288. inline bool BufferStream::wait_readable() const { return true; }
  10289. inline bool BufferStream::wait_writable() const { return true; }
  10290. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10291. #if defined(_MSC_VER) && _MSC_VER < 1910
  10292. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10293. #else
  10294. auto len_read = buffer.copy(ptr, size, position);
  10295. #endif
  10296. position += static_cast<size_t>(len_read);
  10297. return static_cast<ssize_t>(len_read);
  10298. }
  10299. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10300. buffer.append(ptr, size);
  10301. return static_cast<ssize_t>(size);
  10302. }
  10303. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10304. int & /*port*/) const {}
  10305. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10306. int & /*port*/) const {}
  10307. inline socket_t BufferStream::socket() const { return 0; }
  10308. inline time_t BufferStream::duration() const { return 0; }
  10309. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10310. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10311. : MatcherBase(pattern) {
  10312. constexpr const char marker[] = "/:";
  10313. // One past the last ending position of a path param substring
  10314. std::size_t last_param_end = 0;
  10315. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10316. // Needed to ensure that parameter names are unique during matcher
  10317. // construction
  10318. // If exceptions are disabled, only last duplicate path
  10319. // parameter will be set
  10320. std::unordered_set<std::string> param_name_set;
  10321. #endif
  10322. while (true) {
  10323. const auto marker_pos = pattern.find(
  10324. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10325. if (marker_pos == std::string::npos) { break; }
  10326. static_fragments_.push_back(
  10327. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10328. const auto param_name_start = marker_pos + str_len(marker);
  10329. auto sep_pos = pattern.find(separator, param_name_start);
  10330. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10331. auto param_name =
  10332. pattern.substr(param_name_start, sep_pos - param_name_start);
  10333. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10334. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10335. std::string msg = "Encountered path parameter '" + param_name +
  10336. "' multiple times in route pattern '" + pattern + "'.";
  10337. throw std::invalid_argument(msg);
  10338. }
  10339. #endif
  10340. param_names_.push_back(std::move(param_name));
  10341. last_param_end = sep_pos + 1;
  10342. }
  10343. if (last_param_end < pattern.length()) {
  10344. static_fragments_.push_back(pattern.substr(last_param_end));
  10345. }
  10346. }
  10347. inline bool PathParamsMatcher::match(Request &request) const {
  10348. request.matches = std::smatch();
  10349. request.path_params.clear();
  10350. // A pattern without parameters is just a literal path to compare against
  10351. if (param_names_.empty()) { return request.path == pattern(); }
  10352. request.path_params.reserve(param_names_.size());
  10353. // One past the position at which the path matched the pattern last time
  10354. std::size_t starting_pos = 0;
  10355. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10356. const auto &fragment = static_fragments_[i];
  10357. if (starting_pos + fragment.length() > request.path.length()) {
  10358. return false;
  10359. }
  10360. // Avoid unnecessary allocation by using strncmp instead of substr +
  10361. // comparison
  10362. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10363. fragment.length()) != 0) {
  10364. return false;
  10365. }
  10366. starting_pos += fragment.length();
  10367. // Should only happen when we have a static fragment after a param
  10368. // Example: '/users/:id/subscriptions'
  10369. // The 'subscriptions' fragment here does not have a corresponding param
  10370. if (i >= param_names_.size()) { continue; }
  10371. auto sep_pos = request.path.find(separator, starting_pos);
  10372. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10373. const auto &param_name = param_names_[i];
  10374. request.path_params.emplace(
  10375. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10376. // Mark everything up to '/' as matched
  10377. starting_pos = sep_pos + 1;
  10378. }
  10379. // Returns false if the path is longer than the pattern
  10380. return starting_pos >= request.path.length();
  10381. }
  10382. inline bool RegexMatcher::match(Request &request) const {
  10383. request.path_params.clear();
  10384. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10385. // a non-match rather than risking a stack overflow in std::regex_match.
  10386. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10387. return false;
  10388. }
  10389. return std::regex_match(request.path, request.matches, regex_);
  10390. }
  10391. // Enclose IPv6 address in brackets if needed
  10392. inline std::string prepare_host_string(const std::string &host) {
  10393. // Enclose IPv6 address in brackets (but not if already enclosed)
  10394. if (host.find(':') == std::string::npos ||
  10395. (!host.empty() && host[0] == '[')) {
  10396. // IPv4, hostname, or already bracketed IPv6
  10397. return host;
  10398. } else {
  10399. // IPv6 address without brackets
  10400. return "[" + host + "]";
  10401. }
  10402. }
  10403. inline std::string make_host_and_port_string(const std::string &host, int port,
  10404. bool is_ssl) {
  10405. auto result = prepare_host_string(host);
  10406. // Append port if not default
  10407. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10408. ; // do nothing
  10409. } else {
  10410. result += ":" + std::to_string(port);
  10411. }
  10412. return result;
  10413. }
  10414. // Create "host:port" string always including port number (for CONNECT method)
  10415. inline std::string
  10416. make_host_and_port_string_always_port(const std::string &host, int port) {
  10417. return prepare_host_string(host) + ":" + std::to_string(port);
  10418. }
  10419. // Value for the Host header a client sends when the caller supplied none.
  10420. // Only the value: callers decide where in their header list it goes.
  10421. inline std::string make_default_host_header_value(const std::string &host,
  10422. int port, bool is_ssl,
  10423. int address_family) {
  10424. if (address_family == AF_UNIX) { return "localhost"; }
  10425. return make_host_and_port_string(host, port, is_ssl);
  10426. }
  10427. inline void add_default_user_agent_header(Request &req) {
  10428. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10429. if (!req.has_header("User-Agent")) {
  10430. req.set_header("User-Agent",
  10431. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10432. }
  10433. #else
  10434. (void)req;
  10435. #endif
  10436. }
  10437. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10438. NormalizedTarget normalize_target(const std::string &host);
  10439. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10440. bool host_matches_no_proxy(const NormalizedTarget &target,
  10441. const std::vector<NoProxyEntry> &entries);
  10442. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10443. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10444. if (prefix_bits == 0) { return true; }
  10445. int full_bytes = prefix_bits / 8;
  10446. int rem_bits = prefix_bits % 8;
  10447. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10448. static_cast<size_t>(full_bytes)) != 0) {
  10449. return false;
  10450. }
  10451. if (rem_bits == 0) { return true; }
  10452. auto i = static_cast<size_t>(full_bytes);
  10453. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10454. return (ip[i] & mask) == (net[i] & mask);
  10455. }
  10456. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10457. if (token.empty()) { return false; }
  10458. if (token == "*") {
  10459. out.kind = NoProxyKind::Wildcard;
  10460. return true;
  10461. }
  10462. auto slash = token.find('/');
  10463. std::string addr_part =
  10464. (slash == std::string::npos) ? token : token.substr(0, slash);
  10465. std::string prefix_part =
  10466. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10467. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10468. // don't silently treat it as a /32 (or /128).
  10469. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10470. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10471. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10472. // when brackets are present.
  10473. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10474. addr_part.back() == ']';
  10475. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10476. if (!bracketed) {
  10477. struct in_addr v4;
  10478. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10479. int prefix = 32;
  10480. if (!prefix_part.empty()) {
  10481. auto r = from_chars(prefix_part.data(),
  10482. prefix_part.data() + prefix_part.size(), prefix);
  10483. if (r.ec != std::errc{} ||
  10484. r.ptr != prefix_part.data() + prefix_part.size()) {
  10485. return false;
  10486. }
  10487. if (prefix < 0 || prefix > 32) { return false; }
  10488. }
  10489. out.kind = NoProxyKind::IPv4Cidr;
  10490. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10491. out.prefix_bits = prefix;
  10492. return true;
  10493. }
  10494. }
  10495. struct in6_addr v6;
  10496. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10497. int prefix = 128;
  10498. if (!prefix_part.empty()) {
  10499. auto r = from_chars(prefix_part.data(),
  10500. prefix_part.data() + prefix_part.size(), prefix);
  10501. if (r.ec != std::errc{} ||
  10502. r.ptr != prefix_part.data() + prefix_part.size()) {
  10503. return false;
  10504. }
  10505. if (prefix < 0 || prefix > 128) { return false; }
  10506. }
  10507. out.kind = NoProxyKind::IPv6Cidr;
  10508. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10509. out.prefix_bits = prefix;
  10510. return true;
  10511. }
  10512. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10513. // the entry is malformed — don't fall through to the hostname branch.
  10514. if (bracketed) { return false; }
  10515. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10516. if (slash != std::string::npos) { return false; }
  10517. // Port-specific entries (host:port) are not supported.
  10518. if (token.find(':') != std::string::npos) { return false; }
  10519. std::string hostname = case_ignore::to_lower(token);
  10520. while (!hostname.empty() && hostname.front() == '.') {
  10521. hostname.erase(hostname.begin());
  10522. }
  10523. while (!hostname.empty() && hostname.back() == '.') {
  10524. hostname.pop_back();
  10525. }
  10526. if (hostname.empty()) { return false; }
  10527. out.kind = NoProxyKind::HostnameSuffix;
  10528. out.hostname_pattern = std::move(hostname);
  10529. return true;
  10530. }
  10531. inline NormalizedTarget normalize_target(const std::string &host) {
  10532. NormalizedTarget t;
  10533. std::string h = host;
  10534. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10535. h = h.substr(1, h.size() - 2);
  10536. }
  10537. // Strip a single trailing dot so "example.com." canonicalizes to
  10538. // "example.com".
  10539. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10540. t.hostname = case_ignore::to_lower(h);
  10541. if (!t.hostname.empty()) {
  10542. struct in_addr v4;
  10543. struct in6_addr v6;
  10544. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10545. t.is_ipv4 = true;
  10546. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10547. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10548. t.is_ipv6 = true;
  10549. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10550. }
  10551. }
  10552. return t;
  10553. }
  10554. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10555. const std::vector<NoProxyEntry> &entries) {
  10556. if (target.hostname.empty()) { return false; }
  10557. for (const auto &e : entries) {
  10558. switch (e.kind) {
  10559. case NoProxyKind::Wildcard: return true;
  10560. case NoProxyKind::IPv4Cidr:
  10561. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10562. return true;
  10563. }
  10564. break;
  10565. case NoProxyKind::IPv6Cidr:
  10566. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10567. return true;
  10568. }
  10569. break;
  10570. case NoProxyKind::HostnameSuffix:
  10571. if (target.is_ipv4 || target.is_ipv6) { break; }
  10572. if (target.hostname == e.hostname_pattern) { return true; }
  10573. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10574. // an entry of "example.com".
  10575. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10576. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10577. if (target.hostname[offset - 1] == '.' &&
  10578. target.hostname.compare(offset, e.hostname_pattern.size(),
  10579. e.hostname_pattern) == 0) {
  10580. return true;
  10581. }
  10582. }
  10583. break;
  10584. }
  10585. }
  10586. return false;
  10587. }
  10588. template <typename T>
  10589. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10590. T header_writer, Error &error) {
  10591. for (const auto &h : headers) {
  10592. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10593. error = Error::InvalidHeaders;
  10594. return false;
  10595. }
  10596. }
  10597. if (header_writer(strm, headers) <= 0) {
  10598. error = Error::Write;
  10599. return false;
  10600. }
  10601. return true;
  10602. }
  10603. } // namespace detail
  10604. /*
  10605. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10606. */
  10607. #ifdef CPPHTTPLIB_SSL_ENABLED
  10608. namespace detail {
  10609. // SSL socket stream implementation
  10610. inline SSLSocketStream::SSLSocketStream(
  10611. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10612. time_t read_timeout_usec, time_t write_timeout_sec,
  10613. time_t write_timeout_usec, time_t max_timeout_msec,
  10614. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10615. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10616. read_timeout_usec_(read_timeout_usec),
  10617. write_timeout_sec_(write_timeout_sec),
  10618. write_timeout_usec_(write_timeout_usec),
  10619. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10620. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10621. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10622. // Note: create_session() also clears this, but SSLClient currently
  10623. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10624. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10625. // SSL session was created.
  10626. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10627. #endif
  10628. }
  10629. inline SSLSocketStream::~SSLSocketStream() = default;
  10630. inline bool SSLSocketStream::is_readable() const {
  10631. return tls::pending(session_) > 0;
  10632. }
  10633. inline bool SSLSocketStream::wait_readable() const {
  10634. if (max_timeout_msec_ <= 0) {
  10635. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10636. }
  10637. time_t read_timeout_sec;
  10638. time_t read_timeout_usec;
  10639. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10640. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10641. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10642. }
  10643. inline bool SSLSocketStream::wait_writable() const {
  10644. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10645. !tls::is_peer_closed(session_, sock_);
  10646. }
  10647. inline bool SSLSocketStream::ensure_readable() {
  10648. if (readable_hint_) {
  10649. readable_hint_ = false;
  10650. return true;
  10651. }
  10652. return wait_readable();
  10653. }
  10654. inline bool SSLSocketStream::is_peer_alive() const {
  10655. return !tls::is_peer_closed(session_, sock_);
  10656. }
  10657. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10658. if (tls::pending(session_) > 0) {
  10659. tls::TlsError err;
  10660. auto ret = tls::read(session_, ptr, size, err);
  10661. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10662. error_ = Error::ConnectionClosed;
  10663. }
  10664. return ret;
  10665. } else if (ensure_readable()) {
  10666. tls::TlsError err;
  10667. auto ret = tls::read(session_, ptr, size, err);
  10668. if (ret < 0) {
  10669. auto n = 1000;
  10670. #ifdef _WIN32
  10671. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10672. (err.code == tls::ErrorCode::SyscallError &&
  10673. WSAGetLastError() == WSAETIMEDOUT))) {
  10674. #else
  10675. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10676. #endif
  10677. if (tls::pending(session_) > 0) {
  10678. return tls::read(session_, ptr, size, err);
  10679. } else if (wait_readable()) {
  10680. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10681. ret = tls::read(session_, ptr, size, err);
  10682. if (ret >= 0) { return ret; }
  10683. } else {
  10684. break;
  10685. }
  10686. }
  10687. assert(ret < 0);
  10688. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10689. error_ = Error::ConnectionClosed;
  10690. }
  10691. return ret;
  10692. } else {
  10693. error_ = Error::Timeout;
  10694. return -1;
  10695. }
  10696. }
  10697. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10698. if (wait_writable()) {
  10699. auto handle_size =
  10700. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10701. tls::TlsError err;
  10702. auto ret = tls::write(session_, ptr, handle_size, err);
  10703. if (ret < 0) {
  10704. auto n = 1000;
  10705. #ifdef _WIN32
  10706. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10707. (err.code == tls::ErrorCode::SyscallError &&
  10708. WSAGetLastError() == WSAETIMEDOUT))) {
  10709. #else
  10710. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10711. #endif
  10712. if (wait_writable()) {
  10713. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10714. ret = tls::write(session_, ptr, handle_size, err);
  10715. if (ret >= 0) { return ret; }
  10716. } else {
  10717. break;
  10718. }
  10719. }
  10720. assert(ret < 0);
  10721. }
  10722. return ret;
  10723. }
  10724. return -1;
  10725. }
  10726. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10727. int &port) const {
  10728. detail::get_remote_ip_and_port(sock_, ip, port);
  10729. }
  10730. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10731. int &port) const {
  10732. detail::get_local_ip_and_port(sock_, ip, port);
  10733. }
  10734. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10735. inline time_t SSLSocketStream::duration() const {
  10736. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10737. std::chrono::steady_clock::now() - start_time_)
  10738. .count();
  10739. }
  10740. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10741. read_timeout_sec_ = sec;
  10742. read_timeout_usec_ = usec;
  10743. }
  10744. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10745. tls::session_t session,
  10746. time_t read_timeout_sec,
  10747. time_t read_timeout_usec,
  10748. time_t write_timeout_sec,
  10749. time_t write_timeout_usec)
  10750. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10751. read_timeout_usec_(read_timeout_usec),
  10752. write_timeout_sec_(write_timeout_sec),
  10753. write_timeout_usec_(write_timeout_usec),
  10754. start_time_(std::chrono::steady_clock::now()) {
  10755. // The receive and send paths run on different threads, so each TLS call is
  10756. // driven in non-blocking mode and readiness is awaited with select()
  10757. // outside the session lock. Set the socket non-blocking once here; it is
  10758. // never flipped back, so no thread races on the flag.
  10759. detail::set_nonblocking(sock_, true);
  10760. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10761. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10762. #endif
  10763. }
  10764. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10765. inline bool WebSocketSSLStream::is_readable() const {
  10766. std::lock_guard<std::mutex> guard(session_mutex_);
  10767. return tls::pending(session_) > 0;
  10768. }
  10769. inline bool WebSocketSSLStream::wait_readable() const {
  10770. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10771. }
  10772. inline bool WebSocketSSLStream::wait_writable() const {
  10773. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10774. // that probe toggles the socket's blocking flag, which would race with the
  10775. // concurrent reader on a permanently non-blocking socket.
  10776. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10777. }
  10778. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10779. tls::TlsError err;
  10780. auto n = 1000;
  10781. while (--n >= 0) {
  10782. {
  10783. std::lock_guard<std::mutex> guard(session_mutex_);
  10784. auto ret = tls::read(session_, ptr, size, err);
  10785. if (ret > 0) { return ret; }
  10786. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10787. error_ = Error::ConnectionClosed;
  10788. return ret;
  10789. }
  10790. }
  10791. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10792. // direction: the send path shares this session, so output it left pending
  10793. // has to be flushed before more input can be decrypted. Anything else is
  10794. // a hard error.
  10795. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10796. #ifdef _WIN32
  10797. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10798. needs_readable =
  10799. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10800. WSAGetLastError() == WSAETIMEDOUT);
  10801. #endif
  10802. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10803. error_ = Error::Read;
  10804. return -1;
  10805. }
  10806. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10807. error_ = Error::Timeout;
  10808. return -1;
  10809. }
  10810. }
  10811. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10812. // to tell a timeout from a close would otherwise see whatever the previous
  10813. // failure left behind (error_ is never cleared on success).
  10814. error_ = Error::Read;
  10815. return -1;
  10816. }
  10817. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10818. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10819. tls::TlsError err;
  10820. auto n = 1000;
  10821. while (--n >= 0) {
  10822. {
  10823. std::lock_guard<std::mutex> guard(session_mutex_);
  10824. auto ret = tls::write(session_, ptr, handle_size, err);
  10825. if (ret >= 0) { return ret; }
  10826. }
  10827. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10828. // or a post-handshake message must be consumed before the record goes
  10829. // out. Anything else is a hard error.
  10830. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10831. #ifdef _WIN32
  10832. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10833. needs_writable =
  10834. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10835. WSAGetLastError() == WSAETIMEDOUT);
  10836. #endif
  10837. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10838. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10839. }
  10840. return -1;
  10841. }
  10842. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10843. int &port) const {
  10844. detail::get_remote_ip_and_port(sock_, ip, port);
  10845. }
  10846. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10847. int &port) const {
  10848. detail::get_local_ip_and_port(sock_, ip, port);
  10849. }
  10850. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10851. inline time_t WebSocketSSLStream::duration() const {
  10852. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10853. std::chrono::steady_clock::now() - start_time_)
  10854. .count();
  10855. }
  10856. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10857. read_timeout_sec_ = sec;
  10858. read_timeout_usec_ = usec;
  10859. }
  10860. } // namespace detail
  10861. #endif // CPPHTTPLIB_SSL_ENABLED
  10862. /*
  10863. * Group 4: Server implementation
  10864. */
  10865. // HTTP server implementation
  10866. inline Server::Server()
  10867. : new_task_queue([] {
  10868. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10869. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10870. }) {
  10871. #ifndef _WIN32
  10872. signal(SIGPIPE, SIG_IGN);
  10873. #endif
  10874. }
  10875. inline Server::~Server() = default;
  10876. inline std::unique_ptr<detail::MatcherBase>
  10877. Server::make_matcher(const std::string &pattern) {
  10878. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10879. // a path params pattern
  10880. if (pattern.find("/:") != std::string::npos) {
  10881. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10882. }
  10883. // A pattern with no regex metacharacter only has to be compared literally,
  10884. // which is what PathParamsMatcher already does when it captures no
  10885. // parameter, so std::regex is only worth building for the patterns that
  10886. // actually need it
  10887. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10888. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10889. }
  10890. return detail::make_unique<detail::RegexMatcher>(pattern);
  10891. }
  10892. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10893. return add_handler(get_handlers_, pattern, std::move(handler));
  10894. }
  10895. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10896. return add_handler(post_handlers_, pattern, std::move(handler));
  10897. }
  10898. inline Server &Server::Post(const std::string &pattern,
  10899. HandlerWithContentReader handler) {
  10900. return add_handler(post_handlers_for_content_reader_, pattern,
  10901. std::move(handler));
  10902. }
  10903. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10904. return add_handler(put_handlers_, pattern, std::move(handler));
  10905. }
  10906. inline Server &Server::Put(const std::string &pattern,
  10907. HandlerWithContentReader handler) {
  10908. return add_handler(put_handlers_for_content_reader_, pattern,
  10909. std::move(handler));
  10910. }
  10911. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10912. return add_handler(patch_handlers_, pattern, std::move(handler));
  10913. }
  10914. inline Server &Server::Patch(const std::string &pattern,
  10915. HandlerWithContentReader handler) {
  10916. return add_handler(patch_handlers_for_content_reader_, pattern,
  10917. std::move(handler));
  10918. }
  10919. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10920. return add_handler(delete_handlers_, pattern, std::move(handler));
  10921. }
  10922. inline Server &Server::Delete(const std::string &pattern,
  10923. HandlerWithContentReader handler) {
  10924. return add_handler(delete_handlers_for_content_reader_, pattern,
  10925. std::move(handler));
  10926. }
  10927. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10928. return add_handler(options_handlers_, pattern, std::move(handler));
  10929. }
  10930. inline const std::set<std::string> &Server::builtin_methods() {
  10931. thread_local const std::set<std::string> methods{
  10932. "GET", "HEAD", "POST", "PUT", "DELETE",
  10933. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10934. return methods;
  10935. }
  10936. inline Server::CustomHandlerEntry *
  10937. Server::custom_entry_for_registration(const std::string &method) {
  10938. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10939. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10940. // routing() before the custom tables are consulted, so a route registered
  10941. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10942. // there and would be reachable, but they carry protocol-level meaning
  10943. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10944. // library does not route.
  10945. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10946. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10947. has_invalid_registration_ = true;
  10948. return nullptr;
  10949. }
  10950. return &custom_handlers_[method];
  10951. }
  10952. inline Server &Server::CustomRoute(const std::string &method,
  10953. const std::string &pattern,
  10954. Handler handler) {
  10955. auto *entry = custom_entry_for_registration(method);
  10956. if (!entry) { return *this; }
  10957. return add_handler(entry->handlers, pattern, std::move(handler));
  10958. }
  10959. inline Server &Server::CustomRoute(const std::string &method,
  10960. const std::string &pattern,
  10961. HandlerWithContentReader handler) {
  10962. auto *entry = custom_entry_for_registration(method);
  10963. if (!entry) { return *this; }
  10964. return add_handler(entry->handlers_for_content_reader, pattern,
  10965. std::move(handler));
  10966. }
  10967. inline const Server::CustomHandlerEntry *
  10968. Server::find_custom_entry(const std::string &method) const {
  10969. // find() alone would be correct here. The empty() check is what keeps the
  10970. // per-request cost off servers that never call CustomRoute(), which is the
  10971. // overwhelmingly common case; keep it rather than walking into the tree.
  10972. if (custom_handlers_.empty()) { return nullptr; }
  10973. auto it = custom_handlers_.find(method);
  10974. return it == custom_handlers_.end() ? nullptr : &it->second;
  10975. }
  10976. inline Server &Server::WebSocket(const std::string &pattern,
  10977. WebSocketHandler handler) {
  10978. websocket_handlers_.push_back(
  10979. {make_matcher(pattern), std::move(handler), nullptr});
  10980. return *this;
  10981. }
  10982. inline Server &Server::WebSocket(const std::string &pattern,
  10983. WebSocketHandler handler,
  10984. SubProtocolSelector sub_protocol_selector) {
  10985. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10986. std::move(sub_protocol_selector)});
  10987. return *this;
  10988. }
  10989. inline bool Server::set_base_dir(const std::string &dir,
  10990. const std::string &mount_point) {
  10991. return set_mount_point(mount_point, dir);
  10992. }
  10993. inline bool Server::set_mount_point(const std::string &mount_point,
  10994. const std::string &dir, Headers headers) {
  10995. detail::FileStat stat(dir);
  10996. if (stat.is_dir()) {
  10997. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10998. if (!mnt.empty() && mnt[0] == '/') {
  10999. std::string resolved_base;
  11000. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11001. #if defined(_WIN32)
  11002. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11003. resolved_base += '\\';
  11004. }
  11005. #else
  11006. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11007. #endif
  11008. }
  11009. base_dirs_.push_back(
  11010. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11011. return true;
  11012. }
  11013. }
  11014. return false;
  11015. }
  11016. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11017. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11018. if (it->mount_point == mount_point) {
  11019. base_dirs_.erase(it);
  11020. return true;
  11021. }
  11022. }
  11023. return false;
  11024. }
  11025. inline Server &
  11026. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11027. const std::string &mime) {
  11028. file_extension_and_mimetype_map_[ext] = mime;
  11029. return *this;
  11030. }
  11031. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11032. default_file_mimetype_ = mime;
  11033. return *this;
  11034. }
  11035. inline Server &Server::set_file_request_handler(Handler handler) {
  11036. file_request_handler_ = std::move(handler);
  11037. return *this;
  11038. }
  11039. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11040. std::true_type) {
  11041. error_handler_ = std::move(handler);
  11042. return *this;
  11043. }
  11044. inline Server &Server::set_error_handler_core(Handler handler,
  11045. std::false_type) {
  11046. error_handler_ = [handler](const Request &req, Response &res) {
  11047. handler(req, res);
  11048. return HandlerResponse::Handled;
  11049. };
  11050. return *this;
  11051. }
  11052. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11053. exception_handler_ = std::move(handler);
  11054. return *this;
  11055. }
  11056. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11057. pre_routing_handler_ = std::move(handler);
  11058. return *this;
  11059. }
  11060. inline Server &Server::set_post_routing_handler(Handler handler) {
  11061. post_routing_handler_ = std::move(handler);
  11062. return *this;
  11063. }
  11064. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11065. pre_request_handler_ = std::move(handler);
  11066. return *this;
  11067. }
  11068. inline Server &Server::set_logger(Logger logger) {
  11069. logger_ = std::move(logger);
  11070. return *this;
  11071. }
  11072. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11073. error_logger_ = std::move(error_logger);
  11074. return *this;
  11075. }
  11076. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11077. pre_compression_logger_ = std::move(logger);
  11078. return *this;
  11079. }
  11080. inline Server &
  11081. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11082. expect_100_continue_handler_ = std::move(handler);
  11083. return *this;
  11084. }
  11085. inline Server &Server::set_start_handler(StartHandler handler) {
  11086. start_handler_ = std::move(handler);
  11087. return *this;
  11088. }
  11089. inline Server &Server::set_address_family(int family) {
  11090. address_family_ = family;
  11091. return *this;
  11092. }
  11093. inline Server &Server::set_tcp_nodelay(bool on) {
  11094. tcp_nodelay_ = on;
  11095. return *this;
  11096. }
  11097. inline Server &Server::set_ipv6_v6only(bool on) {
  11098. ipv6_v6only_ = on;
  11099. return *this;
  11100. }
  11101. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11102. socket_options_ = std::move(socket_options);
  11103. return *this;
  11104. }
  11105. inline Server &Server::set_default_headers(Headers headers) {
  11106. default_headers_ = std::move(headers);
  11107. return *this;
  11108. }
  11109. inline Server &Server::set_header_writer(
  11110. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11111. header_writer_ = writer;
  11112. return *this;
  11113. }
  11114. inline Server &
  11115. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11116. trusted_proxies_ = proxies;
  11117. return *this;
  11118. }
  11119. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11120. keep_alive_max_count_ = count;
  11121. return *this;
  11122. }
  11123. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11124. keep_alive_timeout_sec_ = sec;
  11125. return *this;
  11126. }
  11127. template <class Rep, class Period>
  11128. inline Server &Server::set_keep_alive_timeout(
  11129. const std::chrono::duration<Rep, Period> &duration) {
  11130. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11131. set_keep_alive_timeout(sec);
  11132. });
  11133. return *this;
  11134. }
  11135. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11136. read_timeout_sec_ = sec;
  11137. read_timeout_usec_ = usec;
  11138. return *this;
  11139. }
  11140. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11141. write_timeout_sec_ = sec;
  11142. write_timeout_usec_ = usec;
  11143. return *this;
  11144. }
  11145. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11146. idle_interval_sec_ = sec;
  11147. idle_interval_usec_ = usec;
  11148. return *this;
  11149. }
  11150. inline Server &Server::set_payload_max_length(size_t length) {
  11151. payload_max_length_ = length;
  11152. return *this;
  11153. }
  11154. inline Server &Server::set_static_file_compression(bool on) {
  11155. static_file_compression_ = on;
  11156. return *this;
  11157. }
  11158. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11159. static_file_compression_min_length_ = length;
  11160. return *this;
  11161. }
  11162. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11163. static_file_compression_max_length_ = length;
  11164. return *this;
  11165. }
  11166. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11167. websocket_max_missed_pongs_ = count;
  11168. return *this;
  11169. }
  11170. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11171. websocket_ping_interval_sec_ = sec;
  11172. return *this;
  11173. }
  11174. template <class Rep, class Period>
  11175. inline Server &Server::set_websocket_ping_interval(
  11176. const std::chrono::duration<Rep, Period> &duration) {
  11177. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11178. set_websocket_ping_interval(sec);
  11179. });
  11180. return *this;
  11181. }
  11182. inline bool Server::bind_to_port(const std::string &host, int port,
  11183. int socket_flags) {
  11184. auto ret = bind_internal(host, port, socket_flags);
  11185. if (ret == -1) { is_decommissioned = true; }
  11186. return ret >= 0;
  11187. }
  11188. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11189. auto ret = bind_internal(host, 0, socket_flags);
  11190. if (ret == -1) { is_decommissioned = true; }
  11191. return ret;
  11192. }
  11193. inline bool Server::listen_after_bind() { return listen_internal(); }
  11194. inline bool Server::listen(const std::string &host, int port,
  11195. int socket_flags) {
  11196. return bind_to_port(host, port, socket_flags) && listen_internal();
  11197. }
  11198. inline bool Server::is_running() const { return is_running_; }
  11199. inline void Server::wait_until_ready() const {
  11200. while (!is_running_ && !is_decommissioned) {
  11201. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11202. }
  11203. }
  11204. inline void Server::stop() noexcept {
  11205. // Release the listening socket whether or not the accept loop is running:
  11206. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11207. // exchange is what makes this safe to call concurrently with the accept loop.
  11208. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11209. if (sock != INVALID_SOCKET) {
  11210. detail::shutdown_socket(sock);
  11211. detail::close_socket(sock);
  11212. }
  11213. is_decommissioned = false;
  11214. }
  11215. inline void Server::decommission() { is_decommissioned = true; }
  11216. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11217. auto len = strlen(s);
  11218. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11219. len -= 2;
  11220. {
  11221. size_t count = 0;
  11222. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11223. switch (count) {
  11224. case 0: req.method = std::string(b, e); break;
  11225. case 1: req.target = std::string(b, e); break;
  11226. case 2: req.version = std::string(b, e); break;
  11227. default: break;
  11228. }
  11229. count++;
  11230. });
  11231. if (count != 3) { return false; }
  11232. }
  11233. // A method outside the built-in set is accepted only when a handler has been
  11234. // registered for it with CustomRoute().
  11235. const auto &methods = builtin_methods();
  11236. if (methods.find(req.method) == methods.end() &&
  11237. !find_custom_entry(req.method)) {
  11238. output_error_log(Error::InvalidHTTPMethod, &req);
  11239. return false;
  11240. }
  11241. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11242. output_error_log(Error::InvalidHTTPVersion, &req);
  11243. return false;
  11244. }
  11245. if (!detail::fields::is_request_target(req.target)) { return false; }
  11246. {
  11247. // Skip URL fragment
  11248. for (size_t i = 0; i < req.target.size(); i++) {
  11249. if (req.target[i] == '#') {
  11250. req.target.erase(i);
  11251. break;
  11252. }
  11253. }
  11254. detail::divide(req.target, '?',
  11255. [&](const char *lhs_data, std::size_t lhs_size,
  11256. const char *rhs_data, std::size_t rhs_size) {
  11257. req.path =
  11258. decode_path_component(std::string(lhs_data, lhs_size));
  11259. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11260. });
  11261. }
  11262. return true;
  11263. }
  11264. inline bool Server::write_response(Stream &strm, bool close_connection,
  11265. Request &req, Response &res) {
  11266. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11267. // incorrectly to the error content.
  11268. req.ranges.clear();
  11269. return write_response_core(strm, close_connection, req, res, false);
  11270. }
  11271. inline bool Server::write_response_with_content(Stream &strm,
  11272. bool close_connection,
  11273. const Request &req,
  11274. Response &res) {
  11275. return write_response_core(strm, close_connection, req, res, true);
  11276. }
  11277. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11278. const Request &req, Response &res,
  11279. bool need_apply_ranges) {
  11280. assert(res.status != -1);
  11281. if (400 <= res.status && error_handler_ &&
  11282. error_handler_(req, res) == HandlerResponse::Handled) {
  11283. need_apply_ranges = true;
  11284. }
  11285. std::string content_type;
  11286. std::string boundary;
  11287. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11288. // Prepare additional headers
  11289. if (close_connection ||
  11290. detail::has_header_token(req.headers, "Connection", "close") ||
  11291. 400 <= res.status || // Don't leave connections open after errors
  11292. // The client withholds the body until `100 Continue`, which was never
  11293. // sent, so whether and when the body follows is unknown.
  11294. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11295. res.set_header("Connection", "close");
  11296. } else {
  11297. std::string s = "timeout=";
  11298. s += std::to_string(keep_alive_timeout_sec_);
  11299. s += ", max=";
  11300. s += std::to_string(keep_alive_max_count_);
  11301. res.set_header("Keep-Alive", s);
  11302. }
  11303. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11304. !res.has_header("Content-Type")) {
  11305. res.set_header("Content-Type", "text/plain");
  11306. }
  11307. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11308. !res.has_header("Content-Length")) {
  11309. res.set_header("Content-Length", "0");
  11310. }
  11311. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11312. res.set_header("Accept-Ranges", "bytes");
  11313. }
  11314. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11315. // Response line and headers
  11316. detail::BufferStream bstrm;
  11317. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11318. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11319. // Combine a small body with the headers so the whole response leaves in a
  11320. // single write. A large body is written on its own instead: a copy of it
  11321. // costs more than the extra write saves.
  11322. auto send_body = req.method != "HEAD";
  11323. auto body_is_separate = false;
  11324. auto provider_done = false;
  11325. if (send_body && !res.body.empty() && !res.content_provider_) {
  11326. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11327. bstrm.write(res.body.data(), res.body.size());
  11328. } else {
  11329. body_is_separate = true;
  11330. }
  11331. } else if (send_body && res.content_provider_ &&
  11332. res.is_file_content_provider_ &&
  11333. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11334. // A small file is read into the same buffer. Other providers may produce
  11335. // their data over time, so they are never held back.
  11336. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11337. return false;
  11338. }
  11339. provider_done = true;
  11340. }
  11341. // Log before writing to avoid race condition with client-side code that
  11342. // accesses logger-captured data immediately after receiving the response.
  11343. output_log(req, res);
  11344. // Flush buffer
  11345. auto &data = bstrm.get_buffer();
  11346. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11347. if (body_is_separate) {
  11348. return detail::write_data(strm, res.body.data(), res.body.size());
  11349. }
  11350. // Streaming body
  11351. if (send_body && res.content_provider_) {
  11352. if (!provider_done &&
  11353. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11354. return false;
  11355. }
  11356. res.content_provider_success_ = true;
  11357. }
  11358. return true;
  11359. }
  11360. inline bool
  11361. Server::write_content_with_provider(Stream &strm, const Request &req,
  11362. Response &res, const std::string &boundary,
  11363. const std::string &content_type) {
  11364. auto is_shutting_down = [this]() {
  11365. return this->svr_sock_ == INVALID_SOCKET;
  11366. };
  11367. if (res.content_length_ > 0) {
  11368. // Only a 206 response is served as a partial representation, matching the
  11369. // condition `apply_ranges()` used to decide the Content-Length and the
  11370. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11371. // only for a 2xx status, slicing under any other status would write a body
  11372. // that disagrees with the header already sent, from an unchecked offset.
  11373. auto is_partial =
  11374. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11375. if (!is_partial) {
  11376. return detail::write_content(strm, res.content_provider_, 0,
  11377. res.content_length_, is_shutting_down);
  11378. } else if (req.ranges.size() == 1) {
  11379. auto offset_and_length = detail::get_range_offset_and_length(
  11380. req.ranges[0], res.content_length_);
  11381. return detail::write_content(strm, res.content_provider_,
  11382. offset_and_length.first,
  11383. offset_and_length.second, is_shutting_down);
  11384. } else {
  11385. return detail::write_multipart_ranges_data(
  11386. strm, req, res, boundary, content_type, res.content_length_,
  11387. is_shutting_down);
  11388. }
  11389. } else {
  11390. if (res.is_chunked_content_provider_) {
  11391. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11392. // re-negotiating here would disagree with them, e.g. once a handler's
  11393. // own Content-Encoding header suppresses the negotiation.
  11394. auto compressor = detail::make_compressor(res.content_coding_);
  11395. if (!compressor) {
  11396. compressor = detail::make_unique<detail::nocompressor>();
  11397. }
  11398. return detail::write_content_chunked(strm, res.content_provider_,
  11399. is_shutting_down, *compressor);
  11400. } else {
  11401. return detail::write_content_without_length(strm, res.content_provider_,
  11402. is_shutting_down);
  11403. }
  11404. }
  11405. }
  11406. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11407. FormFields::iterator cur_field;
  11408. FormFiles::iterator cur_file;
  11409. auto is_text_field = false;
  11410. size_t count = 0;
  11411. if (read_content_core(
  11412. strm, req, res,
  11413. // Regular
  11414. [&](const char *buf, size_t n) {
  11415. // Prevent arithmetic overflow when checking sizes.
  11416. // Avoid computing (req.body.size() + n) directly because
  11417. // adding two unsigned `size_t` values can wrap around and
  11418. // produce a small result instead of indicating overflow.
  11419. // Instead, check using subtraction: ensure `n` does not
  11420. // exceed the remaining capacity `max_size() - size()`.
  11421. if (req.body.size() >= req.body.max_size() ||
  11422. n > req.body.max_size() - req.body.size()) {
  11423. return false;
  11424. }
  11425. // Limit decompressed body size to payload_max_length_ to protect
  11426. // against "zip bomb" attacks where a small compressed payload
  11427. // decompresses to a massive size.
  11428. if (payload_max_length_ > 0 &&
  11429. (req.body.size() >= payload_max_length_ ||
  11430. n > payload_max_length_ - req.body.size())) {
  11431. return false;
  11432. }
  11433. req.body.append(buf, n);
  11434. return true;
  11435. },
  11436. // Multipart FormData
  11437. [&](const FormData &file) {
  11438. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11439. output_error_log(Error::TooManyFormDataFiles, &req);
  11440. return false;
  11441. }
  11442. if (file.filename.empty()) {
  11443. cur_field = req.form.fields.emplace(
  11444. file.name, FormField{file.name, file.content, file.headers});
  11445. is_text_field = true;
  11446. } else {
  11447. cur_file = req.form.files.emplace(file.name, file);
  11448. is_text_field = false;
  11449. }
  11450. return true;
  11451. },
  11452. [&](const char *buf, size_t n) {
  11453. if (is_text_field) {
  11454. auto &content = cur_field->second.content;
  11455. if (content.size() + n > content.max_size()) { return false; }
  11456. content.append(buf, n);
  11457. } else {
  11458. auto &content = cur_file->second.content;
  11459. if (content.size() + n > content.max_size()) { return false; }
  11460. content.append(buf, n);
  11461. }
  11462. return true;
  11463. })) {
  11464. const auto &content_type = req.get_header_value("Content-Type");
  11465. if (detail::extract_media_type(content_type) ==
  11466. "application/x-www-form-urlencoded") {
  11467. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11468. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11469. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11470. return false;
  11471. }
  11472. detail::parse_query_text(req.body, req.params);
  11473. }
  11474. return true;
  11475. }
  11476. return false;
  11477. }
  11478. inline bool Server::read_content_with_content_receiver(
  11479. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11480. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11481. return read_content_core(strm, req, res, std::move(receiver),
  11482. std::move(multipart_header),
  11483. std::move(multipart_receiver));
  11484. }
  11485. inline bool Server::read_content_core(
  11486. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11487. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11488. detail::FormDataParser multipart_form_data_parser;
  11489. ContentReceiverWithProgress out;
  11490. if (req.is_multipart_form_data()) {
  11491. const auto &content_type = req.get_header_value("Content-Type");
  11492. std::string boundary;
  11493. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11494. res.status = StatusCode::BadRequest_400;
  11495. output_error_log(Error::MultipartParsing, &req);
  11496. return false;
  11497. }
  11498. multipart_form_data_parser.set_boundary(std::move(boundary));
  11499. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11500. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11501. multipart_receiver);
  11502. };
  11503. } else {
  11504. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11505. size_t /*len*/) { return receiver(buf, n); };
  11506. }
  11507. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11508. // For non-SSL builds we still scan non-persistent connections for stray
  11509. // body bytes so the payload limit is enforced (413). On keep-alive,
  11510. // pending bytes may be the next request (issue #2450), so skip.
  11511. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11512. if (!req.has_header("Content-Length") &&
  11513. !detail::is_chunked_transfer_encoding(req.headers)) {
  11514. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11515. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11516. auto has_data = strm.is_readable();
  11517. if (!has_data) {
  11518. auto s = strm.socket();
  11519. if (s != INVALID_SOCKET) {
  11520. has_data = detail::select_read(s, 0, 0) > 0;
  11521. }
  11522. }
  11523. if (has_data) {
  11524. // Route through the same decompressing reader used by the
  11525. // length-framed and chunked paths below, so payload_max_length_ is
  11526. // enforced on the decompressed size here too instead of only on the
  11527. // compressed wire bytes.
  11528. return detail::read_content(strm, req, payload_max_length_, res.status,
  11529. nullptr, out, true);
  11530. }
  11531. }
  11532. return true;
  11533. }
  11534. #else
  11535. if (!req.has_header("Content-Length") &&
  11536. !detail::is_chunked_transfer_encoding(req.headers)) {
  11537. return true;
  11538. }
  11539. #endif
  11540. // The client is waiting for this before it sends the body.
  11541. if (req.expect_100_continue_pending_) {
  11542. req.expect_100_continue_pending_ = false;
  11543. detail::write_response_line(strm, StatusCode::Continue_100);
  11544. strm.write("\r\n");
  11545. }
  11546. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11547. out, true)) {
  11548. return false;
  11549. }
  11550. req.body_consumed_ = true;
  11551. if (req.is_multipart_form_data()) {
  11552. if (!multipart_form_data_parser.is_valid()) {
  11553. res.status = StatusCode::BadRequest_400;
  11554. output_error_log(Error::MultipartParsing, &req);
  11555. return false;
  11556. }
  11557. }
  11558. return true;
  11559. }
  11560. inline bool Server::handle_file_request(Request &req, Response &res) {
  11561. for (const auto &entry : base_dirs_) {
  11562. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11563. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11564. // One that already ends in '/' (the root mount among them) carries its own
  11565. // boundary; set_mount_point() guarantees the mount point is not empty.
  11566. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11567. (entry.mount_point.back() == '/' ||
  11568. req.path.size() == entry.mount_point.size() ||
  11569. req.path[entry.mount_point.size()] == '/')) {
  11570. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11571. if (detail::is_valid_path(sub_path)) {
  11572. auto path = entry.base_dir + sub_path;
  11573. if (path.back() == '/') { path += "index.html"; }
  11574. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11575. // but symlinks/junctions can still escape the base directory.
  11576. if (!entry.resolved_base_dir.empty()) {
  11577. std::string resolved_path;
  11578. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11579. !detail::is_path_within_base(resolved_path,
  11580. entry.resolved_base_dir)) {
  11581. res.status = StatusCode::Forbidden_403;
  11582. return true;
  11583. }
  11584. }
  11585. detail::FileStat stat(path);
  11586. if (stat.is_dir()) {
  11587. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11588. return true;
  11589. }
  11590. if (stat.is_file()) {
  11591. for (const auto &kv : entry.headers) {
  11592. res.set_header(kv.first, kv.second);
  11593. }
  11594. auto content_type_of = [&]() {
  11595. return detail::find_content_type(
  11596. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11597. };
  11598. // Only the ETag needs the content type this early, and only to name
  11599. // the coding. Deciding it here would otherwise put a regex in front
  11600. // of the 304 below, which serving a file never used to pay for.
  11601. std::string content_type;
  11602. auto encoding = detail::EncodingType::None;
  11603. if (static_file_compression_) {
  11604. content_type = content_type_of();
  11605. encoding =
  11606. static_file_encoding(req, res, content_type, stat.size());
  11607. }
  11608. // The ETag names the representation actually sent, so a client that
  11609. // cached the compressed form revalidates against the compressed ETag
  11610. // and still gets a 304, while one that took identity keeps the plain
  11611. // ETag.
  11612. auto etag = detail::compute_etag(
  11613. stat, encoding == detail::EncodingType::None
  11614. ? std::string()
  11615. : std::string("-") + detail::encoding_name(encoding));
  11616. if (!etag.empty()) { res.set_header("ETag", etag); }
  11617. auto mtime = stat.mtime();
  11618. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11619. if (!last_modified.empty()) {
  11620. res.set_header("Last-Modified", last_modified);
  11621. }
  11622. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11623. check_if_range(req, etag, mtime);
  11624. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11625. if (!mm->is_open()) {
  11626. output_error_log(Error::OpenFile, &req);
  11627. return false;
  11628. }
  11629. if (!static_file_compression_) { content_type = content_type_of(); }
  11630. detail::set_file_content_provider(res, mm, content_type, encoding);
  11631. if (req.method != "HEAD" && file_request_handler_) {
  11632. file_request_handler_(req, res);
  11633. }
  11634. return true;
  11635. } else {
  11636. output_error_log(Error::OpenFile, &req);
  11637. }
  11638. }
  11639. }
  11640. }
  11641. return false;
  11642. }
  11643. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11644. const std::string &etag,
  11645. time_t mtime) const {
  11646. // Handle conditional GET:
  11647. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11648. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11649. if (req.has_header("If-None-Match")) {
  11650. if (!etag.empty()) {
  11651. auto val =
  11652. detail::get_combined_header_value(req.headers, "If-None-Match");
  11653. // NOTE: We use exact string matching here. This works correctly
  11654. // because our server always generates weak ETags (W/"..."), and
  11655. // clients typically send back the same ETag they received.
  11656. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11657. // If-None-Match, where W/"x" and "x" would match, but this
  11658. // simplified implementation requires exact matches.
  11659. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11660. [&](const char *b, const char *e) {
  11661. auto seg_len = static_cast<size_t>(e - b);
  11662. return (seg_len == 1 && *b == '*') ||
  11663. (seg_len == etag.size() &&
  11664. std::equal(b, e, etag.begin()));
  11665. });
  11666. if (ret) {
  11667. res.status = StatusCode::NotModified_304;
  11668. return true;
  11669. }
  11670. }
  11671. } else if (req.has_header("If-Modified-Since")) {
  11672. auto val = req.get_header_value("If-Modified-Since");
  11673. auto t = detail::parse_http_date(val);
  11674. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11675. res.status = StatusCode::NotModified_304;
  11676. return true;
  11677. }
  11678. }
  11679. return false;
  11680. }
  11681. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11682. time_t mtime) const {
  11683. // Handle If-Range for partial content requests (RFC 9110
  11684. // Section 13.1.5). If-Range is only evaluated when Range header is
  11685. // present. If the validator matches, serve partial content; otherwise
  11686. // serve full content.
  11687. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11688. auto val = req.get_header_value("If-Range");
  11689. auto is_valid_range = [&]() {
  11690. if (detail::is_strong_etag(val)) {
  11691. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11692. // comparison.
  11693. return (!etag.empty() && val == etag);
  11694. } else if (detail::is_weak_etag(val)) {
  11695. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11696. return false;
  11697. } else {
  11698. // HTTP-date comparison
  11699. auto t = detail::parse_http_date(val);
  11700. return (t != static_cast<time_t>(-1) && mtime <= t);
  11701. }
  11702. };
  11703. if (!is_valid_range()) {
  11704. // Validator doesn't match: ignore Range and serve full content
  11705. req.ranges.clear();
  11706. return false;
  11707. }
  11708. }
  11709. return true;
  11710. }
  11711. inline socket_t
  11712. Server::create_server_socket(const std::string &host, int port,
  11713. int socket_flags,
  11714. SocketOptions socket_options) const {
  11715. return detail::create_socket(
  11716. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11717. ipv6_v6only_, std::move(socket_options),
  11718. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11719. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11720. output_error_log(Error::BindIPAddress, nullptr);
  11721. return false;
  11722. }
  11723. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11724. output_error_log(Error::Listen, nullptr);
  11725. return false;
  11726. }
  11727. return true;
  11728. });
  11729. }
  11730. inline int Server::bind_internal(const std::string &host, int port,
  11731. int socket_flags) {
  11732. if (is_decommissioned) { return -1; }
  11733. if (!is_valid()) { return -1; }
  11734. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11735. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11736. if (port == 0) {
  11737. struct sockaddr_storage addr;
  11738. socklen_t addr_len = sizeof(addr);
  11739. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11740. &addr_len) == -1) {
  11741. output_error_log(Error::GetSockName, nullptr);
  11742. return -1;
  11743. }
  11744. if (addr.ss_family == AF_INET) {
  11745. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11746. } else if (addr.ss_family == AF_INET6) {
  11747. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11748. } else {
  11749. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11750. return -1;
  11751. }
  11752. } else {
  11753. return port;
  11754. }
  11755. }
  11756. inline bool Server::listen_internal() {
  11757. // A stop() between bind and listen leaves nothing to accept on. Report
  11758. // failure instead of returning success without ever serving, and mark the
  11759. // server decommissioned the way any failed listen does so that a concurrent
  11760. // wait_until_ready() wakes up instead of spinning forever.
  11761. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11762. is_decommissioned = true;
  11763. return false;
  11764. }
  11765. auto ret = true;
  11766. is_running_ = true;
  11767. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11768. if (start_handler_) { start_handler_(); }
  11769. {
  11770. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11771. while (svr_sock_ != INVALID_SOCKET) {
  11772. #ifndef _WIN32
  11773. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11774. #endif
  11775. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11776. idle_interval_usec_);
  11777. if (val == 0) { // Timeout
  11778. task_queue->on_idle();
  11779. continue;
  11780. }
  11781. #ifndef _WIN32
  11782. }
  11783. #endif
  11784. #if defined _WIN32
  11785. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11786. // OVERLAPPED
  11787. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11788. #elif defined SOCK_CLOEXEC
  11789. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11790. #else
  11791. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11792. #endif
  11793. if (sock == INVALID_SOCKET) {
  11794. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11795. // touches the CRT errno, so the two have to be asked platform by
  11796. // platform rather than by testing errno here.
  11797. if (detail::is_accept_resource_error()) {
  11798. // The per-process descriptor limit or the network stack's buffer
  11799. // space has been reached. Try to accept new connections after a
  11800. // short sleep.
  11801. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11802. continue;
  11803. } else if (detail::is_accept_transient_error()) {
  11804. continue;
  11805. }
  11806. // Take the descriptor out of svr_sock_ before closing it: a later
  11807. // stop() would otherwise shutdown()/close() a value the OS may have
  11808. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11809. // gone. The exchange also settles the race with a concurrent stop(),
  11810. // since whichever side takes the descriptor closes it exactly once.
  11811. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11812. if (listen_sock != INVALID_SOCKET) {
  11813. detail::close_socket(listen_sock);
  11814. ret = false;
  11815. output_error_log(Error::Connection, nullptr);
  11816. } else {
  11817. ; // The server socket was closed by user.
  11818. }
  11819. break;
  11820. }
  11821. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11822. read_timeout_sec_, read_timeout_usec_);
  11823. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11824. write_timeout_sec_, write_timeout_usec_);
  11825. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11826. if (!task_queue->enqueue(
  11827. [this, sock]() { process_and_close_socket(sock); })) {
  11828. output_error_log(Error::ResourceExhaustion, nullptr);
  11829. detail::shutdown_socket(sock);
  11830. detail::close_socket(sock);
  11831. }
  11832. }
  11833. task_queue->shutdown();
  11834. }
  11835. is_decommissioned = !ret;
  11836. return ret;
  11837. }
  11838. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11839. if (pre_routing_handler_ &&
  11840. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11841. return true;
  11842. }
  11843. // File handler
  11844. if ((req.method == "GET" || req.method == "HEAD") &&
  11845. handle_file_request(req, res)) {
  11846. return true;
  11847. }
  11848. const auto *custom = find_custom_entry(req.method);
  11849. // The second clause mirrors what expect_content() does unconditionally for
  11850. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11851. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11852. // `allprop`) would skip its handler and fall through to 404.
  11853. if (detail::expect_content(req) ||
  11854. (custom && !custom->handlers_for_content_reader.empty())) {
  11855. // Content reader handler
  11856. {
  11857. // Track whether the ContentReader was aborted due to the decompressed
  11858. // payload exceeding `payload_max_length_`.
  11859. // The user handler runs after the lambda returns, so we must restore the
  11860. // 413 status if the handler overwrites it.
  11861. bool content_reader_payload_too_large = false;
  11862. ContentReader reader(
  11863. [&](ContentReceiver receiver) {
  11864. auto result = read_content_with_content_receiver(
  11865. strm, req, res, std::move(receiver), nullptr, nullptr);
  11866. if (!result) {
  11867. output_error_log(Error::Read, &req);
  11868. if (res.status == StatusCode::PayloadTooLarge_413) {
  11869. content_reader_payload_too_large = true;
  11870. }
  11871. }
  11872. return result;
  11873. },
  11874. [&](FormDataHeader header, ContentReceiver receiver) {
  11875. auto result = read_content_with_content_receiver(
  11876. strm, req, res, nullptr, std::move(header),
  11877. std::move(receiver));
  11878. if (!result) {
  11879. output_error_log(Error::Read, &req);
  11880. if (res.status == StatusCode::PayloadTooLarge_413) {
  11881. content_reader_payload_too_large = true;
  11882. }
  11883. }
  11884. return result;
  11885. });
  11886. bool dispatched = false;
  11887. if (req.method == "POST") {
  11888. dispatched = dispatch_request_for_content_reader(
  11889. req, res, std::move(reader), post_handlers_for_content_reader_);
  11890. } else if (req.method == "PUT") {
  11891. dispatched = dispatch_request_for_content_reader(
  11892. req, res, std::move(reader), put_handlers_for_content_reader_);
  11893. } else if (req.method == "PATCH") {
  11894. dispatched = dispatch_request_for_content_reader(
  11895. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11896. } else if (req.method == "DELETE") {
  11897. dispatched = dispatch_request_for_content_reader(
  11898. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11899. } else if (custom) {
  11900. dispatched = dispatch_request_for_content_reader(
  11901. req, res, std::move(reader), custom->handlers_for_content_reader);
  11902. }
  11903. if (dispatched) {
  11904. if (content_reader_payload_too_large) {
  11905. // Enforce the limit: override any status the handler may have set
  11906. // and return false so the error path sends a plain 413 response.
  11907. res.status = StatusCode::PayloadTooLarge_413;
  11908. res.body.clear();
  11909. res.content_length_ = 0;
  11910. res.content_provider_ = nullptr;
  11911. return false;
  11912. }
  11913. return true;
  11914. }
  11915. }
  11916. // NOTE: `req.body` is not read here. For a regular handler the body is
  11917. // read inside dispatch_request(), after the route has matched and the
  11918. // pre-request handler has approved the request, so that a rejected
  11919. // request (e.g. failed authentication) never forces us to buffer a
  11920. // potentially large body.
  11921. }
  11922. // Regular handler
  11923. if (req.method == "GET" || req.method == "HEAD") {
  11924. return dispatch_request(req, res, get_handlers_, strm);
  11925. } else if (req.method == "POST") {
  11926. return dispatch_request(req, res, post_handlers_, strm);
  11927. } else if (req.method == "PUT") {
  11928. return dispatch_request(req, res, put_handlers_, strm);
  11929. } else if (req.method == "DELETE") {
  11930. return dispatch_request(req, res, delete_handlers_, strm);
  11931. } else if (req.method == "OPTIONS") {
  11932. return dispatch_request(req, res, options_handlers_, strm);
  11933. } else if (req.method == "PATCH") {
  11934. return dispatch_request(req, res, patch_handlers_, strm);
  11935. } else if (custom) {
  11936. return dispatch_request(req, res, custom->handlers, strm);
  11937. }
  11938. res.status = StatusCode::BadRequest_400;
  11939. return false;
  11940. }
  11941. inline bool Server::dispatch_request(Request &req, Response &res,
  11942. const Handlers &handlers, Stream &strm) {
  11943. for (const auto &x : handlers) {
  11944. const auto &matcher = x.first;
  11945. const auto &handler = x.second;
  11946. if (matcher->match(req)) {
  11947. req.matched_route = matcher->pattern();
  11948. // Run the pre-request handler before reading the body so a rejected
  11949. // request (e.g. failed authentication) never forces us to buffer a
  11950. // potentially large body. `req.matched_route` is available here.
  11951. if (pre_request_handler_ &&
  11952. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11953. return true;
  11954. }
  11955. // The route matched and the request was approved; read the body now.
  11956. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11957. output_error_log(Error::Read, &req);
  11958. return false;
  11959. }
  11960. handler(req, res);
  11961. return true;
  11962. }
  11963. }
  11964. return false;
  11965. }
  11966. // Decides the content coding for a response served straight from a file. Both
  11967. // the ETag, which has to name the representation actually sent, and
  11968. // `apply_static_file_compression()` go through this, so the two cannot drift
  11969. // apart.
  11970. inline detail::EncodingType
  11971. Server::static_file_encoding(const Request &req, const Response &res,
  11972. const std::string &content_type,
  11973. size_t length) const {
  11974. if (!static_file_compression_) { return detail::EncodingType::None; }
  11975. // Nothing to compress, and an empty file already answers with
  11976. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11977. // turn an empty body into a 20-byte gzip stream.
  11978. if (length == 0) { return detail::EncodingType::None; }
  11979. // A file that already fits in a single packet gains nothing from being made
  11980. // smaller, since it still travels in that one segment, and a file of a few
  11981. // bytes comes out larger than it went in.
  11982. if (length < static_file_compression_min_length_) {
  11983. return detail::EncodingType::None;
  11984. }
  11985. // RFC 9110 applies Range to the representation after content coding, so a
  11986. // compressed 206 would mean compressing the whole file and then slicing it.
  11987. // Serve ranges from the identity representation instead.
  11988. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11989. if (static_file_compression_max_length_ > 0 &&
  11990. length > static_file_compression_max_length_) {
  11991. return detail::EncodingType::None;
  11992. }
  11993. return detail::encoding_type(req, res, content_type);
  11994. }
  11995. // Compresses a file-backed content provider into `res.body` and takes over the
  11996. // framing headers. Returns false when the response is left untouched.
  11997. inline bool Server::apply_static_file_compression(const Request &req,
  11998. Response &res) const {
  11999. auto type = res.content_coding_;
  12000. if (type == detail::EncodingType::None || !res.content_provider_) {
  12001. return false;
  12002. }
  12003. auto compressor = detail::make_compressor(type);
  12004. if (!compressor) { return false; }
  12005. output_pre_compression_log(req, res);
  12006. std::string compressed;
  12007. if (!detail::compress_content_provider(res.content_provider_,
  12008. res.content_length_, *compressor,
  12009. compressed)) {
  12010. return false;
  12011. }
  12012. res.body.swap(compressed);
  12013. // The provider was consumed in full, so a resource releaser registered with
  12014. // it should hear about a success when the response goes away.
  12015. res.content_provider_success_ = true;
  12016. res.content_provider_ = nullptr;
  12017. res.content_length_ = 0;
  12018. res.content_coding_ = detail::EncodingType::None;
  12019. res.set_header("Content-Encoding", detail::encoding_name(type));
  12020. res.set_header("Vary", "Accept-Encoding");
  12021. res.set_header("Content-Length", std::to_string(res.body.size()));
  12022. return true;
  12023. }
  12024. inline void Server::apply_ranges(const Request &req, Response &res,
  12025. std::string &content_type,
  12026. std::string &boundary) const {
  12027. // A known-length content provider leaves `res.body` empty, so the compressor
  12028. // at the end of this function never runs for one (issue #2545). A file-backed
  12029. // provider is fully readable right here, so compress it and answer with an
  12030. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12031. // takes the same path as `set_content()` from here on. Range requests never
  12032. // get a content coding, so `Content-Range` still names identity bytes and
  12033. // none of the framing below applies.
  12034. if (apply_static_file_compression(req, res)) { return; }
  12035. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12036. auto it = res.headers.find("Content-Type");
  12037. if (it != res.headers.end()) {
  12038. content_type = it->second;
  12039. res.headers.erase(it);
  12040. }
  12041. boundary = detail::make_multipart_data_boundary();
  12042. res.set_header("Content-Type",
  12043. "multipart/byteranges; boundary=" + boundary);
  12044. }
  12045. auto type = detail::encoding_type(req, res);
  12046. if (res.body.empty()) {
  12047. if (res.content_length_ > 0) {
  12048. size_t length = 0;
  12049. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12050. length = res.content_length_;
  12051. } else if (req.ranges.size() == 1) {
  12052. auto offset_and_length = detail::get_range_offset_and_length(
  12053. req.ranges[0], res.content_length_);
  12054. length = offset_and_length.second;
  12055. auto content_range = detail::make_content_range_header_field(
  12056. offset_and_length, res.content_length_);
  12057. res.set_header("Content-Range", content_range);
  12058. } else {
  12059. length = detail::get_multipart_ranges_data_length(
  12060. req, boundary, content_type, res.content_length_);
  12061. }
  12062. res.set_header("Content-Length", std::to_string(length));
  12063. } else {
  12064. if (res.content_provider_) {
  12065. if (res.is_chunked_content_provider_) {
  12066. res.set_header("Transfer-Encoding", "chunked");
  12067. res.content_coding_ = type;
  12068. if (type != detail::EncodingType::None) {
  12069. res.set_header("Content-Encoding", detail::encoding_name(type));
  12070. res.set_header("Vary", "Accept-Encoding");
  12071. }
  12072. }
  12073. }
  12074. }
  12075. } else {
  12076. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12077. ;
  12078. } else if (req.ranges.size() == 1) {
  12079. auto offset_and_length =
  12080. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12081. auto offset = offset_and_length.first;
  12082. auto length = offset_and_length.second;
  12083. auto content_range = detail::make_content_range_header_field(
  12084. offset_and_length, res.body.size());
  12085. res.set_header("Content-Range", content_range);
  12086. assert(offset + length <= res.body.size());
  12087. res.body = res.body.substr(offset, length);
  12088. } else {
  12089. std::string data;
  12090. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12091. res.body.size(), data);
  12092. res.body.swap(data);
  12093. }
  12094. if (type != detail::EncodingType::None) {
  12095. output_pre_compression_log(req, res);
  12096. if (auto compressor = detail::make_compressor(type)) {
  12097. std::string compressed;
  12098. if (compressor->compress(res.body.data(), res.body.size(), true,
  12099. [&](const char *data, size_t data_len) {
  12100. compressed.append(data, data_len);
  12101. return true;
  12102. })) {
  12103. res.body.swap(compressed);
  12104. res.set_header("Content-Encoding", detail::encoding_name(type));
  12105. res.set_header("Vary", "Accept-Encoding");
  12106. }
  12107. }
  12108. }
  12109. res.content_length_ = res.body.size();
  12110. res.set_header("Content-Length", std::to_string(res.content_length_));
  12111. }
  12112. }
  12113. inline bool Server::dispatch_request_for_content_reader(
  12114. Request &req, Response &res, ContentReader content_reader,
  12115. const HandlersForContentReader &handlers) const {
  12116. for (const auto &x : handlers) {
  12117. const auto &matcher = x.first;
  12118. const auto &handler = x.second;
  12119. if (matcher->match(req)) {
  12120. req.matched_route = matcher->pattern();
  12121. if (!pre_request_handler_ ||
  12122. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12123. handler(req, res, content_reader);
  12124. }
  12125. return true;
  12126. }
  12127. }
  12128. return false;
  12129. }
  12130. inline std::string
  12131. get_client_ip(const std::string &x_forwarded_for,
  12132. const std::vector<std::string> &trusted_proxies) {
  12133. // X-Forwarded-For is a comma-separated list per RFC 7239
  12134. std::vector<std::string> ip_list;
  12135. detail::split(x_forwarded_for.data(),
  12136. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12137. [&](const char *b, const char *e) {
  12138. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12139. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12140. });
  12141. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12142. // no segments. Signal "no client IP derived" with an empty string so the
  12143. // caller can fall back to the connection-level remote address.
  12144. if (ip_list.empty()) { return std::string(); }
  12145. // Each hop appends the address it received the request from, so the rightmost
  12146. // entries are the ones written by our own infrastructure while the leftmost
  12147. // are whatever the original client chose to send. Walk from the right and
  12148. // skip trusted proxies; the first address that is not a trusted proxy is the
  12149. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12150. // from the left instead lets a client forge an arbitrary address by following
  12151. // it with a trusted proxy's address, which the left-to-right scan then
  12152. // returned as the client.
  12153. for (size_t i = ip_list.size(); i-- > 0;) {
  12154. const auto &ip = ip_list[i];
  12155. auto is_trusted_proxy =
  12156. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12157. [&](const std::string &proxy) { return ip == proxy; });
  12158. if (!is_trusted_proxy) { return ip; }
  12159. }
  12160. // Every hop was a trusted proxy; fall back to the first entry.
  12161. return ip_list.front();
  12162. }
  12163. inline bool
  12164. Server::process_request(Stream &strm, const std::string &remote_addr,
  12165. int remote_port, const std::string &local_addr,
  12166. int local_port, bool close_connection,
  12167. bool &connection_closed,
  12168. const std::function<void(Request &)> &setup_request,
  12169. bool *websocket_upgraded) {
  12170. std::array<char, 2048> buf{};
  12171. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12172. // Connection has been closed on client
  12173. if (!line_reader.getline()) { return false; }
  12174. Request req;
  12175. req.start_time_ = std::chrono::steady_clock::now();
  12176. req.remote_addr = remote_addr;
  12177. req.remote_port = remote_port;
  12178. req.local_addr = local_addr;
  12179. req.local_port = local_port;
  12180. Response res;
  12181. res.version = "HTTP/1.1";
  12182. res.headers = default_headers_;
  12183. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12184. // close the connection after that response, whichever path wrote it (an
  12185. // error status, a handler, or a rejected request). Reading on would also
  12186. // parse whatever the client sent next on a connection it considers done.
  12187. auto honor_connection_close = detail::scope_exit([&] {
  12188. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12189. connection_closed = true;
  12190. }
  12191. });
  12192. // Request line and headers. A rejected message leaves the rest of it (and
  12193. // any body) unread, so the connection cannot be reused: the leftover bytes
  12194. // would be parsed as the next request.
  12195. if (!parse_request_line(line_reader.ptr(), req)) {
  12196. connection_closed = true;
  12197. res.status = StatusCode::BadRequest_400;
  12198. output_error_log(Error::InvalidRequestLine, &req);
  12199. return write_response(strm, close_connection, req, res);
  12200. }
  12201. // Request headers
  12202. if (!detail::read_headers(strm, req.headers)) {
  12203. connection_closed = true;
  12204. res.status = StatusCode::BadRequest_400;
  12205. output_error_log(Error::InvalidHeaders, &req);
  12206. return write_response(strm, close_connection, req, res);
  12207. }
  12208. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12209. // which would otherwise let an intermediary and this parser disagree on
  12210. // where the body ends and enable request smuggling. Three cases: a
  12211. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12212. // or empty), which would otherwise be read as "no body"; a non-zero
  12213. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12214. // tolerated for compatibility with existing clients); and a
  12215. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12216. // length undeterminable. None of them may fall through to the "no body"
  12217. // path, or the body bytes are parsed as the next request on a persistent
  12218. // connection.
  12219. auto is_invalid_content_length = false;
  12220. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12221. is_invalid_content_length);
  12222. if (is_invalid_content_length ||
  12223. detail::has_conflicting_content_length(req.headers) ||
  12224. (req.has_header("Transfer-Encoding") &&
  12225. !detail::is_chunked_transfer_encoding(req.headers))) {
  12226. connection_closed = true;
  12227. res.status = StatusCode::BadRequest_400;
  12228. return write_response(strm, close_connection, req, res);
  12229. }
  12230. // Check if the request URI doesn't exceed the limit
  12231. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12232. connection_closed = true;
  12233. res.status = StatusCode::UriTooLong_414;
  12234. output_error_log(Error::ExceedUriMaxLength, &req);
  12235. return write_response(strm, close_connection, req, res);
  12236. }
  12237. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12238. connection_closed = true;
  12239. }
  12240. if (req.version == "HTTP/1.0" &&
  12241. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12242. connection_closed = true;
  12243. }
  12244. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12245. // itself a trusted proxy. Otherwise any direct client could spoof
  12246. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12247. auto is_trusted_peer = std::any_of(
  12248. trusted_proxies_.begin(), trusted_proxies_.end(),
  12249. [&](const std::string &proxy) { return proxy == remote_addr; });
  12250. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12251. // Some proxies append the address they observed as a separate
  12252. // X-Forwarded-For field line instead of extending the one the client sent
  12253. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12254. // be scanned. Reading only the first occurrence would hand back the
  12255. // client-supplied, and therefore forgeable, value.
  12256. auto x_forwarded_for =
  12257. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12258. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12259. req.remote_addr = derived.empty() ? remote_addr : derived;
  12260. } else {
  12261. req.remote_addr = remote_addr;
  12262. }
  12263. req.remote_port = remote_port;
  12264. req.local_addr = local_addr;
  12265. req.local_port = local_port;
  12266. if (req.has_header("Accept")) {
  12267. auto accept_header =
  12268. detail::get_combined_header_value(req.headers, "Accept");
  12269. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12270. connection_closed = true;
  12271. res.status = StatusCode::BadRequest_400;
  12272. output_error_log(Error::HTTPParsing, &req);
  12273. return write_response(strm, close_connection, req, res);
  12274. }
  12275. }
  12276. if (req.has_header("Range")) {
  12277. const auto &range_header_value = req.get_header_value("Range");
  12278. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12279. connection_closed = true;
  12280. res.status = StatusCode::RangeNotSatisfiable_416;
  12281. output_error_log(Error::InvalidRangeHeader, &req);
  12282. return write_response(strm, close_connection, req, res);
  12283. }
  12284. }
  12285. if (setup_request) { setup_request(req); }
  12286. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12287. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12288. // must be ignored. An expectation we do not recognize is left alone; the
  12289. // 417 the section allows for one is a MAY, not a requirement.
  12290. //
  12291. // `100 Continue` itself is deferred until the body is actually read (see
  12292. // read_content_core), so a request rejected by a later handler never
  12293. // invites the client to send a body nobody will read.
  12294. if (req.version != "HTTP/1.0" &&
  12295. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12296. int status = StatusCode::Continue_100;
  12297. if (expect_100_continue_handler_) {
  12298. status = expect_100_continue_handler_(req, res);
  12299. }
  12300. if (status == StatusCode::Continue_100) {
  12301. req.expect_100_continue_pending_ = true;
  12302. } else {
  12303. if (res.status == -1) { res.status = status; }
  12304. connection_closed = true;
  12305. return write_response(strm, true, req, res);
  12306. }
  12307. }
  12308. // Setup `is_connection_closed` method
  12309. auto sock = strm.socket();
  12310. req.is_connection_closed = [sock]() {
  12311. return !detail::is_socket_alive(sock);
  12312. };
  12313. // WebSocket upgrade
  12314. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12315. // that authentication and other middleware can reject the request with an
  12316. // HTTP response (e.g., 401) before the protocol switches.
  12317. if (detail::is_websocket_upgrade(req)) {
  12318. if (pre_routing_handler_ &&
  12319. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12320. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12321. return write_response_with_content(strm, close_connection, req, res);
  12322. }
  12323. // Find matching WebSocket handler
  12324. for (const auto &entry : websocket_handlers_) {
  12325. if (entry.matcher->match(req)) {
  12326. req.matched_route = entry.matcher->pattern();
  12327. if (pre_request_handler_ &&
  12328. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12329. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12330. return write_response_with_content(strm, close_connection, req, res);
  12331. }
  12332. // Compute accept key
  12333. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12334. auto accept_key = detail::websocket_accept_key(client_key);
  12335. // Negotiate subprotocol
  12336. std::string selected_subprotocol;
  12337. if (entry.sub_protocol_selector) {
  12338. auto protocol_header = detail::get_combined_header_value(
  12339. req.headers, "Sec-WebSocket-Protocol");
  12340. if (!protocol_header.empty()) {
  12341. std::vector<std::string> protocols;
  12342. detail::split(protocol_header.data(),
  12343. protocol_header.data() + protocol_header.size(), ',',
  12344. [&](const char *b, const char *e) {
  12345. protocols.emplace_back(b, e);
  12346. });
  12347. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12348. }
  12349. }
  12350. // Send 101 Switching Protocols
  12351. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12352. "Upgrade: websocket\r\n"
  12353. "Connection: Upgrade\r\n"
  12354. "Sec-WebSocket-Accept: " +
  12355. accept_key + "\r\n";
  12356. if (!selected_subprotocol.empty()) {
  12357. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12358. return false;
  12359. }
  12360. handshake_response +=
  12361. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12362. }
  12363. handshake_response += "\r\n";
  12364. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12365. 0) {
  12366. return false;
  12367. }
  12368. connection_closed = true;
  12369. if (websocket_upgraded) { *websocket_upgraded = true; }
  12370. {
  12371. #ifdef CPPHTTPLIB_SSL_ENABLED
  12372. if (req.ssl) {
  12373. // wss: the heartbeat ping thread and the read path enter the same
  12374. // TLS session from different threads. Hand the WebSocket a stream
  12375. // that serializes every TLS call, so the shared SSLSocketStream on
  12376. // the plain HTTP/HTTPS paths stays untouched.
  12377. auto ws_strm =
  12378. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12379. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12380. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12381. write_timeout_sec_, write_timeout_usec_));
  12382. ws::WebSocket ws(std::move(ws_strm), req, true,
  12383. websocket_ping_interval_sec_,
  12384. websocket_max_missed_pongs_);
  12385. entry.handler(req, ws);
  12386. return true;
  12387. }
  12388. #endif
  12389. // Use WebSocket-specific read timeout instead of HTTP timeout
  12390. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12391. 0);
  12392. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12393. websocket_max_missed_pongs_);
  12394. entry.handler(req, ws);
  12395. }
  12396. return true;
  12397. }
  12398. }
  12399. // No matching handler - fall through to 404
  12400. }
  12401. // Routing
  12402. auto routed = false;
  12403. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12404. routed = routing(req, res, strm);
  12405. #else
  12406. try {
  12407. routed = routing(req, res, strm);
  12408. } catch (std::exception &) {
  12409. if (exception_handler_) {
  12410. auto ep = std::current_exception();
  12411. exception_handler_(req, res, ep);
  12412. routed = true;
  12413. } else {
  12414. res.status = StatusCode::InternalServerError_500;
  12415. }
  12416. } catch (...) {
  12417. if (exception_handler_) {
  12418. auto ep = std::current_exception();
  12419. exception_handler_(req, res, ep);
  12420. routed = true;
  12421. } else {
  12422. res.status = StatusCode::InternalServerError_500;
  12423. }
  12424. }
  12425. #endif
  12426. auto ret = false;
  12427. if (routed) {
  12428. if (res.status == -1) {
  12429. res.status = req.ranges.empty() ? StatusCode::OK_200
  12430. : StatusCode::PartialContent_206;
  12431. }
  12432. // Serve file content by using a content provider
  12433. auto file_open_error = false;
  12434. if (!res.file_content_path_.empty()) {
  12435. const auto &path = res.file_content_path_;
  12436. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12437. if (!mm->is_open()) {
  12438. res.body.clear();
  12439. res.content_length_ = 0;
  12440. res.content_provider_ = nullptr;
  12441. res.status = StatusCode::NotFound_404;
  12442. output_error_log(Error::OpenFile, &req);
  12443. file_open_error = true;
  12444. } else {
  12445. auto content_type = res.file_content_content_type_;
  12446. if (content_type.empty()) {
  12447. content_type = detail::find_content_type(
  12448. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12449. }
  12450. detail::set_file_content_provider(
  12451. res, mm, content_type,
  12452. static_file_encoding(req, res, content_type, mm->size()));
  12453. }
  12454. }
  12455. if (file_open_error) {
  12456. ret = write_response(strm, close_connection, req, res);
  12457. } else if (detail::range_error(req, res)) {
  12458. res.body.clear();
  12459. res.content_length_ = 0;
  12460. res.content_provider_ = nullptr;
  12461. res.status = StatusCode::RangeNotSatisfiable_416;
  12462. ret = write_response(strm, close_connection, req, res);
  12463. } else {
  12464. ret = write_response_with_content(strm, close_connection, req, res);
  12465. }
  12466. } else {
  12467. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12468. ret = write_response(strm, close_connection, req, res);
  12469. }
  12470. // Drain any unconsumed framed body to prevent request smuggling on
  12471. // keep-alive. Without framing there is no body to drain — reading would
  12472. // consume the next request (issue #2450). If the response has committed the
  12473. // connection to close, there is no next request to protect.
  12474. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12475. !detail::has_header_token(res.headers, "Connection", "close")) {
  12476. int dummy_status;
  12477. if (!detail::read_content(
  12478. strm, req, payload_max_length_, dummy_status, nullptr,
  12479. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12480. connection_closed = true;
  12481. }
  12482. }
  12483. return ret;
  12484. }
  12485. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12486. inline bool Server::process_and_close_socket(socket_t sock) {
  12487. std::string remote_addr;
  12488. int remote_port = 0;
  12489. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12490. std::string local_addr;
  12491. int local_port = 0;
  12492. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12493. bool websocket_upgraded = false;
  12494. auto ret = serve_guarded([&]() {
  12495. return detail::process_server_socket(
  12496. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12497. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12498. write_timeout_usec_,
  12499. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12500. return process_request(strm, remote_addr, remote_port, local_addr,
  12501. local_port, close_connection,
  12502. connection_closed, nullptr,
  12503. &websocket_upgraded);
  12504. });
  12505. });
  12506. detail::drain_and_close_socket(sock);
  12507. return ret;
  12508. }
  12509. inline void Server::output_log(const Request &req, const Response &res) const {
  12510. if (logger_) {
  12511. std::lock_guard<std::mutex> guard(logger_mutex_);
  12512. logger_(req, res);
  12513. }
  12514. }
  12515. inline void Server::output_pre_compression_log(const Request &req,
  12516. const Response &res) const {
  12517. if (pre_compression_logger_) {
  12518. std::lock_guard<std::mutex> guard(logger_mutex_);
  12519. pre_compression_logger_(req, res);
  12520. }
  12521. }
  12522. inline void Server::output_error_log(const Error &err,
  12523. const Request *req) const {
  12524. if (error_logger_) {
  12525. std::lock_guard<std::mutex> guard(logger_mutex_);
  12526. error_logger_(err, req);
  12527. }
  12528. }
  12529. /*
  12530. * Group 5: ClientImpl and Client (Universal) implementation
  12531. */
  12532. // HTTP client implementation
  12533. inline ClientImpl::ClientImpl(const std::string &host)
  12534. : ClientImpl(host, 80, std::string(), std::string()) {}
  12535. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12536. : ClientImpl(host, port, std::string(), std::string()) {}
  12537. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12538. const std::string &client_cert_path,
  12539. const std::string &client_key_path)
  12540. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12541. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12542. inline ClientImpl::~ClientImpl() {
  12543. // Wait until all the requests in flight are handled.
  12544. size_t retry_count = 10;
  12545. while (retry_count-- > 0) {
  12546. {
  12547. std::lock_guard<std::mutex> guard(socket_mutex_);
  12548. if (socket_requests_in_flight_ == 0) { break; }
  12549. }
  12550. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12551. }
  12552. std::lock_guard<std::mutex> guard(socket_mutex_);
  12553. shutdown_socket(socket_);
  12554. close_socket(socket_);
  12555. }
  12556. inline bool ClientImpl::is_valid() const { return true; }
  12557. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12558. client_cert_path_ = rhs.client_cert_path_;
  12559. client_key_path_ = rhs.client_key_path_;
  12560. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12561. read_timeout_sec_ = rhs.read_timeout_sec_;
  12562. read_timeout_usec_ = rhs.read_timeout_usec_;
  12563. write_timeout_sec_ = rhs.write_timeout_sec_;
  12564. write_timeout_usec_ = rhs.write_timeout_usec_;
  12565. max_timeout_msec_ = rhs.max_timeout_msec_;
  12566. basic_auth_username_ = rhs.basic_auth_username_;
  12567. basic_auth_password_ = rhs.basic_auth_password_;
  12568. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12569. keep_alive_ = rhs.keep_alive_;
  12570. follow_location_ = rhs.follow_location_;
  12571. path_encode_ = rhs.path_encode_;
  12572. address_family_ = rhs.address_family_;
  12573. tcp_nodelay_ = rhs.tcp_nodelay_;
  12574. ipv6_v6only_ = rhs.ipv6_v6only_;
  12575. socket_options_ = rhs.socket_options_;
  12576. compress_ = rhs.compress_;
  12577. decompress_ = rhs.decompress_;
  12578. payload_max_length_ = rhs.payload_max_length_;
  12579. has_payload_max_length_ = rhs.has_payload_max_length_;
  12580. interface_ = rhs.interface_;
  12581. proxy_host_ = rhs.proxy_host_;
  12582. proxy_port_ = rhs.proxy_port_;
  12583. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12584. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12585. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12586. no_proxy_entries_ = rhs.no_proxy_entries_;
  12587. logger_ = rhs.logger_;
  12588. error_logger_ = rhs.error_logger_;
  12589. #ifdef CPPHTTPLIB_SSL_ENABLED
  12590. digest_auth_username_ = rhs.digest_auth_username_;
  12591. digest_auth_password_ = rhs.digest_auth_password_;
  12592. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12593. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12594. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12595. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12596. server_certificate_verification_ = rhs.server_certificate_verification_;
  12597. server_hostname_verification_ = rhs.server_hostname_verification_;
  12598. system_ca_mode_ = rhs.system_ca_mode_;
  12599. #endif
  12600. }
  12601. inline bool
  12602. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12603. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12604. if (no_proxy_entries_.empty()) { return true; }
  12605. // host_ is const so its normalized form is invariant; cache it. The
  12606. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12607. if (host == host_) {
  12608. if (!host_normalized_valid_) {
  12609. host_normalized_ = detail::normalize_target(host_);
  12610. host_normalized_valid_ = true;
  12611. }
  12612. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12613. }
  12614. auto target = detail::normalize_target(host);
  12615. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12616. }
  12617. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12618. if (is_proxy_enabled_for_host(host_)) {
  12619. return detail::create_client_socket(
  12620. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12621. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12622. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12623. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12624. }
  12625. // Check is custom IP or hostname specified for host_
  12626. std::string connect_host;
  12627. std::string ip;
  12628. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12629. return detail::create_client_socket(
  12630. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12631. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12632. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12633. write_timeout_usec_, interface_, error);
  12634. }
  12635. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12636. Error &error) {
  12637. auto sock = create_client_socket(error);
  12638. if (sock == INVALID_SOCKET) { return false; }
  12639. socket.sock = sock;
  12640. return true;
  12641. }
  12642. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12643. return create_and_connect_socket(socket, error);
  12644. }
  12645. inline bool ClientImpl::setup_proxy_connection(
  12646. Socket & /*socket*/,
  12647. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12648. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12649. return true;
  12650. }
  12651. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12652. bool /*shutdown_gracefully*/) {
  12653. // If there are any requests in flight from threads other than us, then it's
  12654. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12655. assert(socket_requests_in_flight_ == 0 ||
  12656. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12657. }
  12658. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12659. if (socket.sock == INVALID_SOCKET) { return; }
  12660. detail::shutdown_socket(socket.sock);
  12661. }
  12662. inline void ClientImpl::close_socket(Socket &socket) {
  12663. // If there are requests in flight in another thread, usually closing
  12664. // the socket will be fine and they will simply receive an error when
  12665. // using the closed socket, but it is still a bug since rarely the OS
  12666. // may reassign the socket id to be used for a new socket, and then
  12667. // suddenly they will be operating on a live socket that is different
  12668. // than the one they intended!
  12669. assert(socket_requests_in_flight_ == 0 ||
  12670. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12671. // It is also a bug if this happens while SSL is still active
  12672. #ifdef CPPHTTPLIB_SSL_ENABLED
  12673. assert(socket.ssl == nullptr);
  12674. #endif
  12675. if (socket.sock == INVALID_SOCKET) { return; }
  12676. detail::close_socket(socket.sock);
  12677. socket.sock = INVALID_SOCKET;
  12678. }
  12679. inline void ClientImpl::disconnect(bool gracefully) {
  12680. shutdown_ssl(socket_, gracefully);
  12681. shutdown_socket(socket_);
  12682. close_socket(socket_);
  12683. }
  12684. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12685. Response &res,
  12686. bool skip_100_continue) const {
  12687. std::array<char, 2048> buf{};
  12688. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12689. if (!line_reader.getline()) { return false; }
  12690. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12691. res.reason)) {
  12692. return req.method == "CONNECT";
  12693. }
  12694. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12695. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12696. if (!line_reader.getline()) { return false; } // CRLF
  12697. if (!line_reader.getline()) { return false; } // next response line
  12698. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12699. res.reason)) {
  12700. return false;
  12701. }
  12702. }
  12703. return true;
  12704. }
  12705. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12706. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12707. auto ret = send_(req, res, error);
  12708. if (error == Error::SSLPeerCouldBeClosed_) {
  12709. assert(!ret);
  12710. ret = send_(req, res, error);
  12711. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12712. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12713. }
  12714. return ret;
  12715. }
  12716. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12717. {
  12718. std::lock_guard<std::mutex> guard(socket_mutex_);
  12719. // Set this to false immediately - if it ever gets set to true by the end
  12720. // of the request, we know another thread instructed us to close the
  12721. // socket.
  12722. socket_should_be_closed_when_request_is_done_ = false;
  12723. auto is_alive = false;
  12724. if (socket_.is_open()) {
  12725. is_alive = detail::is_socket_alive(socket_.sock);
  12726. #ifdef CPPHTTPLIB_SSL_ENABLED
  12727. if (is_alive && is_ssl()) {
  12728. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12729. is_alive = false;
  12730. }
  12731. }
  12732. #endif
  12733. if (!is_alive) {
  12734. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12735. disconnect(/*gracefully=*/false);
  12736. }
  12737. }
  12738. if (!is_alive) {
  12739. if (!ensure_socket_connection(socket_, error)) {
  12740. output_error_log(error, &req);
  12741. return false;
  12742. }
  12743. {
  12744. auto success = true;
  12745. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12746. error)) {
  12747. if (!success) { output_error_log(error, &req); }
  12748. return success;
  12749. }
  12750. }
  12751. }
  12752. // Mark the current socket as being in use so that it cannot be closed by
  12753. // anyone else while this request is ongoing, even though we will be
  12754. // releasing the mutex.
  12755. if (socket_requests_in_flight_ > 1) {
  12756. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12757. }
  12758. socket_requests_in_flight_ += 1;
  12759. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12760. }
  12761. for (const auto &header : default_headers_) {
  12762. if (req.headers.find(header.first) == req.headers.end()) {
  12763. req.headers.insert(header);
  12764. }
  12765. }
  12766. auto ret = false;
  12767. auto close_connection = !keep_alive_;
  12768. auto se = detail::scope_exit([&]() {
  12769. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12770. std::lock_guard<std::mutex> guard(socket_mutex_);
  12771. socket_requests_in_flight_ -= 1;
  12772. if (socket_requests_in_flight_ <= 0) {
  12773. assert(socket_requests_in_flight_ == 0);
  12774. socket_requests_are_from_thread_ = std::thread::id();
  12775. }
  12776. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12777. !ret) {
  12778. disconnect(/*gracefully=*/true);
  12779. }
  12780. });
  12781. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12782. return handle_request(strm, req, res, close_connection, error);
  12783. });
  12784. if (!ret) {
  12785. if (error == Error::Success) {
  12786. error = Error::Unknown;
  12787. output_error_log(error, &req);
  12788. }
  12789. }
  12790. return ret;
  12791. }
  12792. inline Result ClientImpl::send(const Request &req) {
  12793. auto req2 = req;
  12794. return send_(std::move(req2));
  12795. }
  12796. inline Result ClientImpl::send_(Request &&req) {
  12797. auto res = detail::make_unique<Response>();
  12798. auto error = Error::Success;
  12799. auto ret = send(req, *res, error);
  12800. #ifdef CPPHTTPLIB_SSL_ENABLED
  12801. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12802. last_ssl_error_, last_backend_error_};
  12803. #else
  12804. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12805. #endif
  12806. }
  12807. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12808. const std::string &ct) {
  12809. (void)for_stream;
  12810. // Default headers are meant for the origin and may carry its credentials, so
  12811. // keep them off the CONNECT request the proxy reads.
  12812. if (r.method != "CONNECT") {
  12813. for (const auto &header : default_headers_) {
  12814. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12815. }
  12816. }
  12817. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12818. // prepend it rather than appending it after the caller's own fields.
  12819. if (!r.has_header("Host")) {
  12820. r.headers.emplace_front(
  12821. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12822. address_family_));
  12823. }
  12824. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12825. if (!r.content_receiver) {
  12826. if (!r.has_header("Accept-Encoding")) {
  12827. std::string accept_encoding;
  12828. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12829. accept_encoding = "br";
  12830. #endif
  12831. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12832. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12833. accept_encoding += "gzip, deflate";
  12834. #endif
  12835. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12836. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12837. accept_encoding += "zstd";
  12838. #endif
  12839. r.set_header("Accept-Encoding", accept_encoding);
  12840. }
  12841. detail::add_default_user_agent_header(r);
  12842. }
  12843. if (!r.body.empty()) {
  12844. if (!ct.empty() && !r.has_header("Content-Type")) {
  12845. r.headers.emplace("Content-Type", ct);
  12846. }
  12847. if (!r.has_header("Content-Length")) {
  12848. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12849. }
  12850. }
  12851. }
  12852. inline ClientImpl::StreamHandle
  12853. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12854. const Params &params, const Headers &headers,
  12855. const std::string &body,
  12856. const std::string &content_type) {
  12857. StreamHandle handle;
  12858. handle.response = detail::make_unique<Response>();
  12859. handle.error = Error::Success;
  12860. // Encode the target exactly like the buffered send path does, so that the
  12861. // same `path` produces the same request line through either API.
  12862. auto raw_query_path =
  12863. params.empty() ? path : append_query_params(path, params);
  12864. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12865. handle.connection_ = detail::make_unique<ClientConnection>();
  12866. {
  12867. std::lock_guard<std::mutex> guard(socket_mutex_);
  12868. auto is_alive = false;
  12869. if (socket_.is_open()) {
  12870. is_alive = detail::is_socket_alive(socket_.sock);
  12871. #ifdef CPPHTTPLIB_SSL_ENABLED
  12872. if (is_alive && is_ssl()) {
  12873. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12874. is_alive = false;
  12875. }
  12876. }
  12877. #endif
  12878. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12879. }
  12880. if (!is_alive) {
  12881. if (!ensure_socket_connection(socket_, handle.error)) {
  12882. handle.response.reset();
  12883. return handle;
  12884. }
  12885. {
  12886. auto success = true;
  12887. auto start_time = std::chrono::steady_clock::now();
  12888. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12889. success, handle.error)) {
  12890. if (!success) { handle.response.reset(); }
  12891. return handle;
  12892. }
  12893. }
  12894. }
  12895. transfer_socket_ownership_to_handle(handle);
  12896. }
  12897. #ifdef CPPHTTPLIB_SSL_ENABLED
  12898. if (is_ssl() && handle.connection_->session) {
  12899. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12900. handle.connection_->sock, handle.connection_->session,
  12901. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12902. write_timeout_usec_);
  12903. } else {
  12904. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12905. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12906. write_timeout_sec_, write_timeout_usec_);
  12907. }
  12908. #else
  12909. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12910. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12911. write_timeout_sec_, write_timeout_usec_);
  12912. #endif
  12913. handle.stream_ = handle.socket_stream_.get();
  12914. Request req;
  12915. req.method = method;
  12916. req.path = query_path;
  12917. req.headers = headers;
  12918. req.body = body;
  12919. prepare_default_headers(req, true, content_type);
  12920. auto &strm = *handle.stream_;
  12921. // Build the request line and headers in memory first, like write_request()
  12922. // does, so that a rejected header leaves nothing on the wire.
  12923. {
  12924. detail::BufferStream bstrm;
  12925. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12926. handle.error = Error::Write;
  12927. handle.response.reset();
  12928. return handle;
  12929. }
  12930. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12931. handle.error)) {
  12932. handle.response.reset();
  12933. return handle;
  12934. }
  12935. const auto &data = bstrm.get_buffer();
  12936. if (!detail::write_data(strm, data.data(), data.size())) {
  12937. handle.error = Error::Write;
  12938. handle.response.reset();
  12939. return handle;
  12940. }
  12941. }
  12942. if (!body.empty()) {
  12943. if (strm.write(body.data(), body.size()) < 0) {
  12944. handle.error = Error::Write;
  12945. handle.response.reset();
  12946. return handle;
  12947. }
  12948. }
  12949. if (!read_response_line(strm, req, *handle.response) ||
  12950. !detail::read_headers(strm, handle.response->headers)) {
  12951. handle.error = Error::Read;
  12952. handle.response.reset();
  12953. return handle;
  12954. }
  12955. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  12956. // (204/304) response legitimately carries framing headers with no body.
  12957. if (method != "HEAD" &&
  12958. handle.response->status != StatusCode::NoContent_204 &&
  12959. handle.response->status != StatusCode::NotModified_304 &&
  12960. detail::has_conflicting_content_length(handle.response->headers)) {
  12961. handle.error = Error::Read;
  12962. handle.response.reset();
  12963. return handle;
  12964. }
  12965. handle.body_reader_.stream = handle.stream_;
  12966. handle.body_reader_.payload_max_length = payload_max_length_;
  12967. if (handle.response->has_header("Content-Length")) {
  12968. bool is_invalid = false;
  12969. auto content_length = detail::get_header_value_u64(
  12970. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12971. if (is_invalid) {
  12972. handle.error = Error::Read;
  12973. handle.response.reset();
  12974. return handle;
  12975. }
  12976. handle.body_reader_.has_content_length = true;
  12977. handle.body_reader_.content_length = content_length;
  12978. }
  12979. handle.body_reader_.chunked =
  12980. detail::is_chunked_transfer_encoding(handle.response->headers);
  12981. auto content_encoding = detail::get_combined_header_value(
  12982. handle.response->headers, "Content-Encoding");
  12983. if (!content_encoding.empty()) {
  12984. // Same policy as prepare_content_receiver(): reject a coding we know about
  12985. // but were not built with, pass an unrecognized one through as-is.
  12986. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12987. if (!handle.decompressor_) {
  12988. if (detail::is_known_content_encoding(content_encoding)) {
  12989. handle.error = Error::UnsupportedContentEncoding;
  12990. handle.response.reset();
  12991. return handle;
  12992. }
  12993. } else if (!handle.decompressor_->is_valid()) {
  12994. handle.error = Error::Compression;
  12995. handle.response.reset();
  12996. return handle;
  12997. }
  12998. }
  12999. return handle;
  13000. }
  13001. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13002. if (!is_valid() || !response) { return -1; }
  13003. if (decompressor_) { return read_with_decompression(buf, len); }
  13004. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13005. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13006. trailers_parsed_ = true;
  13007. if (body_reader_.chunked_decoder) {
  13008. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13009. response->trailers, response->headers)) {
  13010. return n;
  13011. }
  13012. } else {
  13013. detail::ChunkedDecoder dec(*stream_);
  13014. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13015. return n;
  13016. }
  13017. }
  13018. }
  13019. return n;
  13020. }
  13021. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13022. size_t len) {
  13023. if (decompress_offset_ < decompress_buffer_.size()) {
  13024. auto available = decompress_buffer_.size() - decompress_offset_;
  13025. auto to_copy = (std::min)(len, available);
  13026. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13027. decompress_offset_ += to_copy;
  13028. decompressed_bytes_read_ += to_copy;
  13029. return static_cast<ssize_t>(to_copy);
  13030. }
  13031. decompress_buffer_.clear();
  13032. decompress_offset_ = 0;
  13033. constexpr size_t kDecompressionBufferSize = 8192;
  13034. char compressed_buf[kDecompressionBufferSize];
  13035. while (true) {
  13036. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13037. sizeof(compressed_buf));
  13038. if (n <= 0) { return n; }
  13039. bool decompress_ok = decompressor_->decompress(
  13040. compressed_buf, static_cast<size_t>(n),
  13041. [this](const char *data, size_t data_len) {
  13042. decompress_buffer_.append(data, data_len);
  13043. auto limit = body_reader_.payload_max_length;
  13044. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13045. return false;
  13046. }
  13047. return true;
  13048. });
  13049. if (!decompress_ok) {
  13050. body_reader_.last_error = Error::Read;
  13051. return -1;
  13052. }
  13053. if (!decompress_buffer_.empty()) { break; }
  13054. }
  13055. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13056. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13057. decompress_offset_ = to_copy;
  13058. decompressed_bytes_read_ += to_copy;
  13059. return static_cast<ssize_t>(to_copy);
  13060. }
  13061. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13062. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13063. return;
  13064. }
  13065. trailers_parsed_ = true;
  13066. const auto bufsiz = 128;
  13067. char line_buf[bufsiz];
  13068. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13069. if (!line_reader.getline()) { return; }
  13070. if (!detail::parse_trailers(line_reader, response->trailers,
  13071. response->headers)) {
  13072. return;
  13073. }
  13074. }
  13075. namespace detail {
  13076. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13077. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13078. size_t &out_chunk_offset,
  13079. size_t &out_chunk_total) {
  13080. if (finished) { return 0; }
  13081. if (chunk_remaining == 0) {
  13082. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13083. if (!lr.getline()) { return -1; }
  13084. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13085. // the line terminator is never mistaken for line content.
  13086. const char *eol = lr.ptr() + lr.size();
  13087. if (lr.end_with_crlf()) {
  13088. eol -= 2;
  13089. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13090. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13091. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13092. // has to come off here or the check below would reject the line.
  13093. eol -= 1;
  13094. }
  13095. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13096. const char *p = lr.ptr();
  13097. int v = 0;
  13098. if (p == eol || !is_hex(*p, v)) { return -1; }
  13099. size_t chunk_len = 0;
  13100. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13101. for (; p < eol && is_hex(*p, v); ++p) {
  13102. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13103. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13104. }
  13105. while (p < eol && is_space_or_tab(*p)) {
  13106. ++p;
  13107. }
  13108. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13109. // terminator, and it is built from tokens and quoted-strings, so it never
  13110. // holds a CR, LF or any other control character. getline() reads up to the
  13111. // CRLF, so a bare LF left in here would be swallowed as extension text
  13112. // while an intermediary that ends the line on it delimits the chunks
  13113. // differently, and the two disagree on where the body ends (request
  13114. // smuggling).
  13115. if (p < eol && *p != ';') { return -1; }
  13116. for (; p < eol; ++p) {
  13117. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13118. }
  13119. if (chunk_len == 0) {
  13120. chunk_remaining = 0;
  13121. finished = true;
  13122. out_chunk_offset = 0;
  13123. out_chunk_total = 0;
  13124. return 0;
  13125. }
  13126. chunk_remaining = chunk_len;
  13127. last_chunk_total = chunk_remaining;
  13128. last_chunk_offset = 0;
  13129. }
  13130. auto to_read = (std::min)(chunk_remaining, len);
  13131. auto n = strm.read(buf, to_read);
  13132. if (n <= 0) { return -1; }
  13133. auto offset_before = last_chunk_offset;
  13134. last_chunk_offset += static_cast<size_t>(n);
  13135. chunk_remaining -= static_cast<size_t>(n);
  13136. out_chunk_offset = offset_before;
  13137. out_chunk_total = last_chunk_total;
  13138. if (chunk_remaining == 0) {
  13139. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13140. if (!lr.getline()) { return -1; }
  13141. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13142. }
  13143. return n;
  13144. }
  13145. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13146. const Headers &src_headers) {
  13147. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13148. if (!lr.getline()) { return false; }
  13149. return parse_trailers(lr, dest, src_headers);
  13150. }
  13151. } // namespace detail
  13152. inline void
  13153. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13154. handle.connection_->sock = socket_.sock;
  13155. #ifdef CPPHTTPLIB_SSL_ENABLED
  13156. handle.connection_->session = socket_.ssl;
  13157. socket_.ssl = nullptr;
  13158. #endif
  13159. socket_.sock = INVALID_SOCKET;
  13160. }
  13161. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13162. Response &res, bool close_connection,
  13163. Error &error) {
  13164. if (req.path.empty()) {
  13165. error = Error::Connection;
  13166. output_error_log(error, &req);
  13167. return false;
  13168. }
  13169. auto req_save = req;
  13170. bool ret;
  13171. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13172. auto req2 = req;
  13173. req2.path = "http://" +
  13174. detail::make_host_and_port_string(host_, port_, false) +
  13175. req.path;
  13176. ret = process_request(strm, req2, res, close_connection, error);
  13177. req = std::move(req2);
  13178. req.path = req_save.path;
  13179. } else {
  13180. ret = process_request(strm, req, res, close_connection, error);
  13181. }
  13182. if (!ret) { return false; }
  13183. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13184. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13185. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13186. // for this to be safe.
  13187. // This is safe to call because handle_request is only called by send_
  13188. // which locks the request mutex during the process. It would be a bug
  13189. // to call it from a different thread since it's a thread-safety issue
  13190. // to do these things to the socket if another thread is using the socket.
  13191. std::lock_guard<std::mutex> guard(socket_mutex_);
  13192. disconnect(/*gracefully=*/true);
  13193. }
  13194. if (300 < res.status && res.status < 400 && follow_location_) {
  13195. req = std::move(req_save);
  13196. ret = redirect(req, res, error);
  13197. }
  13198. #ifdef CPPHTTPLIB_SSL_ENABLED
  13199. if ((res.status == StatusCode::Unauthorized_401 ||
  13200. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13201. req.authorization_count_ < 5) {
  13202. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13203. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13204. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13205. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13206. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13207. return ret;
  13208. }
  13209. const auto &username =
  13210. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13211. const auto &password =
  13212. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13213. if (!username.empty() && !password.empty()) {
  13214. std::map<std::string, std::string> auth;
  13215. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13216. Request new_req = req;
  13217. new_req.authorization_count_ += 1;
  13218. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13219. : "Authorization");
  13220. new_req.headers.insert(detail::make_digest_authentication_header(
  13221. req, auth, new_req.authorization_count_, detail::random_string(10),
  13222. username, password, is_proxy));
  13223. Response new_res;
  13224. ret = send(new_req, new_res, error);
  13225. if (ret) { res = std::move(new_res); }
  13226. }
  13227. }
  13228. }
  13229. #endif
  13230. return ret;
  13231. }
  13232. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13233. if (req.redirect_count_ == 0) {
  13234. error = Error::ExceedRedirectCount;
  13235. output_error_log(error, &req);
  13236. return false;
  13237. }
  13238. auto location = res.get_header_value("location");
  13239. if (location.empty()) { return false; }
  13240. detail::UrlComponents uc;
  13241. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13242. uc)) {
  13243. return false;
  13244. }
  13245. // Only follow http/https redirects
  13246. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13247. return false;
  13248. }
  13249. auto scheme = is_ssl() ? "https" : "http";
  13250. auto next_scheme = std::move(uc.scheme);
  13251. auto next_host = std::move(uc.host);
  13252. auto port_str = std::move(uc.port);
  13253. auto next_path = std::move(uc.path);
  13254. auto next_query = std::move(uc.query);
  13255. auto next_port = port_;
  13256. if (!port_str.empty()) {
  13257. if (!detail::parse_port(port_str, next_port)) { return false; }
  13258. } else if (!next_scheme.empty()) {
  13259. next_port = next_scheme == "https" ? 443 : 80;
  13260. }
  13261. if (next_scheme.empty()) { next_scheme = scheme; }
  13262. if (next_host.empty()) { next_host = host_; }
  13263. if (next_path.empty()) { next_path = "/"; }
  13264. auto path = decode_path_component(next_path) + next_query;
  13265. // Same host redirect - use current client
  13266. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13267. return detail::redirect(*this, req, res, path, location, error);
  13268. }
  13269. // Cross-host/scheme redirect - create new client with robust setup
  13270. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13271. path, location, error);
  13272. }
  13273. // New method for robust redirect client creation
  13274. inline bool ClientImpl::create_redirect_client(
  13275. const std::string &scheme, const std::string &host, int port, Request &req,
  13276. Response &res, const std::string &path, const std::string &location,
  13277. Error &error) {
  13278. // Determine if we need SSL
  13279. auto need_ssl = (scheme == "https");
  13280. // Clean up request headers that are host/client specific
  13281. // Remove headers that should not be carried over to new host
  13282. auto headers_to_remove = std::vector<std::string>{
  13283. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13284. for (const auto &header_name : headers_to_remove) {
  13285. auto it = req.headers.find(header_name);
  13286. while (it != req.headers.end()) {
  13287. it = req.headers.erase(it);
  13288. it = req.headers.find(header_name);
  13289. }
  13290. }
  13291. // Create appropriate client type and handle redirect
  13292. if (need_ssl) {
  13293. #ifdef CPPHTTPLIB_SSL_ENABLED
  13294. // Create SSL client for HTTPS redirect
  13295. SSLClient redirect_client(host, port);
  13296. // Setup basic client configuration first
  13297. setup_redirect_client(redirect_client);
  13298. redirect_client.enable_server_certificate_verification(
  13299. server_certificate_verification_);
  13300. redirect_client.enable_server_hostname_verification(
  13301. server_hostname_verification_);
  13302. redirect_client.system_ca_mode_ = system_ca_mode_;
  13303. // Transfer CA certificate to redirect client
  13304. if (!ca_cert_pem_.empty()) {
  13305. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13306. ca_cert_pem_.size());
  13307. }
  13308. if (!ca_cert_file_path_.empty()) {
  13309. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13310. }
  13311. // Client certificates are set through constructor for SSLClient
  13312. // NOTE: SSLClient constructor already takes client_cert_path and
  13313. // client_key_path so we need to create it properly if client certs are
  13314. // needed
  13315. // Execute the redirect
  13316. return detail::redirect(redirect_client, req, res, path, location, error);
  13317. #else
  13318. // SSL not supported - set appropriate error
  13319. error = Error::SSLConnection;
  13320. output_error_log(error, &req);
  13321. return false;
  13322. #endif
  13323. } else {
  13324. // HTTP redirect
  13325. ClientImpl redirect_client(host, port);
  13326. // Setup client with robust configuration
  13327. setup_redirect_client(redirect_client);
  13328. // Execute the redirect
  13329. return detail::redirect(redirect_client, req, res, path, location, error);
  13330. }
  13331. }
  13332. // New method for robust client setup (based on basic_manual_redirect.cpp
  13333. // logic)
  13334. template <typename ClientType>
  13335. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13336. // Copy basic settings first
  13337. client.set_connection_timeout(connection_timeout_sec_);
  13338. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13339. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13340. client.set_keep_alive(keep_alive_);
  13341. client.set_follow_location(
  13342. true); // Enable redirects to handle multi-step redirects
  13343. client.set_path_encode(path_encode_);
  13344. client.set_compress(compress_);
  13345. client.set_decompress(decompress_);
  13346. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13347. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13348. // 15.4, credentials must not be forwarded when redirecting to a different
  13349. // host. This function is only called for cross-host redirects; same-host
  13350. // redirects are handled directly in ClientImpl::redirect().
  13351. // Copy the proxy configuration unconditionally; the per-target bypass is
  13352. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13353. // still use the proxy.
  13354. client.no_proxy_entries_ = no_proxy_entries_;
  13355. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13356. client.set_proxy(proxy_host_, proxy_port_);
  13357. if (!proxy_basic_auth_username_.empty()) {
  13358. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13359. proxy_basic_auth_password_);
  13360. }
  13361. if (!proxy_bearer_token_auth_token_.empty()) {
  13362. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13363. }
  13364. #ifdef CPPHTTPLIB_SSL_ENABLED
  13365. if (!proxy_digest_auth_username_.empty()) {
  13366. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13367. proxy_digest_auth_password_);
  13368. }
  13369. #endif
  13370. }
  13371. // Copy network and socket settings
  13372. client.set_address_family(address_family_);
  13373. client.set_tcp_nodelay(tcp_nodelay_);
  13374. client.set_ipv6_v6only(ipv6_v6only_);
  13375. if (socket_options_) { client.set_socket_options(socket_options_); }
  13376. if (!interface_.empty()) { client.set_interface(interface_); }
  13377. // Copy logging and headers
  13378. if (logger_) { client.set_logger(logger_); }
  13379. if (error_logger_) { client.set_error_logger(error_logger_); }
  13380. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13381. // Each new client should generate its own headers based on its target host
  13382. }
  13383. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13384. const Request &req,
  13385. Error &error) const {
  13386. auto is_shutting_down = []() { return false; };
  13387. if (req.is_chunked_content_provider_) {
  13388. auto compressor = compress_ ? detail::create_compressor().first
  13389. : std::unique_ptr<detail::compressor>();
  13390. if (!compressor) {
  13391. compressor = detail::make_unique<detail::nocompressor>();
  13392. }
  13393. return detail::write_content_chunked(strm, req.content_provider_,
  13394. is_shutting_down, *compressor, error);
  13395. } else {
  13396. return detail::write_content_with_progress(
  13397. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13398. req.upload_progress, error);
  13399. }
  13400. }
  13401. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13402. bool close_connection, Error &error,
  13403. bool skip_body, bool &rejected_locally) {
  13404. rejected_locally = false;
  13405. // Prepare additional headers
  13406. if (close_connection) {
  13407. if (!req.has_header("Connection")) {
  13408. req.set_header("Connection", "close");
  13409. }
  13410. }
  13411. std::string ct_for_defaults;
  13412. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13413. ct_for_defaults = "text/plain";
  13414. }
  13415. prepare_default_headers(req, false, ct_for_defaults);
  13416. if (req.body.empty()) {
  13417. if (req.content_provider_) {
  13418. if (!req.is_chunked_content_provider_) {
  13419. if (!req.has_header("Content-Length")) {
  13420. auto length = std::to_string(req.content_length_);
  13421. req.set_header("Content-Length", length);
  13422. }
  13423. }
  13424. } else {
  13425. if (req.method == "POST" || req.method == "PUT" ||
  13426. req.method == "PATCH") {
  13427. req.set_header("Content-Length", "0");
  13428. }
  13429. }
  13430. }
  13431. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13432. // it opens is read by the origin. Each credential goes only to its own hop.
  13433. auto is_connect = req.method == "CONNECT";
  13434. if (!is_connect && !req.has_header("Authorization")) {
  13435. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13436. req.headers.insert(make_basic_authentication_header(
  13437. basic_auth_username_, basic_auth_password_, false));
  13438. } else if (!bearer_token_auth_token_.empty()) {
  13439. req.headers.insert(make_bearer_token_authentication_header(
  13440. bearer_token_auth_token_, false));
  13441. }
  13442. }
  13443. // Proxy-Authorization is only sent when the proxy reads this message —
  13444. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13445. // would leak proxy credentials to the destination server.
  13446. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13447. if (!proxy_basic_auth_username_.empty() &&
  13448. !proxy_basic_auth_password_.empty() &&
  13449. !req.has_header("Proxy-Authorization")) {
  13450. req.headers.insert(make_basic_authentication_header(
  13451. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13452. }
  13453. if (!proxy_bearer_token_auth_token_.empty() &&
  13454. !req.has_header("Proxy-Authorization")) {
  13455. req.headers.insert(make_bearer_token_authentication_header(
  13456. proxy_bearer_token_auth_token_, true));
  13457. }
  13458. }
  13459. // Request line and headers
  13460. {
  13461. detail::BufferStream bstrm;
  13462. // Extract the query from req.path. The encoding itself is delegated to
  13463. // `encode_request_target`; the raw query is still needed here to decide
  13464. // between populating `req.params` from it and falling back to building a
  13465. // query out of caller-supplied `req.params`.
  13466. auto query_pos = req.path.find('?');
  13467. auto query_part = query_pos == std::string::npos
  13468. ? std::string()
  13469. : req.path.substr(query_pos + 1);
  13470. auto path_with_query =
  13471. detail::encode_request_target(req.path, path_encode_);
  13472. if (!query_part.empty()) {
  13473. // The query already came in through `req.path`; still populate
  13474. // `req.params` for handlers/users who read them.
  13475. detail::parse_query_text(query_part, req.params);
  13476. } else if (!req.params.empty()) {
  13477. // No query in `req.path`; build one from `req.params` so existing
  13478. // callers that pass `Params` separately continue to work.
  13479. path_with_query = append_query_params(path_with_query, req.params);
  13480. }
  13481. // Write request line and headers
  13482. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13483. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13484. // CR/LF smuggled in via a decoded redirect Location under
  13485. // set_path_encode(false)) must fail the request cleanly instead of
  13486. // emitting a request-line-less, header-injecting request.
  13487. error = Error::Write;
  13488. rejected_locally = true;
  13489. output_error_log(error, &req);
  13490. return false;
  13491. }
  13492. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13493. error)) {
  13494. rejected_locally = true;
  13495. output_error_log(error, &req);
  13496. return false;
  13497. }
  13498. // Flush buffer
  13499. auto &data = bstrm.get_buffer();
  13500. if (!detail::write_data(strm, data.data(), data.size())) {
  13501. error = Error::Write;
  13502. output_error_log(error, &req);
  13503. return false;
  13504. }
  13505. }
  13506. // After sending request line and headers, wait briefly for an early server
  13507. // response (e.g. 4xx) and avoid sending a potentially large request body
  13508. // unnecessarily. This workaround is only enabled on Windows because Unix
  13509. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13510. // buffering can accept large writes even when the peer already responded.
  13511. // Check the stream first (which covers SSL via `is_readable()`), then
  13512. // fall back to select on the socket. Only perform the wait for very large
  13513. // request bodies to avoid interfering with normal small requests and
  13514. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13515. // response. Skip this check when using Expect: 100-continue, as the protocol
  13516. // handles early responses properly.
  13517. #if defined(_WIN32)
  13518. if (!skip_body &&
  13519. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13520. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13521. auto start = std::chrono::high_resolution_clock::now();
  13522. for (;;) {
  13523. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13524. // from SSL internals. If the underlying socket is readable, assume an
  13525. // early response may be present.
  13526. auto sock = strm.socket();
  13527. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13528. return false;
  13529. }
  13530. // Fallback to stream-level check for non-socket streams or when the
  13531. // socket isn't reporting readable. Avoid using `is_readable()` for
  13532. // SSL, since `SSL_pending()` may report buffered records that do not
  13533. // indicate a complete application-level response yet.
  13534. if (!is_ssl() && strm.is_readable()) { return false; }
  13535. auto now = std::chrono::high_resolution_clock::now();
  13536. auto elapsed =
  13537. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13538. .count();
  13539. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13540. break;
  13541. }
  13542. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13543. }
  13544. }
  13545. #endif
  13546. // Body
  13547. if (skip_body) { return true; }
  13548. return write_request_body(strm, req, error);
  13549. }
  13550. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13551. Error &error) {
  13552. if (req.body.empty()) {
  13553. return write_content_with_provider(strm, req, error);
  13554. }
  13555. if (req.upload_progress) {
  13556. auto body_size = req.body.size();
  13557. size_t written = 0;
  13558. auto data = req.body.data();
  13559. while (written < body_size) {
  13560. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13561. if (!detail::write_data(strm, data + written, to_write)) {
  13562. error = Error::Write;
  13563. output_error_log(error, &req);
  13564. return false;
  13565. }
  13566. written += to_write;
  13567. if (!req.upload_progress(written, body_size)) {
  13568. error = Error::Canceled;
  13569. output_error_log(error, &req);
  13570. return false;
  13571. }
  13572. }
  13573. } else {
  13574. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13575. error = Error::Write;
  13576. output_error_log(error, &req);
  13577. return false;
  13578. }
  13579. }
  13580. return true;
  13581. }
  13582. inline std::unique_ptr<Response>
  13583. ClientImpl::send_with_content_provider_and_receiver(
  13584. Request &req, const char *body, size_t content_length,
  13585. ContentProvider content_provider,
  13586. ContentProviderWithoutLength content_provider_without_length,
  13587. const std::string &content_type, ContentReceiver content_receiver,
  13588. Error &error) {
  13589. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13590. auto enc = compress_
  13591. ? detail::create_compressor()
  13592. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13593. nullptr, nullptr);
  13594. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13595. if (enc.first && !content_provider_without_length) {
  13596. auto &compressor = enc.first;
  13597. if (content_provider) {
  13598. auto ok = true;
  13599. auto finished = false;
  13600. size_t offset = 0;
  13601. DataSink data_sink;
  13602. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13603. if (ok) {
  13604. auto last = offset + data_len == content_length;
  13605. auto ret = compressor->compress(
  13606. data, data_len, last,
  13607. [&](const char *compressed_data, size_t compressed_data_len) {
  13608. req.body.append(compressed_data, compressed_data_len);
  13609. return true;
  13610. });
  13611. if (ret) {
  13612. offset += data_len;
  13613. } else {
  13614. ok = false;
  13615. }
  13616. }
  13617. return ok;
  13618. };
  13619. // As in detail::write_content_with_progress(): the body is framed by
  13620. // content_length, so a provider that finishes early has truncated it.
  13621. // Stop and report that instead of calling the provider forever.
  13622. data_sink.done = [&]() { finished = true; };
  13623. while (ok && !finished && offset < content_length) {
  13624. if (!content_provider(offset, content_length - offset, data_sink)) {
  13625. error = Error::Canceled;
  13626. output_error_log(error, &req);
  13627. return nullptr;
  13628. }
  13629. }
  13630. // A short body here means either the provider stopped early or the
  13631. // compressor gave up. The branch below reports a failing compressor as
  13632. // Error::Compression, so keep the two distinguishable.
  13633. if (offset < content_length) {
  13634. error = ok ? Error::Write : Error::Compression;
  13635. output_error_log(error, &req);
  13636. return nullptr;
  13637. }
  13638. } else {
  13639. if (!compressor->compress(body, content_length, true,
  13640. [&](const char *data, size_t data_len) {
  13641. req.body.append(data, data_len);
  13642. return true;
  13643. })) {
  13644. error = Error::Compression;
  13645. output_error_log(error, &req);
  13646. return nullptr;
  13647. }
  13648. }
  13649. } else {
  13650. if (content_provider) {
  13651. req.content_length_ = content_length;
  13652. req.content_provider_ = std::move(content_provider);
  13653. req.is_chunked_content_provider_ = false;
  13654. } else if (content_provider_without_length) {
  13655. req.content_length_ = 0;
  13656. req.content_provider_ = detail::ContentProviderAdapter(
  13657. std::move(content_provider_without_length));
  13658. req.is_chunked_content_provider_ = true;
  13659. req.set_header("Transfer-Encoding", "chunked");
  13660. } else {
  13661. req.body.assign(body, content_length);
  13662. }
  13663. }
  13664. if (content_receiver) {
  13665. req.content_receiver =
  13666. [content_receiver](const char *data, size_t data_length,
  13667. size_t /*offset*/, size_t /*total_length*/) {
  13668. return content_receiver(data, data_length);
  13669. };
  13670. }
  13671. auto res = detail::make_unique<Response>();
  13672. return send(req, *res, error) ? std::move(res) : nullptr;
  13673. }
  13674. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13675. const std::string &method, const std::string &path, const Headers &headers,
  13676. const char *body, size_t content_length, ContentProvider content_provider,
  13677. ContentProviderWithoutLength content_provider_without_length,
  13678. const std::string &content_type, ContentReceiver content_receiver,
  13679. UploadProgress progress) {
  13680. Request req;
  13681. req.method = method;
  13682. req.headers = headers;
  13683. req.path = path;
  13684. req.upload_progress = std::move(progress);
  13685. if (max_timeout_msec_ > 0) {
  13686. req.start_time_ = std::chrono::steady_clock::now();
  13687. }
  13688. auto error = Error::Success;
  13689. auto res = send_with_content_provider_and_receiver(
  13690. req, body, content_length, std::move(content_provider),
  13691. std::move(content_provider_without_length), content_type,
  13692. std::move(content_receiver), error);
  13693. #ifdef CPPHTTPLIB_SSL_ENABLED
  13694. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13695. last_backend_error_};
  13696. #else
  13697. return Result{std::move(res), error, std::move(req.headers)};
  13698. #endif
  13699. }
  13700. inline void ClientImpl::output_log(const Request &req,
  13701. const Response &res) const {
  13702. if (logger_) {
  13703. std::lock_guard<std::mutex> guard(logger_mutex_);
  13704. logger_(req, res);
  13705. }
  13706. }
  13707. inline void ClientImpl::output_error_log(const Error &err,
  13708. const Request *req) const {
  13709. if (error_logger_) {
  13710. std::lock_guard<std::mutex> guard(logger_mutex_);
  13711. error_logger_(err, req);
  13712. }
  13713. }
  13714. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13715. Response &res, bool close_connection,
  13716. Error &error) {
  13717. // Auto-add Expect: 100-continue for large bodies
  13718. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13719. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13720. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13721. req.set_header("Expect", "100-continue");
  13722. }
  13723. }
  13724. // Check for Expect: 100-continue
  13725. auto expect_100_continue =
  13726. detail::has_header_token(req.headers, "Expect", "100-continue");
  13727. // Send request (skip body if using Expect: 100-continue)
  13728. auto rejected_locally = false;
  13729. auto write_request_success =
  13730. write_request(strm, req, close_connection, error, expect_100_continue,
  13731. rejected_locally);
  13732. // A failed write normally still reads the response below, since the server
  13733. // may have answered early (e.g. 413/414) and closed while the body was being
  13734. // sent. A request rejected before any byte reached the socket gets no such
  13735. // response, and waiting for one would block until the read timeout.
  13736. if (rejected_locally) { return false; }
  13737. #ifdef CPPHTTPLIB_SSL_ENABLED
  13738. if (is_ssl() && !expect_100_continue) {
  13739. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13740. if (!is_proxy_enabled) {
  13741. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13742. error = Error::SSLPeerCouldBeClosed_;
  13743. output_error_log(error, &req);
  13744. return false;
  13745. }
  13746. }
  13747. }
  13748. #endif
  13749. // Handle Expect: 100-continue.
  13750. //
  13751. // Wait for an interim/early response by attempting to read the status line
  13752. // under a short timeout, instead of trusting raw socket readability. Over
  13753. // TLS, post-handshake records (e.g. session tickets) make the socket
  13754. // readable without any HTTP response being available; relying on
  13755. // `select_read` there caused the body to be withheld forever and the
  13756. // request to fail with `Read` (#2458). If no status line arrives within the
  13757. // timeout, send the body anyway (matching curl's behavior).
  13758. auto status_line_read = false;
  13759. if (expect_100_continue && write_request_success) {
  13760. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13761. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13762. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13763. strm.set_read_timeout(sec, usec);
  13764. status_line_read = read_response_line(strm, req, res, false);
  13765. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13766. }
  13767. if (!status_line_read) {
  13768. // No interim response within the timeout: send the body and handle the
  13769. // response as usual.
  13770. if (!write_request_body(strm, req, error)) { return false; }
  13771. expect_100_continue = false; // Switch to normal response handling
  13772. }
  13773. }
  13774. // Receive response and headers
  13775. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13776. if ((!status_line_read &&
  13777. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13778. !detail::read_headers(strm, res.headers)) {
  13779. if (write_request_success) { error = Error::Read; }
  13780. output_error_log(error, &req);
  13781. return false;
  13782. }
  13783. if (!write_request_success) { return false; }
  13784. // Handle Expect: 100-continue response
  13785. if (expect_100_continue) {
  13786. if (res.status == StatusCode::Continue_100) {
  13787. // Server accepted, send the body
  13788. if (!write_request_body(strm, req, error)) { return false; }
  13789. // Read the actual response
  13790. res.headers.clear();
  13791. res.body.clear();
  13792. if (!read_response_line(strm, req, res) ||
  13793. !detail::read_headers(strm, res.headers)) {
  13794. error = Error::Read;
  13795. output_error_log(error, &req);
  13796. return false;
  13797. }
  13798. }
  13799. // If not 100 Continue, server returned an error; proceed with that response
  13800. }
  13801. // Body
  13802. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13803. req.method != "CONNECT") {
  13804. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13805. // whose final transfer coding is not chunked is not ambiguous: its body
  13806. // runs until the server closes the connection, so it is not rejected.
  13807. // HEAD/204 are excluded above and a 304 carries no body.
  13808. if (res.status != StatusCode::NotModified_304 &&
  13809. detail::has_conflicting_content_length(res.headers)) {
  13810. error = Error::Read;
  13811. output_error_log(error, &req);
  13812. return false;
  13813. }
  13814. auto redirect = 300 < res.status && res.status < 400 &&
  13815. res.status != StatusCode::NotModified_304 &&
  13816. follow_location_;
  13817. if (req.response_handler && !redirect) {
  13818. if (!req.response_handler(res)) {
  13819. error = Error::Canceled;
  13820. output_error_log(error, &req);
  13821. return false;
  13822. }
  13823. }
  13824. auto out =
  13825. req.content_receiver
  13826. ? static_cast<ContentReceiverWithProgress>(
  13827. [&](const char *buf, size_t n, size_t off, size_t len) {
  13828. if (redirect) { return true; }
  13829. auto ret = req.content_receiver(buf, n, off, len);
  13830. if (!ret) {
  13831. error = Error::Canceled;
  13832. output_error_log(error, &req);
  13833. }
  13834. return ret;
  13835. })
  13836. : static_cast<ContentReceiverWithProgress>(
  13837. [&](const char *buf, size_t n, size_t /*off*/,
  13838. size_t /*len*/) {
  13839. assert(res.body.size() + n <= res.body.max_size());
  13840. if (payload_max_length_ > 0 &&
  13841. (res.body.size() >= payload_max_length_ ||
  13842. n > payload_max_length_ - res.body.size())) {
  13843. return false;
  13844. }
  13845. res.body.append(buf, n);
  13846. return true;
  13847. });
  13848. auto progress = [&](size_t current, size_t total) {
  13849. if (!req.download_progress || redirect) { return true; }
  13850. auto ret = req.download_progress(current, total);
  13851. if (!ret) {
  13852. error = Error::Canceled;
  13853. output_error_log(error, &req);
  13854. }
  13855. return ret;
  13856. };
  13857. if (res.has_header("Content-Length")) {
  13858. if (!req.content_receiver) {
  13859. auto len = res.get_header_value_u64("Content-Length");
  13860. if (len > res.body.max_size()) {
  13861. error = Error::Read;
  13862. output_error_log(error, &req);
  13863. return false;
  13864. }
  13865. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13866. // hostile or malformed server sends an enormous Content-Length.
  13867. // The actual body read below is bounded by payload_max_length_,
  13868. // so reserving more than that is never useful.
  13869. auto reserve_len = static_cast<size_t>(len);
  13870. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13871. reserve_len = payload_max_length_;
  13872. }
  13873. res.body.reserve(reserve_len);
  13874. }
  13875. }
  13876. if (res.status != StatusCode::NotModified_304) {
  13877. auto content_status = 0;
  13878. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13879. ? (std::numeric_limits<size_t>::max)()
  13880. : payload_max_length_;
  13881. if (!detail::read_content(strm, res, max_length, content_status,
  13882. std::move(progress), std::move(out),
  13883. decompress_)) {
  13884. if (error != Error::Canceled) {
  13885. // Tell the caller apart from a plain read failure when the body could
  13886. // not be decoded because of its Content-Encoding.
  13887. switch (content_status) {
  13888. case StatusCode::UnsupportedMediaType_415:
  13889. error = Error::UnsupportedContentEncoding;
  13890. break;
  13891. case StatusCode::InternalServerError_500:
  13892. error = Error::Compression;
  13893. break;
  13894. default: error = Error::Read; break;
  13895. }
  13896. }
  13897. output_error_log(error, &req);
  13898. return false;
  13899. }
  13900. }
  13901. }
  13902. // Log
  13903. output_log(req, res);
  13904. return true;
  13905. }
  13906. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13907. const std::string &boundary, const UploadFormDataItems &items,
  13908. const FormDataProviderItems &provider_items) const {
  13909. size_t cur_item = 0;
  13910. size_t cur_start = 0;
  13911. // cur_item and cur_start are copied to within the std::function and
  13912. // maintain state between successive calls
  13913. return [&, cur_item, cur_start](size_t offset,
  13914. DataSink &sink) mutable -> bool {
  13915. if (!offset && !items.empty()) {
  13916. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13917. return true;
  13918. } else if (cur_item < provider_items.size()) {
  13919. if (!cur_start) {
  13920. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13921. provider_items[cur_item], boundary);
  13922. offset += begin.size();
  13923. cur_start = offset;
  13924. sink.os << begin;
  13925. }
  13926. DataSink cur_sink;
  13927. auto has_data = true;
  13928. cur_sink.write = sink.write;
  13929. // Forward is_writable so a provider item asking whether it may keep
  13930. // going gets the outer sink's answer rather than the default `true`.
  13931. cur_sink.is_writable = sink.is_writable;
  13932. cur_sink.done = [&]() { has_data = false; };
  13933. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13934. return false;
  13935. }
  13936. if (!has_data) {
  13937. sink.os << detail::serialize_multipart_formdata_item_end();
  13938. cur_item++;
  13939. cur_start = 0;
  13940. }
  13941. return true;
  13942. } else {
  13943. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13944. sink.done();
  13945. return true;
  13946. }
  13947. };
  13948. }
  13949. inline bool ClientImpl::process_socket(
  13950. const Socket &socket,
  13951. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13952. std::function<bool(Stream &strm)> callback) {
  13953. return detail::process_client_socket(
  13954. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13955. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13956. }
  13957. inline bool ClientImpl::is_ssl() const { return false; }
  13958. inline Result ClientImpl::Get(const std::string &path,
  13959. DownloadProgress progress) {
  13960. return Get(path, Headers(), std::move(progress));
  13961. }
  13962. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13963. DownloadProgress progress) {
  13964. return Get(path, params, Headers(), std::move(progress));
  13965. }
  13966. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13967. const Headers &headers,
  13968. DownloadProgress progress) {
  13969. if (params.empty()) { return Get(path, headers); }
  13970. std::string path_with_query = append_query_params(path, params);
  13971. return Get(path_with_query, headers, std::move(progress));
  13972. }
  13973. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13974. DownloadProgress progress) {
  13975. Request req;
  13976. req.method = "GET";
  13977. req.path = path;
  13978. req.headers = headers;
  13979. req.download_progress = std::move(progress);
  13980. if (max_timeout_msec_ > 0) {
  13981. req.start_time_ = std::chrono::steady_clock::now();
  13982. }
  13983. return send_(std::move(req));
  13984. }
  13985. inline Result ClientImpl::Get(const std::string &path,
  13986. ContentReceiver content_receiver,
  13987. DownloadProgress progress) {
  13988. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13989. std::move(progress));
  13990. }
  13991. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13992. ContentReceiver content_receiver,
  13993. DownloadProgress progress) {
  13994. return Get(path, headers, nullptr, std::move(content_receiver),
  13995. std::move(progress));
  13996. }
  13997. inline Result ClientImpl::Get(const std::string &path,
  13998. ResponseHandler response_handler,
  13999. ContentReceiver content_receiver,
  14000. DownloadProgress progress) {
  14001. return Get(path, Headers(), std::move(response_handler),
  14002. std::move(content_receiver), std::move(progress));
  14003. }
  14004. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14005. ResponseHandler response_handler,
  14006. ContentReceiver content_receiver,
  14007. DownloadProgress progress) {
  14008. Request req;
  14009. req.method = "GET";
  14010. req.path = path;
  14011. req.headers = headers;
  14012. req.response_handler = std::move(response_handler);
  14013. req.content_receiver =
  14014. [content_receiver](const char *data, size_t data_length,
  14015. size_t /*offset*/, size_t /*total_length*/) {
  14016. return content_receiver(data, data_length);
  14017. };
  14018. req.download_progress = std::move(progress);
  14019. if (max_timeout_msec_ > 0) {
  14020. req.start_time_ = std::chrono::steady_clock::now();
  14021. }
  14022. return send_(std::move(req));
  14023. }
  14024. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14025. const Headers &headers,
  14026. ContentReceiver content_receiver,
  14027. DownloadProgress progress) {
  14028. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14029. std::move(progress));
  14030. }
  14031. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14032. const Headers &headers,
  14033. ResponseHandler response_handler,
  14034. ContentReceiver content_receiver,
  14035. DownloadProgress progress) {
  14036. if (params.empty()) {
  14037. return Get(path, headers, std::move(response_handler),
  14038. std::move(content_receiver), std::move(progress));
  14039. }
  14040. std::string path_with_query = append_query_params(path, params);
  14041. return Get(path_with_query, headers, std::move(response_handler),
  14042. std::move(content_receiver), std::move(progress));
  14043. }
  14044. inline Result ClientImpl::Head(const std::string &path) {
  14045. return Head(path, Headers());
  14046. }
  14047. inline Result ClientImpl::Head(const std::string &path,
  14048. const Headers &headers) {
  14049. Request req;
  14050. req.method = "HEAD";
  14051. req.headers = headers;
  14052. req.path = path;
  14053. if (max_timeout_msec_ > 0) {
  14054. req.start_time_ = std::chrono::steady_clock::now();
  14055. }
  14056. return send_(std::move(req));
  14057. }
  14058. inline Result ClientImpl::Post(const std::string &path) {
  14059. return Post(path, std::string(), std::string());
  14060. }
  14061. inline Result ClientImpl::Post(const std::string &path,
  14062. const Headers &headers) {
  14063. return Post(path, headers, nullptr, 0, std::string());
  14064. }
  14065. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14066. size_t content_length,
  14067. const std::string &content_type,
  14068. UploadProgress progress) {
  14069. return Post(path, Headers(), body, content_length, content_type, progress);
  14070. }
  14071. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14072. const std::string &content_type,
  14073. UploadProgress progress) {
  14074. return Post(path, Headers(), body, content_type, progress);
  14075. }
  14076. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14077. return Post(path, Headers(), params);
  14078. }
  14079. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14080. ContentProvider content_provider,
  14081. const std::string &content_type,
  14082. UploadProgress progress) {
  14083. return Post(path, Headers(), content_length, std::move(content_provider),
  14084. content_type, progress);
  14085. }
  14086. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14087. ContentProvider content_provider,
  14088. const std::string &content_type,
  14089. ContentReceiver content_receiver,
  14090. UploadProgress progress) {
  14091. return Post(path, Headers(), content_length, std::move(content_provider),
  14092. content_type, std::move(content_receiver), progress);
  14093. }
  14094. inline Result ClientImpl::Post(const std::string &path,
  14095. ContentProviderWithoutLength content_provider,
  14096. const std::string &content_type,
  14097. UploadProgress progress) {
  14098. return Post(path, Headers(), std::move(content_provider), content_type,
  14099. progress);
  14100. }
  14101. inline Result ClientImpl::Post(const std::string &path,
  14102. ContentProviderWithoutLength content_provider,
  14103. const std::string &content_type,
  14104. ContentReceiver content_receiver,
  14105. UploadProgress progress) {
  14106. return Post(path, Headers(), std::move(content_provider), content_type,
  14107. std::move(content_receiver), progress);
  14108. }
  14109. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14110. const Params &params) {
  14111. auto query = detail::params_to_query_str(params);
  14112. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14113. }
  14114. inline Result ClientImpl::Post(const std::string &path,
  14115. const UploadFormDataItems &items,
  14116. UploadProgress progress) {
  14117. return Post(path, Headers(), items, progress);
  14118. }
  14119. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14120. const UploadFormDataItems &items,
  14121. UploadProgress progress) {
  14122. const auto &boundary = detail::make_multipart_data_boundary();
  14123. const auto &content_type =
  14124. detail::serialize_multipart_formdata_get_content_type(boundary);
  14125. auto content_length = detail::get_multipart_content_length(items, boundary);
  14126. return Post(path, headers, content_length,
  14127. detail::make_multipart_content_provider(items, boundary),
  14128. content_type, progress);
  14129. }
  14130. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14131. const UploadFormDataItems &items,
  14132. const std::string &boundary,
  14133. UploadProgress progress) {
  14134. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14135. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14136. }
  14137. const auto &content_type =
  14138. detail::serialize_multipart_formdata_get_content_type(boundary);
  14139. auto content_length = detail::get_multipart_content_length(items, boundary);
  14140. return Post(path, headers, content_length,
  14141. detail::make_multipart_content_provider(items, boundary),
  14142. content_type, progress);
  14143. }
  14144. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14145. const char *body, size_t content_length,
  14146. const std::string &content_type,
  14147. UploadProgress progress) {
  14148. return send_with_content_provider_and_receiver(
  14149. "POST", path, headers, body, content_length, nullptr, nullptr,
  14150. content_type, nullptr, progress);
  14151. }
  14152. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14153. const std::string &body,
  14154. const std::string &content_type,
  14155. UploadProgress progress) {
  14156. return send_with_content_provider_and_receiver(
  14157. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14158. content_type, nullptr, progress);
  14159. }
  14160. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14161. size_t content_length,
  14162. ContentProvider content_provider,
  14163. const std::string &content_type,
  14164. UploadProgress progress) {
  14165. return send_with_content_provider_and_receiver(
  14166. "POST", path, headers, nullptr, content_length,
  14167. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14168. }
  14169. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14170. size_t content_length,
  14171. ContentProvider content_provider,
  14172. const std::string &content_type,
  14173. ContentReceiver content_receiver,
  14174. DownloadProgress progress) {
  14175. return send_with_content_provider_and_receiver(
  14176. "POST", path, headers, nullptr, content_length,
  14177. std::move(content_provider), nullptr, content_type,
  14178. std::move(content_receiver), std::move(progress));
  14179. }
  14180. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14181. ContentProviderWithoutLength content_provider,
  14182. const std::string &content_type,
  14183. UploadProgress progress) {
  14184. return send_with_content_provider_and_receiver(
  14185. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14186. content_type, nullptr, progress);
  14187. }
  14188. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14189. ContentProviderWithoutLength content_provider,
  14190. const std::string &content_type,
  14191. ContentReceiver content_receiver,
  14192. DownloadProgress progress) {
  14193. return send_with_content_provider_and_receiver(
  14194. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14195. content_type, std::move(content_receiver), std::move(progress));
  14196. }
  14197. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14198. const UploadFormDataItems &items,
  14199. const FormDataProviderItems &provider_items,
  14200. UploadProgress progress) {
  14201. const auto &boundary = detail::make_multipart_data_boundary();
  14202. const auto &content_type =
  14203. detail::serialize_multipart_formdata_get_content_type(boundary);
  14204. return send_with_content_provider_and_receiver(
  14205. "POST", path, headers, nullptr, 0, nullptr,
  14206. get_multipart_content_provider(boundary, items, provider_items),
  14207. content_type, nullptr, progress);
  14208. }
  14209. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14210. const std::string &body,
  14211. const std::string &content_type,
  14212. ContentReceiver content_receiver,
  14213. DownloadProgress progress) {
  14214. Request req;
  14215. req.method = "POST";
  14216. req.path = path;
  14217. req.headers = headers;
  14218. req.body = body;
  14219. req.content_receiver =
  14220. [content_receiver](const char *data, size_t data_length,
  14221. size_t /*offset*/, size_t /*total_length*/) {
  14222. return content_receiver(data, data_length);
  14223. };
  14224. req.download_progress = std::move(progress);
  14225. if (max_timeout_msec_ > 0) {
  14226. req.start_time_ = std::chrono::steady_clock::now();
  14227. }
  14228. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14229. return send_(std::move(req));
  14230. }
  14231. inline Result ClientImpl::Put(const std::string &path) {
  14232. return Put(path, std::string(), std::string());
  14233. }
  14234. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14235. return Put(path, headers, nullptr, 0, std::string());
  14236. }
  14237. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14238. size_t content_length,
  14239. const std::string &content_type,
  14240. UploadProgress progress) {
  14241. return Put(path, Headers(), body, content_length, content_type, progress);
  14242. }
  14243. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14244. const std::string &content_type,
  14245. UploadProgress progress) {
  14246. return Put(path, Headers(), body, content_type, progress);
  14247. }
  14248. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14249. return Put(path, Headers(), params);
  14250. }
  14251. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14252. ContentProvider content_provider,
  14253. const std::string &content_type,
  14254. UploadProgress progress) {
  14255. return Put(path, Headers(), content_length, std::move(content_provider),
  14256. content_type, progress);
  14257. }
  14258. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14259. ContentProvider content_provider,
  14260. const std::string &content_type,
  14261. ContentReceiver content_receiver,
  14262. UploadProgress progress) {
  14263. return Put(path, Headers(), content_length, std::move(content_provider),
  14264. content_type, std::move(content_receiver), progress);
  14265. }
  14266. inline Result ClientImpl::Put(const std::string &path,
  14267. ContentProviderWithoutLength content_provider,
  14268. const std::string &content_type,
  14269. UploadProgress progress) {
  14270. return Put(path, Headers(), std::move(content_provider), content_type,
  14271. progress);
  14272. }
  14273. inline Result ClientImpl::Put(const std::string &path,
  14274. ContentProviderWithoutLength content_provider,
  14275. const std::string &content_type,
  14276. ContentReceiver content_receiver,
  14277. UploadProgress progress) {
  14278. return Put(path, Headers(), std::move(content_provider), content_type,
  14279. std::move(content_receiver), progress);
  14280. }
  14281. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14282. const Params &params) {
  14283. auto query = detail::params_to_query_str(params);
  14284. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14285. }
  14286. inline Result ClientImpl::Put(const std::string &path,
  14287. const UploadFormDataItems &items,
  14288. UploadProgress progress) {
  14289. return Put(path, Headers(), items, progress);
  14290. }
  14291. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14292. const UploadFormDataItems &items,
  14293. UploadProgress progress) {
  14294. const auto &boundary = detail::make_multipart_data_boundary();
  14295. const auto &content_type =
  14296. detail::serialize_multipart_formdata_get_content_type(boundary);
  14297. auto content_length = detail::get_multipart_content_length(items, boundary);
  14298. return Put(path, headers, content_length,
  14299. detail::make_multipart_content_provider(items, boundary),
  14300. content_type, progress);
  14301. }
  14302. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14303. const UploadFormDataItems &items,
  14304. const std::string &boundary,
  14305. UploadProgress progress) {
  14306. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14307. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14308. }
  14309. const auto &content_type =
  14310. detail::serialize_multipart_formdata_get_content_type(boundary);
  14311. auto content_length = detail::get_multipart_content_length(items, boundary);
  14312. return Put(path, headers, content_length,
  14313. detail::make_multipart_content_provider(items, boundary),
  14314. content_type, progress);
  14315. }
  14316. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14317. const char *body, size_t content_length,
  14318. const std::string &content_type,
  14319. UploadProgress progress) {
  14320. return send_with_content_provider_and_receiver(
  14321. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14322. content_type, nullptr, progress);
  14323. }
  14324. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14325. const std::string &body,
  14326. const std::string &content_type,
  14327. UploadProgress progress) {
  14328. return send_with_content_provider_and_receiver(
  14329. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14330. content_type, nullptr, progress);
  14331. }
  14332. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14333. size_t content_length,
  14334. ContentProvider content_provider,
  14335. const std::string &content_type,
  14336. UploadProgress progress) {
  14337. return send_with_content_provider_and_receiver(
  14338. "PUT", path, headers, nullptr, content_length,
  14339. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14340. }
  14341. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14342. size_t content_length,
  14343. ContentProvider content_provider,
  14344. const std::string &content_type,
  14345. ContentReceiver content_receiver,
  14346. UploadProgress progress) {
  14347. return send_with_content_provider_and_receiver(
  14348. "PUT", path, headers, nullptr, content_length,
  14349. std::move(content_provider), nullptr, content_type,
  14350. std::move(content_receiver), progress);
  14351. }
  14352. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14353. ContentProviderWithoutLength content_provider,
  14354. const std::string &content_type,
  14355. UploadProgress progress) {
  14356. return send_with_content_provider_and_receiver(
  14357. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14358. content_type, nullptr, progress);
  14359. }
  14360. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14361. ContentProviderWithoutLength content_provider,
  14362. const std::string &content_type,
  14363. ContentReceiver content_receiver,
  14364. UploadProgress progress) {
  14365. return send_with_content_provider_and_receiver(
  14366. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14367. content_type, std::move(content_receiver), progress);
  14368. }
  14369. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14370. const UploadFormDataItems &items,
  14371. const FormDataProviderItems &provider_items,
  14372. UploadProgress progress) {
  14373. const auto &boundary = detail::make_multipart_data_boundary();
  14374. const auto &content_type =
  14375. detail::serialize_multipart_formdata_get_content_type(boundary);
  14376. return send_with_content_provider_and_receiver(
  14377. "PUT", path, headers, nullptr, 0, nullptr,
  14378. get_multipart_content_provider(boundary, items, provider_items),
  14379. content_type, nullptr, progress);
  14380. }
  14381. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14382. const std::string &body,
  14383. const std::string &content_type,
  14384. ContentReceiver content_receiver,
  14385. DownloadProgress progress) {
  14386. Request req;
  14387. req.method = "PUT";
  14388. req.path = path;
  14389. req.headers = headers;
  14390. req.body = body;
  14391. req.content_receiver =
  14392. [content_receiver](const char *data, size_t data_length,
  14393. size_t /*offset*/, size_t /*total_length*/) {
  14394. return content_receiver(data, data_length);
  14395. };
  14396. req.download_progress = std::move(progress);
  14397. if (max_timeout_msec_ > 0) {
  14398. req.start_time_ = std::chrono::steady_clock::now();
  14399. }
  14400. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14401. return send_(std::move(req));
  14402. }
  14403. inline Result ClientImpl::Patch(const std::string &path) {
  14404. return Patch(path, std::string(), std::string());
  14405. }
  14406. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14407. UploadProgress progress) {
  14408. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14409. }
  14410. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14411. size_t content_length,
  14412. const std::string &content_type,
  14413. UploadProgress progress) {
  14414. return Patch(path, Headers(), body, content_length, content_type, progress);
  14415. }
  14416. inline Result ClientImpl::Patch(const std::string &path,
  14417. const std::string &body,
  14418. const std::string &content_type,
  14419. UploadProgress progress) {
  14420. return Patch(path, Headers(), body, content_type, progress);
  14421. }
  14422. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14423. return Patch(path, Headers(), params);
  14424. }
  14425. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14426. ContentProvider content_provider,
  14427. const std::string &content_type,
  14428. UploadProgress progress) {
  14429. return Patch(path, Headers(), content_length, std::move(content_provider),
  14430. content_type, progress);
  14431. }
  14432. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14433. ContentProvider content_provider,
  14434. const std::string &content_type,
  14435. ContentReceiver content_receiver,
  14436. UploadProgress progress) {
  14437. return Patch(path, Headers(), content_length, std::move(content_provider),
  14438. content_type, std::move(content_receiver), progress);
  14439. }
  14440. inline Result ClientImpl::Patch(const std::string &path,
  14441. ContentProviderWithoutLength content_provider,
  14442. const std::string &content_type,
  14443. UploadProgress progress) {
  14444. return Patch(path, Headers(), std::move(content_provider), content_type,
  14445. progress);
  14446. }
  14447. inline Result ClientImpl::Patch(const std::string &path,
  14448. ContentProviderWithoutLength content_provider,
  14449. const std::string &content_type,
  14450. ContentReceiver content_receiver,
  14451. UploadProgress progress) {
  14452. return Patch(path, Headers(), std::move(content_provider), content_type,
  14453. std::move(content_receiver), progress);
  14454. }
  14455. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14456. const Params &params) {
  14457. auto query = detail::params_to_query_str(params);
  14458. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14459. }
  14460. inline Result ClientImpl::Patch(const std::string &path,
  14461. const UploadFormDataItems &items,
  14462. UploadProgress progress) {
  14463. return Patch(path, Headers(), items, progress);
  14464. }
  14465. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14466. const UploadFormDataItems &items,
  14467. UploadProgress progress) {
  14468. const auto &boundary = detail::make_multipart_data_boundary();
  14469. const auto &content_type =
  14470. detail::serialize_multipart_formdata_get_content_type(boundary);
  14471. auto content_length = detail::get_multipart_content_length(items, boundary);
  14472. return Patch(path, headers, content_length,
  14473. detail::make_multipart_content_provider(items, boundary),
  14474. content_type, progress);
  14475. }
  14476. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14477. const UploadFormDataItems &items,
  14478. const std::string &boundary,
  14479. UploadProgress progress) {
  14480. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14481. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14482. }
  14483. const auto &content_type =
  14484. detail::serialize_multipart_formdata_get_content_type(boundary);
  14485. auto content_length = detail::get_multipart_content_length(items, boundary);
  14486. return Patch(path, headers, content_length,
  14487. detail::make_multipart_content_provider(items, boundary),
  14488. content_type, progress);
  14489. }
  14490. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14491. const char *body, size_t content_length,
  14492. const std::string &content_type,
  14493. UploadProgress progress) {
  14494. return send_with_content_provider_and_receiver(
  14495. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14496. content_type, nullptr, progress);
  14497. }
  14498. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14499. const std::string &body,
  14500. const std::string &content_type,
  14501. UploadProgress progress) {
  14502. return send_with_content_provider_and_receiver(
  14503. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14504. content_type, nullptr, progress);
  14505. }
  14506. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14507. size_t content_length,
  14508. ContentProvider content_provider,
  14509. const std::string &content_type,
  14510. UploadProgress progress) {
  14511. return send_with_content_provider_and_receiver(
  14512. "PATCH", path, headers, nullptr, content_length,
  14513. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14514. }
  14515. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14516. size_t content_length,
  14517. ContentProvider content_provider,
  14518. const std::string &content_type,
  14519. ContentReceiver content_receiver,
  14520. UploadProgress progress) {
  14521. return send_with_content_provider_and_receiver(
  14522. "PATCH", path, headers, nullptr, content_length,
  14523. std::move(content_provider), nullptr, content_type,
  14524. std::move(content_receiver), progress);
  14525. }
  14526. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14527. ContentProviderWithoutLength content_provider,
  14528. const std::string &content_type,
  14529. UploadProgress progress) {
  14530. return send_with_content_provider_and_receiver(
  14531. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14532. content_type, nullptr, progress);
  14533. }
  14534. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14535. ContentProviderWithoutLength content_provider,
  14536. const std::string &content_type,
  14537. ContentReceiver content_receiver,
  14538. UploadProgress progress) {
  14539. return send_with_content_provider_and_receiver(
  14540. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14541. content_type, std::move(content_receiver), progress);
  14542. }
  14543. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14544. const UploadFormDataItems &items,
  14545. const FormDataProviderItems &provider_items,
  14546. UploadProgress progress) {
  14547. const auto &boundary = detail::make_multipart_data_boundary();
  14548. const auto &content_type =
  14549. detail::serialize_multipart_formdata_get_content_type(boundary);
  14550. return send_with_content_provider_and_receiver(
  14551. "PATCH", path, headers, nullptr, 0, nullptr,
  14552. get_multipart_content_provider(boundary, items, provider_items),
  14553. content_type, nullptr, progress);
  14554. }
  14555. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14556. const std::string &body,
  14557. const std::string &content_type,
  14558. ContentReceiver content_receiver,
  14559. DownloadProgress progress) {
  14560. Request req;
  14561. req.method = "PATCH";
  14562. req.path = path;
  14563. req.headers = headers;
  14564. req.body = body;
  14565. req.content_receiver =
  14566. [content_receiver](const char *data, size_t data_length,
  14567. size_t /*offset*/, size_t /*total_length*/) {
  14568. return content_receiver(data, data_length);
  14569. };
  14570. req.download_progress = std::move(progress);
  14571. if (max_timeout_msec_ > 0) {
  14572. req.start_time_ = std::chrono::steady_clock::now();
  14573. }
  14574. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14575. return send_(std::move(req));
  14576. }
  14577. inline Result ClientImpl::Delete(const std::string &path,
  14578. DownloadProgress progress) {
  14579. return Delete(path, Headers(), std::string(), std::string(), progress);
  14580. }
  14581. inline Result ClientImpl::Delete(const std::string &path,
  14582. const Headers &headers,
  14583. DownloadProgress progress) {
  14584. return Delete(path, headers, std::string(), std::string(), progress);
  14585. }
  14586. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14587. size_t content_length,
  14588. const std::string &content_type,
  14589. DownloadProgress progress) {
  14590. return Delete(path, Headers(), body, content_length, content_type, progress);
  14591. }
  14592. inline Result ClientImpl::Delete(const std::string &path,
  14593. const std::string &body,
  14594. const std::string &content_type,
  14595. DownloadProgress progress) {
  14596. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14597. progress);
  14598. }
  14599. inline Result ClientImpl::Delete(const std::string &path,
  14600. const Headers &headers,
  14601. const std::string &body,
  14602. const std::string &content_type,
  14603. DownloadProgress progress) {
  14604. return Delete(path, headers, body.data(), body.size(), content_type,
  14605. progress);
  14606. }
  14607. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14608. DownloadProgress progress) {
  14609. return Delete(path, Headers(), params, progress);
  14610. }
  14611. inline Result ClientImpl::Delete(const std::string &path,
  14612. const Headers &headers, const Params &params,
  14613. DownloadProgress progress) {
  14614. auto query = detail::params_to_query_str(params);
  14615. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14616. progress);
  14617. }
  14618. inline Result ClientImpl::Delete(const std::string &path,
  14619. const Headers &headers, const char *body,
  14620. size_t content_length,
  14621. const std::string &content_type,
  14622. DownloadProgress progress) {
  14623. Request req;
  14624. req.method = "DELETE";
  14625. req.headers = headers;
  14626. req.path = path;
  14627. req.download_progress = std::move(progress);
  14628. if (max_timeout_msec_ > 0) {
  14629. req.start_time_ = std::chrono::steady_clock::now();
  14630. }
  14631. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14632. req.body.assign(body, content_length);
  14633. return send_(std::move(req));
  14634. }
  14635. inline Result ClientImpl::Options(const std::string &path) {
  14636. return Options(path, Headers());
  14637. }
  14638. inline Result ClientImpl::Options(const std::string &path,
  14639. const Headers &headers) {
  14640. Request req;
  14641. req.method = "OPTIONS";
  14642. req.headers = headers;
  14643. req.path = path;
  14644. if (max_timeout_msec_ > 0) {
  14645. req.start_time_ = std::chrono::steady_clock::now();
  14646. }
  14647. return send_(std::move(req));
  14648. }
  14649. inline void ClientImpl::stop() {
  14650. std::lock_guard<std::mutex> guard(socket_mutex_);
  14651. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14652. // do is to shutdown_socket, so that threads using this socket suddenly
  14653. // discover they can't read/write any more and error out. Everything else
  14654. // (closing the socket, shutting ssl down) is unsafe because these actions
  14655. // are not thread-safe.
  14656. if (socket_requests_in_flight_ > 0) {
  14657. shutdown_socket(socket_);
  14658. // Aside from that, we set a flag for the socket to be closed when we're
  14659. // done.
  14660. socket_should_be_closed_when_request_is_done_ = true;
  14661. return;
  14662. }
  14663. disconnect(/*gracefully=*/true);
  14664. }
  14665. inline std::string ClientImpl::host() const { return host_; }
  14666. inline int ClientImpl::port() const { return port_; }
  14667. inline size_t ClientImpl::is_socket_open() const {
  14668. std::lock_guard<std::mutex> guard(socket_mutex_);
  14669. return socket_.is_open();
  14670. }
  14671. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14672. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14673. connection_timeout_sec_ = sec;
  14674. connection_timeout_usec_ = usec;
  14675. }
  14676. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14677. read_timeout_sec_ = sec;
  14678. read_timeout_usec_ = usec;
  14679. }
  14680. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14681. write_timeout_sec_ = sec;
  14682. write_timeout_usec_ = usec;
  14683. }
  14684. inline void ClientImpl::set_max_timeout(time_t msec) {
  14685. max_timeout_msec_ = msec;
  14686. }
  14687. inline void ClientImpl::set_basic_auth(const std::string &username,
  14688. const std::string &password) {
  14689. basic_auth_username_ = username;
  14690. basic_auth_password_ = password;
  14691. }
  14692. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14693. bearer_token_auth_token_ = token;
  14694. }
  14695. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14696. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14697. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14698. inline void
  14699. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14700. addr_map_ = std::move(addr_map);
  14701. }
  14702. inline void ClientImpl::set_default_headers(Headers headers) {
  14703. default_headers_ = std::move(headers);
  14704. }
  14705. inline void ClientImpl::set_header_writer(
  14706. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14707. header_writer_ = writer;
  14708. }
  14709. inline void ClientImpl::set_address_family(int family) {
  14710. address_family_ = family;
  14711. }
  14712. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14713. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14714. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14715. socket_options_ = std::move(socket_options);
  14716. }
  14717. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14718. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14719. inline void ClientImpl::set_payload_max_length(size_t length) {
  14720. payload_max_length_ = length;
  14721. has_payload_max_length_ = true;
  14722. }
  14723. inline void ClientImpl::set_interface(const std::string &intf) {
  14724. interface_ = intf;
  14725. }
  14726. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14727. proxy_host_ = host;
  14728. proxy_port_ = port;
  14729. std::lock_guard<std::mutex> guard(socket_mutex_);
  14730. disconnect(/*gracefully=*/true);
  14731. }
  14732. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14733. const std::string &password) {
  14734. proxy_basic_auth_username_ = username;
  14735. proxy_basic_auth_password_ = password;
  14736. }
  14737. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14738. proxy_bearer_token_auth_token_ = token;
  14739. }
  14740. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14741. std::vector<detail::NoProxyEntry> parsed;
  14742. parsed.reserve(patterns.size());
  14743. for (const auto &p : patterns) {
  14744. auto trimmed = detail::trim_copy(p);
  14745. if (trimmed.empty()) { continue; }
  14746. detail::NoProxyEntry entry;
  14747. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14748. parsed.push_back(std::move(entry));
  14749. }
  14750. }
  14751. no_proxy_entries_ = std::move(parsed);
  14752. std::lock_guard<std::mutex> guard(socket_mutex_);
  14753. disconnect(/*gracefully=*/true);
  14754. }
  14755. #ifdef CPPHTTPLIB_SSL_ENABLED
  14756. inline void ClientImpl::set_digest_auth(const std::string &username,
  14757. const std::string &password) {
  14758. digest_auth_username_ = username;
  14759. digest_auth_password_ = password;
  14760. }
  14761. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14762. const std::string &ca_cert_dir_path) {
  14763. ca_cert_file_path_ = ca_cert_file_path;
  14764. ca_cert_dir_path_ = ca_cert_dir_path;
  14765. }
  14766. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14767. const std::string &password) {
  14768. proxy_digest_auth_username_ = username;
  14769. proxy_digest_auth_password_ = password;
  14770. }
  14771. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14772. server_certificate_verification_ = enabled;
  14773. }
  14774. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14775. server_hostname_verification_ = enabled;
  14776. }
  14777. inline void ClientImpl::enable_system_ca(bool enabled) {
  14778. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14779. }
  14780. #endif
  14781. inline void ClientImpl::set_logger(Logger logger) {
  14782. logger_ = std::move(logger);
  14783. }
  14784. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14785. error_logger_ = std::move(error_logger);
  14786. }
  14787. /*
  14788. * SSL/TLS Common Implementation
  14789. */
  14790. inline ClientConnection::~ClientConnection() {
  14791. #ifdef CPPHTTPLIB_SSL_ENABLED
  14792. if (session) {
  14793. tls::shutdown(session, true);
  14794. tls::free_session(session);
  14795. session = nullptr;
  14796. }
  14797. #endif
  14798. if (sock != INVALID_SOCKET) {
  14799. detail::close_socket(sock);
  14800. sock = INVALID_SOCKET;
  14801. }
  14802. }
  14803. // Universal client implementation
  14804. inline Client::Client(const std::string &scheme_host_port)
  14805. : Client(scheme_host_port, std::string(), std::string()) {}
  14806. inline Client::Client(const std::string &scheme_host_port,
  14807. const std::string &client_cert_path,
  14808. const std::string &client_key_path) {
  14809. detail::UrlComponents uc;
  14810. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14811. auto &scheme = uc.scheme;
  14812. #ifdef CPPHTTPLIB_SSL_ENABLED
  14813. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14814. #else
  14815. if (!scheme.empty() && scheme != "http") {
  14816. #endif
  14817. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14818. std::string msg = "'" + scheme + "' scheme is not supported.";
  14819. throw std::invalid_argument(msg);
  14820. #endif
  14821. return;
  14822. }
  14823. auto is_ssl = scheme == "https";
  14824. auto host = std::move(uc.host);
  14825. auto port = is_ssl ? 443 : 80;
  14826. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14827. if (is_ssl) {
  14828. #ifdef CPPHTTPLIB_SSL_ENABLED
  14829. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14830. client_key_path);
  14831. is_ssl_ = is_ssl;
  14832. #endif
  14833. } else {
  14834. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14835. client_key_path);
  14836. }
  14837. } else {
  14838. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14839. // if port param below changes.
  14840. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14841. client_cert_path, client_key_path);
  14842. }
  14843. }
  14844. inline Client::Client(const std::string &host, int port)
  14845. : Client(host, port, std::string(), std::string()) {}
  14846. inline Client::Client(const std::string &host, int port,
  14847. const std::string &client_cert_path,
  14848. const std::string &client_key_path)
  14849. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14850. client_key_path)) {}
  14851. inline Client::~Client() = default;
  14852. inline bool Client::is_valid() const {
  14853. return cli_ != nullptr && cli_->is_valid();
  14854. }
  14855. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14856. return cli_->Get(path, std::move(progress));
  14857. }
  14858. inline Result Client::Get(const std::string &path, const Headers &headers,
  14859. DownloadProgress progress) {
  14860. return cli_->Get(path, headers, std::move(progress));
  14861. }
  14862. inline Result Client::Get(const std::string &path,
  14863. ContentReceiver content_receiver,
  14864. DownloadProgress progress) {
  14865. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14866. }
  14867. inline Result Client::Get(const std::string &path, const Headers &headers,
  14868. ContentReceiver content_receiver,
  14869. DownloadProgress progress) {
  14870. return cli_->Get(path, headers, std::move(content_receiver),
  14871. std::move(progress));
  14872. }
  14873. inline Result Client::Get(const std::string &path,
  14874. ResponseHandler response_handler,
  14875. ContentReceiver content_receiver,
  14876. DownloadProgress progress) {
  14877. return cli_->Get(path, std::move(response_handler),
  14878. std::move(content_receiver), std::move(progress));
  14879. }
  14880. inline Result Client::Get(const std::string &path, const Headers &headers,
  14881. ResponseHandler response_handler,
  14882. ContentReceiver content_receiver,
  14883. DownloadProgress progress) {
  14884. return cli_->Get(path, headers, std::move(response_handler),
  14885. std::move(content_receiver), std::move(progress));
  14886. }
  14887. inline Result Client::Get(const std::string &path, const Params &params,
  14888. DownloadProgress progress) {
  14889. return cli_->Get(path, params, std::move(progress));
  14890. }
  14891. inline Result Client::Get(const std::string &path, const Params &params,
  14892. const Headers &headers, DownloadProgress progress) {
  14893. return cli_->Get(path, params, headers, std::move(progress));
  14894. }
  14895. inline Result Client::Get(const std::string &path, const Params &params,
  14896. const Headers &headers,
  14897. ContentReceiver content_receiver,
  14898. DownloadProgress progress) {
  14899. return cli_->Get(path, params, headers, std::move(content_receiver),
  14900. std::move(progress));
  14901. }
  14902. inline Result Client::Get(const std::string &path, const Params &params,
  14903. const Headers &headers,
  14904. ResponseHandler response_handler,
  14905. ContentReceiver content_receiver,
  14906. DownloadProgress progress) {
  14907. return cli_->Get(path, params, headers, std::move(response_handler),
  14908. std::move(content_receiver), std::move(progress));
  14909. }
  14910. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14911. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14912. return cli_->Head(path, headers);
  14913. }
  14914. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14915. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14916. return cli_->Post(path, headers);
  14917. }
  14918. inline Result Client::Post(const std::string &path, const char *body,
  14919. size_t content_length,
  14920. const std::string &content_type,
  14921. UploadProgress progress) {
  14922. return cli_->Post(path, body, content_length, content_type, progress);
  14923. }
  14924. inline Result Client::Post(const std::string &path, const Headers &headers,
  14925. const char *body, size_t content_length,
  14926. const std::string &content_type,
  14927. UploadProgress progress) {
  14928. return cli_->Post(path, headers, body, content_length, content_type,
  14929. progress);
  14930. }
  14931. inline Result Client::Post(const std::string &path, const std::string &body,
  14932. const std::string &content_type,
  14933. UploadProgress progress) {
  14934. return cli_->Post(path, body, content_type, progress);
  14935. }
  14936. inline Result Client::Post(const std::string &path, const Headers &headers,
  14937. const std::string &body,
  14938. const std::string &content_type,
  14939. UploadProgress progress) {
  14940. return cli_->Post(path, headers, body, content_type, progress);
  14941. }
  14942. inline Result Client::Post(const std::string &path, size_t content_length,
  14943. ContentProvider content_provider,
  14944. const std::string &content_type,
  14945. UploadProgress progress) {
  14946. return cli_->Post(path, content_length, std::move(content_provider),
  14947. content_type, progress);
  14948. }
  14949. inline Result Client::Post(const std::string &path, size_t content_length,
  14950. ContentProvider content_provider,
  14951. const std::string &content_type,
  14952. ContentReceiver content_receiver,
  14953. UploadProgress progress) {
  14954. return cli_->Post(path, content_length, std::move(content_provider),
  14955. content_type, std::move(content_receiver), progress);
  14956. }
  14957. inline Result Client::Post(const std::string &path,
  14958. ContentProviderWithoutLength content_provider,
  14959. const std::string &content_type,
  14960. UploadProgress progress) {
  14961. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14962. }
  14963. inline Result Client::Post(const std::string &path,
  14964. ContentProviderWithoutLength content_provider,
  14965. const std::string &content_type,
  14966. ContentReceiver content_receiver,
  14967. UploadProgress progress) {
  14968. return cli_->Post(path, std::move(content_provider), content_type,
  14969. std::move(content_receiver), progress);
  14970. }
  14971. inline Result Client::Post(const std::string &path, const Headers &headers,
  14972. size_t content_length,
  14973. ContentProvider content_provider,
  14974. const std::string &content_type,
  14975. UploadProgress progress) {
  14976. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14977. content_type, progress);
  14978. }
  14979. inline Result Client::Post(const std::string &path, const Headers &headers,
  14980. size_t content_length,
  14981. ContentProvider content_provider,
  14982. const std::string &content_type,
  14983. ContentReceiver content_receiver,
  14984. DownloadProgress progress) {
  14985. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14986. content_type, std::move(content_receiver), progress);
  14987. }
  14988. inline Result Client::Post(const std::string &path, const Headers &headers,
  14989. ContentProviderWithoutLength content_provider,
  14990. const std::string &content_type,
  14991. UploadProgress progress) {
  14992. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14993. progress);
  14994. }
  14995. inline Result Client::Post(const std::string &path, const Headers &headers,
  14996. ContentProviderWithoutLength content_provider,
  14997. const std::string &content_type,
  14998. ContentReceiver content_receiver,
  14999. DownloadProgress progress) {
  15000. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15001. std::move(content_receiver), progress);
  15002. }
  15003. inline Result Client::Post(const std::string &path, const Params &params) {
  15004. return cli_->Post(path, params);
  15005. }
  15006. inline Result Client::Post(const std::string &path, const Headers &headers,
  15007. const Params &params) {
  15008. return cli_->Post(path, headers, params);
  15009. }
  15010. inline Result Client::Post(const std::string &path,
  15011. const UploadFormDataItems &items,
  15012. UploadProgress progress) {
  15013. return cli_->Post(path, items, progress);
  15014. }
  15015. inline Result Client::Post(const std::string &path, const Headers &headers,
  15016. const UploadFormDataItems &items,
  15017. UploadProgress progress) {
  15018. return cli_->Post(path, headers, items, progress);
  15019. }
  15020. inline Result Client::Post(const std::string &path, const Headers &headers,
  15021. const UploadFormDataItems &items,
  15022. const std::string &boundary,
  15023. UploadProgress progress) {
  15024. return cli_->Post(path, headers, items, boundary, progress);
  15025. }
  15026. inline Result Client::Post(const std::string &path, const Headers &headers,
  15027. const UploadFormDataItems &items,
  15028. const FormDataProviderItems &provider_items,
  15029. UploadProgress progress) {
  15030. return cli_->Post(path, headers, items, provider_items, progress);
  15031. }
  15032. inline Result Client::Post(const std::string &path, const Headers &headers,
  15033. const std::string &body,
  15034. const std::string &content_type,
  15035. ContentReceiver content_receiver,
  15036. DownloadProgress progress) {
  15037. return cli_->Post(path, headers, body, content_type,
  15038. std::move(content_receiver), progress);
  15039. }
  15040. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15041. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15042. return cli_->Put(path, headers);
  15043. }
  15044. inline Result Client::Put(const std::string &path, const char *body,
  15045. size_t content_length,
  15046. const std::string &content_type,
  15047. UploadProgress progress) {
  15048. return cli_->Put(path, body, content_length, content_type, progress);
  15049. }
  15050. inline Result Client::Put(const std::string &path, const Headers &headers,
  15051. const char *body, size_t content_length,
  15052. const std::string &content_type,
  15053. UploadProgress progress) {
  15054. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15055. }
  15056. inline Result Client::Put(const std::string &path, const std::string &body,
  15057. const std::string &content_type,
  15058. UploadProgress progress) {
  15059. return cli_->Put(path, body, content_type, progress);
  15060. }
  15061. inline Result Client::Put(const std::string &path, const Headers &headers,
  15062. const std::string &body,
  15063. const std::string &content_type,
  15064. UploadProgress progress) {
  15065. return cli_->Put(path, headers, body, content_type, progress);
  15066. }
  15067. inline Result Client::Put(const std::string &path, size_t content_length,
  15068. ContentProvider content_provider,
  15069. const std::string &content_type,
  15070. UploadProgress progress) {
  15071. return cli_->Put(path, content_length, std::move(content_provider),
  15072. content_type, progress);
  15073. }
  15074. inline Result Client::Put(const std::string &path, size_t content_length,
  15075. ContentProvider content_provider,
  15076. const std::string &content_type,
  15077. ContentReceiver content_receiver,
  15078. UploadProgress progress) {
  15079. return cli_->Put(path, content_length, std::move(content_provider),
  15080. content_type, std::move(content_receiver), progress);
  15081. }
  15082. inline Result Client::Put(const std::string &path,
  15083. ContentProviderWithoutLength content_provider,
  15084. const std::string &content_type,
  15085. UploadProgress progress) {
  15086. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15087. }
  15088. inline Result Client::Put(const std::string &path,
  15089. ContentProviderWithoutLength content_provider,
  15090. const std::string &content_type,
  15091. ContentReceiver content_receiver,
  15092. UploadProgress progress) {
  15093. return cli_->Put(path, std::move(content_provider), content_type,
  15094. std::move(content_receiver), progress);
  15095. }
  15096. inline Result Client::Put(const std::string &path, const Headers &headers,
  15097. size_t content_length,
  15098. ContentProvider content_provider,
  15099. const std::string &content_type,
  15100. UploadProgress progress) {
  15101. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15102. content_type, progress);
  15103. }
  15104. inline Result Client::Put(const std::string &path, const Headers &headers,
  15105. size_t content_length,
  15106. ContentProvider content_provider,
  15107. const std::string &content_type,
  15108. ContentReceiver content_receiver,
  15109. UploadProgress progress) {
  15110. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15111. content_type, std::move(content_receiver), progress);
  15112. }
  15113. inline Result Client::Put(const std::string &path, const Headers &headers,
  15114. ContentProviderWithoutLength content_provider,
  15115. const std::string &content_type,
  15116. UploadProgress progress) {
  15117. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15118. progress);
  15119. }
  15120. inline Result Client::Put(const std::string &path, const Headers &headers,
  15121. ContentProviderWithoutLength content_provider,
  15122. const std::string &content_type,
  15123. ContentReceiver content_receiver,
  15124. UploadProgress progress) {
  15125. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15126. std::move(content_receiver), progress);
  15127. }
  15128. inline Result Client::Put(const std::string &path, const Params &params) {
  15129. return cli_->Put(path, params);
  15130. }
  15131. inline Result Client::Put(const std::string &path, const Headers &headers,
  15132. const Params &params) {
  15133. return cli_->Put(path, headers, params);
  15134. }
  15135. inline Result Client::Put(const std::string &path,
  15136. const UploadFormDataItems &items,
  15137. UploadProgress progress) {
  15138. return cli_->Put(path, items, progress);
  15139. }
  15140. inline Result Client::Put(const std::string &path, const Headers &headers,
  15141. const UploadFormDataItems &items,
  15142. UploadProgress progress) {
  15143. return cli_->Put(path, headers, items, progress);
  15144. }
  15145. inline Result Client::Put(const std::string &path, const Headers &headers,
  15146. const UploadFormDataItems &items,
  15147. const std::string &boundary,
  15148. UploadProgress progress) {
  15149. return cli_->Put(path, headers, items, boundary, progress);
  15150. }
  15151. inline Result Client::Put(const std::string &path, const Headers &headers,
  15152. const UploadFormDataItems &items,
  15153. const FormDataProviderItems &provider_items,
  15154. UploadProgress progress) {
  15155. return cli_->Put(path, headers, items, provider_items, progress);
  15156. }
  15157. inline Result Client::Put(const std::string &path, const Headers &headers,
  15158. const std::string &body,
  15159. const std::string &content_type,
  15160. ContentReceiver content_receiver,
  15161. DownloadProgress progress) {
  15162. return cli_->Put(path, headers, body, content_type, content_receiver,
  15163. progress);
  15164. }
  15165. inline Result Client::Patch(const std::string &path) {
  15166. return cli_->Patch(path);
  15167. }
  15168. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15169. return cli_->Patch(path, headers);
  15170. }
  15171. inline Result Client::Patch(const std::string &path, const char *body,
  15172. size_t content_length,
  15173. const std::string &content_type,
  15174. UploadProgress progress) {
  15175. return cli_->Patch(path, body, content_length, content_type, progress);
  15176. }
  15177. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15178. const char *body, size_t content_length,
  15179. const std::string &content_type,
  15180. UploadProgress progress) {
  15181. return cli_->Patch(path, headers, body, content_length, content_type,
  15182. progress);
  15183. }
  15184. inline Result Client::Patch(const std::string &path, const std::string &body,
  15185. const std::string &content_type,
  15186. UploadProgress progress) {
  15187. return cli_->Patch(path, body, content_type, progress);
  15188. }
  15189. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15190. const std::string &body,
  15191. const std::string &content_type,
  15192. UploadProgress progress) {
  15193. return cli_->Patch(path, headers, body, content_type, progress);
  15194. }
  15195. inline Result Client::Patch(const std::string &path, size_t content_length,
  15196. ContentProvider content_provider,
  15197. const std::string &content_type,
  15198. UploadProgress progress) {
  15199. return cli_->Patch(path, content_length, std::move(content_provider),
  15200. content_type, progress);
  15201. }
  15202. inline Result Client::Patch(const std::string &path, size_t content_length,
  15203. ContentProvider content_provider,
  15204. const std::string &content_type,
  15205. ContentReceiver content_receiver,
  15206. UploadProgress progress) {
  15207. return cli_->Patch(path, content_length, std::move(content_provider),
  15208. content_type, std::move(content_receiver), progress);
  15209. }
  15210. inline Result Client::Patch(const std::string &path,
  15211. ContentProviderWithoutLength content_provider,
  15212. const std::string &content_type,
  15213. UploadProgress progress) {
  15214. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15215. }
  15216. inline Result Client::Patch(const std::string &path,
  15217. ContentProviderWithoutLength content_provider,
  15218. const std::string &content_type,
  15219. ContentReceiver content_receiver,
  15220. UploadProgress progress) {
  15221. return cli_->Patch(path, std::move(content_provider), content_type,
  15222. std::move(content_receiver), progress);
  15223. }
  15224. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15225. size_t content_length,
  15226. ContentProvider content_provider,
  15227. const std::string &content_type,
  15228. UploadProgress progress) {
  15229. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15230. content_type, progress);
  15231. }
  15232. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15233. size_t content_length,
  15234. ContentProvider content_provider,
  15235. const std::string &content_type,
  15236. ContentReceiver content_receiver,
  15237. UploadProgress progress) {
  15238. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15239. content_type, std::move(content_receiver), progress);
  15240. }
  15241. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15242. ContentProviderWithoutLength content_provider,
  15243. const std::string &content_type,
  15244. UploadProgress progress) {
  15245. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15246. progress);
  15247. }
  15248. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15249. ContentProviderWithoutLength content_provider,
  15250. const std::string &content_type,
  15251. ContentReceiver content_receiver,
  15252. UploadProgress progress) {
  15253. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15254. std::move(content_receiver), progress);
  15255. }
  15256. inline Result Client::Patch(const std::string &path, const Params &params) {
  15257. return cli_->Patch(path, params);
  15258. }
  15259. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15260. const Params &params) {
  15261. return cli_->Patch(path, headers, params);
  15262. }
  15263. inline Result Client::Patch(const std::string &path,
  15264. const UploadFormDataItems &items,
  15265. UploadProgress progress) {
  15266. return cli_->Patch(path, items, progress);
  15267. }
  15268. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15269. const UploadFormDataItems &items,
  15270. UploadProgress progress) {
  15271. return cli_->Patch(path, headers, items, progress);
  15272. }
  15273. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15274. const UploadFormDataItems &items,
  15275. const std::string &boundary,
  15276. UploadProgress progress) {
  15277. return cli_->Patch(path, headers, items, boundary, progress);
  15278. }
  15279. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15280. const UploadFormDataItems &items,
  15281. const FormDataProviderItems &provider_items,
  15282. UploadProgress progress) {
  15283. return cli_->Patch(path, headers, items, provider_items, progress);
  15284. }
  15285. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15286. const std::string &body,
  15287. const std::string &content_type,
  15288. ContentReceiver content_receiver,
  15289. DownloadProgress progress) {
  15290. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15291. progress);
  15292. }
  15293. inline Result Client::Delete(const std::string &path,
  15294. DownloadProgress progress) {
  15295. return cli_->Delete(path, progress);
  15296. }
  15297. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15298. DownloadProgress progress) {
  15299. return cli_->Delete(path, headers, progress);
  15300. }
  15301. inline Result Client::Delete(const std::string &path, const char *body,
  15302. size_t content_length,
  15303. const std::string &content_type,
  15304. DownloadProgress progress) {
  15305. return cli_->Delete(path, body, content_length, content_type, progress);
  15306. }
  15307. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15308. const char *body, size_t content_length,
  15309. const std::string &content_type,
  15310. DownloadProgress progress) {
  15311. return cli_->Delete(path, headers, body, content_length, content_type,
  15312. progress);
  15313. }
  15314. inline Result Client::Delete(const std::string &path, const std::string &body,
  15315. const std::string &content_type,
  15316. DownloadProgress progress) {
  15317. return cli_->Delete(path, body, content_type, progress);
  15318. }
  15319. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15320. const std::string &body,
  15321. const std::string &content_type,
  15322. DownloadProgress progress) {
  15323. return cli_->Delete(path, headers, body, content_type, progress);
  15324. }
  15325. inline Result Client::Delete(const std::string &path, const Params &params,
  15326. DownloadProgress progress) {
  15327. return cli_->Delete(path, params, progress);
  15328. }
  15329. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15330. const Params &params, DownloadProgress progress) {
  15331. return cli_->Delete(path, headers, params, progress);
  15332. }
  15333. inline Result Client::Options(const std::string &path) {
  15334. return cli_->Options(path);
  15335. }
  15336. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15337. return cli_->Options(path, headers);
  15338. }
  15339. inline ClientImpl::StreamHandle
  15340. Client::open_stream(const std::string &method, const std::string &path,
  15341. const Params &params, const Headers &headers,
  15342. const std::string &body, const std::string &content_type) {
  15343. return cli_->open_stream(method, path, params, headers, body, content_type);
  15344. }
  15345. inline bool Client::send(Request &req, Response &res, Error &error) {
  15346. return cli_->send(req, res, error);
  15347. }
  15348. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15349. inline void Client::stop() { cli_->stop(); }
  15350. inline std::string Client::host() const { return cli_->host(); }
  15351. inline int Client::port() const { return cli_->port(); }
  15352. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15353. inline socket_t Client::socket() const { return cli_->socket(); }
  15354. inline void
  15355. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15356. cli_->set_hostname_addr_map(std::move(addr_map));
  15357. }
  15358. inline void Client::set_default_headers(Headers headers) {
  15359. cli_->set_default_headers(std::move(headers));
  15360. }
  15361. inline void Client::set_header_writer(
  15362. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15363. cli_->set_header_writer(writer);
  15364. }
  15365. inline void Client::set_address_family(int family) {
  15366. cli_->set_address_family(family);
  15367. }
  15368. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15369. inline void Client::set_socket_options(SocketOptions socket_options) {
  15370. cli_->set_socket_options(std::move(socket_options));
  15371. }
  15372. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15373. cli_->set_connection_timeout(sec, usec);
  15374. }
  15375. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15376. cli_->set_read_timeout(sec, usec);
  15377. }
  15378. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15379. cli_->set_write_timeout(sec, usec);
  15380. }
  15381. inline void Client::set_basic_auth(const std::string &username,
  15382. const std::string &password) {
  15383. cli_->set_basic_auth(username, password);
  15384. }
  15385. inline void Client::set_bearer_token_auth(const std::string &token) {
  15386. cli_->set_bearer_token_auth(token);
  15387. }
  15388. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15389. inline void Client::set_follow_location(bool on) {
  15390. cli_->set_follow_location(on);
  15391. }
  15392. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15393. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15394. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15395. inline void Client::set_payload_max_length(size_t length) {
  15396. cli_->set_payload_max_length(length);
  15397. }
  15398. inline void Client::set_interface(const std::string &intf) {
  15399. cli_->set_interface(intf);
  15400. }
  15401. inline void Client::set_proxy(const std::string &host, int port) {
  15402. cli_->set_proxy(host, port);
  15403. }
  15404. inline void Client::set_proxy_basic_auth(const std::string &username,
  15405. const std::string &password) {
  15406. cli_->set_proxy_basic_auth(username, password);
  15407. }
  15408. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15409. cli_->set_proxy_bearer_token_auth(token);
  15410. }
  15411. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15412. cli_->set_no_proxy(patterns);
  15413. }
  15414. inline void Client::set_logger(Logger logger) {
  15415. cli_->set_logger(std::move(logger));
  15416. }
  15417. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15418. cli_->set_error_logger(std::move(error_logger));
  15419. }
  15420. /*
  15421. * Group 6: SSL Server and Client implementation
  15422. */
  15423. #ifdef CPPHTTPLIB_SSL_ENABLED
  15424. // SSL HTTP server implementation
  15425. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15426. const char *client_ca_cert_file_path,
  15427. const char *client_ca_cert_dir_path,
  15428. const char *private_key_password) {
  15429. using namespace tls;
  15430. ctx_ = create_server_context();
  15431. if (!ctx_) { return; }
  15432. // Load server certificate and private key
  15433. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15434. private_key_password)) {
  15435. last_ssl_error_ = static_cast<int>(get_error());
  15436. free_context(ctx_);
  15437. ctx_ = nullptr;
  15438. return;
  15439. }
  15440. // Load client CA certificates for client authentication
  15441. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15442. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15443. client_ca_cert_dir_path)) {
  15444. last_ssl_error_ = static_cast<int>(get_error());
  15445. free_context(ctx_);
  15446. ctx_ = nullptr;
  15447. return;
  15448. }
  15449. // Enable client certificate verification
  15450. set_verify_client(ctx_, true);
  15451. }
  15452. }
  15453. inline SSLServer::SSLServer(const PemMemory &pem) {
  15454. using namespace tls;
  15455. ctx_ = create_server_context();
  15456. if (ctx_) {
  15457. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15458. pem.private_key_password)) {
  15459. last_ssl_error_ = static_cast<int>(get_error());
  15460. free_context(ctx_);
  15461. ctx_ = nullptr;
  15462. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15463. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15464. last_ssl_error_ = static_cast<int>(get_error());
  15465. free_context(ctx_);
  15466. ctx_ = nullptr;
  15467. } else {
  15468. set_verify_client(ctx_, true);
  15469. }
  15470. }
  15471. }
  15472. }
  15473. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15474. using namespace tls;
  15475. ctx_ = create_server_context();
  15476. if (ctx_) {
  15477. if (!setup_callback(ctx_)) {
  15478. free_context(ctx_);
  15479. ctx_ = nullptr;
  15480. }
  15481. }
  15482. }
  15483. inline SSLServer::~SSLServer() {
  15484. if (ctx_) { tls::free_context(ctx_); }
  15485. }
  15486. inline bool SSLServer::is_valid() const {
  15487. return ctx_ != nullptr && Server::is_valid();
  15488. }
  15489. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15490. using namespace tls;
  15491. // Create TLS session with mutex protection
  15492. session_t session = nullptr;
  15493. {
  15494. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15495. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15496. }
  15497. if (!session) {
  15498. last_ssl_error_ = static_cast<int>(get_error());
  15499. detail::shutdown_socket(sock);
  15500. detail::close_socket(sock);
  15501. return false;
  15502. }
  15503. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15504. bool handshake_done = false;
  15505. bool ret = false;
  15506. bool websocket_upgraded = false;
  15507. auto cleanup = detail::scope_exit([&] {
  15508. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15509. free_session(session);
  15510. detail::shutdown_socket(sock);
  15511. detail::close_socket(sock);
  15512. });
  15513. // Perform TLS accept handshake with timeout
  15514. TlsError tls_err;
  15515. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15516. &tls_err)) {
  15517. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15518. // Map TlsError to legacy ssl_error for backward compatibility
  15519. if (tls_err.code == ErrorCode::WantRead) {
  15520. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15521. } else if (tls_err.code == ErrorCode::WantWrite) {
  15522. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15523. } else {
  15524. last_ssl_error_ = SSL_ERROR_SSL;
  15525. }
  15526. #else
  15527. last_ssl_error_ = static_cast<int>(get_error());
  15528. #endif
  15529. return false;
  15530. }
  15531. handshake_done = true;
  15532. std::string remote_addr;
  15533. int remote_port = 0;
  15534. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15535. std::string local_addr;
  15536. int local_port = 0;
  15537. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15538. ret = serve_guarded([&]() {
  15539. return detail::process_server_socket_ssl(
  15540. svr_sock_, session, sock, keep_alive_max_count_,
  15541. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15542. write_timeout_sec_, write_timeout_usec_,
  15543. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15544. return process_request(
  15545. strm, remote_addr, remote_port, local_addr, local_port,
  15546. close_connection, connection_closed,
  15547. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15548. });
  15549. });
  15550. return ret;
  15551. }
  15552. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15553. const char *key_pem,
  15554. const char *client_ca_pem,
  15555. const char *password) {
  15556. if (!ctx_) { return false; }
  15557. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15558. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15559. return false;
  15560. }
  15561. if (client_ca_pem) {
  15562. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15563. }
  15564. return true;
  15565. }
  15566. // SSL HTTP client implementation
  15567. inline SSLClient::~SSLClient() {
  15568. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15569. // base function rather than the derived function once we get to the
  15570. // base class destructor, and won't free the SSL (causing a leak).
  15571. // This must happen before the context is freed below: some backends
  15572. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15573. // context, so freeing the context first leaves close_notify reading
  15574. // freed memory.
  15575. shutdown_ssl_impl(socket_, true);
  15576. if (ctx_) {
  15577. tls::free_context(ctx_);
  15578. ctx_ = nullptr;
  15579. }
  15580. }
  15581. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15582. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15583. shutdown_ssl_impl(socket, shutdown_gracefully);
  15584. }
  15585. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15586. bool shutdown_gracefully) {
  15587. if (socket.sock == INVALID_SOCKET) {
  15588. assert(socket.ssl == nullptr);
  15589. return;
  15590. }
  15591. if (socket.ssl) {
  15592. tls::shutdown(socket.ssl, shutdown_gracefully);
  15593. {
  15594. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15595. tls::free_session(socket.ssl);
  15596. }
  15597. socket.ssl = nullptr;
  15598. }
  15599. assert(socket.ssl == nullptr);
  15600. }
  15601. inline bool SSLClient::process_socket(
  15602. const Socket &socket,
  15603. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15604. std::function<bool(Stream &strm)> callback) {
  15605. assert(socket.ssl);
  15606. return detail::process_client_socket_ssl(
  15607. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15608. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15609. std::move(callback));
  15610. }
  15611. inline bool SSLClient::is_ssl() const { return true; }
  15612. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15613. if (!is_valid()) {
  15614. error = Error::SSLConnection;
  15615. return false;
  15616. }
  15617. return ClientImpl::create_and_connect_socket(socket, error);
  15618. }
  15619. inline bool SSLClient::setup_proxy_connection(
  15620. Socket &socket,
  15621. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15622. Response &res, bool &success, Error &error) {
  15623. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15624. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15625. return false;
  15626. }
  15627. if (!initialize_ssl(socket, error)) {
  15628. success = false;
  15629. return false;
  15630. }
  15631. return true;
  15632. }
  15633. // Assumes that socket_mutex_ is locked and that there are no requests in
  15634. // flight
  15635. inline bool SSLClient::connect_with_proxy(
  15636. Socket &socket,
  15637. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15638. Response &res, bool &success, Error &error) {
  15639. success = true;
  15640. Response proxy_res;
  15641. if (!detail::process_client_socket(
  15642. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15643. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15644. start_time, [&](Stream &strm) {
  15645. Request req2;
  15646. req2.method = "CONNECT";
  15647. req2.path =
  15648. detail::make_host_and_port_string_always_port(host_, port_);
  15649. if (max_timeout_msec_ > 0) {
  15650. req2.start_time_ = std::chrono::steady_clock::now();
  15651. }
  15652. return process_request(strm, req2, proxy_res, false, error);
  15653. })) {
  15654. // Thread-safe to close everything because we are assuming there are no
  15655. // requests in flight
  15656. shutdown_ssl(socket, true);
  15657. shutdown_socket(socket);
  15658. close_socket(socket);
  15659. success = false;
  15660. return false;
  15661. }
  15662. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15663. if (!proxy_digest_auth_username_.empty() &&
  15664. !proxy_digest_auth_password_.empty()) {
  15665. std::map<std::string, std::string> auth;
  15666. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15667. // Close the current socket and create a new one for the authenticated
  15668. // request
  15669. shutdown_ssl(socket, true);
  15670. shutdown_socket(socket);
  15671. close_socket(socket);
  15672. // Create a new socket for the authenticated CONNECT request
  15673. if (!ensure_socket_connection(socket, error)) {
  15674. success = false;
  15675. output_error_log(error, nullptr);
  15676. return false;
  15677. }
  15678. proxy_res = Response();
  15679. if (!detail::process_client_socket(
  15680. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15681. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15682. start_time, [&](Stream &strm) {
  15683. Request req3;
  15684. req3.method = "CONNECT";
  15685. req3.path = detail::make_host_and_port_string_always_port(
  15686. host_, port_);
  15687. req3.headers.insert(detail::make_digest_authentication_header(
  15688. req3, auth, 1, detail::random_string(10),
  15689. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15690. true));
  15691. if (max_timeout_msec_ > 0) {
  15692. req3.start_time_ = std::chrono::steady_clock::now();
  15693. }
  15694. return process_request(strm, req3, proxy_res, false, error);
  15695. })) {
  15696. // Thread-safe to close everything because we are assuming there are
  15697. // no requests in flight
  15698. shutdown_ssl(socket, true);
  15699. shutdown_socket(socket);
  15700. close_socket(socket);
  15701. success = false;
  15702. return false;
  15703. }
  15704. }
  15705. }
  15706. }
  15707. // If status code is not 200, proxy request is failed.
  15708. // Set error to ProxyConnection and return proxy response
  15709. // as the response of the request
  15710. if (proxy_res.status != StatusCode::OK_200) {
  15711. error = Error::ProxyConnection;
  15712. output_error_log(error, nullptr);
  15713. res = std::move(proxy_res);
  15714. // Thread-safe to close everything because we are assuming there are
  15715. // no requests in flight
  15716. shutdown_ssl(socket, true);
  15717. shutdown_socket(socket);
  15718. close_socket(socket);
  15719. return false;
  15720. }
  15721. return true;
  15722. }
  15723. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15724. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15725. if (is_proxy_enabled_for_host(host_)) { return true; }
  15726. if (!initialize_ssl(socket, error)) {
  15727. shutdown_socket(socket);
  15728. close_socket(socket);
  15729. return false;
  15730. }
  15731. return true;
  15732. }
  15733. // SSL HTTP client implementation
  15734. inline SSLClient::SSLClient(const std::string &host)
  15735. : SSLClient(host, 443, std::string(), std::string()) {}
  15736. inline SSLClient::SSLClient(const std::string &host, int port)
  15737. : SSLClient(host, port, std::string(), std::string()) {}
  15738. inline void SSLClient::init_ctx() {
  15739. ctx_ = tls::create_client_context();
  15740. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15741. }
  15742. inline void SSLClient::reset_ctx_on_error() {
  15743. last_backend_error_ = tls::get_error();
  15744. tls::free_context(ctx_);
  15745. ctx_ = nullptr;
  15746. }
  15747. inline SSLClient::SSLClient(const std::string &host, int port,
  15748. const std::string &client_cert_path,
  15749. const std::string &client_key_path,
  15750. const std::string &private_key_password)
  15751. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15752. init_ctx();
  15753. if (!ctx_) { return; }
  15754. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15755. const char *password =
  15756. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15757. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15758. client_key_path.c_str(), password)) {
  15759. reset_ctx_on_error();
  15760. }
  15761. }
  15762. }
  15763. inline SSLClient::SSLClient(const std::string &host, int port,
  15764. const PemMemory &pem)
  15765. : ClientImpl(host, port) {
  15766. init_ctx();
  15767. if (!ctx_) { return; }
  15768. if (pem.cert_pem && pem.key_pem) {
  15769. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15770. pem.private_key_password)) {
  15771. reset_ctx_on_error();
  15772. }
  15773. }
  15774. }
  15775. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15776. if (ca_cert_store && ctx_) {
  15777. // set_ca_store takes ownership of ca_cert_store
  15778. tls::set_ca_store(ctx_, ca_cert_store);
  15779. ca_cert_store_set_ = true;
  15780. } else if (ca_cert_store) {
  15781. tls::free_ca_store(ca_cert_store);
  15782. }
  15783. }
  15784. inline void
  15785. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15786. if (!ctx_) { return; }
  15787. tls::set_verify_callback(ctx_, verifier);
  15788. }
  15789. inline void SSLClient::set_session_verifier(
  15790. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15791. session_verifier_ = std::move(verifier);
  15792. }
  15793. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15794. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15795. enable_windows_cert_verification_ = enabled;
  15796. }
  15797. #endif
  15798. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15799. std::size_t size) {
  15800. if (ctx_ && ca_cert && size > 0) {
  15801. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15802. tls::load_ca_pem(ctx_, ca_cert, size);
  15803. }
  15804. }
  15805. inline bool SSLClient::load_certs() {
  15806. auto ret = true;
  15807. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15808. // one client is shared across concurrent requests here.
  15809. std::call_once(initialize_cert_, [&]() {
  15810. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15811. ret = detail::load_client_ca_config(
  15812. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15813. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15814. last_backend_error_);
  15815. });
  15816. return ret;
  15817. }
  15818. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15819. // Load CA certificates if server verification is enabled
  15820. if (server_certificate_verification_) {
  15821. if (!load_certs()) {
  15822. error = Error::SSLLoadingCerts;
  15823. output_error_log(error, nullptr);
  15824. return false;
  15825. }
  15826. }
  15827. detail::ClientTlsSessionOptions options;
  15828. options.server_hostname_verification = server_hostname_verification_;
  15829. options.session_verifier = session_verifier_;
  15830. options.ctx_mutex = &ctx_mutex_;
  15831. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15832. // Skip Schannel when a custom CA cert is specified, as the Windows
  15833. // certificate store would not know about user-provided CA certificates.
  15834. // Also skip when system CA trust is explicitly disabled.
  15835. options.windows_cert_verification =
  15836. enable_windows_cert_verification_ &&
  15837. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15838. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15839. #endif
  15840. tls::session_t session = nullptr;
  15841. // Use scope_exit to ensure session is freed on error paths
  15842. bool success = false;
  15843. auto session_guard = detail::scope_exit([&] {
  15844. if (!success) { tls::free_session(session); }
  15845. });
  15846. detail::ClientTlsSessionError tls_error;
  15847. if (!detail::setup_client_tls_session(
  15848. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15849. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15850. options)) {
  15851. error = tls_error.error;
  15852. last_ssl_error_ = tls_error.ssl_error;
  15853. last_backend_error_ = tls_error.backend_error;
  15854. output_error_log(error, nullptr);
  15855. return false;
  15856. }
  15857. success = true;
  15858. socket.ssl = session;
  15859. return true;
  15860. }
  15861. inline void Client::set_digest_auth(const std::string &username,
  15862. const std::string &password) {
  15863. cli_->set_digest_auth(username, password);
  15864. }
  15865. inline void Client::set_proxy_digest_auth(const std::string &username,
  15866. const std::string &password) {
  15867. cli_->set_proxy_digest_auth(username, password);
  15868. }
  15869. inline void Client::enable_server_certificate_verification(bool enabled) {
  15870. cli_->enable_server_certificate_verification(enabled);
  15871. }
  15872. inline void Client::enable_server_hostname_verification(bool enabled) {
  15873. cli_->enable_server_hostname_verification(enabled);
  15874. }
  15875. inline void Client::enable_system_ca(bool enabled) {
  15876. cli_->enable_system_ca(enabled);
  15877. }
  15878. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15879. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15880. if (is_ssl_) {
  15881. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15882. enabled);
  15883. }
  15884. }
  15885. #endif
  15886. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15887. const std::string &ca_cert_dir_path) {
  15888. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15889. }
  15890. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15891. if (is_ssl_) {
  15892. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15893. } else if (ca_cert_store) {
  15894. tls::free_ca_store(ca_cert_store);
  15895. }
  15896. }
  15897. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15898. if (is_ssl_) {
  15899. // Use the PEM-based path so the CA data is retained for redirect transfer
  15900. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15901. }
  15902. }
  15903. inline void
  15904. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15905. if (is_ssl_) {
  15906. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15907. std::move(verifier));
  15908. }
  15909. }
  15910. inline void Client::set_session_verifier(
  15911. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15912. if (is_ssl_) {
  15913. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15914. }
  15915. }
  15916. inline tls::ctx_t Client::tls_context() const {
  15917. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15918. return nullptr;
  15919. }
  15920. #endif // CPPHTTPLIB_SSL_ENABLED
  15921. /*
  15922. * Group 7: TLS abstraction layer - Common API
  15923. */
  15924. #ifdef CPPHTTPLIB_SSL_ENABLED
  15925. namespace tls {
  15926. // Helper for PeerCert construction
  15927. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15928. return PeerCert(get_peer_cert(session));
  15929. }
  15930. namespace impl {
  15931. inline VerifyCallback &get_verify_callback() {
  15932. static thread_local VerifyCallback callback;
  15933. return callback;
  15934. }
  15935. inline VerifyCallback &get_mbedtls_verify_callback() {
  15936. static thread_local VerifyCallback callback;
  15937. return callback;
  15938. }
  15939. // Check if a string is an IPv4 address
  15940. inline bool is_ipv4_address(const std::string &str) {
  15941. int dots = 0;
  15942. for (char c : str) {
  15943. if (c == '.') {
  15944. dots++;
  15945. } else if (!detail::is_ascii_digit(c)) {
  15946. return false;
  15947. }
  15948. }
  15949. return dots == 3;
  15950. }
  15951. // Parse IPv4 address string to bytes
  15952. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15953. const char *p = str.c_str();
  15954. for (int i = 0; i < 4; i++) {
  15955. if (i > 0) {
  15956. if (*p != '.') { return false; }
  15957. p++;
  15958. }
  15959. int val = 0;
  15960. int digits = 0;
  15961. while (detail::is_ascii_digit(*p)) {
  15962. val = val * 10 + (*p - '0');
  15963. if (val > 255) { return false; }
  15964. p++;
  15965. digits++;
  15966. }
  15967. if (digits == 0) { return false; }
  15968. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15969. if (digits > 1 && *(p - digits) == '0') { return false; }
  15970. out[i] = static_cast<unsigned char>(val);
  15971. }
  15972. return *p == '\0';
  15973. }
  15974. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15975. // `out` must have room for at least 16 bytes. Returns the address length
  15976. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15977. // literal. Used to match a host against iPAddress SANs the same way the
  15978. // OpenSSL backend does via X509_check_ip.
  15979. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15980. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15981. struct in6_addr addr6 = {};
  15982. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15983. memcpy(out, &addr6, 16);
  15984. return 16;
  15985. }
  15986. return 0;
  15987. }
  15988. #ifdef _WIN32
  15989. // Enumerate Windows system certificates and call callback with DER data
  15990. template <typename Callback>
  15991. inline bool enumerate_windows_system_certs(Callback cb) {
  15992. bool loaded = false;
  15993. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15994. for (auto store_name : store_names) {
  15995. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15996. if (hStore) {
  15997. PCCERT_CONTEXT pContext = nullptr;
  15998. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15999. nullptr) {
  16000. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16001. loaded = true;
  16002. }
  16003. }
  16004. CertCloseStore(hStore, 0);
  16005. }
  16006. }
  16007. return loaded;
  16008. }
  16009. #endif
  16010. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16011. // Enumerate macOS Keychain certificates and call callback with DER data
  16012. template <typename Callback>
  16013. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16014. bool loaded = false;
  16015. const SecTrustSettingsDomain domains[] = {
  16016. kSecTrustSettingsDomainSystem,
  16017. kSecTrustSettingsDomainAdmin,
  16018. kSecTrustSettingsDomainUser,
  16019. };
  16020. for (auto domain : domains) {
  16021. CFArrayRef certs = nullptr;
  16022. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16023. if (status != errSecSuccess || !certs) {
  16024. if (certs) CFRelease(certs);
  16025. continue;
  16026. }
  16027. CFIndex count = CFArrayGetCount(certs);
  16028. for (CFIndex i = 0; i < count; i++) {
  16029. SecCertificateRef cert =
  16030. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16031. CFDataRef data = SecCertificateCopyData(cert);
  16032. if (data) {
  16033. if (cb(CFDataGetBytePtr(data),
  16034. static_cast<size_t>(CFDataGetLength(data)))) {
  16035. loaded = true;
  16036. }
  16037. CFRelease(data);
  16038. }
  16039. }
  16040. CFRelease(certs);
  16041. }
  16042. return loaded;
  16043. }
  16044. #endif
  16045. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16046. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16047. // Common CA certificate file paths on Linux/Unix
  16048. inline const char **system_ca_paths() {
  16049. static const char *paths[] = {
  16050. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16051. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16052. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16053. "/etc/pki/tls/cacert.pem", // OpenELEC
  16054. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16055. nullptr};
  16056. return paths;
  16057. }
  16058. // Common CA certificate directory paths on Linux/Unix
  16059. inline const char **system_ca_dirs() {
  16060. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16061. "/etc/pki/tls/certs", // RHEL/CentOS
  16062. "/usr/share/ca-certificates", // Other
  16063. nullptr};
  16064. return dirs;
  16065. }
  16066. #endif
  16067. } // namespace impl
  16068. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16069. const char *ca_dir) {
  16070. if (!ctx) { return false; }
  16071. bool success = true;
  16072. if (ca_file && *ca_file) {
  16073. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16074. }
  16075. if (ca_dir && *ca_dir) {
  16076. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16077. }
  16078. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16079. // Set CA list for client certificate request (CertificateRequest message)
  16080. if (ca_file && *ca_file) {
  16081. auto list = SSL_load_client_CA_file(ca_file);
  16082. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16083. }
  16084. #endif
  16085. return success;
  16086. }
  16087. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16088. const char *password) {
  16089. return set_client_cert_pem(ctx, cert, key, password);
  16090. }
  16091. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16092. const char *key_path, const char *password) {
  16093. return set_client_cert_file(ctx, cert_path, key_path, password);
  16094. }
  16095. // PeerCert implementation
  16096. inline PeerCert::PeerCert() = default;
  16097. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16098. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16099. other.cert_ = nullptr;
  16100. }
  16101. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16102. if (this != &other) {
  16103. if (cert_) { free_cert(cert_); }
  16104. cert_ = other.cert_;
  16105. other.cert_ = nullptr;
  16106. }
  16107. return *this;
  16108. }
  16109. inline PeerCert::~PeerCert() {
  16110. if (cert_) { free_cert(cert_); }
  16111. }
  16112. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16113. inline std::string PeerCert::subject_cn() const {
  16114. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16115. }
  16116. inline std::string PeerCert::issuer_name() const {
  16117. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16118. }
  16119. inline bool PeerCert::check_hostname(const char *hostname) const {
  16120. return cert_ ? verify_hostname(cert_, hostname) : false;
  16121. }
  16122. inline std::vector<SanEntry> PeerCert::sans() const {
  16123. std::vector<SanEntry> result;
  16124. if (cert_) { get_cert_sans(cert_, result); }
  16125. return result;
  16126. }
  16127. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16128. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16129. }
  16130. inline std::string PeerCert::serial() const {
  16131. return cert_ ? get_cert_serial(cert_) : std::string();
  16132. }
  16133. // VerifyContext method implementations
  16134. inline std::string VerifyContext::subject_cn() const {
  16135. return cert ? get_cert_subject_cn(cert) : std::string();
  16136. }
  16137. inline std::string VerifyContext::issuer_name() const {
  16138. return cert ? get_cert_issuer_name(cert) : std::string();
  16139. }
  16140. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16141. return cert ? verify_hostname(cert, hostname) : false;
  16142. }
  16143. inline std::vector<SanEntry> VerifyContext::sans() const {
  16144. std::vector<SanEntry> result;
  16145. if (cert) { get_cert_sans(cert, result); }
  16146. return result;
  16147. }
  16148. inline bool VerifyContext::validity(time_t &not_before,
  16149. time_t &not_after) const {
  16150. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16151. }
  16152. inline std::string VerifyContext::serial() const {
  16153. return cert ? get_cert_serial(cert) : std::string();
  16154. }
  16155. // TlsError static method implementation
  16156. inline std::string TlsError::verify_error_to_string(long error_code) {
  16157. return verify_error_string(error_code);
  16158. }
  16159. } // namespace tls
  16160. // Request::peer_cert() implementation
  16161. inline tls::PeerCert Request::peer_cert() const {
  16162. return tls::get_peer_cert_from_session(ssl);
  16163. }
  16164. // Request::sni() implementation
  16165. inline std::string Request::sni() const {
  16166. if (!ssl) { return std::string(); }
  16167. const char *s = tls::get_sni(ssl);
  16168. return s ? std::string(s) : std::string();
  16169. }
  16170. #endif // CPPHTTPLIB_SSL_ENABLED
  16171. /*
  16172. * Group 8: TLS abstraction layer - OpenSSL backend
  16173. */
  16174. /*
  16175. * OpenSSL Backend Implementation
  16176. */
  16177. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16178. namespace tls {
  16179. namespace impl {
  16180. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16181. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16182. switch (ssl_error) {
  16183. case SSL_ERROR_NONE: return ErrorCode::Success;
  16184. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16185. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16186. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16187. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16188. case SSL_ERROR_SSL:
  16189. default: return ErrorCode::Fatal;
  16190. }
  16191. }
  16192. // Helper: Create client CA list from PEM string
  16193. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16194. // Caller takes ownership of returned list
  16195. inline STACK_OF(X509_NAME) *
  16196. create_client_ca_list_from_pem(const char *ca_pem) {
  16197. if (!ca_pem) { return nullptr; }
  16198. auto ca_list = sk_X509_NAME_new_null();
  16199. if (!ca_list) { return nullptr; }
  16200. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16201. if (!bio) {
  16202. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16203. return nullptr;
  16204. }
  16205. X509 *cert = nullptr;
  16206. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16207. nullptr) {
  16208. const X509_NAME *name = X509_get_subject_name(cert);
  16209. if (name) {
  16210. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16211. }
  16212. X509_free(cert);
  16213. }
  16214. BIO_free(bio);
  16215. return ca_list;
  16216. }
  16217. // OpenSSL verify callback wrapper
  16218. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16219. auto &callback = get_verify_callback();
  16220. if (!callback) { return preverify_ok; }
  16221. // Get SSL object from X509_STORE_CTX
  16222. auto ssl = static_cast<SSL *>(
  16223. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16224. if (!ssl) { return preverify_ok; }
  16225. // Get current certificate and depth
  16226. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16227. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16228. int error = X509_STORE_CTX_get_error(ctx);
  16229. // Build context
  16230. VerifyContext verify_ctx;
  16231. verify_ctx.session = static_cast<session_t>(ssl);
  16232. verify_ctx.cert = static_cast<cert_t>(cert);
  16233. verify_ctx.depth = depth;
  16234. verify_ctx.preverify_ok = (preverify_ok != 0);
  16235. verify_ctx.error_code = error;
  16236. verify_ctx.error_string =
  16237. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16238. return callback(verify_ctx) ? 1 : 0;
  16239. }
  16240. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16241. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16242. // that must be released with release_store_objects
  16243. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16244. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16245. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16246. #endif
  16247. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16248. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16249. return X509_STORE_get1_objects(store);
  16250. #else
  16251. return X509_STORE_get0_objects(store);
  16252. #endif
  16253. }
  16254. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16255. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16256. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16257. #else
  16258. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16259. #endif
  16260. }
  16261. } // namespace impl
  16262. inline ctx_t create_client_context() {
  16263. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16264. if (ctx) {
  16265. // Disable auto-retry to properly handle non-blocking I/O
  16266. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16267. // Set minimum TLS version
  16268. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16269. }
  16270. return static_cast<ctx_t>(ctx);
  16271. }
  16272. inline void free_context(ctx_t ctx) {
  16273. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16274. }
  16275. inline bool set_min_version(ctx_t ctx, Version version) {
  16276. if (!ctx) return false;
  16277. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16278. static_cast<int>(version)) == 1;
  16279. }
  16280. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16281. if (!ctx || !pem || len == 0) return false;
  16282. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16283. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16284. if (!store) return false;
  16285. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16286. if (!bio) return false;
  16287. bool ok = true;
  16288. X509 *cert = nullptr;
  16289. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16290. nullptr) {
  16291. if (X509_STORE_add_cert(store, cert) != 1) {
  16292. // Ignore duplicate errors
  16293. auto err = ERR_peek_last_error();
  16294. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16295. ok = false;
  16296. }
  16297. }
  16298. X509_free(cert);
  16299. if (!ok) break;
  16300. }
  16301. BIO_free(bio);
  16302. // Clear any "no more certificates" errors
  16303. ERR_clear_error();
  16304. return ok;
  16305. }
  16306. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16307. if (!ctx || !file_path) return false;
  16308. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16309. nullptr) == 1;
  16310. }
  16311. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16312. if (!ctx || !dir_path) return false;
  16313. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16314. dir_path) == 1;
  16315. }
  16316. inline bool load_system_certs(ctx_t ctx) {
  16317. if (!ctx) return false;
  16318. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16319. #ifdef _WIN32
  16320. // Windows: Load from system certificate store (ROOT and CA)
  16321. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16322. if (!store) return false;
  16323. bool loaded_any = false;
  16324. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16325. for (auto store_name : store_names) {
  16326. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16327. if (!hStore) continue;
  16328. PCCERT_CONTEXT pContext = nullptr;
  16329. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16330. nullptr) {
  16331. const unsigned char *data = pContext->pbCertEncoded;
  16332. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16333. if (x509) {
  16334. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16335. X509_free(x509);
  16336. }
  16337. }
  16338. CertCloseStore(hStore, 0);
  16339. }
  16340. return loaded_any;
  16341. #elif defined(__APPLE__)
  16342. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16343. // macOS: Load from Keychain
  16344. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16345. if (!store) return false;
  16346. bool loaded_any = false;
  16347. const SecTrustSettingsDomain domains[] = {
  16348. kSecTrustSettingsDomainSystem,
  16349. kSecTrustSettingsDomainAdmin,
  16350. kSecTrustSettingsDomainUser,
  16351. };
  16352. for (auto domain : domains) {
  16353. CFArrayRef certs = nullptr;
  16354. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16355. !certs) {
  16356. if (certs) CFRelease(certs);
  16357. continue;
  16358. }
  16359. auto count = CFArrayGetCount(certs);
  16360. for (CFIndex i = 0; i < count; i++) {
  16361. auto cert = reinterpret_cast<SecCertificateRef>(
  16362. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16363. CFDataRef der = SecCertificateCopyData(cert);
  16364. if (der) {
  16365. const unsigned char *data = CFDataGetBytePtr(der);
  16366. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16367. if (x509) {
  16368. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16369. X509_free(x509);
  16370. }
  16371. CFRelease(der);
  16372. }
  16373. }
  16374. CFRelease(certs);
  16375. }
  16376. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16377. #else
  16378. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16379. #endif
  16380. #else
  16381. // Other Unix: use default verify paths
  16382. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16383. #endif
  16384. }
  16385. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16386. const char *password) {
  16387. if (!ctx || !cert || !key) return false;
  16388. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16389. // Load certificate
  16390. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16391. if (!cert_bio) return false;
  16392. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16393. BIO_free(cert_bio);
  16394. if (!x509) return false;
  16395. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16396. X509_free(x509);
  16397. if (!cert_ok) return false;
  16398. // Load private key
  16399. auto key_bio = BIO_new_mem_buf(key, -1);
  16400. if (!key_bio) return false;
  16401. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16402. password ? const_cast<char *>(password)
  16403. : nullptr);
  16404. BIO_free(key_bio);
  16405. if (!pkey) return false;
  16406. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16407. EVP_PKEY_free(pkey);
  16408. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16409. }
  16410. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16411. const char *key_path, const char *password) {
  16412. if (!ctx || !cert_path || !key_path) return false;
  16413. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16414. if (password && password[0] != '\0') {
  16415. SSL_CTX_set_default_passwd_cb_userdata(
  16416. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16417. }
  16418. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16419. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16420. }
  16421. inline ctx_t create_server_context() {
  16422. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16423. if (ctx) {
  16424. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16425. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16426. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16427. }
  16428. return static_cast<ctx_t>(ctx);
  16429. }
  16430. inline void set_verify_client(ctx_t ctx, bool require) {
  16431. if (!ctx) return;
  16432. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16433. require
  16434. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16435. : SSL_VERIFY_NONE,
  16436. nullptr);
  16437. }
  16438. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16439. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16440. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16441. SSL *ssl = SSL_new(ssl_ctx);
  16442. if (!ssl) return nullptr;
  16443. // Disable auto-retry for proper non-blocking I/O handling
  16444. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16445. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16446. if (!bio) {
  16447. SSL_free(ssl);
  16448. return nullptr;
  16449. }
  16450. SSL_set_bio(ssl, bio, bio);
  16451. return static_cast<session_t>(ssl);
  16452. }
  16453. inline void free_session(session_t session) {
  16454. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16455. }
  16456. inline bool set_sni(session_t session, const char *hostname,
  16457. bool /*verify_hostname*/) {
  16458. if (!session || !hostname) return false;
  16459. auto ssl = static_cast<SSL *>(session);
  16460. // Set SNI (Server Name Indication) only - does not enable verification.
  16461. // OpenSSL never binds identity checking to SNI (that happens post-
  16462. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16463. #if defined(OPENSSL_IS_BORINGSSL)
  16464. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16465. #else
  16466. // Direct call instead of macro to suppress -Wold-style-cast warning
  16467. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16468. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16469. #endif
  16470. }
  16471. inline TlsError connect(session_t session) {
  16472. if (!session) { return TlsError(); }
  16473. auto ssl = static_cast<SSL *>(session);
  16474. auto ret = SSL_connect(ssl);
  16475. TlsError err;
  16476. if (ret == 1) {
  16477. err.code = ErrorCode::Success;
  16478. } else {
  16479. auto ssl_err = SSL_get_error(ssl, ret);
  16480. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16481. err.backend_code = ERR_get_error();
  16482. }
  16483. return err;
  16484. }
  16485. inline TlsError accept(session_t session) {
  16486. if (!session) { return TlsError(); }
  16487. auto ssl = static_cast<SSL *>(session);
  16488. auto ret = SSL_accept(ssl);
  16489. TlsError err;
  16490. if (ret == 1) {
  16491. err.code = ErrorCode::Success;
  16492. } else {
  16493. auto ssl_err = SSL_get_error(ssl, ret);
  16494. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16495. err.backend_code = ERR_get_error();
  16496. }
  16497. return err;
  16498. }
  16499. inline bool connect_nonblocking(session_t session, socket_t sock,
  16500. time_t timeout_sec, time_t timeout_usec,
  16501. TlsError *err) {
  16502. if (!session) {
  16503. if (err) { err->code = ErrorCode::Fatal; }
  16504. return false;
  16505. }
  16506. auto ssl = static_cast<SSL *>(session);
  16507. auto bio = SSL_get_rbio(ssl);
  16508. // Set non-blocking mode for handshake
  16509. detail::set_nonblocking(sock, true);
  16510. if (bio) { BIO_set_nbio(bio, 1); }
  16511. auto cleanup = detail::scope_exit([&]() {
  16512. // Restore blocking mode after handshake
  16513. if (bio) { BIO_set_nbio(bio, 0); }
  16514. detail::set_nonblocking(sock, false);
  16515. });
  16516. auto res = 0;
  16517. while ((res = SSL_connect(ssl)) != 1) {
  16518. auto ssl_err = SSL_get_error(ssl, res);
  16519. switch (ssl_err) {
  16520. case SSL_ERROR_WANT_READ:
  16521. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16522. continue;
  16523. }
  16524. break;
  16525. case SSL_ERROR_WANT_WRITE:
  16526. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16527. continue;
  16528. }
  16529. break;
  16530. default: break;
  16531. }
  16532. if (err) {
  16533. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16534. err->backend_code = ERR_get_error();
  16535. }
  16536. return false;
  16537. }
  16538. if (err) { err->code = ErrorCode::Success; }
  16539. return true;
  16540. }
  16541. inline bool accept_nonblocking(session_t session, socket_t sock,
  16542. time_t timeout_sec, time_t timeout_usec,
  16543. TlsError *err) {
  16544. if (!session) {
  16545. if (err) { err->code = ErrorCode::Fatal; }
  16546. return false;
  16547. }
  16548. auto ssl = static_cast<SSL *>(session);
  16549. auto bio = SSL_get_rbio(ssl);
  16550. // Set non-blocking mode for handshake
  16551. detail::set_nonblocking(sock, true);
  16552. if (bio) { BIO_set_nbio(bio, 1); }
  16553. auto cleanup = detail::scope_exit([&]() {
  16554. // Restore blocking mode after handshake
  16555. if (bio) { BIO_set_nbio(bio, 0); }
  16556. detail::set_nonblocking(sock, false);
  16557. });
  16558. auto res = 0;
  16559. while ((res = SSL_accept(ssl)) != 1) {
  16560. auto ssl_err = SSL_get_error(ssl, res);
  16561. switch (ssl_err) {
  16562. case SSL_ERROR_WANT_READ:
  16563. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16564. continue;
  16565. }
  16566. break;
  16567. case SSL_ERROR_WANT_WRITE:
  16568. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16569. continue;
  16570. }
  16571. break;
  16572. default: break;
  16573. }
  16574. if (err) {
  16575. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16576. err->backend_code = ERR_get_error();
  16577. }
  16578. return false;
  16579. }
  16580. if (err) { err->code = ErrorCode::Success; }
  16581. return true;
  16582. }
  16583. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16584. if (!session || !buf) {
  16585. err.code = ErrorCode::Fatal;
  16586. return -1;
  16587. }
  16588. auto ssl = static_cast<SSL *>(session);
  16589. constexpr auto max_len =
  16590. static_cast<size_t>((std::numeric_limits<int>::max)());
  16591. if (len > max_len) { len = max_len; }
  16592. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16593. if (ret > 0) {
  16594. err.code = ErrorCode::Success;
  16595. return ret;
  16596. }
  16597. auto ssl_err = SSL_get_error(ssl, ret);
  16598. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16599. if (err.code == ErrorCode::PeerClosed) {
  16600. return 0;
  16601. } // Gracefully handle the peer closed state.
  16602. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16603. return -1;
  16604. }
  16605. inline ssize_t write(session_t session, const void *buf, size_t len,
  16606. TlsError &err) {
  16607. if (!session || !buf) {
  16608. err.code = ErrorCode::Fatal;
  16609. return -1;
  16610. }
  16611. auto ssl = static_cast<SSL *>(session);
  16612. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16613. if (ret > 0) {
  16614. err.code = ErrorCode::Success;
  16615. return ret;
  16616. }
  16617. auto ssl_err = SSL_get_error(ssl, ret);
  16618. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16619. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16620. return -1;
  16621. }
  16622. inline int pending(const_session_t session) {
  16623. if (!session) return 0;
  16624. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16625. }
  16626. inline void shutdown(session_t session, bool graceful) {
  16627. if (!session) return;
  16628. auto ssl = static_cast<SSL *>(session);
  16629. if (graceful) {
  16630. // Send close_notify without waiting for the peer's. The connection is
  16631. // closed right after this, so a unidirectional shutdown is enough, and an
  16632. // idle peer that never answers would otherwise hold this thread until the
  16633. // read timeout. The other backends do not wait either.
  16634. SSL_shutdown(ssl);
  16635. }
  16636. }
  16637. inline bool is_peer_closed(session_t session, socket_t sock) {
  16638. if (!session) return true;
  16639. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16640. detail::set_nonblocking(sock, true);
  16641. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16642. auto ssl = static_cast<SSL *>(session);
  16643. char buf;
  16644. auto ret = SSL_peek(ssl, &buf, 1);
  16645. if (ret > 0) return false;
  16646. auto err = SSL_get_error(ssl, ret);
  16647. return err == SSL_ERROR_ZERO_RETURN;
  16648. }
  16649. inline cert_t get_peer_cert(const_session_t session) {
  16650. if (!session) return nullptr;
  16651. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16652. static_cast<SSL *>(const_cast<void *>(session))));
  16653. }
  16654. inline size_t get_peer_certs(const_session_t session,
  16655. std::vector<cert_t> &certs) {
  16656. certs.clear();
  16657. if (!session) { return 0; }
  16658. auto ssl = static_cast<const SSL *>(session);
  16659. // On the server side, the chain leaves out the peer's own certificate
  16660. if (SSL_is_server(ssl)) {
  16661. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16662. }
  16663. auto sk = SSL_get_peer_cert_chain(ssl);
  16664. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16665. auto x509 = sk_X509_value(sk, i);
  16666. X509_up_ref(x509);
  16667. certs.push_back(static_cast<cert_t>(x509));
  16668. }
  16669. return certs.size();
  16670. }
  16671. inline void free_cert(cert_t cert) {
  16672. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16673. }
  16674. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16675. if (!cert || !hostname) return false;
  16676. auto x509 = static_cast<X509 *>(cert);
  16677. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16678. if (detail::is_ip_address(hostname)) {
  16679. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16680. }
  16681. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16682. }
  16683. inline uint64_t hostname_mismatch_code() {
  16684. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16685. }
  16686. inline long get_verify_result(const_session_t session) {
  16687. if (!session) return X509_V_ERR_UNSPECIFIED;
  16688. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16689. }
  16690. inline std::string get_cert_subject_cn(cert_t cert) {
  16691. if (!cert) return "";
  16692. auto x509 = static_cast<X509 *>(cert);
  16693. auto subject_name = X509_get_subject_name(x509);
  16694. if (!subject_name) return "";
  16695. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16696. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16697. if (idx < 0) return "";
  16698. auto entry = X509_NAME_get_entry(subject_name, idx);
  16699. if (!entry) return "";
  16700. auto data = X509_NAME_ENTRY_get_data(entry);
  16701. if (!data) return "";
  16702. return std::string(
  16703. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16704. static_cast<size_t>(ASN1_STRING_length(data)));
  16705. }
  16706. inline std::string get_cert_issuer_name(cert_t cert) {
  16707. if (!cert) return "";
  16708. auto x509 = static_cast<X509 *>(cert);
  16709. auto issuer_name = X509_get_issuer_name(x509);
  16710. if (!issuer_name) return "";
  16711. char buf[256];
  16712. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16713. return std::string(buf);
  16714. }
  16715. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16716. sans.clear();
  16717. if (!cert) return false;
  16718. auto x509 = static_cast<X509 *>(cert);
  16719. auto names = static_cast<GENERAL_NAMES *>(
  16720. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16721. if (!names) return true; // No SANs is valid
  16722. auto count = sk_GENERAL_NAME_num(names);
  16723. for (decltype(count) i = 0; i < count; i++) {
  16724. auto gen = sk_GENERAL_NAME_value(names, i);
  16725. if (!gen) continue;
  16726. SanEntry entry;
  16727. switch (gen->type) {
  16728. case GEN_DNS:
  16729. entry.type = SanType::DNS;
  16730. if (gen->d.dNSName) {
  16731. entry.value = std::string(
  16732. reinterpret_cast<const char *>(
  16733. ASN1_STRING_get0_data(gen->d.dNSName)),
  16734. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16735. }
  16736. break;
  16737. case GEN_IPADD:
  16738. entry.type = SanType::IP;
  16739. if (gen->d.iPAddress) {
  16740. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16741. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16742. if (len == 4) {
  16743. // IPv4
  16744. char buf[INET_ADDRSTRLEN];
  16745. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16746. entry.value = buf;
  16747. } else if (len == 16) {
  16748. // IPv6
  16749. char buf[INET6_ADDRSTRLEN];
  16750. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16751. entry.value = buf;
  16752. }
  16753. }
  16754. break;
  16755. case GEN_EMAIL:
  16756. entry.type = SanType::EMAIL;
  16757. if (gen->d.rfc822Name) {
  16758. entry.value = std::string(
  16759. reinterpret_cast<const char *>(
  16760. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16761. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16762. }
  16763. break;
  16764. case GEN_URI:
  16765. entry.type = SanType::URI;
  16766. if (gen->d.uniformResourceIdentifier) {
  16767. entry.value = std::string(
  16768. reinterpret_cast<const char *>(
  16769. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16770. static_cast<size_t>(
  16771. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16772. }
  16773. break;
  16774. default: entry.type = SanType::OTHER; break;
  16775. }
  16776. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16777. }
  16778. GENERAL_NAMES_free(names);
  16779. return true;
  16780. }
  16781. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16782. time_t &not_after) {
  16783. if (!cert) return false;
  16784. auto x509 = static_cast<X509 *>(cert);
  16785. auto nb = X509_get0_notBefore(x509);
  16786. auto na = X509_get0_notAfter(x509);
  16787. if (!nb || !na) return false;
  16788. ASN1_TIME *epoch = ASN1_TIME_new();
  16789. if (!epoch) return false;
  16790. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16791. if (!ASN1_TIME_set(epoch, 0)) return false;
  16792. int pday, psec;
  16793. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16794. not_before = 86400 * (time_t)pday + psec;
  16795. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16796. not_after = 86400 * (time_t)pday + psec;
  16797. return true;
  16798. }
  16799. inline std::string get_cert_serial(cert_t cert) {
  16800. if (!cert) return "";
  16801. auto x509 = static_cast<X509 *>(cert);
  16802. auto serial = X509_get_serialNumber(x509);
  16803. if (!serial) return "";
  16804. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16805. if (!bn) return "";
  16806. auto hex = BN_bn2hex(bn);
  16807. BN_free(bn);
  16808. if (!hex) return "";
  16809. std::string result(hex);
  16810. OPENSSL_free(hex);
  16811. return result;
  16812. }
  16813. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16814. if (!cert) return false;
  16815. auto x509 = static_cast<X509 *>(cert);
  16816. auto len = i2d_X509(x509, nullptr);
  16817. if (len < 0) return false;
  16818. der.resize(static_cast<size_t>(len));
  16819. auto p = der.data();
  16820. i2d_X509(x509, &p);
  16821. return true;
  16822. }
  16823. inline const char *get_sni(const_session_t session) {
  16824. if (!session) return nullptr;
  16825. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16826. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16827. }
  16828. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16829. inline uint64_t get_error() { return ERR_get_error(); }
  16830. inline std::string error_string(uint64_t code) {
  16831. char buf[256];
  16832. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16833. return std::string(buf);
  16834. }
  16835. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16836. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16837. if (!mem) { return nullptr; }
  16838. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16839. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16840. if (!inf) { return nullptr; }
  16841. auto store = X509_STORE_new();
  16842. if (store) {
  16843. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16844. auto itmp = sk_X509_INFO_value(inf, i);
  16845. if (!itmp) { continue; }
  16846. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16847. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16848. }
  16849. }
  16850. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16851. return static_cast<ca_store_t>(store);
  16852. }
  16853. inline void free_ca_store(ca_store_t store) {
  16854. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16855. }
  16856. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16857. if (!ctx || !store) { return false; }
  16858. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16859. auto x509_store = static_cast<X509_STORE *>(store);
  16860. // Check if same store is already set
  16861. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16862. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16863. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16864. return true;
  16865. }
  16866. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16867. certs.clear();
  16868. if (!ctx) { return 0; }
  16869. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16870. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16871. if (!store) { return 0; }
  16872. auto objs = impl::get_store_objects(store);
  16873. if (!objs) { return 0; }
  16874. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16875. auto count = sk_X509_OBJECT_num(objs);
  16876. for (decltype(count) i = 0; i < count; i++) {
  16877. auto obj = sk_X509_OBJECT_value(objs, i);
  16878. if (!obj) { continue; }
  16879. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16880. auto x509 = X509_OBJECT_get0_X509(obj);
  16881. if (x509) {
  16882. // Increment reference count so caller can free it
  16883. X509_up_ref(x509);
  16884. certs.push_back(static_cast<cert_t>(x509));
  16885. }
  16886. }
  16887. }
  16888. return certs.size();
  16889. }
  16890. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16891. std::vector<std::string> names;
  16892. if (!ctx) { return names; }
  16893. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16894. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16895. if (!store) { return names; }
  16896. auto objs = impl::get_store_objects(store);
  16897. if (!objs) { return names; }
  16898. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16899. auto count = sk_X509_OBJECT_num(objs);
  16900. for (decltype(count) i = 0; i < count; i++) {
  16901. auto obj = sk_X509_OBJECT_value(objs, i);
  16902. if (!obj) { continue; }
  16903. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16904. auto x509 = X509_OBJECT_get0_X509(obj);
  16905. if (x509) {
  16906. auto subject = X509_get_subject_name(x509);
  16907. if (subject) {
  16908. char buf[512];
  16909. X509_NAME_oneline(subject, buf, sizeof(buf));
  16910. names.push_back(buf);
  16911. }
  16912. }
  16913. }
  16914. }
  16915. return names;
  16916. }
  16917. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16918. const char *key_pem, const char *password) {
  16919. if (!ctx || !cert_pem || !key_pem) { return false; }
  16920. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16921. // Load certificate from PEM
  16922. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16923. if (!cert_bio) { return false; }
  16924. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16925. BIO_free(cert_bio);
  16926. if (!cert) { return false; }
  16927. // Load private key from PEM
  16928. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16929. if (!key_bio) {
  16930. X509_free(cert);
  16931. return false;
  16932. }
  16933. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16934. password ? const_cast<char *>(password)
  16935. : nullptr);
  16936. BIO_free(key_bio);
  16937. if (!key) {
  16938. X509_free(cert);
  16939. return false;
  16940. }
  16941. // Update certificate and key
  16942. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16943. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16944. X509_free(cert);
  16945. EVP_PKEY_free(key);
  16946. return ret;
  16947. }
  16948. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16949. if (!ctx || !ca_pem) { return false; }
  16950. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16951. // Create new X509_STORE from PEM
  16952. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16953. if (!store) { return false; }
  16954. // SSL_CTX_set_cert_store takes ownership
  16955. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16956. // Set client CA list for client certificate request
  16957. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16958. if (ca_list) {
  16959. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16960. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16961. }
  16962. return true;
  16963. }
  16964. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16965. if (!ctx) { return false; }
  16966. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16967. impl::get_verify_callback() = std::move(callback);
  16968. if (impl::get_verify_callback()) {
  16969. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16970. } else {
  16971. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16972. }
  16973. return true;
  16974. }
  16975. inline long get_verify_error(const_session_t session) {
  16976. if (!session) { return -1; }
  16977. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16978. return SSL_get_verify_result(ssl);
  16979. }
  16980. inline std::string verify_error_string(long error_code) {
  16981. if (error_code == X509_V_OK) { return ""; }
  16982. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16983. return str ? str : "unknown error";
  16984. }
  16985. } // namespace tls
  16986. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16987. /*
  16988. * Group 9: TLS abstraction layer - Mbed TLS backend
  16989. */
  16990. /*
  16991. * Mbed TLS Backend Implementation
  16992. */
  16993. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16994. namespace tls {
  16995. namespace impl {
  16996. // Mbed TLS session wrapper
  16997. struct MbedTlsSession {
  16998. mbedtls_ssl_context ssl;
  16999. socket_t sock = INVALID_SOCKET;
  17000. std::string hostname; // For client: set via set_sni
  17001. std::string sni_hostname; // For server: received from client via SNI callback
  17002. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17003. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17004. // (e.g. a response that arrived while this side was still in its post-write
  17005. // check), the byte is pushed back here and served by the next read().
  17006. unsigned char peeked_byte = 0;
  17007. bool has_peeked_byte = false;
  17008. // Set by set_sni() when the caller disabled hostname verification, so the
  17009. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17010. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17011. // OpenSSL and wolfSSL keep them independent).
  17012. bool suppress_hostname_mismatch = false;
  17013. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  17014. // decide which verify callback to install when hostname verification is
  17015. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  17016. // wired for this context, or a self-contained one otherwise, so a session
  17017. // that never opted into a callback never consults the process-wide
  17018. // set_verify_callback() slot (which some other, unrelated client may have
  17019. // populated).
  17020. bool has_verify_callback = false;
  17021. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17022. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17023. MbedTlsSession(const MbedTlsSession &) = delete;
  17024. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17025. };
  17026. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17027. // queue)
  17028. inline int &mbedtls_last_error() {
  17029. static thread_local int err = 0;
  17030. return err;
  17031. }
  17032. // Helper to map Mbed TLS error to ErrorCode
  17033. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17034. uint32_t verify_flags) {
  17035. if (ret == 0) { return ErrorCode::Success; }
  17036. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17037. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17038. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17039. return ErrorCode::PeerClosed;
  17040. }
  17041. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17042. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17043. out_errno = errno;
  17044. return ErrorCode::SyscallError;
  17045. }
  17046. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17047. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17048. // the handshake's chain verification (see set_sni()); a mismatch there
  17049. // is reported the same way as any other verify_flags bit. Report it as
  17050. // HostnameMismatch, matching the other backends and the post-handshake
  17051. // identity check below, but only when naming is the sole problem -
  17052. // if the chain itself is also untrusted/expired/etc., that takes
  17053. // priority over the naming detail.
  17054. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17055. return ErrorCode::HostnameMismatch;
  17056. }
  17057. return ErrorCode::CertVerifyFailed;
  17058. }
  17059. return ErrorCode::Fatal;
  17060. }
  17061. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17062. // return value, including the verify-flags-dependent HostnameMismatch
  17063. // mapping; shared by connect() and connect_nonblocking() so the
  17064. // backend_code policy for that mapping only lives in one place.
  17065. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17066. int ret) {
  17067. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17068. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17069. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17070. ? static_cast<uint64_t>(verify_flags)
  17071. : static_cast<uint64_t>(-ret);
  17072. }
  17073. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17074. // non-fatal notification delivered between records, not an error and not
  17075. // application data, so I/O calls that see it should just be retried. Kept in
  17076. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17077. // splitting the closing brace across an #if.
  17078. inline bool mbedtls_is_session_ticket(int ret) {
  17079. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17080. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17081. #else
  17082. (void)ret;
  17083. return false;
  17084. #endif
  17085. }
  17086. // BIO-like send callback for Mbed TLS
  17087. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17088. size_t len) {
  17089. auto sock = *static_cast<socket_t *>(ctx);
  17090. #ifdef _WIN32
  17091. auto ret =
  17092. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17093. if (ret == SOCKET_ERROR) {
  17094. int err = WSAGetLastError();
  17095. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17096. return MBEDTLS_ERR_NET_SEND_FAILED;
  17097. }
  17098. #else
  17099. auto ret = send(sock, buf, len, 0);
  17100. if (ret < 0) {
  17101. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17102. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17103. }
  17104. return MBEDTLS_ERR_NET_SEND_FAILED;
  17105. }
  17106. #endif
  17107. return static_cast<int>(ret);
  17108. }
  17109. // BIO-like recv callback for Mbed TLS
  17110. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17111. auto sock = *static_cast<socket_t *>(ctx);
  17112. #ifdef _WIN32
  17113. auto ret =
  17114. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17115. if (ret == SOCKET_ERROR) {
  17116. int err = WSAGetLastError();
  17117. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17118. return MBEDTLS_ERR_NET_RECV_FAILED;
  17119. }
  17120. #else
  17121. auto ret = recv(sock, buf, len, 0);
  17122. if (ret < 0) {
  17123. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17124. return MBEDTLS_ERR_SSL_WANT_READ;
  17125. }
  17126. return MBEDTLS_ERR_NET_RECV_FAILED;
  17127. }
  17128. #endif
  17129. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17130. return static_cast<int>(ret);
  17131. }
  17132. // MbedTlsContext constructor/destructor implementations
  17133. inline MbedTlsContext::MbedTlsContext() {
  17134. mbedtls_ssl_config_init(&conf);
  17135. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17136. mbedtls_entropy_init(&entropy);
  17137. mbedtls_ctr_drbg_init(&ctr_drbg);
  17138. #endif
  17139. mbedtls_x509_crt_init(&ca_chain);
  17140. mbedtls_x509_crt_init(&own_cert);
  17141. mbedtls_pk_init(&own_key);
  17142. }
  17143. inline MbedTlsContext::~MbedTlsContext() {
  17144. mbedtls_pk_free(&own_key);
  17145. mbedtls_x509_crt_free(&own_cert);
  17146. mbedtls_x509_crt_free(&ca_chain);
  17147. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17148. mbedtls_ctr_drbg_free(&ctr_drbg);
  17149. mbedtls_entropy_free(&entropy);
  17150. #endif
  17151. mbedtls_ssl_config_free(&conf);
  17152. }
  17153. // Thread-local storage for SNI captured during handshake
  17154. // This is needed because the SNI callback doesn't have a way to pass
  17155. // session-specific data before the session is fully set up
  17156. inline std::string &mbedpending_sni() {
  17157. static thread_local std::string sni;
  17158. return sni;
  17159. }
  17160. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17161. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17162. const unsigned char *name, size_t name_len) {
  17163. (void)p_ctx;
  17164. (void)ssl;
  17165. // Store SNI name in thread-local storage
  17166. // It will be retrieved and stored in the session after handshake
  17167. if (name && name_len > 0) {
  17168. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17169. } else {
  17170. mbedpending_sni().clear();
  17171. }
  17172. return 0; // Accept any SNI
  17173. }
  17174. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17175. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17176. }
  17177. // Verify callback used when hostname verification is disabled for a session
  17178. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17179. // has_verify_callback is false). Deliberately does not consult
  17180. // get_verify_callback(): that slot is process-wide, so reading it here would
  17181. // pick up whatever another, unrelated client last installed there.
  17182. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17183. mbedtls_x509_crt *, int,
  17184. uint32_t *flags) {
  17185. (void)data;
  17186. mbedtls_clear_cn_mismatch(flags);
  17187. return 0;
  17188. }
  17189. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17190. int cert_depth, uint32_t *flags);
  17191. // MbedTLS verify callback wrapper
  17192. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17193. int cert_depth, uint32_t *flags) {
  17194. // data points to the MbedTlsSession
  17195. auto *session = static_cast<MbedTlsSession *>(data);
  17196. // set_sni() disabled hostname verification for this session: drop the
  17197. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17198. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17199. // SNI. The final pass/fail decision still comes from the remaining flags
  17200. // (or, below, from the user's own verify callback).
  17201. if (session && session->suppress_hostname_mismatch) {
  17202. mbedtls_clear_cn_mismatch(flags);
  17203. }
  17204. auto &callback = get_verify_callback();
  17205. if (!callback) { return 0; } // Continue with default verification
  17206. // Build context
  17207. VerifyContext verify_ctx;
  17208. verify_ctx.session = static_cast<session_t>(session);
  17209. verify_ctx.cert = static_cast<cert_t>(crt);
  17210. verify_ctx.depth = cert_depth;
  17211. verify_ctx.preverify_ok = (*flags == 0);
  17212. verify_ctx.error_code = static_cast<long>(*flags);
  17213. // Convert Mbed TLS flags to error string
  17214. static thread_local char error_buf[256];
  17215. if (*flags != 0) {
  17216. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17217. verify_ctx.error_string = error_buf;
  17218. } else {
  17219. verify_ctx.error_string = nullptr;
  17220. }
  17221. bool accepted = callback(verify_ctx);
  17222. if (accepted) {
  17223. *flags = 0; // Clear all error flags
  17224. return 0;
  17225. }
  17226. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17227. }
  17228. } // namespace impl
  17229. inline ctx_t create_client_context() {
  17230. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17231. if (!ctx) { return nullptr; }
  17232. ctx->is_server = false;
  17233. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17234. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17235. if (!detail::ensure_mbedtls_psa_crypto()) {
  17236. delete ctx;
  17237. return nullptr;
  17238. }
  17239. int ret;
  17240. #else
  17241. // Seed the random number generator
  17242. const char *pers = "httplib_client";
  17243. int ret = mbedtls_ctr_drbg_seed(
  17244. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17245. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17246. if (ret != 0) {
  17247. impl::mbedtls_last_error() = ret;
  17248. delete ctx;
  17249. return nullptr;
  17250. }
  17251. #endif
  17252. // Set up SSL config for client
  17253. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17254. MBEDTLS_SSL_TRANSPORT_STREAM,
  17255. MBEDTLS_SSL_PRESET_DEFAULT);
  17256. if (ret != 0) {
  17257. impl::mbedtls_last_error() = ret;
  17258. delete ctx;
  17259. return nullptr;
  17260. }
  17261. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17262. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17263. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17264. #endif
  17265. // Default: verify peer certificate
  17266. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17267. // Set minimum TLS version to 1.2
  17268. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17269. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17270. #else
  17271. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17272. MBEDTLS_SSL_MINOR_VERSION_3);
  17273. #endif
  17274. return static_cast<ctx_t>(ctx);
  17275. }
  17276. inline ctx_t create_server_context() {
  17277. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17278. if (!ctx) { return nullptr; }
  17279. ctx->is_server = true;
  17280. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17281. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17282. if (!detail::ensure_mbedtls_psa_crypto()) {
  17283. delete ctx;
  17284. return nullptr;
  17285. }
  17286. int ret;
  17287. #else
  17288. // Seed the random number generator
  17289. const char *pers = "httplib_server";
  17290. int ret = mbedtls_ctr_drbg_seed(
  17291. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17292. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17293. if (ret != 0) {
  17294. impl::mbedtls_last_error() = ret;
  17295. delete ctx;
  17296. return nullptr;
  17297. }
  17298. #endif
  17299. // Set up SSL config for server
  17300. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17301. MBEDTLS_SSL_TRANSPORT_STREAM,
  17302. MBEDTLS_SSL_PRESET_DEFAULT);
  17303. if (ret != 0) {
  17304. impl::mbedtls_last_error() = ret;
  17305. delete ctx;
  17306. return nullptr;
  17307. }
  17308. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17309. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17310. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17311. #endif
  17312. // Default: don't verify client
  17313. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17314. // Set minimum TLS version to 1.2
  17315. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17316. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17317. #else
  17318. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17319. MBEDTLS_SSL_MINOR_VERSION_3);
  17320. #endif
  17321. // Set SNI callback to capture client's SNI hostname
  17322. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17323. return static_cast<ctx_t>(ctx);
  17324. }
  17325. inline void free_context(ctx_t ctx) {
  17326. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17327. }
  17328. inline bool set_min_version(ctx_t ctx, Version version) {
  17329. if (!ctx) { return false; }
  17330. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17331. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17332. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17333. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17334. if (version >= Version::TLS1_3) {
  17335. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17336. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17337. #endif
  17338. }
  17339. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17340. #else
  17341. // Mbed TLS 2.x uses major/minor version numbers
  17342. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17343. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17344. if (version >= Version::TLS1_3) {
  17345. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17346. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17347. #else
  17348. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17349. #endif
  17350. }
  17351. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17352. #endif
  17353. return true;
  17354. }
  17355. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17356. if (!ctx || !pem) { return false; }
  17357. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17358. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17359. // Add null terminator if not present
  17360. std::string pem_str(pem, len);
  17361. int ret = mbedtls_x509_crt_parse(
  17362. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17363. pem_str.size() + 1);
  17364. if (ret != 0) {
  17365. impl::mbedtls_last_error() = ret;
  17366. return false;
  17367. }
  17368. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17369. return true;
  17370. }
  17371. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17372. if (!ctx || !file_path) { return false; }
  17373. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17374. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17375. if (ret != 0) {
  17376. impl::mbedtls_last_error() = ret;
  17377. return false;
  17378. }
  17379. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17380. return true;
  17381. }
  17382. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17383. if (!ctx || !dir_path) { return false; }
  17384. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17385. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17386. if (ret < 0) { // Returns number of certs on success, negative on error
  17387. impl::mbedtls_last_error() = ret;
  17388. return false;
  17389. }
  17390. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17391. return true;
  17392. }
  17393. inline bool load_system_certs(ctx_t ctx) {
  17394. if (!ctx) { return false; }
  17395. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17396. bool loaded = false;
  17397. #ifdef _WIN32
  17398. loaded = impl::enumerate_windows_system_certs(
  17399. [&](const unsigned char *data, size_t len) {
  17400. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17401. });
  17402. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17403. loaded = impl::enumerate_macos_keychain_certs(
  17404. [&](const unsigned char *data, size_t len) {
  17405. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17406. });
  17407. #else
  17408. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17409. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17410. loaded = true;
  17411. break;
  17412. }
  17413. }
  17414. if (!loaded) {
  17415. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17416. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17417. loaded = true;
  17418. break;
  17419. }
  17420. }
  17421. }
  17422. #endif
  17423. if (loaded) {
  17424. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17425. }
  17426. return loaded;
  17427. }
  17428. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17429. const char *password) {
  17430. if (!ctx || !cert || !key) { return false; }
  17431. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17432. // Parse certificate
  17433. std::string cert_str(cert);
  17434. int ret = mbedtls_x509_crt_parse(
  17435. &mctx->own_cert,
  17436. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17437. cert_str.size() + 1);
  17438. if (ret != 0) {
  17439. impl::mbedtls_last_error() = ret;
  17440. return false;
  17441. }
  17442. // Parse private key
  17443. std::string key_str(key);
  17444. const unsigned char *pwd =
  17445. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17446. size_t pwd_len = password ? strlen(password) : 0;
  17447. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17448. ret = mbedtls_pk_parse_key(
  17449. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17450. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17451. &mctx->ctr_drbg);
  17452. #else
  17453. ret = mbedtls_pk_parse_key(
  17454. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17455. key_str.size() + 1, pwd, pwd_len);
  17456. #endif
  17457. if (ret != 0) {
  17458. impl::mbedtls_last_error() = ret;
  17459. return false;
  17460. }
  17461. // Verify that the certificate and private key match.
  17462. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17463. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17464. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17465. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17466. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17467. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17468. #else
  17469. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17470. #endif
  17471. if (ret != 0) {
  17472. impl::mbedtls_last_error() = ret;
  17473. return false;
  17474. }
  17475. #endif
  17476. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17477. if (ret != 0) {
  17478. impl::mbedtls_last_error() = ret;
  17479. return false;
  17480. }
  17481. return true;
  17482. }
  17483. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17484. const char *key_path, const char *password) {
  17485. if (!ctx || !cert_path || !key_path) { return false; }
  17486. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17487. // Parse certificate file
  17488. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17489. if (ret != 0) {
  17490. impl::mbedtls_last_error() = ret;
  17491. return false;
  17492. }
  17493. // Parse private key file
  17494. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17495. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17496. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17497. #else
  17498. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17499. #endif
  17500. if (ret != 0) {
  17501. impl::mbedtls_last_error() = ret;
  17502. return false;
  17503. }
  17504. // Verify that the certificate and private key match.
  17505. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17506. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17507. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17508. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17509. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17510. #else
  17511. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17512. #endif
  17513. if (ret != 0) {
  17514. impl::mbedtls_last_error() = ret;
  17515. return false;
  17516. }
  17517. #endif
  17518. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17519. if (ret != 0) {
  17520. impl::mbedtls_last_error() = ret;
  17521. return false;
  17522. }
  17523. return true;
  17524. }
  17525. inline void set_verify_client(ctx_t ctx, bool require) {
  17526. if (!ctx) { return; }
  17527. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17528. mctx->verify_client = require;
  17529. if (require) {
  17530. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17531. } else {
  17532. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17533. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17534. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17535. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17536. : MBEDTLS_SSL_VERIFY_NONE);
  17537. }
  17538. }
  17539. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17540. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17541. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17542. auto session = new (std::nothrow) impl::MbedTlsSession();
  17543. if (!session) { return nullptr; }
  17544. session->sock = sock;
  17545. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17546. if (ret != 0) {
  17547. impl::mbedtls_last_error() = ret;
  17548. delete session;
  17549. return nullptr;
  17550. }
  17551. // Explicitly opt out of in-handshake hostname verification by default;
  17552. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17553. // fails outright when no hostname was set. set_sni() installs the real
  17554. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17555. // caller verifies the certificate identity post-handshake via
  17556. // verify_hostname().
  17557. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17558. // Set BIO callbacks
  17559. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17560. impl::mbedtls_net_recv_cb, nullptr);
  17561. // Set per-session verify callback with session pointer if callback is
  17562. // registered
  17563. session->has_verify_callback = mctx->has_verify_callback;
  17564. if (mctx->has_verify_callback) {
  17565. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17566. session);
  17567. }
  17568. return static_cast<session_t>(session);
  17569. }
  17570. inline void free_session(session_t session) {
  17571. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17572. }
  17573. inline bool set_sni(session_t session, const char *hostname,
  17574. bool verify_hostname) {
  17575. if (!session || !hostname) { return false; }
  17576. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17577. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17578. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17579. // independently, so a disabled hostname check is handled below by masking
  17580. // the resulting mismatch flag instead of skipping this call.
  17581. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17582. if (ret != 0) {
  17583. impl::mbedtls_last_error() = ret;
  17584. return false;
  17585. }
  17586. msession->hostname = hostname;
  17587. if (!verify_hostname) {
  17588. msession->suppress_hostname_mismatch = true;
  17589. // If a user verify callback is already wired for this session,
  17590. // mbedtls_verify_callback() masks the mismatch flag itself before
  17591. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17592. // here would be redundant. Otherwise install the self-contained masking
  17593. // callback, which never touches the process-wide callback slot.
  17594. if (!msession->has_verify_callback) {
  17595. mbedtls_ssl_set_verify(&msession->ssl,
  17596. impl::mbedtls_mask_hostname_mismatch_callback,
  17597. msession);
  17598. }
  17599. }
  17600. return true;
  17601. }
  17602. inline TlsError connect(session_t session) {
  17603. TlsError err;
  17604. if (!session) {
  17605. err.code = ErrorCode::Fatal;
  17606. return err;
  17607. }
  17608. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17609. int ret;
  17610. do {
  17611. ret = mbedtls_ssl_handshake(&msession->ssl);
  17612. } while (impl::mbedtls_is_session_ticket(ret));
  17613. if (ret == 0) {
  17614. err.code = ErrorCode::Success;
  17615. } else {
  17616. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17617. impl::mbedtls_last_error() = ret;
  17618. }
  17619. return err;
  17620. }
  17621. inline TlsError accept(session_t session) {
  17622. // Same as connect for Mbed TLS - handshake works for both client and server
  17623. auto result = connect(session);
  17624. // After successful handshake, capture SNI from thread-local storage
  17625. if (result.code == ErrorCode::Success && session) {
  17626. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17627. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17628. impl::mbedpending_sni().clear();
  17629. }
  17630. return result;
  17631. }
  17632. inline bool connect_nonblocking(session_t session, socket_t sock,
  17633. time_t timeout_sec, time_t timeout_usec,
  17634. TlsError *err) {
  17635. if (!session) {
  17636. if (err) { err->code = ErrorCode::Fatal; }
  17637. return false;
  17638. }
  17639. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17640. // Set socket to non-blocking mode
  17641. detail::set_nonblocking(sock, true);
  17642. auto cleanup =
  17643. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17644. int ret;
  17645. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17646. // Non-fatal TLS 1.3 ticket; retry immediately.
  17647. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17648. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17649. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17650. continue;
  17651. }
  17652. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17653. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17654. continue;
  17655. }
  17656. }
  17657. // TlsError or timeout
  17658. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17659. impl::mbedtls_last_error() = ret;
  17660. return false;
  17661. }
  17662. if (err) { err->code = ErrorCode::Success; }
  17663. return true;
  17664. }
  17665. inline bool accept_nonblocking(session_t session, socket_t sock,
  17666. time_t timeout_sec, time_t timeout_usec,
  17667. TlsError *err) {
  17668. // Same implementation as connect for Mbed TLS
  17669. bool result =
  17670. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17671. // After successful handshake, capture SNI from thread-local storage
  17672. if (result && session) {
  17673. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17674. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17675. impl::mbedpending_sni().clear();
  17676. }
  17677. return result;
  17678. }
  17679. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17680. if (!session || !buf) {
  17681. err.code = ErrorCode::Fatal;
  17682. return -1;
  17683. }
  17684. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17685. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17686. if (msession->has_peeked_byte) {
  17687. if (len == 0) { return 0; }
  17688. auto p = static_cast<unsigned char *>(buf);
  17689. p[0] = msession->peeked_byte;
  17690. msession->has_peeked_byte = false;
  17691. size_t n = 1;
  17692. // Top up with any already-decrypted bytes without risking a block.
  17693. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17694. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17695. if (extra > 0) { n += static_cast<size_t>(extra); }
  17696. }
  17697. err.code = ErrorCode::Success;
  17698. return static_cast<ssize_t>(n);
  17699. }
  17700. int ret;
  17701. do {
  17702. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17703. len);
  17704. } while (impl::mbedtls_is_session_ticket(ret));
  17705. if (ret > 0) {
  17706. err.code = ErrorCode::Success;
  17707. return static_cast<ssize_t>(ret);
  17708. }
  17709. if (ret == 0) {
  17710. err.code = ErrorCode::PeerClosed;
  17711. return 0;
  17712. }
  17713. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17714. err.backend_code = static_cast<uint64_t>(-ret);
  17715. impl::mbedtls_last_error() = ret;
  17716. // mbedTLS signals a clean close_notify via a negative error code rather
  17717. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17718. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17719. return -1;
  17720. }
  17721. inline ssize_t write(session_t session, const void *buf, size_t len,
  17722. TlsError &err) {
  17723. if (!session || !buf) {
  17724. err.code = ErrorCode::Fatal;
  17725. return -1;
  17726. }
  17727. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17728. int ret;
  17729. do {
  17730. ret = mbedtls_ssl_write(&msession->ssl,
  17731. static_cast<const unsigned char *>(buf), len);
  17732. } while (impl::mbedtls_is_session_ticket(ret));
  17733. if (ret > 0) {
  17734. err.code = ErrorCode::Success;
  17735. return static_cast<ssize_t>(ret);
  17736. }
  17737. if (ret == 0) {
  17738. err.code = ErrorCode::PeerClosed;
  17739. return 0;
  17740. }
  17741. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17742. err.backend_code = static_cast<uint64_t>(-ret);
  17743. impl::mbedtls_last_error() = ret;
  17744. return -1;
  17745. }
  17746. inline int pending(const_session_t session) {
  17747. if (!session) { return 0; }
  17748. auto msession =
  17749. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17750. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17751. (msession->has_peeked_byte ? 1 : 0);
  17752. }
  17753. inline void shutdown(session_t session, bool graceful) {
  17754. if (!session) { return; }
  17755. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17756. if (graceful) {
  17757. // Try to send close_notify, but don't block forever
  17758. int ret;
  17759. int attempts = 0;
  17760. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17761. attempts < 3) {
  17762. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17763. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17764. break;
  17765. }
  17766. attempts++;
  17767. }
  17768. }
  17769. }
  17770. inline bool is_peer_closed(session_t session, socket_t sock) {
  17771. if (!session || sock == INVALID_SOCKET) { return true; }
  17772. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17773. // Check if there's already decrypted or pushed-back data available.
  17774. // If so, the connection is definitely alive.
  17775. if (msession->has_peeked_byte ||
  17776. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17777. return false;
  17778. }
  17779. // Set socket to non-blocking to avoid blocking on read
  17780. detail::set_nonblocking(sock, true);
  17781. auto cleanup =
  17782. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17783. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17784. // on application data — e.g. a response that already arrived — push the
  17785. // byte back so the next read() delivers it instead of losing it.
  17786. unsigned char buf;
  17787. int ret;
  17788. do {
  17789. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17790. } while (impl::mbedtls_is_session_ticket(ret));
  17791. // If we got data or WANT_READ (would block), connection is alive
  17792. if (ret > 0) {
  17793. msession->peeked_byte = buf;
  17794. msession->has_peeked_byte = true;
  17795. return false;
  17796. }
  17797. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17798. // If we get a peer close notify or a connection reset, the peer is closed
  17799. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17800. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17801. }
  17802. inline cert_t get_peer_cert(const_session_t session) {
  17803. if (!session) { return nullptr; }
  17804. auto msession =
  17805. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17806. // Mbed TLS returns a pointer to the internal peer cert chain.
  17807. // WARNING: This pointer is only valid while the session is active.
  17808. // Do not use the certificate after calling free_session().
  17809. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17810. return const_cast<mbedtls_x509_crt *>(cert);
  17811. }
  17812. inline size_t get_peer_certs(const_session_t session,
  17813. std::vector<cert_t> &certs) {
  17814. certs.clear();
  17815. // Mbed TLS parses the whole received chain into a list headed by the peer
  17816. // certificate, owned by the session like get_peer_cert()'s result
  17817. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  17818. crt && crt->raw.len > 0; crt = crt->next) {
  17819. certs.push_back(static_cast<cert_t>(crt));
  17820. }
  17821. return certs.size();
  17822. }
  17823. inline void free_cert(cert_t cert) {
  17824. // Mbed TLS: peer certificate is owned by the SSL context.
  17825. // No-op here, but callers should still call this for cross-backend
  17826. // portability.
  17827. (void)cert;
  17828. }
  17829. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17830. if (!cert || !hostname) { return false; }
  17831. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17832. std::string host_str(hostname);
  17833. // Check if hostname is an IP address (IPv4 or IPv6)
  17834. unsigned char ip_bytes[16];
  17835. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17836. auto is_ip = ip_len > 0;
  17837. // Check Subject Alternative Names (SAN)
  17838. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17839. // - DNS names: raw string bytes
  17840. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17841. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17842. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17843. const unsigned char *p = san->buf.p;
  17844. size_t len = san->buf.len;
  17845. if (is_ip) {
  17846. // For an IP host, only a matching iPAddress SAN of the same family
  17847. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17848. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17849. } else {
  17850. // Check if this SAN is a DNS name (printable ASCII string)
  17851. bool is_dns = len > 0;
  17852. for (size_t i = 0; i < len && is_dns; i++) {
  17853. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17854. }
  17855. if (is_dns) {
  17856. std::string san_name(reinterpret_cast<const char *>(p), len);
  17857. if (detail::match_hostname(san_name, host_str)) { return true; }
  17858. }
  17859. }
  17860. san = san->next;
  17861. }
  17862. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17863. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17864. // the OpenSSL backend's X509_check_ip behaves the same way).
  17865. if (!is_ip) {
  17866. char cn[256];
  17867. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17868. if (ret > 0) {
  17869. std::string cn_str(cn);
  17870. // Look for "CN=" in the DN string
  17871. size_t cn_pos = cn_str.find("CN=");
  17872. if (cn_pos != std::string::npos) {
  17873. size_t start = cn_pos + 3;
  17874. size_t end = cn_str.find(',', start);
  17875. std::string cn_value =
  17876. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17877. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17878. }
  17879. }
  17880. }
  17881. return false;
  17882. }
  17883. inline uint64_t hostname_mismatch_code() {
  17884. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17885. }
  17886. inline long get_verify_result(const_session_t session) {
  17887. if (!session) { return -1; }
  17888. auto msession =
  17889. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17890. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17891. // Return 0 (X509_V_OK equivalent) if verification passed
  17892. return flags == 0 ? 0 : static_cast<long>(flags);
  17893. }
  17894. inline std::string get_cert_subject_cn(cert_t cert) {
  17895. if (!cert) return "";
  17896. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17897. // Find the CN in the subject
  17898. const mbedtls_x509_name *name = &x509->subject;
  17899. while (name != nullptr) {
  17900. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17901. return std::string(reinterpret_cast<const char *>(name->val.p),
  17902. name->val.len);
  17903. }
  17904. name = name->next;
  17905. }
  17906. return "";
  17907. }
  17908. inline std::string get_cert_issuer_name(cert_t cert) {
  17909. if (!cert) return "";
  17910. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17911. // Build a human-readable issuer name string
  17912. char buf[512];
  17913. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17914. if (ret < 0) return "";
  17915. return std::string(buf);
  17916. }
  17917. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17918. sans.clear();
  17919. if (!cert) return false;
  17920. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17921. // Parse the Subject Alternative Name extension
  17922. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17923. while (cur != nullptr) {
  17924. if (cur->buf.len > 0) {
  17925. // Mbed TLS stores SAN as ASN.1 sequences
  17926. // The tag byte indicates the type
  17927. const unsigned char *p = cur->buf.p;
  17928. size_t len = cur->buf.len;
  17929. // First byte is the tag
  17930. unsigned char tag = *p;
  17931. p++;
  17932. len--;
  17933. // Parse length (simple single-byte length assumed)
  17934. if (len > 0 && *p < 0x80) {
  17935. size_t value_len = *p;
  17936. p++;
  17937. len--;
  17938. if (value_len <= len) {
  17939. SanEntry entry;
  17940. // ASN.1 context tags for GeneralName
  17941. switch (tag & 0x1F) {
  17942. case 2: // dNSName
  17943. entry.type = SanType::DNS;
  17944. entry.value =
  17945. std::string(reinterpret_cast<const char *>(p), value_len);
  17946. break;
  17947. case 7: // iPAddress
  17948. entry.type = SanType::IP;
  17949. if (value_len == 4) {
  17950. // IPv4
  17951. char buf[16];
  17952. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17953. entry.value = buf;
  17954. } else if (value_len == 16) {
  17955. // IPv6
  17956. char buf[64];
  17957. snprintf(buf, sizeof(buf),
  17958. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17959. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17960. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17961. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17962. entry.value = buf;
  17963. }
  17964. break;
  17965. case 1: // rfc822Name (email)
  17966. entry.type = SanType::EMAIL;
  17967. entry.value =
  17968. std::string(reinterpret_cast<const char *>(p), value_len);
  17969. break;
  17970. case 6: // uniformResourceIdentifier
  17971. entry.type = SanType::URI;
  17972. entry.value =
  17973. std::string(reinterpret_cast<const char *>(p), value_len);
  17974. break;
  17975. default: entry.type = SanType::OTHER; break;
  17976. }
  17977. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17978. }
  17979. }
  17980. }
  17981. cur = cur->next;
  17982. }
  17983. return true;
  17984. }
  17985. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17986. time_t &not_after) {
  17987. if (!cert) return false;
  17988. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17989. // Convert mbedtls_x509_time to time_t
  17990. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17991. struct tm tm_time = {};
  17992. tm_time.tm_year = t.year - 1900;
  17993. tm_time.tm_mon = t.mon - 1;
  17994. tm_time.tm_mday = t.day;
  17995. tm_time.tm_hour = t.hour;
  17996. tm_time.tm_min = t.min;
  17997. tm_time.tm_sec = t.sec;
  17998. #ifdef _WIN32
  17999. return _mkgmtime(&tm_time);
  18000. #else
  18001. return timegm(&tm_time);
  18002. #endif
  18003. };
  18004. not_before = to_time_t(x509->valid_from);
  18005. not_after = to_time_t(x509->valid_to);
  18006. return true;
  18007. }
  18008. inline std::string get_cert_serial(cert_t cert) {
  18009. if (!cert) return "";
  18010. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18011. // Convert serial number to hex string
  18012. std::string result;
  18013. result.reserve(x509->serial.len * 2);
  18014. for (size_t i = 0; i < x509->serial.len; i++) {
  18015. char hex[3];
  18016. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18017. result += hex;
  18018. }
  18019. return result;
  18020. }
  18021. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18022. if (!cert) return false;
  18023. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18024. if (!crt->raw.p || crt->raw.len == 0) return false;
  18025. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18026. return true;
  18027. }
  18028. inline const char *get_sni(const_session_t session) {
  18029. if (!session) return nullptr;
  18030. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18031. // For server: return SNI received from client during handshake
  18032. if (!msession->sni_hostname.empty()) {
  18033. return msession->sni_hostname.c_str();
  18034. }
  18035. // For client: return the hostname set via set_sni
  18036. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18037. return nullptr;
  18038. }
  18039. inline uint64_t peek_error() {
  18040. // Mbed TLS doesn't have an error queue, return the last error
  18041. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18042. }
  18043. inline uint64_t get_error() {
  18044. // Mbed TLS doesn't have an error queue, return and clear the last error
  18045. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18046. impl::mbedtls_last_error() = 0;
  18047. return err;
  18048. }
  18049. inline std::string error_string(uint64_t code) {
  18050. char buf[256];
  18051. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18052. return std::string(buf);
  18053. }
  18054. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18055. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18056. if (!ca_chain) { return nullptr; }
  18057. mbedtls_x509_crt_init(ca_chain);
  18058. // mbedtls_x509_crt_parse expects null-terminated PEM
  18059. int ret = mbedtls_x509_crt_parse(ca_chain,
  18060. reinterpret_cast<const unsigned char *>(pem),
  18061. len + 1); // +1 for null terminator
  18062. if (ret != 0) {
  18063. // Try without +1 in case PEM is already null-terminated
  18064. ret = mbedtls_x509_crt_parse(
  18065. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18066. if (ret != 0) {
  18067. mbedtls_x509_crt_free(ca_chain);
  18068. delete ca_chain;
  18069. return nullptr;
  18070. }
  18071. }
  18072. return static_cast<ca_store_t>(ca_chain);
  18073. }
  18074. inline void free_ca_store(ca_store_t store) {
  18075. if (store) {
  18076. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18077. mbedtls_x509_crt_free(ca_chain);
  18078. delete ca_chain;
  18079. }
  18080. }
  18081. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18082. if (!ctx || !store) { return false; }
  18083. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18084. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18085. // Free existing CA chain
  18086. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18087. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18088. // Copy the CA chain (deep copy)
  18089. // Parse from the raw data of the source cert
  18090. mbedtls_x509_crt *src = ca_chain;
  18091. while (src != nullptr) {
  18092. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18093. src->raw.len);
  18094. if (ret != 0) {
  18095. free_ca_store(store);
  18096. return false;
  18097. }
  18098. src = src->next;
  18099. }
  18100. // This function takes ownership of the store; the chain was deep-copied
  18101. // above, so release the source
  18102. free_ca_store(store);
  18103. // Update the SSL config to use the new CA chain
  18104. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18105. return true;
  18106. }
  18107. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18108. certs.clear();
  18109. if (!ctx) { return 0; }
  18110. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18111. // Iterate through the CA chain
  18112. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18113. while (cert != nullptr && cert->raw.len > 0) {
  18114. // Create a copy of the certificate for the caller
  18115. auto *copy = new mbedtls_x509_crt;
  18116. mbedtls_x509_crt_init(copy);
  18117. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18118. if (ret == 0) {
  18119. certs.push_back(static_cast<cert_t>(copy));
  18120. } else {
  18121. mbedtls_x509_crt_free(copy);
  18122. delete copy;
  18123. }
  18124. cert = cert->next;
  18125. }
  18126. return certs.size();
  18127. }
  18128. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18129. std::vector<std::string> names;
  18130. if (!ctx) { return names; }
  18131. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18132. // Iterate through the CA chain
  18133. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18134. while (cert != nullptr && cert->raw.len > 0) {
  18135. char buf[512];
  18136. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18137. if (ret > 0) { names.push_back(buf); }
  18138. cert = cert->next;
  18139. }
  18140. return names;
  18141. }
  18142. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18143. const char *key_pem, const char *password) {
  18144. if (!ctx || !cert_pem || !key_pem) { return false; }
  18145. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18146. // Free existing certificate and key
  18147. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18148. mbedtls_pk_free(&mbed_ctx->own_key);
  18149. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18150. mbedtls_pk_init(&mbed_ctx->own_key);
  18151. // Parse certificate PEM
  18152. int ret = mbedtls_x509_crt_parse(
  18153. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18154. strlen(cert_pem) + 1);
  18155. if (ret != 0) {
  18156. impl::mbedtls_last_error() = ret;
  18157. return false;
  18158. }
  18159. // Parse private key PEM
  18160. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18161. ret = mbedtls_pk_parse_key(
  18162. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18163. strlen(key_pem) + 1,
  18164. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18165. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18166. &mbed_ctx->ctr_drbg);
  18167. #else
  18168. ret = mbedtls_pk_parse_key(
  18169. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18170. strlen(key_pem) + 1,
  18171. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18172. password ? strlen(password) : 0);
  18173. #endif
  18174. if (ret != 0) {
  18175. impl::mbedtls_last_error() = ret;
  18176. return false;
  18177. }
  18178. // Configure SSL to use the new certificate and key
  18179. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18180. &mbed_ctx->own_key);
  18181. if (ret != 0) {
  18182. impl::mbedtls_last_error() = ret;
  18183. return false;
  18184. }
  18185. return true;
  18186. }
  18187. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18188. if (!ctx || !ca_pem) { return false; }
  18189. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18190. // Free existing CA chain
  18191. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18192. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18193. // Parse CA PEM
  18194. int ret = mbedtls_x509_crt_parse(
  18195. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18196. strlen(ca_pem) + 1);
  18197. if (ret != 0) {
  18198. impl::mbedtls_last_error() = ret;
  18199. return false;
  18200. }
  18201. // Update SSL config to use new CA chain
  18202. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18203. return true;
  18204. }
  18205. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18206. if (!ctx) { return false; }
  18207. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18208. impl::get_verify_callback() = std::move(callback);
  18209. mbed_ctx->has_verify_callback =
  18210. static_cast<bool>(impl::get_verify_callback());
  18211. if (mbed_ctx->has_verify_callback) {
  18212. // Set OPTIONAL mode to ensure callback is called even when verification
  18213. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18214. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18215. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18216. nullptr);
  18217. } else {
  18218. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18219. }
  18220. return true;
  18221. }
  18222. inline long get_verify_error(const_session_t session) {
  18223. if (!session) { return -1; }
  18224. auto *msession =
  18225. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18226. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18227. }
  18228. inline std::string verify_error_string(long error_code) {
  18229. if (error_code == 0) { return ""; }
  18230. char buf[256];
  18231. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18232. static_cast<uint32_t>(error_code));
  18233. // Remove trailing newline if present
  18234. std::string result(buf);
  18235. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18236. result.pop_back();
  18237. }
  18238. return result;
  18239. }
  18240. } // namespace tls
  18241. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18242. /*
  18243. * Group 10: TLS abstraction layer - wolfSSL backend
  18244. */
  18245. /*
  18246. * wolfSSL Backend Implementation
  18247. */
  18248. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18249. namespace tls {
  18250. namespace impl {
  18251. // wolfSSL session wrapper
  18252. struct WolfSSLSession {
  18253. WOLFSSL *ssl = nullptr;
  18254. socket_t sock = INVALID_SOCKET;
  18255. std::string hostname; // For client: set via set_sni
  18256. std::string sni_hostname; // For server: received from client via SNI callback
  18257. WolfSSLSession() = default;
  18258. ~WolfSSLSession() {
  18259. if (ssl) { wolfSSL_free(ssl); }
  18260. }
  18261. WolfSSLSession(const WolfSSLSession &) = delete;
  18262. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18263. };
  18264. // Thread-local error code accessor for wolfSSL
  18265. inline uint64_t &wolfssl_last_error() {
  18266. static thread_local uint64_t err = 0;
  18267. return err;
  18268. }
  18269. // Helper to map wolfSSL error to ErrorCode.
  18270. // ssl_error is the value from wolfSSL_get_error().
  18271. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18272. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18273. int &out_errno) {
  18274. switch (ssl_error) {
  18275. case SSL_ERROR_NONE: return ErrorCode::Success;
  18276. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18277. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18278. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18279. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18280. default:
  18281. if (ssl) {
  18282. // wolfSSL stores the low-level error code as a negative value.
  18283. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18284. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18285. if (low_err == DOMAIN_NAME_MISMATCH) {
  18286. return ErrorCode::HostnameMismatch;
  18287. }
  18288. // Check verify result to distinguish cert verification from generic SSL
  18289. // errors.
  18290. long vr = wolfSSL_get_verify_result(ssl);
  18291. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18292. }
  18293. return ErrorCode::Fatal;
  18294. }
  18295. }
  18296. // WolfSSLContext constructor/destructor implementations
  18297. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18298. inline WolfSSLContext::~WolfSSLContext() {
  18299. if (ctx) { wolfSSL_CTX_free(ctx); }
  18300. }
  18301. // Thread-local storage for SNI captured during handshake
  18302. inline std::string &wolfssl_pending_sni() {
  18303. static thread_local std::string sni;
  18304. return sni;
  18305. }
  18306. // SNI callback for wolfSSL server to capture client's SNI hostname
  18307. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18308. (void)ret;
  18309. (void)exArg;
  18310. void *name_data = nullptr;
  18311. unsigned short name_len =
  18312. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18313. if (name_data && name_len > 0) {
  18314. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18315. name_len);
  18316. } else {
  18317. wolfssl_pending_sni().clear();
  18318. }
  18319. return 0; // Continue regardless
  18320. }
  18321. // wolfSSL verify callback wrapper
  18322. inline int wolfssl_verify_callback(int preverify_ok,
  18323. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18324. auto &callback = get_verify_callback();
  18325. if (!callback) { return preverify_ok; }
  18326. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18327. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18328. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18329. // Get the WOLFSSL object from the X509_STORE_CTX
  18330. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18331. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18332. VerifyContext verify_ctx;
  18333. verify_ctx.session = static_cast<session_t>(ssl);
  18334. verify_ctx.cert = static_cast<cert_t>(cert);
  18335. verify_ctx.depth = depth;
  18336. verify_ctx.preverify_ok = (preverify_ok != 0);
  18337. verify_ctx.error_code = static_cast<long>(err);
  18338. if (err != 0) {
  18339. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18340. } else {
  18341. verify_ctx.error_string = nullptr;
  18342. }
  18343. bool accepted = callback(verify_ctx);
  18344. return accepted ? 1 : 0;
  18345. }
  18346. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18347. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18348. wolfSSL_CTX_set_default_passwd_cb(
  18349. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18350. auto *pwd = static_cast<const char *>(userdata);
  18351. if (!pwd) return 0;
  18352. auto len = static_cast<int>(strlen(pwd));
  18353. if (len > size) len = size;
  18354. memcpy(buf, pwd, static_cast<size_t>(len));
  18355. return len;
  18356. });
  18357. }
  18358. } // namespace impl
  18359. inline ctx_t create_client_context() {
  18360. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18361. if (!ctx) { return nullptr; }
  18362. ctx->is_server = false;
  18363. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18364. if (!method) {
  18365. delete ctx;
  18366. return nullptr;
  18367. }
  18368. ctx->ctx = wolfSSL_CTX_new(method);
  18369. if (!ctx->ctx) {
  18370. delete ctx;
  18371. return nullptr;
  18372. }
  18373. // Default: verify peer certificate
  18374. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18375. return static_cast<ctx_t>(ctx);
  18376. }
  18377. inline ctx_t create_server_context() {
  18378. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18379. if (!ctx) { return nullptr; }
  18380. ctx->is_server = true;
  18381. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18382. if (!method) {
  18383. delete ctx;
  18384. return nullptr;
  18385. }
  18386. ctx->ctx = wolfSSL_CTX_new(method);
  18387. if (!ctx->ctx) {
  18388. delete ctx;
  18389. return nullptr;
  18390. }
  18391. // Default: don't verify client
  18392. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18393. // Enable SNI on server
  18394. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18395. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18396. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18397. return static_cast<ctx_t>(ctx);
  18398. }
  18399. inline void free_context(ctx_t ctx) {
  18400. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18401. }
  18402. inline bool set_min_version(ctx_t ctx, Version version) {
  18403. if (!ctx) { return false; }
  18404. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18405. int min_ver = WOLFSSL_TLSV1_2;
  18406. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18407. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18408. }
  18409. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18410. if (!ctx || !pem) { return false; }
  18411. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18412. int ret = wolfSSL_CTX_load_verify_buffer(
  18413. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18414. static_cast<long>(len), SSL_FILETYPE_PEM);
  18415. if (ret != SSL_SUCCESS) {
  18416. impl::wolfssl_last_error() =
  18417. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18418. return false;
  18419. }
  18420. wctx->ca_pem_data_.append(pem, len);
  18421. return true;
  18422. }
  18423. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18424. if (!ctx || !file_path) { return false; }
  18425. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18426. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18427. if (ret != SSL_SUCCESS) {
  18428. impl::wolfssl_last_error() =
  18429. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18430. return false;
  18431. }
  18432. return true;
  18433. }
  18434. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18435. if (!ctx || !dir_path) { return false; }
  18436. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18437. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18438. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18439. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18440. // immediately. Return true even on failure since the CA file may have
  18441. // already been loaded, matching OpenSSL's lenient behavior.
  18442. (void)ret;
  18443. return true;
  18444. }
  18445. inline bool load_system_certs(ctx_t ctx) {
  18446. if (!ctx) { return false; }
  18447. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18448. bool loaded = false;
  18449. #ifdef _WIN32
  18450. loaded = impl::enumerate_windows_system_certs(
  18451. [&](const unsigned char *data, size_t len) {
  18452. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18453. static_cast<long>(len),
  18454. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18455. });
  18456. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18457. loaded = impl::enumerate_macos_keychain_certs(
  18458. [&](const unsigned char *data, size_t len) {
  18459. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18460. static_cast<long>(len),
  18461. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18462. });
  18463. #else
  18464. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18465. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18466. SSL_SUCCESS) {
  18467. loaded = true;
  18468. break;
  18469. }
  18470. }
  18471. if (!loaded) {
  18472. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18473. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18474. SSL_SUCCESS) {
  18475. loaded = true;
  18476. break;
  18477. }
  18478. }
  18479. }
  18480. #endif
  18481. return loaded;
  18482. }
  18483. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18484. const char *password) {
  18485. if (!ctx || !cert || !key) { return false; }
  18486. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18487. // Load certificate
  18488. int ret = wolfSSL_CTX_use_certificate_buffer(
  18489. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18490. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18491. if (ret != SSL_SUCCESS) {
  18492. impl::wolfssl_last_error() =
  18493. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18494. return false;
  18495. }
  18496. // Set password callback if password is provided
  18497. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18498. // Load private key
  18499. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18500. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18501. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18502. if (ret != SSL_SUCCESS) {
  18503. impl::wolfssl_last_error() =
  18504. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18505. return false;
  18506. }
  18507. // Verify that the certificate and private key match
  18508. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18509. }
  18510. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18511. const char *key_path, const char *password) {
  18512. if (!ctx || !cert_path || !key_path) { return false; }
  18513. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18514. // Load certificate file
  18515. int ret =
  18516. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18517. if (ret != SSL_SUCCESS) {
  18518. impl::wolfssl_last_error() =
  18519. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18520. return false;
  18521. }
  18522. // Set password callback if password is provided
  18523. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18524. // Load private key file
  18525. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18526. if (ret != SSL_SUCCESS) {
  18527. impl::wolfssl_last_error() =
  18528. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18529. return false;
  18530. }
  18531. // Verify that the certificate and private key match
  18532. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18533. }
  18534. inline void set_verify_client(ctx_t ctx, bool require) {
  18535. if (!ctx) { return; }
  18536. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18537. wctx->verify_client = require;
  18538. if (require) {
  18539. wolfSSL_CTX_set_verify(
  18540. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18541. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18542. } else {
  18543. if (wctx->has_verify_callback) {
  18544. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18545. impl::wolfssl_verify_callback);
  18546. } else {
  18547. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18548. }
  18549. }
  18550. }
  18551. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18552. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18553. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18554. auto session = new (std::nothrow) impl::WolfSSLSession();
  18555. if (!session) { return nullptr; }
  18556. session->sock = sock;
  18557. session->ssl = wolfSSL_new(wctx->ctx);
  18558. if (!session->ssl) {
  18559. impl::wolfssl_last_error() =
  18560. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18561. delete session;
  18562. return nullptr;
  18563. }
  18564. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18565. return static_cast<session_t>(session);
  18566. }
  18567. inline void free_session(session_t session) {
  18568. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18569. }
  18570. inline bool set_sni(session_t session, const char *hostname,
  18571. bool verify_hostname) {
  18572. if (!session || !hostname) { return false; }
  18573. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18574. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18575. static_cast<word16>(strlen(hostname)));
  18576. if (ret != WOLFSSL_SUCCESS) {
  18577. impl::wolfssl_last_error() =
  18578. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18579. return false;
  18580. }
  18581. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18582. // separately from the SNI extension sent above; skip it when hostname
  18583. // verification is disabled so only the chain is checked, matching OpenSSL.
  18584. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18585. wsession->hostname = hostname;
  18586. return true;
  18587. }
  18588. inline TlsError connect(session_t session) {
  18589. TlsError err;
  18590. if (!session) {
  18591. err.code = ErrorCode::Fatal;
  18592. return err;
  18593. }
  18594. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18595. int ret = wolfSSL_connect(wsession->ssl);
  18596. if (ret == SSL_SUCCESS) {
  18597. err.code = ErrorCode::Success;
  18598. } else {
  18599. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18600. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18601. err.backend_code = static_cast<uint64_t>(ssl_error);
  18602. impl::wolfssl_last_error() = err.backend_code;
  18603. }
  18604. return err;
  18605. }
  18606. inline TlsError accept(session_t session) {
  18607. TlsError err;
  18608. if (!session) {
  18609. err.code = ErrorCode::Fatal;
  18610. return err;
  18611. }
  18612. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18613. int ret = wolfSSL_accept(wsession->ssl);
  18614. if (ret == SSL_SUCCESS) {
  18615. err.code = ErrorCode::Success;
  18616. // Capture SNI from thread-local storage after successful handshake
  18617. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18618. impl::wolfssl_pending_sni().clear();
  18619. } else {
  18620. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18621. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18622. err.backend_code = static_cast<uint64_t>(ssl_error);
  18623. impl::wolfssl_last_error() = err.backend_code;
  18624. }
  18625. return err;
  18626. }
  18627. inline bool connect_nonblocking(session_t session, socket_t sock,
  18628. time_t timeout_sec, time_t timeout_usec,
  18629. TlsError *err) {
  18630. if (!session) {
  18631. if (err) { err->code = ErrorCode::Fatal; }
  18632. return false;
  18633. }
  18634. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18635. // Set socket to non-blocking mode
  18636. detail::set_nonblocking(sock, true);
  18637. auto cleanup =
  18638. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18639. int ret;
  18640. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18641. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18642. if (ssl_error == SSL_ERROR_WANT_READ) {
  18643. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18644. continue;
  18645. }
  18646. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18647. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18648. continue;
  18649. }
  18650. }
  18651. // Error or timeout
  18652. if (err) {
  18653. err->code =
  18654. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18655. err->backend_code = static_cast<uint64_t>(ssl_error);
  18656. }
  18657. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18658. return false;
  18659. }
  18660. if (err) { err->code = ErrorCode::Success; }
  18661. return true;
  18662. }
  18663. inline bool accept_nonblocking(session_t session, socket_t sock,
  18664. time_t timeout_sec, time_t timeout_usec,
  18665. TlsError *err) {
  18666. if (!session) {
  18667. if (err) { err->code = ErrorCode::Fatal; }
  18668. return false;
  18669. }
  18670. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18671. // Set socket to non-blocking mode
  18672. detail::set_nonblocking(sock, true);
  18673. auto cleanup =
  18674. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18675. int ret;
  18676. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18677. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18678. if (ssl_error == SSL_ERROR_WANT_READ) {
  18679. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18680. continue;
  18681. }
  18682. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18683. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18684. continue;
  18685. }
  18686. }
  18687. // Error or timeout
  18688. if (err) {
  18689. err->code =
  18690. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18691. err->backend_code = static_cast<uint64_t>(ssl_error);
  18692. }
  18693. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18694. return false;
  18695. }
  18696. if (err) { err->code = ErrorCode::Success; }
  18697. // Capture SNI from thread-local storage after successful handshake
  18698. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18699. impl::wolfssl_pending_sni().clear();
  18700. return true;
  18701. }
  18702. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18703. if (!session || !buf) {
  18704. err.code = ErrorCode::Fatal;
  18705. return -1;
  18706. }
  18707. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18708. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18709. if (ret > 0) {
  18710. err.code = ErrorCode::Success;
  18711. return static_cast<ssize_t>(ret);
  18712. }
  18713. if (ret == 0) {
  18714. err.code = ErrorCode::PeerClosed;
  18715. return 0;
  18716. }
  18717. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18718. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18719. err.backend_code = static_cast<uint64_t>(ssl_error);
  18720. impl::wolfssl_last_error() = err.backend_code;
  18721. return -1;
  18722. }
  18723. inline ssize_t write(session_t session, const void *buf, size_t len,
  18724. TlsError &err) {
  18725. if (!session || !buf) {
  18726. err.code = ErrorCode::Fatal;
  18727. return -1;
  18728. }
  18729. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18730. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18731. if (ret > 0) {
  18732. err.code = ErrorCode::Success;
  18733. return static_cast<ssize_t>(ret);
  18734. }
  18735. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18736. // Treat this as an error (return -1) so callers don't spin in a
  18737. // write loop adding zero to the offset.
  18738. if (ret == 0) {
  18739. err.code = ErrorCode::PeerClosed;
  18740. return -1;
  18741. }
  18742. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18743. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18744. err.backend_code = static_cast<uint64_t>(ssl_error);
  18745. impl::wolfssl_last_error() = err.backend_code;
  18746. return -1;
  18747. }
  18748. inline int pending(const_session_t session) {
  18749. if (!session) { return 0; }
  18750. auto wsession =
  18751. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18752. return wolfSSL_pending(wsession->ssl);
  18753. }
  18754. inline void shutdown(session_t session, bool graceful) {
  18755. if (!session) { return; }
  18756. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18757. if (graceful) {
  18758. int ret;
  18759. int attempts = 0;
  18760. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18761. attempts < 3) {
  18762. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18763. if (ssl_error != SSL_ERROR_WANT_READ &&
  18764. ssl_error != SSL_ERROR_WANT_WRITE) {
  18765. break;
  18766. }
  18767. attempts++;
  18768. }
  18769. } else {
  18770. wolfSSL_shutdown(wsession->ssl);
  18771. }
  18772. }
  18773. inline bool is_peer_closed(session_t session, socket_t sock) {
  18774. if (!session || sock == INVALID_SOCKET) { return true; }
  18775. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18776. // Check if there's already decrypted data available
  18777. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18778. // Set socket to non-blocking to avoid blocking on read
  18779. detail::set_nonblocking(sock, true);
  18780. auto cleanup =
  18781. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18782. // Peek 1 byte to check connection status without consuming data
  18783. unsigned char buf;
  18784. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18785. // If we got data or WANT_READ (would block), connection is alive
  18786. if (ret > 0) { return false; }
  18787. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18788. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18789. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18790. ret == 0;
  18791. }
  18792. inline cert_t get_peer_cert(const_session_t session) {
  18793. if (!session) { return nullptr; }
  18794. auto wsession =
  18795. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18796. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18797. return static_cast<cert_t>(cert);
  18798. }
  18799. inline size_t get_peer_certs(const_session_t session,
  18800. std::vector<cert_t> &certs) {
  18801. certs.clear();
  18802. if (!session) { return 0; }
  18803. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  18804. #ifdef SESSION_CERTS
  18805. auto wsession =
  18806. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18807. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  18808. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  18809. for (int i = 0; i < count; i++) {
  18810. auto x509 = wolfSSL_get_chain_X509(chain, i);
  18811. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18812. }
  18813. #endif
  18814. return certs.size();
  18815. }
  18816. inline void free_cert(cert_t cert) {
  18817. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18818. }
  18819. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18820. if (!cert || !hostname) { return false; }
  18821. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18822. std::string host_str(hostname);
  18823. // Check if hostname is an IP address (IPv4 or IPv6)
  18824. unsigned char ip_bytes[16];
  18825. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18826. auto is_ip = ip_len > 0;
  18827. // Check Subject Alternative Names
  18828. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18829. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18830. if (san_names) {
  18831. int san_count = wolfSSL_sk_num(san_names);
  18832. for (int i = 0; i < san_count; i++) {
  18833. auto *names =
  18834. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18835. if (!names) continue;
  18836. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18837. // DNS name
  18838. unsigned char *dns_name = nullptr;
  18839. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18840. if (dns_name && dns_len > 0) {
  18841. std::string san_name(reinterpret_cast<char *>(dns_name),
  18842. static_cast<size_t>(dns_len));
  18843. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18844. if (detail::match_hostname(san_name, host_str)) {
  18845. wolfSSL_sk_free(san_names);
  18846. return true;
  18847. }
  18848. }
  18849. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18850. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18851. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18852. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18853. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18854. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18855. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18856. wolfSSL_sk_free(san_names);
  18857. return true;
  18858. }
  18859. }
  18860. }
  18861. wolfSSL_sk_free(san_names);
  18862. }
  18863. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18864. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18865. // the OpenSSL backend's X509_check_ip behaves the same way).
  18866. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18867. if (subject) {
  18868. char cn[256] = {};
  18869. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18870. sizeof(cn));
  18871. if (cn_len > 0) {
  18872. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18873. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18874. }
  18875. }
  18876. return false;
  18877. }
  18878. inline uint64_t hostname_mismatch_code() {
  18879. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18880. }
  18881. inline long get_verify_result(const_session_t session) {
  18882. if (!session) { return -1; }
  18883. auto wsession =
  18884. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18885. long result = wolfSSL_get_verify_result(wsession->ssl);
  18886. return result;
  18887. }
  18888. inline std::string get_cert_subject_cn(cert_t cert) {
  18889. if (!cert) return "";
  18890. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18891. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18892. if (!subject) return "";
  18893. char cn[256] = {};
  18894. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18895. sizeof(cn));
  18896. if (cn_len <= 0) return "";
  18897. return std::string(cn, static_cast<size_t>(cn_len));
  18898. }
  18899. inline std::string get_cert_issuer_name(cert_t cert) {
  18900. if (!cert) return "";
  18901. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18902. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18903. if (!issuer) return "";
  18904. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18905. if (!name_str) return "";
  18906. std::string result(name_str);
  18907. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18908. return result;
  18909. }
  18910. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18911. sans.clear();
  18912. if (!cert) return false;
  18913. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18914. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18915. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18916. if (!san_names) return true; // No SANs is not an error
  18917. int count = wolfSSL_sk_num(san_names);
  18918. for (int i = 0; i < count; i++) {
  18919. auto *name =
  18920. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18921. if (!name) continue;
  18922. SanEntry entry;
  18923. switch (name->type) {
  18924. case WOLFSSL_GEN_DNS: {
  18925. entry.type = SanType::DNS;
  18926. unsigned char *dns_name = nullptr;
  18927. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18928. if (dns_name && dns_len > 0) {
  18929. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18930. static_cast<size_t>(dns_len));
  18931. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18932. }
  18933. break;
  18934. }
  18935. case WOLFSSL_GEN_IPADD: {
  18936. entry.type = SanType::IP;
  18937. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18938. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18939. if (ip_data && ip_len == 4) {
  18940. char buf[16];
  18941. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18942. ip_data[2], ip_data[3]);
  18943. entry.value = buf;
  18944. } else if (ip_data && ip_len == 16) {
  18945. char buf[64];
  18946. snprintf(buf, sizeof(buf),
  18947. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18948. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18949. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18950. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18951. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18952. ip_data[14], ip_data[15]);
  18953. entry.value = buf;
  18954. }
  18955. break;
  18956. }
  18957. case WOLFSSL_GEN_EMAIL:
  18958. entry.type = SanType::EMAIL;
  18959. {
  18960. unsigned char *email = nullptr;
  18961. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18962. if (email && email_len > 0) {
  18963. entry.value = std::string(reinterpret_cast<char *>(email),
  18964. static_cast<size_t>(email_len));
  18965. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18966. }
  18967. }
  18968. break;
  18969. case WOLFSSL_GEN_URI:
  18970. entry.type = SanType::URI;
  18971. {
  18972. unsigned char *uri = nullptr;
  18973. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18974. &uri, name->d.uniformResourceIdentifier);
  18975. if (uri && uri_len > 0) {
  18976. entry.value = std::string(reinterpret_cast<char *>(uri),
  18977. static_cast<size_t>(uri_len));
  18978. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18979. }
  18980. }
  18981. break;
  18982. default: entry.type = SanType::OTHER; break;
  18983. }
  18984. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18985. }
  18986. wolfSSL_sk_free(san_names);
  18987. return true;
  18988. }
  18989. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18990. time_t &not_after) {
  18991. if (!cert) return false;
  18992. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18993. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18994. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18995. if (!nb || !na) return false;
  18996. // wolfSSL_ASN1_TIME_to_tm is available
  18997. struct tm tm_nb = {}, tm_na = {};
  18998. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18999. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19000. #ifdef _WIN32
  19001. not_before = _mkgmtime(&tm_nb);
  19002. not_after = _mkgmtime(&tm_na);
  19003. #else
  19004. not_before = timegm(&tm_nb);
  19005. not_after = timegm(&tm_na);
  19006. #endif
  19007. return true;
  19008. }
  19009. inline std::string get_cert_serial(cert_t cert) {
  19010. if (!cert) return "";
  19011. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19012. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19013. if (!serial_asn1) return "";
  19014. // Get the serial number data
  19015. int len = serial_asn1->length;
  19016. unsigned char *data = serial_asn1->data;
  19017. if (!data || len <= 0) return "";
  19018. std::string result;
  19019. result.reserve(static_cast<size_t>(len) * 2);
  19020. for (int i = 0; i < len; i++) {
  19021. char hex[3];
  19022. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19023. result += hex;
  19024. }
  19025. return result;
  19026. }
  19027. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19028. if (!cert) return false;
  19029. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19030. int der_len = 0;
  19031. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19032. if (!der_data || der_len <= 0) return false;
  19033. der.assign(der_data, der_data + der_len);
  19034. return true;
  19035. }
  19036. inline const char *get_sni(const_session_t session) {
  19037. if (!session) return nullptr;
  19038. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19039. // For server: return SNI received from client during handshake
  19040. if (!wsession->sni_hostname.empty()) {
  19041. return wsession->sni_hostname.c_str();
  19042. }
  19043. // For client: return the hostname set via set_sni
  19044. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19045. return nullptr;
  19046. }
  19047. inline uint64_t peek_error() {
  19048. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19049. }
  19050. inline uint64_t get_error() {
  19051. uint64_t err = impl::wolfssl_last_error();
  19052. impl::wolfssl_last_error() = 0;
  19053. return err;
  19054. }
  19055. inline std::string error_string(uint64_t code) {
  19056. char buf[256];
  19057. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19058. return std::string(buf);
  19059. }
  19060. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19061. if (!pem || len == 0) { return nullptr; }
  19062. // Validate by attempting to load into a temporary ctx
  19063. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19064. if (!tmp_ctx) { return nullptr; }
  19065. int ret = wolfSSL_CTX_load_verify_buffer(
  19066. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19067. static_cast<long>(len), SSL_FILETYPE_PEM);
  19068. wolfSSL_CTX_free(tmp_ctx);
  19069. if (ret != SSL_SUCCESS) { return nullptr; }
  19070. return static_cast<ca_store_t>(
  19071. new impl::WolfSSLCAStore{std::string(pem, len)});
  19072. }
  19073. inline void free_ca_store(ca_store_t store) {
  19074. delete static_cast<impl::WolfSSLCAStore *>(store);
  19075. }
  19076. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19077. if (!ctx || !store) { return false; }
  19078. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19079. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19080. int ret = wolfSSL_CTX_load_verify_buffer(
  19081. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19082. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19083. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19084. // This function takes ownership of the store; the PEM data was copied into
  19085. // the context, so release the source
  19086. free_ca_store(store);
  19087. return ret == SSL_SUCCESS;
  19088. }
  19089. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19090. certs.clear();
  19091. if (!ctx) { return 0; }
  19092. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19093. if (wctx->ca_pem_data_.empty()) { return 0; }
  19094. const std::string &pem = wctx->ca_pem_data_;
  19095. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19096. const std::string end_marker = "-----END CERTIFICATE-----";
  19097. size_t pos = 0;
  19098. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19099. size_t end_pos = pem.find(end_marker, pos);
  19100. if (end_pos == std::string::npos) { break; }
  19101. end_pos += end_marker.size();
  19102. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19103. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19104. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19105. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19106. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19107. pos = end_pos;
  19108. }
  19109. return certs.size();
  19110. }
  19111. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19112. std::vector<std::string> names;
  19113. if (!ctx) { return names; }
  19114. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19115. if (wctx->ca_pem_data_.empty()) { return names; }
  19116. const std::string &pem = wctx->ca_pem_data_;
  19117. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19118. const std::string end_marker = "-----END CERTIFICATE-----";
  19119. size_t pos = 0;
  19120. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19121. size_t end_pos = pem.find(end_marker, pos);
  19122. if (end_pos == std::string::npos) { break; }
  19123. end_pos += end_marker.size();
  19124. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19125. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19126. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19127. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19128. if (x509) {
  19129. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19130. if (subject) {
  19131. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19132. if (name_str) {
  19133. names.push_back(name_str);
  19134. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19135. }
  19136. }
  19137. wolfSSL_X509_free(x509);
  19138. }
  19139. pos = end_pos;
  19140. }
  19141. return names;
  19142. }
  19143. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19144. const char *key_pem, const char *password) {
  19145. if (!ctx || !cert_pem || !key_pem) { return false; }
  19146. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19147. // Load new certificate
  19148. int ret = wolfSSL_CTX_use_certificate_buffer(
  19149. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19150. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19151. if (ret != SSL_SUCCESS) {
  19152. impl::wolfssl_last_error() =
  19153. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19154. return false;
  19155. }
  19156. // Set password if provided
  19157. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19158. // Load new private key
  19159. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19160. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19161. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19162. if (ret != SSL_SUCCESS) {
  19163. impl::wolfssl_last_error() =
  19164. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19165. return false;
  19166. }
  19167. return true;
  19168. }
  19169. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19170. if (!ctx || !ca_pem) { return false; }
  19171. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19172. int ret = wolfSSL_CTX_load_verify_buffer(
  19173. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19174. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19175. if (ret != SSL_SUCCESS) {
  19176. impl::wolfssl_last_error() =
  19177. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19178. return false;
  19179. }
  19180. return true;
  19181. }
  19182. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19183. if (!ctx) { return false; }
  19184. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19185. impl::get_verify_callback() = std::move(callback);
  19186. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19187. if (wctx->has_verify_callback) {
  19188. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19189. impl::wolfssl_verify_callback);
  19190. } else {
  19191. wolfSSL_CTX_set_verify(
  19192. wctx->ctx,
  19193. wctx->verify_client
  19194. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19195. : SSL_VERIFY_NONE,
  19196. nullptr);
  19197. }
  19198. return true;
  19199. }
  19200. inline long get_verify_error(const_session_t session) {
  19201. if (!session) { return -1; }
  19202. auto *wsession =
  19203. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19204. return wolfSSL_get_verify_result(wsession->ssl);
  19205. }
  19206. inline std::string verify_error_string(long error_code) {
  19207. if (error_code == 0) { return ""; }
  19208. const char *str =
  19209. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19210. return str ? std::string(str) : std::string();
  19211. }
  19212. } // namespace tls
  19213. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19214. // WebSocket implementation
  19215. namespace ws {
  19216. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19217. bool fin) {
  19218. std::lock_guard<std::mutex> lock(write_mutex_);
  19219. if (closed_) { return false; }
  19220. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19221. }
  19222. inline ReadResult WebSocket::read(std::string &msg) {
  19223. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19224. while (!closed_) {
  19225. Opcode opcode;
  19226. std::string payload;
  19227. bool fin;
  19228. impl::FrameRead r =
  19229. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19230. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19231. // A timeout landed on a frame boundary: the connection is untouched and
  19232. // still usable, so hand control back without closing it. That is only
  19233. // useful to a caller who asked for the timeout; the compile-time default
  19234. // is a backstop against a peer gone quiet, and elapsing it closes the
  19235. // connection so a plain `while (ws.read(msg))` loop ends.
  19236. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19237. if (r != impl::FrameRead::Ok) {
  19238. closed_ = true;
  19239. return Fail;
  19240. }
  19241. switch (opcode) {
  19242. case Opcode::Ping: {
  19243. std::lock_guard<std::mutex> lock(write_mutex_);
  19244. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19245. payload.size(), true, !is_server_);
  19246. continue;
  19247. }
  19248. case Opcode::Pong: {
  19249. std::lock_guard<std::mutex> lock(ping_mutex_);
  19250. unacked_pings_ = 0;
  19251. continue;
  19252. }
  19253. case Opcode::Close: {
  19254. if (!closed_.exchange(true)) {
  19255. // Echo close frame back
  19256. std::lock_guard<std::mutex> lock(write_mutex_);
  19257. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19258. payload.size(), true, !is_server_);
  19259. }
  19260. return Fail;
  19261. }
  19262. case Opcode::Text:
  19263. case Opcode::Binary: {
  19264. auto result = opcode == Opcode::Text ? Text : Binary;
  19265. msg = std::move(payload);
  19266. // Handle fragmentation
  19267. if (!fin) {
  19268. while (true) {
  19269. Opcode cont_opcode;
  19270. std::string cont_payload;
  19271. bool cont_fin;
  19272. // A timeout is not reportable here: half of a fragmented message is
  19273. // already in `msg` and read() has no way to resume it, so it is a
  19274. // failure like any other. Timeouts are only ever seen on a message
  19275. // boundary.
  19276. if (impl::read_websocket_frame(
  19277. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19278. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19279. impl::FrameRead::Ok) {
  19280. closed_ = true;
  19281. return Fail;
  19282. }
  19283. if (cont_opcode == Opcode::Ping) {
  19284. std::lock_guard<std::mutex> lock(write_mutex_);
  19285. detail::write_websocket_frame(
  19286. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19287. true, !is_server_);
  19288. continue;
  19289. }
  19290. if (cont_opcode == Opcode::Pong) {
  19291. std::lock_guard<std::mutex> lock(ping_mutex_);
  19292. unacked_pings_ = 0;
  19293. continue;
  19294. }
  19295. if (cont_opcode == Opcode::Close) {
  19296. if (!closed_.exchange(true)) {
  19297. std::lock_guard<std::mutex> lock(write_mutex_);
  19298. detail::write_websocket_frame(
  19299. strm_, Opcode::Close, cont_payload.data(),
  19300. cont_payload.size(), true, !is_server_);
  19301. }
  19302. return Fail;
  19303. }
  19304. // RFC 6455: continuation frames must use opcode 0x0
  19305. if (cont_opcode != Opcode::Continuation) {
  19306. closed_ = true;
  19307. return Fail;
  19308. }
  19309. msg += cont_payload;
  19310. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19311. closed_ = true;
  19312. return Fail;
  19313. }
  19314. if (cont_fin) { break; }
  19315. }
  19316. }
  19317. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19318. if (result == Text && !impl::is_valid_utf8(msg)) {
  19319. // close() takes the read lock to wait for the peer's Close reply, so
  19320. // it must not run while this thread still holds it.
  19321. read_lock.unlock();
  19322. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19323. return Fail;
  19324. }
  19325. return result;
  19326. }
  19327. default: closed_ = true; return Fail;
  19328. }
  19329. }
  19330. return Fail;
  19331. }
  19332. inline bool WebSocket::send(const std::string &data) {
  19333. return send_frame(Opcode::Text, data.data(), data.size());
  19334. }
  19335. inline bool WebSocket::send(const char *data, size_t len) {
  19336. return send_frame(Opcode::Binary, data, len);
  19337. }
  19338. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19339. if (closed_.exchange(true)) { return; }
  19340. ping_cv_.notify_all();
  19341. std::string payload;
  19342. auto code = static_cast<uint16_t>(status);
  19343. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19344. payload.push_back(static_cast<char>(code & 0xFF));
  19345. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19346. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19347. payload += reason.substr(0, 123);
  19348. {
  19349. std::lock_guard<std::mutex> lock(write_mutex_);
  19350. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19351. payload.size(), true, !is_server_);
  19352. }
  19353. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19354. // Close response before closing the TCP connection.
  19355. //
  19356. // Wait only when no other thread is parsing frames. When one is, it is the
  19357. // thread positioned to see the peer's reply, and reading here would take
  19358. // bytes out of the message it is assembling. Bailing out also leaves the
  19359. // stream, including its read timeout, entirely to that thread.
  19360. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19361. if (!read_lock.owns_lock()) { return; }
  19362. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19363. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19364. Opcode op;
  19365. std::string resp;
  19366. bool fin;
  19367. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19368. impl::FrameRead::Ok) {
  19369. if (op == Opcode::Close) { break; }
  19370. }
  19371. }
  19372. inline WebSocket::~WebSocket() {
  19373. {
  19374. std::lock_guard<std::mutex> lock(ping_mutex_);
  19375. closed_ = true;
  19376. }
  19377. ping_cv_.notify_all();
  19378. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19379. }
  19380. inline void WebSocket::start_heartbeat() {
  19381. if (ping_interval_sec_ == 0) { return; }
  19382. ping_thread_ = std::thread([this]() {
  19383. std::unique_lock<std::mutex> lock(ping_mutex_);
  19384. while (!closed_) {
  19385. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19386. if (closed_) { break; }
  19387. // If the peer has failed to respond to the previous pings, give up.
  19388. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19389. // opt-in liveness check controlled by max_missed_pongs_.
  19390. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19391. lock.unlock();
  19392. close(CloseStatus::GoingAway, "pong timeout");
  19393. return;
  19394. }
  19395. lock.unlock();
  19396. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19397. lock.lock();
  19398. closed_ = true;
  19399. break;
  19400. }
  19401. lock.lock();
  19402. unacked_pings_++;
  19403. }
  19404. });
  19405. }
  19406. inline const Request &WebSocket::request() const { return req_; }
  19407. inline bool WebSocket::is_open() const { return !closed_; }
  19408. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19409. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19410. // poll(), where 0 would instead mean "return immediately", so hand it the
  19411. // negative poll uses for an unbounded wait.
  19412. if (sec == 0 && usec == 0) { sec = -1; }
  19413. strm_.set_read_timeout(sec, usec);
  19414. read_timeout_set_ = true;
  19415. }
  19416. // WebSocketClient implementation
  19417. inline WebSocketClient::WebSocketClient(
  19418. const std::string &scheme_host_port_path, const Headers &headers)
  19419. : headers_(headers) {
  19420. detail::UrlComponents uc;
  19421. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19422. !uc.host.empty() && !uc.path.empty()) {
  19423. auto &scheme = uc.scheme;
  19424. #ifdef CPPHTTPLIB_SSL_ENABLED
  19425. if (scheme != "ws" && scheme != "wss") {
  19426. #else
  19427. if (scheme != "ws") {
  19428. #endif
  19429. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19430. std::string msg = "'" + scheme + "' scheme is not supported.";
  19431. throw std::invalid_argument(msg);
  19432. #endif
  19433. return;
  19434. }
  19435. auto is_ssl = scheme == "wss";
  19436. host_ = std::move(uc.host);
  19437. port_ = is_ssl ? 443 : 80;
  19438. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19439. path_ = std::move(uc.path);
  19440. if (!uc.query.empty()) { path_ += uc.query; }
  19441. #ifdef CPPHTTPLIB_SSL_ENABLED
  19442. is_ssl_ = is_ssl;
  19443. if (is_ssl_) {
  19444. // The context lives as long as the client so that CA configuration
  19445. // survives reconnects; sessions are created per connection.
  19446. tls_ctx_ = tls::create_client_context();
  19447. if (!tls_ctx_) { return; }
  19448. }
  19449. #else
  19450. if (is_ssl) { return; }
  19451. #endif
  19452. is_valid_ = true;
  19453. }
  19454. }
  19455. #ifdef CPPHTTPLIB_SSL_ENABLED
  19456. inline WebSocketClient::WebSocketClient(
  19457. const std::string &scheme_host_port_path, const PemMemory &pem,
  19458. const Headers &headers)
  19459. : WebSocketClient(scheme_host_port_path, headers) {
  19460. // For ws:// URLs the client certificate is silently ignored, consistent
  19461. // with the TLS-only setters such as set_ca_cert_path().
  19462. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19463. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19464. pem.private_key_password)) {
  19465. tls::free_context(tls_ctx_);
  19466. tls_ctx_ = nullptr;
  19467. is_valid_ = false;
  19468. }
  19469. }
  19470. }
  19471. #endif
  19472. inline WebSocketClient::~WebSocketClient() {
  19473. shutdown_and_close();
  19474. #ifdef CPPHTTPLIB_SSL_ENABLED
  19475. if (tls_ctx_) {
  19476. tls::free_context(tls_ctx_);
  19477. tls_ctx_ = nullptr;
  19478. }
  19479. #endif
  19480. }
  19481. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19482. inline void WebSocketClient::shutdown_and_close() {
  19483. // Send the close frame while the TLS session is still alive: ws_ holds an
  19484. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19485. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19486. if (ws_ && ws_->is_open()) { ws_->close(); }
  19487. ws_.reset();
  19488. #ifdef CPPHTTPLIB_SSL_ENABLED
  19489. if (is_ssl_) {
  19490. if (tls_session_) {
  19491. tls::shutdown(tls_session_, true);
  19492. tls::free_session(tls_session_);
  19493. tls_session_ = nullptr;
  19494. }
  19495. }
  19496. #endif
  19497. if (sock_ != INVALID_SOCKET) {
  19498. detail::shutdown_socket(sock_);
  19499. detail::close_socket(sock_);
  19500. sock_ = INVALID_SOCKET;
  19501. }
  19502. }
  19503. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19504. Error &error, int &ssl_error,
  19505. uint64_t &ssl_backend_error) {
  19506. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19507. // The streams wait with poll(), where 0 instead means "return immediately",
  19508. // so they are given the negative poll uses for an unbounded wait.
  19509. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19510. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19511. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19512. // The handshake belongs to establishing the connection, so an unset read
  19513. // timeout leaves it bounded by the connection timeout instead of forever.
  19514. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19515. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19516. #ifdef CPPHTTPLIB_SSL_ENABLED
  19517. if (is_ssl_) {
  19518. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19519. // is not safe to call concurrently on one client to begin with, since
  19520. // nothing else here is guarded either.
  19521. if (server_certificate_verification_ && !certs_loaded_) {
  19522. uint64_t backend_error = 0;
  19523. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19524. ca_cert_dir_path_, custom_ca_loaded_,
  19525. system_ca_mode_, backend_error);
  19526. certs_loaded_ = true;
  19527. }
  19528. detail::ClientTlsSessionOptions options;
  19529. options.server_hostname_verification = server_hostname_verification_;
  19530. detail::ClientTlsSessionError tls_error;
  19531. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19532. server_certificate_verification_,
  19533. hs_sec, hs_usec, &tls_error,
  19534. options)) {
  19535. error = tls_error.error;
  19536. ssl_error = tls_error.ssl_error;
  19537. ssl_backend_error = tls_error.backend_error;
  19538. return false;
  19539. }
  19540. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19541. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19542. write_timeout_usec_));
  19543. return true;
  19544. }
  19545. #else
  19546. (void)error;
  19547. (void)ssl_error;
  19548. (void)ssl_backend_error;
  19549. (void)hs_sec;
  19550. (void)hs_usec;
  19551. #endif
  19552. strm = std::unique_ptr<Stream>(
  19553. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19554. write_timeout_sec_, write_timeout_usec_));
  19555. return true;
  19556. }
  19557. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19558. #ifdef CPPHTTPLIB_SSL_ENABLED
  19559. auto is_ssl = is_ssl_;
  19560. #else
  19561. auto is_ssl = false;
  19562. #endif
  19563. if (!req.has_header("Host")) {
  19564. req.headers.emplace("Host", detail::make_default_host_header_value(
  19565. host_, port_, is_ssl, address_family_));
  19566. }
  19567. detail::add_default_user_agent_header(req);
  19568. }
  19569. inline Result WebSocketClient::connect() {
  19570. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19571. shutdown_and_close();
  19572. // Check is custom IP or hostname specified for host_
  19573. std::string connect_host;
  19574. std::string ip;
  19575. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19576. auto error = Error::Success;
  19577. sock_ = detail::create_client_socket(
  19578. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19579. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19580. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19581. write_timeout_usec_, interface_, error);
  19582. if (sock_ == INVALID_SOCKET) {
  19583. if (error == Error::Success) { error = Error::Connection; }
  19584. return Result{error, -1, Headers{}};
  19585. }
  19586. std::unique_ptr<Stream> strm;
  19587. auto stream_error = Error::SSLConnection;
  19588. int ssl_error = 0;
  19589. uint64_t ssl_backend_error = 0;
  19590. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19591. shutdown_and_close();
  19592. #ifdef CPPHTTPLIB_SSL_ENABLED
  19593. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19594. #else
  19595. return Result{stream_error, -1, Headers{}};
  19596. #endif
  19597. }
  19598. Request req;
  19599. req.method = "GET";
  19600. req.path = path_;
  19601. req.headers = headers_;
  19602. prepare_default_headers(req);
  19603. detail::WebSocketUpgradeResponse upgrade;
  19604. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19605. shutdown_and_close();
  19606. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19607. }
  19608. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19609. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19610. websocket_ping_interval_sec_,
  19611. websocket_max_missed_pongs_));
  19612. // The stream was created with the timeout already; tell the WebSocket
  19613. // whether it came from the caller, so read() knows to report it as Timeout.
  19614. ws_->read_timeout_set_ = read_timeout_set_;
  19615. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19616. }
  19617. inline ReadResult WebSocketClient::read(std::string &msg) {
  19618. if (!ws_) { return Fail; }
  19619. return ws_->read(msg);
  19620. }
  19621. inline bool WebSocketClient::send(const std::string &data) {
  19622. if (!ws_) { return false; }
  19623. return ws_->send(data);
  19624. }
  19625. inline bool WebSocketClient::send(const char *data, size_t len) {
  19626. if (!ws_) { return false; }
  19627. return ws_->send(data, len);
  19628. }
  19629. inline void WebSocketClient::close(CloseStatus status,
  19630. const std::string &reason) {
  19631. if (ws_) { ws_->close(status, reason); }
  19632. }
  19633. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19634. inline const std::string &WebSocketClient::subprotocol() const {
  19635. return subprotocol_;
  19636. }
  19637. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19638. read_timeout_sec_ = sec;
  19639. read_timeout_usec_ = usec;
  19640. read_timeout_set_ = true;
  19641. // The members above only seed the next connect(); read() consults the
  19642. // stream, so an already-open connection has to be told directly.
  19643. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19644. }
  19645. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19646. write_timeout_sec_ = sec;
  19647. write_timeout_usec_ = usec;
  19648. }
  19649. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19650. websocket_ping_interval_sec_ = sec;
  19651. }
  19652. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19653. websocket_max_missed_pongs_ = count;
  19654. }
  19655. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19656. inline void WebSocketClient::set_address_family(int family) {
  19657. address_family_ = family;
  19658. }
  19659. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19660. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19661. socket_options_ = std::move(socket_options);
  19662. }
  19663. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19664. connection_timeout_sec_ = sec;
  19665. connection_timeout_usec_ = usec;
  19666. }
  19667. inline void WebSocketClient::set_interface(const std::string &intf) {
  19668. interface_ = intf;
  19669. }
  19670. inline void WebSocketClient::set_hostname_addr_map(
  19671. std::map<std::string, std::string> addr_map) {
  19672. addr_map_ = std::move(addr_map);
  19673. }
  19674. #ifdef CPPHTTPLIB_SSL_ENABLED
  19675. inline void
  19676. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19677. const std::string &ca_cert_dir_path) {
  19678. ca_cert_file_path_ = ca_cert_file_path;
  19679. ca_cert_dir_path_ = ca_cert_dir_path;
  19680. }
  19681. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19682. if (store && tls_ctx_) {
  19683. // set_ca_store takes ownership of store
  19684. tls::set_ca_store(tls_ctx_, store);
  19685. custom_ca_loaded_ = true;
  19686. } else if (store) {
  19687. tls::free_ca_store(store);
  19688. }
  19689. }
  19690. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19691. std::size_t size) {
  19692. if (tls_ctx_ && ca_cert && size > 0) {
  19693. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19694. custom_ca_loaded_ = true;
  19695. }
  19696. }
  19697. inline void
  19698. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19699. server_certificate_verification_ = enabled;
  19700. }
  19701. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19702. server_hostname_verification_ = enabled;
  19703. }
  19704. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19705. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19706. }
  19707. #endif // CPPHTTPLIB_SSL_ENABLED
  19708. } // namespace ws
  19709. // ----------------------------------------------------------------------------
  19710. } // namespace httplib
  19711. #endif // CPPHTTPLIB_HTTPLIB_H