httplib.h 786 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073
  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. void free_cert(cert_t cert);
  4216. bool verify_hostname(cert_t cert, const char *hostname);
  4217. uint64_t hostname_mismatch_code();
  4218. long get_verify_result(const_session_t session);
  4219. // Certificate introspection
  4220. std::string get_cert_subject_cn(cert_t cert);
  4221. std::string get_cert_issuer_name(cert_t cert);
  4222. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4223. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4224. std::string get_cert_serial(cert_t cert);
  4225. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4226. const char *get_sni(const_session_t session);
  4227. // CA store management
  4228. ca_store_t create_ca_store(const char *pem, size_t len);
  4229. void free_ca_store(ca_store_t store);
  4230. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4231. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4232. std::vector<std::string> get_ca_names(ctx_t ctx);
  4233. // Dynamic certificate update (for servers)
  4234. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4235. const char *password);
  4236. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4237. // Certificate verification callback
  4238. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4239. long get_verify_error(const_session_t session);
  4240. std::string verify_error_string(long error_code);
  4241. // TlsError information
  4242. uint64_t peek_error();
  4243. uint64_t get_error();
  4244. std::string error_string(uint64_t code);
  4245. } // namespace tls
  4246. #endif // CPPHTTPLIB_SSL_ENABLED
  4247. /*
  4248. * Group 1: detail namespace - Non-SSL utilities
  4249. */
  4250. namespace detail {
  4251. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4252. const void *optval, socklen_t optlen) {
  4253. return setsockopt(sock, level, optname,
  4254. #ifdef _WIN32
  4255. reinterpret_cast<const char *>(optval),
  4256. #else
  4257. optval,
  4258. #endif
  4259. optlen) == 0;
  4260. }
  4261. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4262. time_t sec, time_t usec) {
  4263. #ifdef _WIN32
  4264. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4265. #else
  4266. timeval timeout;
  4267. timeout.tv_sec = static_cast<long>(sec);
  4268. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4269. #endif
  4270. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4271. }
  4272. inline bool is_hex(char c, int &v) {
  4273. if (is_ascii_digit(c)) {
  4274. v = c - '0';
  4275. return true;
  4276. } else if ('A' <= c && c <= 'F') {
  4277. v = c - 'A' + 10;
  4278. return true;
  4279. } else if ('a' <= c && c <= 'f') {
  4280. v = c - 'a' + 10;
  4281. return true;
  4282. }
  4283. return false;
  4284. }
  4285. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4286. int &val) {
  4287. if (i >= s.size()) { return false; }
  4288. val = 0;
  4289. for (; cnt; i++, cnt--) {
  4290. if (!s[i]) { return false; }
  4291. auto v = 0;
  4292. if (is_hex(s[i], v)) {
  4293. val = val * 16 + v;
  4294. } else {
  4295. return false;
  4296. }
  4297. }
  4298. return true;
  4299. }
  4300. inline std::string from_i_to_hex(size_t n) {
  4301. static const auto charset = "0123456789abcdef";
  4302. std::string ret;
  4303. do {
  4304. ret = charset[n & 15] + ret;
  4305. n >>= 4;
  4306. } while (n > 0);
  4307. return ret;
  4308. }
  4309. inline std::string compute_etag(const FileStat &fs,
  4310. const std::string &suffix = std::string()) {
  4311. if (!fs.is_file()) { return std::string(); }
  4312. // If mtime cannot be determined (negative value indicates an error
  4313. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4314. // value like 0 could collide with a real file that legitimately has
  4315. // mtime == 0 (epoch) and lead to misleading validators.
  4316. auto mtime_raw = fs.mtime();
  4317. if (mtime_raw < 0) { return std::string(); }
  4318. auto mtime = static_cast<size_t>(mtime_raw);
  4319. auto size = fs.size();
  4320. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4321. from_i_to_hex(size) + suffix + "\"";
  4322. }
  4323. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4324. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4325. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4326. inline std::string file_mtime_to_http_date(time_t mtime) {
  4327. if (mtime < 0) { return std::string(); }
  4328. struct tm tm_buf;
  4329. #ifdef _WIN32
  4330. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4331. #else
  4332. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4333. #endif
  4334. char buf[64];
  4335. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4336. return std::string();
  4337. }
  4338. return std::string(buf);
  4339. }
  4340. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4341. inline time_t parse_http_date(const std::string &date_str) {
  4342. struct tm tm_buf;
  4343. // Create a classic locale object once for all parsing attempts
  4344. const std::locale classic_locale = std::locale::classic();
  4345. // Try to parse using std::get_time (C++11, cross-platform)
  4346. auto try_parse = [&](const char *fmt) -> bool {
  4347. std::istringstream ss(date_str);
  4348. ss.imbue(classic_locale);
  4349. memset(&tm_buf, 0, sizeof(tm_buf));
  4350. ss >> std::get_time(&tm_buf, fmt);
  4351. return !ss.fail();
  4352. };
  4353. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4354. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4355. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4356. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4357. // asctime format: "Sun Nov 6 08:49:37 1994"
  4358. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4359. return static_cast<time_t>(-1);
  4360. }
  4361. }
  4362. }
  4363. #ifdef _WIN32
  4364. return _mkgmtime(&tm_buf);
  4365. #elif defined _AIX
  4366. return mktime(&tm_buf);
  4367. #else
  4368. return timegm(&tm_buf);
  4369. #endif
  4370. }
  4371. inline bool is_weak_etag(const std::string &s) {
  4372. // Check if the string is a weak ETag (starts with 'W/"')
  4373. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4374. }
  4375. inline bool is_strong_etag(const std::string &s) {
  4376. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4377. // chars)
  4378. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4379. }
  4380. inline size_t to_utf8(int code, char *buff) {
  4381. if (code < 0x0080) {
  4382. buff[0] = static_cast<char>(code & 0x7F);
  4383. return 1;
  4384. } else if (code < 0x0800) {
  4385. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4386. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4387. return 2;
  4388. } else if (code < 0xD800) {
  4389. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4390. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4391. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4392. return 3;
  4393. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4394. return 0;
  4395. } else if (code < 0x10000) {
  4396. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4397. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4398. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4399. return 3;
  4400. } else if (code < 0x110000) {
  4401. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4402. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4403. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4404. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4405. return 4;
  4406. }
  4407. // NOTREACHED
  4408. return 0;
  4409. }
  4410. } // namespace detail
  4411. namespace ws {
  4412. namespace impl {
  4413. inline bool is_valid_utf8(const std::string &s) {
  4414. size_t i = 0;
  4415. auto n = s.size();
  4416. while (i < n) {
  4417. auto c = static_cast<unsigned char>(s[i]);
  4418. size_t len;
  4419. uint32_t cp;
  4420. if (c < 0x80) {
  4421. i++;
  4422. continue;
  4423. } else if ((c & 0xE0) == 0xC0) {
  4424. len = 2;
  4425. cp = c & 0x1F;
  4426. } else if ((c & 0xF0) == 0xE0) {
  4427. len = 3;
  4428. cp = c & 0x0F;
  4429. } else if ((c & 0xF8) == 0xF0) {
  4430. len = 4;
  4431. cp = c & 0x07;
  4432. } else {
  4433. return false;
  4434. }
  4435. if (i + len > n) { return false; }
  4436. for (size_t j = 1; j < len; j++) {
  4437. auto b = static_cast<unsigned char>(s[i + j]);
  4438. if ((b & 0xC0) != 0x80) { return false; }
  4439. cp = (cp << 6) | (b & 0x3F);
  4440. }
  4441. // Overlong encoding check
  4442. if (len == 2 && cp < 0x80) { return false; }
  4443. if (len == 3 && cp < 0x800) { return false; }
  4444. if (len == 4 && cp < 0x10000) { return false; }
  4445. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4446. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4447. if (cp > 0x10FFFF) { return false; }
  4448. i += len;
  4449. }
  4450. return true;
  4451. }
  4452. } // namespace impl
  4453. } // namespace ws
  4454. namespace detail {
  4455. // NOTE: This code came up with the following stackoverflow post:
  4456. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4457. inline std::string base64_encode(const std::string &in) {
  4458. static const auto lookup =
  4459. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4460. std::string out;
  4461. out.reserve(in.size());
  4462. // Unsigned: the accumulator is never masked, so with a signed int the
  4463. // `val << 8` below overflows once enough bytes are folded in (undefined
  4464. // behaviour before C++20). Only the low bits are ever emitted, so the
  4465. // wrap-around of an unsigned accumulator does not affect the output.
  4466. uint32_t val = 0;
  4467. auto valb = -6;
  4468. for (auto c : in) {
  4469. val = (val << 8) + static_cast<uint8_t>(c);
  4470. valb += 8;
  4471. while (valb >= 0) {
  4472. out.push_back(lookup[(val >> valb) & 0x3F]);
  4473. valb -= 6;
  4474. }
  4475. }
  4476. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4477. while (out.size() % 4) {
  4478. out.push_back('=');
  4479. }
  4480. return out;
  4481. }
  4482. inline std::string sha1(const std::string &input) {
  4483. // RFC 3174 SHA-1 implementation
  4484. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4485. return (x << n) | (x >> (32 - n));
  4486. };
  4487. uint32_t h0 = 0x67452301;
  4488. uint32_t h1 = 0xEFCDAB89;
  4489. uint32_t h2 = 0x98BADCFE;
  4490. uint32_t h3 = 0x10325476;
  4491. uint32_t h4 = 0xC3D2E1F0;
  4492. // Pre-processing: adding padding bits
  4493. std::string msg = input;
  4494. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4495. msg.push_back(static_cast<char>(0x80u));
  4496. while (msg.size() % 64 != 56) {
  4497. msg.push_back(0);
  4498. }
  4499. // Append original length in bits as 64-bit big-endian
  4500. for (int i = 56; i >= 0; i -= 8) {
  4501. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4502. }
  4503. // Process each 512-bit chunk
  4504. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4505. uint32_t w[80];
  4506. for (size_t i = 0; i < 16; i++) {
  4507. w[i] =
  4508. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4509. << 24) |
  4510. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4511. << 16) |
  4512. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4513. << 8) |
  4514. (static_cast<uint32_t>(
  4515. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4516. }
  4517. for (int i = 16; i < 80; i++) {
  4518. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4519. }
  4520. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4521. for (int i = 0; i < 80; i++) {
  4522. uint32_t f, k;
  4523. if (i < 20) {
  4524. f = (b & c) | ((~b) & d);
  4525. k = 0x5A827999;
  4526. } else if (i < 40) {
  4527. f = b ^ c ^ d;
  4528. k = 0x6ED9EBA1;
  4529. } else if (i < 60) {
  4530. f = (b & c) | (b & d) | (c & d);
  4531. k = 0x8F1BBCDC;
  4532. } else {
  4533. f = b ^ c ^ d;
  4534. k = 0xCA62C1D6;
  4535. }
  4536. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4537. e = d;
  4538. d = c;
  4539. c = left_rotate(b, 30);
  4540. b = a;
  4541. a = temp;
  4542. }
  4543. h0 += a;
  4544. h1 += b;
  4545. h2 += c;
  4546. h3 += d;
  4547. h4 += e;
  4548. }
  4549. // Produce the final hash as a 20-byte binary string
  4550. std::string hash(20, '\0');
  4551. for (size_t i = 0; i < 4; i++) {
  4552. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4553. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4554. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4555. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4556. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4557. }
  4558. return hash;
  4559. }
  4560. inline std::string websocket_accept_key(const std::string &client_key) {
  4561. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4562. return base64_encode(sha1(client_key + magic));
  4563. }
  4564. inline bool is_websocket_upgrade(const Request &req) {
  4565. if (req.method != "GET") { return false; }
  4566. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4567. // list of protocols and asks recipients to match each name
  4568. // case-insensitively, so look for the token rather than compare the whole
  4569. // field value.
  4570. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4571. // Check Connection: Upgrade
  4572. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4573. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4574. // RFC 6455 Section 4.2.1
  4575. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4576. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4577. return false;
  4578. }
  4579. static const std::string b64chars =
  4580. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4581. for (size_t i = 0; i < 22; i++) {
  4582. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4583. }
  4584. // Check Sec-WebSocket-Version: 13
  4585. auto version = req.get_header_value("Sec-WebSocket-Version");
  4586. if (version != "13") { return false; }
  4587. return true;
  4588. }
  4589. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4590. const char *data, size_t len, bool fin,
  4591. bool mask) {
  4592. // First byte: FIN + opcode
  4593. uint8_t header[2];
  4594. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4595. (static_cast<uint8_t>(opcode) & 0x0F));
  4596. // Second byte: MASK + payload length
  4597. if (len < 126) {
  4598. header[1] = static_cast<uint8_t>(len);
  4599. if (mask) { header[1] |= 0x80; }
  4600. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4601. } else if (len <= 0xFFFF) {
  4602. header[1] = 126;
  4603. if (mask) { header[1] |= 0x80; }
  4604. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4605. uint8_t ext[2];
  4606. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4607. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4608. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4609. } else {
  4610. header[1] = 127;
  4611. if (mask) { header[1] |= 0x80; }
  4612. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4613. uint8_t ext[8];
  4614. for (int i = 7; i >= 0; i--) {
  4615. ext[7 - i] =
  4616. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4617. }
  4618. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4619. }
  4620. if (mask) {
  4621. // Generate random mask key
  4622. thread_local std::mt19937 rng(std::random_device{}());
  4623. uint8_t mask_key[4];
  4624. auto r = rng();
  4625. std::memcpy(mask_key, &r, 4);
  4626. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4627. // Write masked payload in chunks
  4628. const size_t chunk_size = 4096;
  4629. std::vector<char> buf((std::min)(len, chunk_size));
  4630. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4631. size_t n = (std::min)(chunk_size, len - offset);
  4632. for (size_t i = 0; i < n; i++) {
  4633. buf[i] =
  4634. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4635. }
  4636. if (strm.write(buf.data(), n) < 0) { return false; }
  4637. }
  4638. } else {
  4639. if (len > 0) {
  4640. if (strm.write(data, len) < 0) { return false; }
  4641. }
  4642. }
  4643. return true;
  4644. }
  4645. } // namespace detail
  4646. namespace ws {
  4647. namespace impl {
  4648. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4649. // hands back whatever its buffer already holds -- so every multi-byte field has
  4650. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4651. // header straddles the read buffer's boundary.
  4652. //
  4653. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4654. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4655. // there is a failure like any other. (When read() fails it always records why,
  4656. // so the error belongs to this call and not to an earlier one.)
  4657. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4658. auto p = static_cast<char *>(buf);
  4659. size_t total = 0;
  4660. while (total < size) {
  4661. auto n = strm.read(p + total, size - total);
  4662. if (n <= 0) {
  4663. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4664. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4665. }
  4666. total += static_cast<size_t>(n);
  4667. }
  4668. return FrameRead::Ok;
  4669. }
  4670. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4671. std::string &payload, bool &fin,
  4672. bool expect_masked, size_t max_len) {
  4673. // Read first 2 bytes. This is the only read that may report a timeout: it
  4674. // sits on a frame boundary, where nothing has been consumed yet.
  4675. uint8_t header[2];
  4676. FrameRead first = read_exact(strm, header, 2);
  4677. if (first != FrameRead::Ok) { return first; }
  4678. fin = (header[0] & 0x80) != 0;
  4679. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4680. if (header[0] & 0x70) { return FrameRead::Fail; }
  4681. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4682. bool masked = (header[1] & 0x80) != 0;
  4683. uint64_t payload_len = header[1] & 0x7F;
  4684. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4685. // MUST have a payload length of 125 bytes or less
  4686. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4687. if (is_control) {
  4688. if (!fin) { return FrameRead::Fail; }
  4689. if (payload_len > 125) { return FrameRead::Fail; }
  4690. }
  4691. if (masked != expect_masked) { return FrameRead::Fail; }
  4692. // Extended payload length
  4693. if (payload_len == 126) {
  4694. uint8_t ext[2];
  4695. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4696. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4697. } else if (payload_len == 127) {
  4698. uint8_t ext[8];
  4699. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4700. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4701. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4702. payload_len = 0;
  4703. for (int i = 0; i < 8; i++) {
  4704. payload_len = (payload_len << 8) | ext[i];
  4705. }
  4706. }
  4707. if (payload_len > max_len) { return FrameRead::Fail; }
  4708. // Read mask key if present
  4709. uint8_t mask_key[4] = {0};
  4710. if (masked) {
  4711. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4712. return FrameRead::Fail;
  4713. }
  4714. }
  4715. // Read payload
  4716. payload.resize(static_cast<size_t>(payload_len));
  4717. if (payload_len > 0 &&
  4718. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4719. FrameRead::Ok) {
  4720. return FrameRead::Fail;
  4721. }
  4722. // Unmask if needed
  4723. if (masked) {
  4724. for (size_t i = 0; i < payload.size(); i++) {
  4725. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4726. }
  4727. }
  4728. return FrameRead::Ok;
  4729. }
  4730. } // namespace impl
  4731. } // namespace ws
  4732. namespace detail {
  4733. inline bool is_valid_path(const std::string &path) {
  4734. size_t level = 0;
  4735. size_t i = 0;
  4736. // Skip slash
  4737. while (i < path.size() && path[i] == '/') {
  4738. i++;
  4739. }
  4740. while (i < path.size()) {
  4741. // Read component
  4742. auto beg = i;
  4743. while (i < path.size() && path[i] != '/') {
  4744. if (path[i] == '\0') {
  4745. return false;
  4746. } else if (path[i] == '\\') {
  4747. return false;
  4748. }
  4749. i++;
  4750. }
  4751. auto len = i - beg;
  4752. assert(len > 0);
  4753. if (!path.compare(beg, len, ".")) {
  4754. ;
  4755. } else if (!path.compare(beg, len, "..")) {
  4756. if (level == 0) { return false; }
  4757. level--;
  4758. } else {
  4759. level++;
  4760. }
  4761. // Skip slash
  4762. while (i < path.size() && path[i] == '/') {
  4763. i++;
  4764. }
  4765. }
  4766. return true;
  4767. }
  4768. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4769. #if defined(_WIN32)
  4770. char buf[_MAX_PATH];
  4771. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4772. resolved = buf;
  4773. #elif defined(PATH_MAX)
  4774. char buf[PATH_MAX];
  4775. if (realpath(path, buf) == nullptr) { return false; }
  4776. resolved = buf;
  4777. #else
  4778. auto buf = realpath(path, nullptr);
  4779. auto guard = scope_exit([&]() { std::free(buf); });
  4780. if (buf == nullptr) { return false; }
  4781. resolved = buf;
  4782. #endif
  4783. return true;
  4784. }
  4785. inline bool is_path_within_base(const std::string &resolved_path,
  4786. const std::string &resolved_base) {
  4787. #if defined(_WIN32)
  4788. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4789. resolved_base.size()) == 0;
  4790. #else
  4791. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4792. resolved_base.size()) == 0;
  4793. #endif
  4794. }
  4795. inline FileStat::FileStat(const std::string &path) {
  4796. #if defined(_WIN32)
  4797. auto wpath = u8string_to_wstring(path.c_str());
  4798. ret_ = _wstat(wpath.c_str(), &st_);
  4799. #else
  4800. ret_ = stat(path.c_str(), &st_);
  4801. #endif
  4802. }
  4803. inline bool FileStat::is_file() const {
  4804. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4805. }
  4806. inline bool FileStat::is_dir() const {
  4807. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4808. }
  4809. inline time_t FileStat::mtime() const {
  4810. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4811. : static_cast<time_t>(-1);
  4812. }
  4813. inline size_t FileStat::size() const {
  4814. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4815. }
  4816. inline std::string encode_path(const std::string &s) {
  4817. std::string result;
  4818. result.reserve(s.size());
  4819. for (size_t i = 0; s[i]; i++) {
  4820. switch (s[i]) {
  4821. case ' ': result += "%20"; break;
  4822. case '+': result += "%2B"; break;
  4823. case '\'': result += "%27"; break;
  4824. case ',': result += "%2C"; break;
  4825. // case ':': result += "%3A"; break; // ok? probably...
  4826. case ';': result += "%3B"; break;
  4827. default:
  4828. auto c = static_cast<uint8_t>(s[i]);
  4829. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4830. // in a request-target as-is.
  4831. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4832. result += '%';
  4833. char hex[4];
  4834. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4835. assert(len == 2);
  4836. result.append(hex, static_cast<size_t>(len));
  4837. } else {
  4838. result += s[i];
  4839. }
  4840. break;
  4841. }
  4842. }
  4843. return result;
  4844. }
  4845. inline std::string file_extension(const std::string &path) {
  4846. std::smatch m;
  4847. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4848. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4849. return std::string();
  4850. }
  4851. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4852. template <typename T>
  4853. inline bool parse_header(const char *beg, const char *end, T fn);
  4854. template <typename T>
  4855. inline bool parse_header(const char *beg, const char *end, T fn) {
  4856. // Skip trailing spaces and tabs.
  4857. while (beg < end && is_space_or_tab(end[-1])) {
  4858. end--;
  4859. }
  4860. auto p = beg;
  4861. while (p < end && *p != ':') {
  4862. p++;
  4863. }
  4864. auto name = std::string(beg, p);
  4865. if (!detail::fields::is_field_name(name)) { return false; }
  4866. if (p == end) { return false; }
  4867. auto key_end = p;
  4868. if (*p++ != ':') { return false; }
  4869. while (p < end && is_space_or_tab(*p)) {
  4870. p++;
  4871. }
  4872. if (p <= end) {
  4873. auto key_len = key_end - beg;
  4874. if (!key_len) { return false; }
  4875. auto key = std::string(beg, key_end);
  4876. auto val = std::string(p, end);
  4877. if (!detail::fields::is_field_value(val)) { return false; }
  4878. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4879. // percent-decoded by the recipient. Applications that need to interpret a
  4880. // value as a URI component should call httplib::decode_uri_component()
  4881. // (or decode_path_component()) explicitly.
  4882. fn(key, val);
  4883. return true;
  4884. }
  4885. return false;
  4886. }
  4887. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4888. const Headers &src_headers) {
  4889. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4890. // transfer coding is complete when a chunk with a chunk-size of zero is
  4891. // received, possibly followed by a trailer section, and finally terminated by
  4892. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4893. //
  4894. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4895. // doesn't care for the existence of the final CRLF. In other words, it seems
  4896. // to be ok whether the final CRLF exists or not in the chunked data.
  4897. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4898. //
  4899. // According to the reference code in RFC 9112, cpp-httplib now allows
  4900. // chunked transfer coding data without the final CRLF.
  4901. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4902. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4903. "transfer-encoding",
  4904. "content-length",
  4905. "host",
  4906. "authorization",
  4907. "www-authenticate",
  4908. "proxy-authenticate",
  4909. "proxy-authorization",
  4910. "cookie",
  4911. "set-cookie",
  4912. "cache-control",
  4913. "expect",
  4914. "max-forwards",
  4915. "pragma",
  4916. "range",
  4917. "te",
  4918. "age",
  4919. "expires",
  4920. "date",
  4921. "location",
  4922. "retry-after",
  4923. "vary",
  4924. "warning",
  4925. "content-encoding",
  4926. "content-type",
  4927. "content-range",
  4928. "trailer"};
  4929. case_ignore::unordered_set<std::string> declared_trailers;
  4930. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4931. if (!trailer_header.empty()) {
  4932. // split() trims each token and skips empty ones, so the name arrives ready
  4933. // to look up.
  4934. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4935. ',', [&](const char *b, const char *e) {
  4936. // A legitimate message declares only a handful of trailers. Cap the
  4937. // set so a peer cannot grow it without bound: an oversized set only
  4938. // arises from an attempt to force many colliding names into
  4939. // quadratic lookups (case_ignore::hash is unkeyed).
  4940. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4941. return;
  4942. }
  4943. std::string key(b, e);
  4944. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4945. declared_trailers.insert(key);
  4946. }
  4947. });
  4948. }
  4949. size_t trailer_header_count = 0;
  4950. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4951. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4952. // Count every received trailer field, not only the declared ones stored in
  4953. // dest, so undeclared fields cannot keep this loop running past the limit.
  4954. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4955. constexpr auto line_terminator_len = 2;
  4956. auto line_beg = line_reader.ptr();
  4957. auto line_end =
  4958. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4959. if (!parse_header(line_beg, line_end,
  4960. [&](const std::string &key, const std::string &val) {
  4961. if (declared_trailers.find(key) !=
  4962. declared_trailers.end()) {
  4963. dest.emplace(key, val);
  4964. }
  4965. })) {
  4966. return false;
  4967. }
  4968. trailer_header_count++;
  4969. if (!line_reader.getline()) { return false; }
  4970. }
  4971. return true;
  4972. }
  4973. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4974. size_t right) {
  4975. while (b + left < e && is_space_or_tab(b[left])) {
  4976. left++;
  4977. }
  4978. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4979. right--;
  4980. }
  4981. return std::make_pair(left, right);
  4982. }
  4983. inline std::string trim_copy(const std::string &s) {
  4984. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4985. return s.substr(r.first, r.second - r.first);
  4986. }
  4987. inline std::string trim_double_quotes_copy(const std::string &s) {
  4988. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4989. return s.substr(1, s.size() - 2);
  4990. }
  4991. return s;
  4992. }
  4993. inline void
  4994. divide(const char *data, std::size_t size, char d,
  4995. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4996. fn) {
  4997. const auto it = std::find(data, data + size, d);
  4998. const auto found = static_cast<std::size_t>(it != data + size);
  4999. const auto lhs_data = data;
  5000. const auto lhs_size = static_cast<std::size_t>(it - data);
  5001. const auto rhs_data = it + found;
  5002. const auto rhs_size = size - lhs_size - found;
  5003. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5004. }
  5005. inline void
  5006. divide(const std::string &str, char d,
  5007. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5008. fn) {
  5009. divide(str.data(), str.size(), d, std::move(fn));
  5010. }
  5011. inline void split(const char *b, const char *e, char d,
  5012. std::function<void(const char *, const char *)> fn) {
  5013. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5014. }
  5015. inline void split(const char *b, const char *e, char d, size_t m,
  5016. std::function<void(const char *, const char *)> fn) {
  5017. size_t i = 0;
  5018. size_t beg = 0;
  5019. size_t count = 1;
  5020. while (e ? (b + i < e) : (b[i] != '\0')) {
  5021. if (b[i] == d && count < m) {
  5022. auto r = trim(b, e, beg, i);
  5023. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5024. beg = i + 1;
  5025. count++;
  5026. }
  5027. i++;
  5028. }
  5029. if (i) {
  5030. auto r = trim(b, e, beg, i);
  5031. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5032. }
  5033. }
  5034. // Same contract as split(), except that a delimiter inside a quoted-string is
  5035. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5036. // quoted-string, and ';' and '=' are legal characters inside one.
  5037. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5038. std::function<void(const char *, const char *)> fn) {
  5039. size_t i = 0;
  5040. size_t beg = 0;
  5041. size_t count = 1;
  5042. auto in_quotes = false;
  5043. while (e ? (b + i < e) : (b[i] != '\0')) {
  5044. if (b[i] == '"') {
  5045. in_quotes = !in_quotes;
  5046. } else if (b[i] == d && !in_quotes && count < m) {
  5047. auto r = trim(b, e, beg, i);
  5048. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5049. beg = i + 1;
  5050. count++;
  5051. }
  5052. i++;
  5053. }
  5054. if (i) {
  5055. auto r = trim(b, e, beg, i);
  5056. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5057. }
  5058. }
  5059. inline void split_unquoted(const char *b, const char *e, char d,
  5060. std::function<void(const char *, const char *)> fn) {
  5061. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5062. std::move(fn));
  5063. }
  5064. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5065. // key a token, so the first '=' is the separator even when the value is a
  5066. // quoted-string carrying more of them.
  5067. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5068. std::string &val) {
  5069. divide(
  5070. b, static_cast<std::size_t>(e - b), '=',
  5071. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5072. const auto kr = trim(kb, kb + klen, 0, klen);
  5073. key.assign(kb + kr.first, kb + kr.second);
  5074. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5075. val.assign(vb + vr.first, vb + vr.second);
  5076. });
  5077. }
  5078. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5079. std::function<bool(const char *, const char *)> fn) {
  5080. size_t i = 0;
  5081. size_t beg = 0;
  5082. size_t count = 1;
  5083. while (e ? (b + i < e) : (b[i] != '\0')) {
  5084. if (b[i] == d && count < m) {
  5085. auto r = trim(b, e, beg, i);
  5086. if (r.first < r.second) {
  5087. auto found = fn(&b[r.first], &b[r.second]);
  5088. if (found) { return true; }
  5089. }
  5090. beg = i + 1;
  5091. count++;
  5092. }
  5093. i++;
  5094. }
  5095. if (i) {
  5096. auto r = trim(b, e, beg, i);
  5097. if (r.first < r.second) {
  5098. auto found = fn(&b[r.first], &b[r.second]);
  5099. if (found) { return true; }
  5100. }
  5101. }
  5102. return false;
  5103. }
  5104. inline bool split_find(const char *b, const char *e, char d,
  5105. std::function<bool(const char *, const char *)> fn) {
  5106. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5107. std::move(fn));
  5108. }
  5109. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5110. size_t fixed_buffer_size)
  5111. : strm_(strm), fixed_buffer_(fixed_buffer),
  5112. fixed_buffer_size_(fixed_buffer_size) {}
  5113. inline const char *stream_line_reader::ptr() const {
  5114. if (growable_buffer_.empty()) {
  5115. return fixed_buffer_;
  5116. } else {
  5117. return growable_buffer_.data();
  5118. }
  5119. }
  5120. inline size_t stream_line_reader::size() const {
  5121. if (growable_buffer_.empty()) {
  5122. return fixed_buffer_used_size_;
  5123. } else {
  5124. return growable_buffer_.size();
  5125. }
  5126. }
  5127. inline bool stream_line_reader::end_with_crlf() const {
  5128. auto end = ptr() + size();
  5129. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5130. }
  5131. inline bool stream_line_reader::getline() {
  5132. fixed_buffer_used_size_ = 0;
  5133. growable_buffer_.clear();
  5134. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5135. char prev_byte = 0;
  5136. #endif
  5137. for (size_t i = 0;; i++) {
  5138. // Fast path: whatever the stream has already buffered can be scanned for
  5139. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5140. // call, a bounds check and a one-byte copy per character of the request.
  5141. size_t buffered_size = 0;
  5142. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5143. auto take = buffered_size;
  5144. auto terminated = false;
  5145. for (size_t at = 0; at < buffered_size;) {
  5146. auto nl = static_cast<const char *>(
  5147. memchr(buffered + at, '\n', buffered_size - at));
  5148. if (!nl) { break; }
  5149. auto pos = static_cast<size_t>(nl - buffered);
  5150. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5151. take = pos + 1;
  5152. terminated = true;
  5153. break;
  5154. #else
  5155. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5156. // be the last byte of an earlier chunk, hence prev_byte.
  5157. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5158. take = pos + 1;
  5159. terminated = true;
  5160. break;
  5161. }
  5162. at = pos + 1;
  5163. #endif
  5164. }
  5165. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5166. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5167. prev_byte = buffered[take - 1];
  5168. #endif
  5169. append(buffered, take);
  5170. strm_.consume_buffered(take);
  5171. i += take;
  5172. if (terminated) { return true; }
  5173. continue;
  5174. }
  5175. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5176. // Treat exceptionally long lines as an error to
  5177. // prevent infinite loops/memory exhaustion
  5178. return false;
  5179. }
  5180. char byte;
  5181. auto n = strm_.read(&byte, 1);
  5182. if (n < 0) {
  5183. return false;
  5184. } else if (n == 0) {
  5185. if (i == 0) {
  5186. return false;
  5187. } else {
  5188. break;
  5189. }
  5190. }
  5191. append(byte);
  5192. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5193. if (byte == '\n') { break; }
  5194. #else
  5195. if (prev_byte == '\r' && byte == '\n') { break; }
  5196. prev_byte = byte;
  5197. #endif
  5198. }
  5199. return true;
  5200. }
  5201. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5202. inline void stream_line_reader::append(const char *data, size_t size) {
  5203. // Once the line has outgrown the fixed buffer everything must keep going to
  5204. // the growable one, even if a later chunk would have fit. Without the
  5205. // emptiness check a short append after a long one would land in the fixed
  5206. // buffer, which ptr() and size() no longer look at, and be lost.
  5207. if (growable_buffer_.empty() &&
  5208. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5209. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5210. fixed_buffer_used_size_ += size;
  5211. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5212. } else {
  5213. // Unlike the per-character overload, this can be the very first append of
  5214. // the line, so the fixed buffer may hold nothing and carry no terminator
  5215. // yet. assign() takes an explicit length and does not need one.
  5216. if (growable_buffer_.empty()) {
  5217. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5218. }
  5219. growable_buffer_.append(data, size);
  5220. }
  5221. }
  5222. inline mmap::mmap(const char *path) { open(path); }
  5223. inline mmap::~mmap() { close(); }
  5224. inline bool mmap::open(const char *path) {
  5225. close();
  5226. #if defined(_WIN32)
  5227. auto wpath = u8string_to_wstring(path);
  5228. if (wpath.empty()) { return false; }
  5229. hFile_ =
  5230. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5231. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5232. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5233. LARGE_INTEGER size{};
  5234. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5235. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5236. // See:
  5237. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5238. if (static_cast<ULONGLONG>(size.QuadPart) >
  5239. (std::numeric_limits<decltype(size_)>::max)()) {
  5240. // `size_t` might be 32-bits, on 32-bits Windows.
  5241. return false;
  5242. }
  5243. size_ = static_cast<size_t>(size.QuadPart);
  5244. hMapping_ =
  5245. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5246. // Special treatment for an empty file...
  5247. if (hMapping_ == NULL && size_ == 0) {
  5248. close();
  5249. is_open_empty_file = true;
  5250. return true;
  5251. }
  5252. if (hMapping_ == NULL) {
  5253. close();
  5254. return false;
  5255. }
  5256. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5257. if (addr_ == nullptr) {
  5258. close();
  5259. return false;
  5260. }
  5261. #else
  5262. fd_ = ::open(path, O_RDONLY);
  5263. if (fd_ == -1) { return false; }
  5264. struct stat sb;
  5265. if (fstat(fd_, &sb) == -1) {
  5266. close();
  5267. return false;
  5268. }
  5269. size_ = static_cast<size_t>(sb.st_size);
  5270. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5271. // Special treatment for an empty file...
  5272. if (addr_ == MAP_FAILED && size_ == 0) {
  5273. close();
  5274. is_open_empty_file = true;
  5275. return false;
  5276. }
  5277. if (addr_ == MAP_FAILED) {
  5278. // Clear the sentinel before `close()`, since `is_open()` only checks
  5279. // `addr_` against nullptr and `munmap()` must not be called with it.
  5280. addr_ = nullptr;
  5281. close();
  5282. return false;
  5283. }
  5284. #endif
  5285. return true;
  5286. }
  5287. inline bool mmap::is_open() const {
  5288. return is_open_empty_file ? true : addr_ != nullptr;
  5289. }
  5290. inline size_t mmap::size() const { return size_; }
  5291. inline const char *mmap::data() const {
  5292. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5293. }
  5294. inline void mmap::close() {
  5295. #if defined(_WIN32)
  5296. if (addr_) {
  5297. ::UnmapViewOfFile(addr_);
  5298. addr_ = nullptr;
  5299. }
  5300. if (hMapping_) {
  5301. ::CloseHandle(hMapping_);
  5302. hMapping_ = NULL;
  5303. }
  5304. if (hFile_ != INVALID_HANDLE_VALUE) {
  5305. ::CloseHandle(hFile_);
  5306. hFile_ = INVALID_HANDLE_VALUE;
  5307. }
  5308. is_open_empty_file = false;
  5309. #else
  5310. if (addr_ != nullptr) {
  5311. munmap(addr_, size_);
  5312. addr_ = nullptr;
  5313. }
  5314. if (fd_ != -1) {
  5315. ::close(fd_);
  5316. fd_ = -1;
  5317. }
  5318. #endif
  5319. size_ = 0;
  5320. }
  5321. inline int close_socket(socket_t sock) noexcept {
  5322. #ifdef _WIN32
  5323. return closesocket(sock);
  5324. #else
  5325. return close(sock);
  5326. #endif
  5327. }
  5328. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5329. ssize_t res = 0;
  5330. while (true) {
  5331. res = fn();
  5332. if (res < 0 && errno == EINTR) {
  5333. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5334. continue;
  5335. }
  5336. break;
  5337. }
  5338. return res;
  5339. }
  5340. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5341. return handle_EINTR([&]() {
  5342. return recv(sock,
  5343. #ifdef _WIN32
  5344. static_cast<char *>(ptr), static_cast<int>(size),
  5345. #else
  5346. ptr, size,
  5347. #endif
  5348. flags);
  5349. });
  5350. }
  5351. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5352. int flags) {
  5353. return handle_EINTR([&]() {
  5354. return send(sock,
  5355. #ifdef _WIN32
  5356. static_cast<const char *>(ptr), static_cast<int>(size),
  5357. #else
  5358. ptr, size,
  5359. #endif
  5360. flags);
  5361. });
  5362. }
  5363. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5364. #ifdef _WIN32
  5365. return ::WSAPoll(fds, nfds, timeout);
  5366. #else
  5367. return ::poll(fds, nfds, timeout);
  5368. #endif
  5369. }
  5370. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5371. time_t usec) {
  5372. struct pollfd pfd;
  5373. pfd.fd = sock;
  5374. pfd.events = events;
  5375. pfd.revents = 0;
  5376. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5377. // "return immediately", which callers here rely on to probe a socket.
  5378. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5379. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5380. }
  5381. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5382. return select_impl(sock, POLLIN, sec, usec);
  5383. }
  5384. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5385. return select_impl(sock, POLLOUT, sec, usec);
  5386. }
  5387. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5388. time_t usec) {
  5389. struct pollfd pfd_read;
  5390. pfd_read.fd = sock;
  5391. pfd_read.events = POLLIN | POLLOUT;
  5392. pfd_read.revents = 0;
  5393. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5394. auto poll_res =
  5395. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5396. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5397. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5398. auto error = 0;
  5399. socklen_t len = sizeof(error);
  5400. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5401. reinterpret_cast<char *>(&error), &len);
  5402. auto successful = res >= 0 && !error;
  5403. return successful ? Error::Success : Error::Connection;
  5404. }
  5405. return Error::Connection;
  5406. }
  5407. inline bool is_socket_alive(socket_t sock) {
  5408. const auto val = detail::select_read(sock, 0, 0);
  5409. if (val == 0) {
  5410. return true;
  5411. } else if (val < 0 && errno == EBADF) {
  5412. return false;
  5413. }
  5414. char buf[1];
  5415. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5416. }
  5417. class SocketStream final : public Stream {
  5418. public:
  5419. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5420. time_t write_timeout_sec, time_t write_timeout_usec,
  5421. time_t max_timeout_msec = 0,
  5422. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5423. (std::chrono::steady_clock::time_point::min)());
  5424. ~SocketStream() override;
  5425. bool is_readable() const override;
  5426. bool wait_readable() const override;
  5427. bool wait_writable() const override;
  5428. bool is_peer_alive() const override;
  5429. ssize_t read(char *ptr, size_t size) override;
  5430. ssize_t write(const char *ptr, size_t size) override;
  5431. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5432. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5433. socket_t socket() const override;
  5434. time_t duration() const override;
  5435. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5436. const char *buffered_data(size_t &size) const override;
  5437. void consume_buffered(size_t size) override;
  5438. // The caller has just seen this socket become readable. Lets the next read
  5439. // skip its own readiness wait, which would otherwise ask the kernel a
  5440. // question that was answered a moment ago. Consumed by that read.
  5441. void set_readable_hint() { readable_hint_ = true; }
  5442. private:
  5443. bool ensure_readable();
  5444. socket_t sock_;
  5445. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5446. // thread while a read is in flight -- that is the point of it, for a caller
  5447. // holding one connection and wanting control back to send on it.
  5448. std::atomic<time_t> read_timeout_sec_;
  5449. std::atomic<time_t> read_timeout_usec_;
  5450. time_t write_timeout_sec_;
  5451. time_t write_timeout_usec_;
  5452. time_t max_timeout_msec_;
  5453. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5454. std::vector<char> read_buff_;
  5455. size_t read_buff_off_ = 0;
  5456. size_t read_buff_content_size_ = 0;
  5457. bool readable_hint_ = false;
  5458. static const size_t read_buff_size_ = 1024l * 4;
  5459. };
  5460. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5461. time_t keep_alive_timeout_sec) {
  5462. using namespace std::chrono;
  5463. const auto interval_usec =
  5464. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5465. // Avoid expensive `steady_clock::now()` call for the first time
  5466. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5467. const auto start = steady_clock::now() - microseconds{interval_usec};
  5468. const auto timeout = seconds{keep_alive_timeout_sec};
  5469. while (true) {
  5470. if (svr_sock == INVALID_SOCKET) {
  5471. break; // Server socket is closed
  5472. }
  5473. auto val = select_read(sock, 0, interval_usec);
  5474. if (val < 0) {
  5475. break; // Ssocket error
  5476. } else if (val == 0) {
  5477. if (steady_clock::now() - start > timeout) {
  5478. break; // Timeout
  5479. }
  5480. } else {
  5481. return true; // Ready for read
  5482. }
  5483. }
  5484. return false;
  5485. }
  5486. template <typename T>
  5487. inline bool
  5488. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5489. size_t keep_alive_max_count,
  5490. time_t keep_alive_timeout_sec, T callback) {
  5491. assert(keep_alive_max_count > 0);
  5492. auto ret = false;
  5493. auto count = keep_alive_max_count;
  5494. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5495. auto close_connection = count == 1;
  5496. auto connection_closed = false;
  5497. ret = callback(close_connection, connection_closed);
  5498. if (!ret || connection_closed) { break; }
  5499. count--;
  5500. }
  5501. return ret;
  5502. }
  5503. template <typename T>
  5504. inline bool
  5505. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5506. size_t keep_alive_max_count,
  5507. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5508. time_t read_timeout_usec, time_t write_timeout_sec,
  5509. time_t write_timeout_usec, T callback) {
  5510. return process_server_socket_core(
  5511. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5512. [&](bool close_connection, bool &connection_closed) {
  5513. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5514. write_timeout_sec, write_timeout_usec);
  5515. // process_server_socket_core() only gets here once keep_alive() has
  5516. // seen the socket go readable.
  5517. strm.set_readable_hint();
  5518. return callback(strm, close_connection, connection_closed);
  5519. });
  5520. }
  5521. inline bool process_client_socket(
  5522. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5523. time_t write_timeout_sec, time_t write_timeout_usec,
  5524. time_t max_timeout_msec,
  5525. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5526. std::function<bool(Stream &)> callback) {
  5527. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5528. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5529. start_time);
  5530. return callback(strm);
  5531. }
  5532. inline int shutdown_socket(socket_t sock) noexcept {
  5533. #ifdef _WIN32
  5534. return shutdown(sock, SD_BOTH);
  5535. #else
  5536. return shutdown(sock, SHUT_RDWR);
  5537. #endif
  5538. }
  5539. // Half-closes the write side and drains any in-flight/queued bytes before
  5540. // the final shutdown+close. Closing with unread data in the receive queue
  5541. // (or bytes arriving after the receive side is closed) makes the stack send
  5542. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5543. // response as a failed read even though it was fully written.
  5544. inline void drain_and_close_socket(socket_t sock) noexcept {
  5545. #ifdef _WIN32
  5546. shutdown(sock, SD_SEND);
  5547. #else
  5548. shutdown(sock, SHUT_WR);
  5549. #endif
  5550. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5551. size_t total = 0;
  5552. const auto deadline = std::chrono::steady_clock::now() +
  5553. std::chrono::milliseconds(100); // bound #1
  5554. while (total < size_t(1024u * 1024u)) { // bound #2
  5555. const auto remaining =
  5556. std::chrono::duration_cast<std::chrono::microseconds>(
  5557. deadline - std::chrono::steady_clock::now())
  5558. .count();
  5559. if (remaining <= 0) { break; }
  5560. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5561. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5562. if (n <= 0) { break; }
  5563. total += static_cast<size_t>(n);
  5564. }
  5565. shutdown_socket(sock);
  5566. close_socket(sock);
  5567. }
  5568. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5569. if (s.size() > 1 && s[0] == '\0') {
  5570. auto ret = s;
  5571. ret[0] = '@';
  5572. return ret;
  5573. }
  5574. return s;
  5575. }
  5576. inline std::string
  5577. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5578. if (s.size() > 1 && s[0] == '@') {
  5579. auto ret = s;
  5580. ret[0] = '\0';
  5581. return ret;
  5582. }
  5583. return s;
  5584. }
  5585. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5586. const struct addrinfo *hints,
  5587. struct addrinfo **res, time_t timeout_sec) {
  5588. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5589. if (timeout_sec <= 0) {
  5590. // No timeout specified, use standard getaddrinfo
  5591. return getaddrinfo(node, service, hints, res);
  5592. }
  5593. #ifdef _WIN32
  5594. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5595. OVERLAPPED overlapped = {};
  5596. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5597. if (!event) { return EAI_FAIL; }
  5598. overlapped.hEvent = event;
  5599. PADDRINFOEXW result_addrinfo = nullptr;
  5600. HANDLE cancel_handle = nullptr;
  5601. ADDRINFOEXW hints_ex = {};
  5602. if (hints) {
  5603. hints_ex.ai_flags = hints->ai_flags;
  5604. hints_ex.ai_family = hints->ai_family;
  5605. hints_ex.ai_socktype = hints->ai_socktype;
  5606. hints_ex.ai_protocol = hints->ai_protocol;
  5607. }
  5608. auto wnode = u8string_to_wstring(node);
  5609. auto wservice = u8string_to_wstring(service);
  5610. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5611. hints ? &hints_ex : nullptr, &result_addrinfo,
  5612. nullptr, &overlapped, nullptr, &cancel_handle);
  5613. if (ret == WSA_IO_PENDING) {
  5614. auto wait_result =
  5615. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5616. if (wait_result == WAIT_TIMEOUT) {
  5617. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5618. ::CloseHandle(event);
  5619. return EAI_AGAIN;
  5620. }
  5621. DWORD bytes_returned;
  5622. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5623. &bytes_returned, FALSE)) {
  5624. ::CloseHandle(event);
  5625. return ::WSAGetLastError();
  5626. }
  5627. }
  5628. ::CloseHandle(event);
  5629. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5630. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5631. return 0;
  5632. }
  5633. return ret;
  5634. #elif TARGET_OS_MAC && defined(__clang__)
  5635. if (!node) { return EAI_NONAME; }
  5636. // macOS implementation using CFHost API for asynchronous DNS resolution
  5637. CFStringRef hostname_ref = CFStringCreateWithCString(
  5638. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5639. if (!hostname_ref) { return EAI_MEMORY; }
  5640. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5641. CFRelease(hostname_ref);
  5642. if (!host_ref) { return EAI_MEMORY; }
  5643. // Set up context for callback
  5644. struct CFHostContext {
  5645. bool completed = false;
  5646. bool success = false;
  5647. CFArrayRef addresses = nullptr;
  5648. std::mutex mutex;
  5649. std::condition_variable cv;
  5650. } context;
  5651. CFHostClientContext client_context;
  5652. memset(&client_context, 0, sizeof(client_context));
  5653. client_context.info = &context;
  5654. // Set callback
  5655. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5656. const CFStreamError *error, void *info) {
  5657. auto ctx = static_cast<CFHostContext *>(info);
  5658. std::lock_guard<std::mutex> lock(ctx->mutex);
  5659. if (error && error->error != 0) {
  5660. ctx->success = false;
  5661. } else {
  5662. Boolean hasBeenResolved;
  5663. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5664. if (ctx->addresses && hasBeenResolved) {
  5665. CFRetain(ctx->addresses);
  5666. ctx->success = true;
  5667. } else {
  5668. ctx->success = false;
  5669. }
  5670. }
  5671. ctx->completed = true;
  5672. ctx->cv.notify_one();
  5673. };
  5674. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5675. CFRelease(host_ref);
  5676. return EAI_SYSTEM;
  5677. }
  5678. // Schedule on run loop
  5679. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5680. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5681. // Start resolution
  5682. CFStreamError stream_error;
  5683. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5684. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5685. CFRelease(host_ref);
  5686. return EAI_FAIL;
  5687. }
  5688. // Wait for completion with timeout
  5689. auto timeout_time =
  5690. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5691. bool timed_out = false;
  5692. {
  5693. std::unique_lock<std::mutex> lock(context.mutex);
  5694. while (!context.completed) {
  5695. auto now = std::chrono::steady_clock::now();
  5696. if (now >= timeout_time) {
  5697. timed_out = true;
  5698. break;
  5699. }
  5700. // Run the runloop for a short time
  5701. lock.unlock();
  5702. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5703. lock.lock();
  5704. }
  5705. }
  5706. // Clean up
  5707. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5708. CFHostSetClient(host_ref, nullptr, nullptr);
  5709. if (timed_out || !context.completed) {
  5710. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5711. CFRelease(host_ref);
  5712. return EAI_AGAIN;
  5713. }
  5714. if (!context.success || !context.addresses) {
  5715. CFRelease(host_ref);
  5716. return EAI_NODATA;
  5717. }
  5718. // Convert CFArray to addrinfo
  5719. CFIndex count = CFArrayGetCount(context.addresses);
  5720. if (count == 0) {
  5721. CFRelease(context.addresses);
  5722. CFRelease(host_ref);
  5723. return EAI_NODATA;
  5724. }
  5725. struct addrinfo *result_addrinfo = nullptr;
  5726. struct addrinfo **current = &result_addrinfo;
  5727. for (CFIndex i = 0; i < count; i++) {
  5728. CFDataRef addr_data =
  5729. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5730. if (!addr_data) continue;
  5731. const struct sockaddr *sockaddr_ptr =
  5732. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5733. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5734. // Allocate addrinfo structure
  5735. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5736. if (!*current) {
  5737. freeaddrinfo(result_addrinfo);
  5738. CFRelease(context.addresses);
  5739. CFRelease(host_ref);
  5740. return EAI_MEMORY;
  5741. }
  5742. memset(*current, 0, sizeof(struct addrinfo));
  5743. // Set up addrinfo fields
  5744. (*current)->ai_family = sockaddr_ptr->sa_family;
  5745. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5746. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5747. (*current)->ai_addrlen = sockaddr_len;
  5748. // Copy sockaddr
  5749. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5750. if (!(*current)->ai_addr) {
  5751. freeaddrinfo(result_addrinfo);
  5752. CFRelease(context.addresses);
  5753. CFRelease(host_ref);
  5754. return EAI_MEMORY;
  5755. }
  5756. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5757. // Set port if service is specified
  5758. if (service && *service) {
  5759. int port = 0;
  5760. if (parse_port(service, strlen(service), port)) {
  5761. if (sockaddr_ptr->sa_family == AF_INET) {
  5762. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5763. ->sin_port = htons(static_cast<uint16_t>(port));
  5764. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5765. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5766. ->sin6_port = htons(static_cast<uint16_t>(port));
  5767. }
  5768. }
  5769. }
  5770. current = &((*current)->ai_next);
  5771. }
  5772. CFRelease(context.addresses);
  5773. CFRelease(host_ref);
  5774. *res = result_addrinfo;
  5775. return 0;
  5776. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5777. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5778. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5779. // the resolver worker still references the stack-local gaicb. The cancel
  5780. // path therefore waits (gai_suspend with no timeout) for the worker to
  5781. // actually finish before letting the stack frame go. The trade-off is that
  5782. // a wedged DNS server can hold this thread for the system resolver timeout
  5783. // (~30s by default) past the caller's connection timeout.
  5784. struct gaicb request{};
  5785. struct gaicb *requests[1] = {&request};
  5786. struct sigevent sevp{};
  5787. struct timespec timeout{timeout_sec, 0};
  5788. request.ar_name = node;
  5789. request.ar_service = service;
  5790. request.ar_request = hints;
  5791. sevp.sigev_notify = SIGEV_NONE;
  5792. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5793. if (rc != 0) { return rc; }
  5794. auto cleanup = scope_exit([&] {
  5795. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5796. });
  5797. int wait_result = gai_suspend(requests, 1, &timeout);
  5798. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5799. int gai_result = gai_error(&request);
  5800. if (gai_result == 0) {
  5801. *res = request.ar_result;
  5802. request.ar_result = nullptr;
  5803. return 0;
  5804. }
  5805. return gai_result;
  5806. }
  5807. gai_cancel(&request);
  5808. while (gai_error(&request) == EAI_INPROGRESS) {
  5809. gai_suspend(requests, 1, nullptr);
  5810. }
  5811. return wait_result;
  5812. #else
  5813. // Fallback implementation using thread-based timeout for other Unix systems.
  5814. struct GetAddrInfoState {
  5815. ~GetAddrInfoState() {
  5816. if (info) { freeaddrinfo(info); }
  5817. }
  5818. std::mutex mutex;
  5819. std::condition_variable result_cv;
  5820. bool completed = false;
  5821. int result = EAI_SYSTEM;
  5822. std::string node;
  5823. std::string service;
  5824. struct addrinfo hints;
  5825. struct addrinfo *info = nullptr;
  5826. };
  5827. // Allocate on the heap, so the resolver thread can keep using the data.
  5828. auto state = std::make_shared<GetAddrInfoState>();
  5829. if (node) { state->node = node; }
  5830. state->service = service;
  5831. state->hints = *hints;
  5832. std::thread resolve_thread([state]() {
  5833. auto thread_result =
  5834. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5835. &state->info);
  5836. std::lock_guard<std::mutex> lock(state->mutex);
  5837. state->result = thread_result;
  5838. state->completed = true;
  5839. state->result_cv.notify_one();
  5840. });
  5841. // Wait for completion or timeout
  5842. std::unique_lock<std::mutex> lock(state->mutex);
  5843. auto finished =
  5844. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5845. [&] { return state->completed; });
  5846. if (finished) {
  5847. // Operation completed within timeout
  5848. resolve_thread.join();
  5849. *res = state->info;
  5850. state->info = nullptr; // Pass ownership to caller
  5851. return state->result;
  5852. } else {
  5853. // Timeout occurred
  5854. resolve_thread.detach(); // Let the thread finish in background
  5855. return EAI_AGAIN; // Return timeout error
  5856. }
  5857. #endif
  5858. #else
  5859. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5860. return getaddrinfo(node, service, hints, res);
  5861. #endif
  5862. }
  5863. template <typename BindOrConnect>
  5864. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5865. int address_family, int socket_flags, bool tcp_nodelay,
  5866. bool ipv6_v6only, SocketOptions socket_options,
  5867. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5868. // Get address info
  5869. const char *node = nullptr;
  5870. struct addrinfo hints;
  5871. struct addrinfo *result;
  5872. memset(&hints, 0, sizeof(struct addrinfo));
  5873. hints.ai_socktype = SOCK_STREAM;
  5874. hints.ai_protocol = IPPROTO_IP;
  5875. if (!ip.empty()) {
  5876. node = ip.c_str();
  5877. // Ask getaddrinfo to convert IP in c-string to address
  5878. hints.ai_family = AF_UNSPEC;
  5879. hints.ai_flags = AI_NUMERICHOST;
  5880. } else {
  5881. if (!host.empty()) { node = host.c_str(); }
  5882. hints.ai_family = address_family;
  5883. hints.ai_flags = socket_flags;
  5884. }
  5885. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5886. if (hints.ai_family == AF_UNIX) {
  5887. const auto addrlen = host.length();
  5888. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5889. #ifdef SOCK_CLOEXEC
  5890. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5891. hints.ai_protocol);
  5892. #else
  5893. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5894. #endif
  5895. if (sock != INVALID_SOCKET) {
  5896. sockaddr_un addr{};
  5897. addr.sun_family = AF_UNIX;
  5898. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5899. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5900. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5901. hints.ai_addrlen = static_cast<socklen_t>(
  5902. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5903. #ifndef SOCK_CLOEXEC
  5904. #ifndef _WIN32
  5905. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5906. #endif
  5907. #endif
  5908. if (socket_options) { socket_options(sock); }
  5909. #ifdef _WIN32
  5910. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5911. // remove the option.
  5912. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5913. #endif
  5914. bool dummy;
  5915. if (!bind_or_connect(sock, hints, dummy)) {
  5916. close_socket(sock);
  5917. sock = INVALID_SOCKET;
  5918. }
  5919. }
  5920. return sock;
  5921. }
  5922. #endif
  5923. auto service = std::to_string(port);
  5924. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5925. timeout_sec)) {
  5926. #if defined __linux__ && !defined __ANDROID__
  5927. res_init();
  5928. #endif
  5929. return INVALID_SOCKET;
  5930. }
  5931. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5932. for (auto rp = result; rp; rp = rp->ai_next) {
  5933. // Create a socket
  5934. #ifdef _WIN32
  5935. auto sock =
  5936. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5937. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5938. /**
  5939. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5940. * and above the socket creation fails on older Windows Systems.
  5941. *
  5942. * Let's try to create a socket the old way in this case.
  5943. *
  5944. * Reference:
  5945. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5946. *
  5947. * WSA_FLAG_NO_HANDLE_INHERIT:
  5948. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5949. * SP1, and later
  5950. *
  5951. */
  5952. if (sock == INVALID_SOCKET) {
  5953. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5954. }
  5955. #else
  5956. #ifdef SOCK_CLOEXEC
  5957. auto sock =
  5958. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5959. #else
  5960. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5961. #endif
  5962. #endif
  5963. if (sock == INVALID_SOCKET) { continue; }
  5964. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5965. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5966. close_socket(sock);
  5967. continue;
  5968. }
  5969. #endif
  5970. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5971. if (rp->ai_family == AF_INET6) {
  5972. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5973. }
  5974. if (socket_options) { socket_options(sock); }
  5975. // bind or connect
  5976. auto quit = false;
  5977. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5978. close_socket(sock);
  5979. if (quit) { break; }
  5980. }
  5981. return INVALID_SOCKET;
  5982. }
  5983. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5984. #ifdef _WIN32
  5985. auto flags = nonblocking ? 1UL : 0UL;
  5986. ioctlsocket(sock, FIONBIO, &flags);
  5987. #else
  5988. auto flags = fcntl(sock, F_GETFL, 0);
  5989. fcntl(sock, F_SETFL,
  5990. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5991. #endif
  5992. }
  5993. inline bool is_connection_error() {
  5994. #ifdef _WIN32
  5995. return WSAGetLastError() != WSAEWOULDBLOCK;
  5996. #else
  5997. return errno != EINPROGRESS;
  5998. #endif
  5999. }
  6000. // accept() failed because the process or the network stack is temporarily out
  6001. // of resources. The listening socket is still usable, so back off briefly and
  6002. // try again.
  6003. inline bool is_accept_resource_error() {
  6004. #ifdef _WIN32
  6005. auto err = WSAGetLastError();
  6006. return err == WSAEMFILE || err == WSAENOBUFS;
  6007. #else
  6008. auto err = errno;
  6009. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6010. #endif
  6011. }
  6012. // accept() failed for a reason that says nothing about the listening socket:
  6013. // the pending connection went away before it could be accepted, or the call
  6014. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6015. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6016. // connection that way.
  6017. inline bool is_accept_transient_error() {
  6018. #ifdef _WIN32
  6019. auto err = WSAGetLastError();
  6020. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6021. err == WSAECONNABORTED;
  6022. #else
  6023. auto err = errno;
  6024. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6025. err == ECONNABORTED;
  6026. #endif
  6027. }
  6028. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6029. struct addrinfo hints;
  6030. struct addrinfo *result;
  6031. memset(&hints, 0, sizeof(struct addrinfo));
  6032. hints.ai_family = AF_UNSPEC;
  6033. hints.ai_socktype = SOCK_STREAM;
  6034. hints.ai_protocol = 0;
  6035. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6036. return false;
  6037. }
  6038. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6039. auto ret = false;
  6040. for (auto rp = result; rp; rp = rp->ai_next) {
  6041. const auto &ai = *rp;
  6042. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6043. ret = true;
  6044. break;
  6045. }
  6046. }
  6047. return ret;
  6048. }
  6049. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6050. #define USE_IF2IP
  6051. #endif
  6052. #ifdef USE_IF2IP
  6053. inline std::string if2ip(int address_family, const std::string &ifn) {
  6054. struct ifaddrs *ifap;
  6055. getifaddrs(&ifap);
  6056. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6057. std::string addr_candidate;
  6058. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6059. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6060. (AF_UNSPEC == address_family ||
  6061. ifa->ifa_addr->sa_family == address_family)) {
  6062. if (ifa->ifa_addr->sa_family == AF_INET) {
  6063. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6064. char buf[INET_ADDRSTRLEN];
  6065. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6066. return std::string(buf, INET_ADDRSTRLEN);
  6067. }
  6068. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6069. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6070. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6071. char buf[INET6_ADDRSTRLEN] = {};
  6072. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6073. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6074. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6075. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6076. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6077. } else {
  6078. return std::string(buf, INET6_ADDRSTRLEN);
  6079. }
  6080. }
  6081. }
  6082. }
  6083. }
  6084. }
  6085. return addr_candidate;
  6086. }
  6087. #endif
  6088. inline socket_t create_client_socket(
  6089. const std::string &host, const std::string &ip, int port,
  6090. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6091. SocketOptions socket_options, time_t connection_timeout_sec,
  6092. time_t connection_timeout_usec, time_t read_timeout_sec,
  6093. time_t read_timeout_usec, time_t write_timeout_sec,
  6094. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6095. auto sock = create_socket(
  6096. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6097. std::move(socket_options),
  6098. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6099. if (!intf.empty()) {
  6100. #ifdef USE_IF2IP
  6101. auto ip_from_if = if2ip(address_family, intf);
  6102. if (ip_from_if.empty()) { ip_from_if = intf; }
  6103. if (!bind_ip_address(sock2, ip_from_if)) {
  6104. error = Error::BindIPAddress;
  6105. return false;
  6106. }
  6107. #endif
  6108. }
  6109. set_nonblocking(sock2, true);
  6110. auto ret =
  6111. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6112. if (ret < 0) {
  6113. if (is_connection_error()) {
  6114. error = Error::Connection;
  6115. return false;
  6116. }
  6117. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6118. connection_timeout_usec);
  6119. if (error != Error::Success) {
  6120. if (error == Error::ConnectionTimeout) { quit = true; }
  6121. return false;
  6122. }
  6123. }
  6124. set_nonblocking(sock2, false);
  6125. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6126. read_timeout_usec);
  6127. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6128. write_timeout_usec);
  6129. error = Error::Success;
  6130. return true;
  6131. },
  6132. connection_timeout_sec); // Pass DNS timeout
  6133. if (sock != INVALID_SOCKET) {
  6134. error = Error::Success;
  6135. } else {
  6136. if (error == Error::Success) { error = Error::Connection; }
  6137. }
  6138. return sock;
  6139. }
  6140. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6141. socklen_t addr_len, std::string &ip, int &port) {
  6142. if (addr.ss_family == AF_INET) {
  6143. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6144. } else if (addr.ss_family == AF_INET6) {
  6145. port =
  6146. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6147. } else {
  6148. return false;
  6149. }
  6150. std::array<char, NI_MAXHOST> ipstr{};
  6151. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6152. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6153. 0, NI_NUMERICHOST)) {
  6154. return false;
  6155. }
  6156. ip = ipstr.data();
  6157. return true;
  6158. }
  6159. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6160. struct sockaddr_storage addr;
  6161. socklen_t addr_len = sizeof(addr);
  6162. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6163. &addr_len)) {
  6164. get_ip_and_port(addr, addr_len, ip, port);
  6165. }
  6166. }
  6167. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6168. struct sockaddr_storage addr;
  6169. socklen_t addr_len = sizeof(addr);
  6170. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6171. &addr_len)) {
  6172. #ifndef _WIN32
  6173. if (addr.ss_family == AF_UNIX) {
  6174. #if defined(__linux__)
  6175. struct ucred ucred;
  6176. socklen_t len = sizeof(ucred);
  6177. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6178. port = ucred.pid;
  6179. }
  6180. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6181. pid_t pid;
  6182. socklen_t len = sizeof(pid);
  6183. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6184. port = pid;
  6185. }
  6186. #endif
  6187. return;
  6188. }
  6189. #endif
  6190. get_ip_and_port(addr, addr_len, ip, port);
  6191. }
  6192. }
  6193. // Recursive form retained so operator""_t below can compute hashes for
  6194. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6195. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6196. // instead, which is iterative and stack-safe.
  6197. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6198. unsigned int h) {
  6199. return (l == 0)
  6200. ? h
  6201. : str2tag_core(
  6202. s + 1, l - 1,
  6203. // Unsets the 6 high bits of h, therefore no overflow happens
  6204. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6205. h * 33) ^
  6206. static_cast<unsigned char>(*s));
  6207. }
  6208. inline unsigned int str2tag(const std::string &s) {
  6209. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6210. // for compile-time UDL evaluation of short string literals, but at runtime
  6211. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6212. // would blow the stack with one frame per character.
  6213. unsigned int h = 0;
  6214. for (auto c : s) {
  6215. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6216. static_cast<unsigned char>(c);
  6217. }
  6218. return h;
  6219. }
  6220. namespace udl {
  6221. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6222. return str2tag_core(s, l, 0);
  6223. }
  6224. } // namespace udl
  6225. inline std::string
  6226. find_content_type(const std::string &path,
  6227. const std::map<std::string, std::string> &user_data,
  6228. const std::string &default_content_type) {
  6229. auto ext = file_extension(path);
  6230. auto it = user_data.find(ext);
  6231. if (it != user_data.end()) { return it->second; }
  6232. using udl::operator""_t;
  6233. switch (str2tag(ext)) {
  6234. default: return default_content_type;
  6235. case "css"_t: return "text/css";
  6236. case "csv"_t: return "text/csv";
  6237. case "htm"_t:
  6238. case "html"_t: return "text/html";
  6239. case "js"_t:
  6240. case "mjs"_t: return "text/javascript";
  6241. case "txt"_t: return "text/plain";
  6242. case "vtt"_t: return "text/vtt";
  6243. case "apng"_t: return "image/apng";
  6244. case "avif"_t: return "image/avif";
  6245. case "bmp"_t: return "image/bmp";
  6246. case "gif"_t: return "image/gif";
  6247. case "png"_t: return "image/png";
  6248. case "svg"_t: return "image/svg+xml";
  6249. case "webp"_t: return "image/webp";
  6250. case "ico"_t: return "image/x-icon";
  6251. case "tif"_t: return "image/tiff";
  6252. case "tiff"_t: return "image/tiff";
  6253. case "jpg"_t:
  6254. case "jpeg"_t: return "image/jpeg";
  6255. case "mp4"_t: return "video/mp4";
  6256. case "mpeg"_t: return "video/mpeg";
  6257. case "webm"_t: return "video/webm";
  6258. case "mp3"_t: return "audio/mp3";
  6259. case "mpga"_t: return "audio/mpeg";
  6260. case "weba"_t: return "audio/webm";
  6261. case "wav"_t: return "audio/wave";
  6262. case "otf"_t: return "font/otf";
  6263. case "ttf"_t: return "font/ttf";
  6264. case "woff"_t: return "font/woff";
  6265. case "woff2"_t: return "font/woff2";
  6266. case "7z"_t: return "application/x-7z-compressed";
  6267. case "atom"_t: return "application/atom+xml";
  6268. case "pdf"_t: return "application/pdf";
  6269. case "json"_t: return "application/json";
  6270. case "rss"_t: return "application/rss+xml";
  6271. case "tar"_t: return "application/x-tar";
  6272. case "xht"_t:
  6273. case "xhtml"_t: return "application/xhtml+xml";
  6274. case "xslt"_t: return "application/xslt+xml";
  6275. case "xml"_t: return "application/xml";
  6276. case "gz"_t: return "application/gzip";
  6277. case "zip"_t: return "application/zip";
  6278. case "wasm"_t: return "application/wasm";
  6279. }
  6280. }
  6281. inline std::string
  6282. extract_media_type(const std::string &content_type,
  6283. std::map<std::string, std::string> *params = nullptr) {
  6284. // Extract type/subtype from Content-Type value (RFC 2045)
  6285. // e.g. "application/json; charset=utf-8" -> "application/json"
  6286. auto media_type = content_type;
  6287. auto semicolon_pos = media_type.find(';');
  6288. if (semicolon_pos != std::string::npos) {
  6289. auto param_str = media_type.substr(semicolon_pos + 1);
  6290. media_type = media_type.substr(0, semicolon_pos);
  6291. if (params) {
  6292. // Parse parameters: key=value pairs separated by ';'
  6293. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6294. [&](const char *b, const char *e) {
  6295. std::string key;
  6296. std::string val;
  6297. divide_param_pair(b, e, key, val);
  6298. if (!key.empty()) {
  6299. params->emplace(trim_copy(key),
  6300. trim_double_quotes_copy(val));
  6301. }
  6302. });
  6303. }
  6304. }
  6305. // Trim whitespace from media type
  6306. return trim_copy(media_type);
  6307. }
  6308. inline bool can_compress_content_type(const std::string &content_type) {
  6309. using udl::operator""_t;
  6310. auto mime_type = extract_media_type(content_type);
  6311. auto tag = str2tag(mime_type);
  6312. switch (tag) {
  6313. case "image/svg+xml"_t:
  6314. case "application/javascript"_t:
  6315. case "application/x-javascript"_t:
  6316. case "application/json"_t:
  6317. case "application/ld+json"_t:
  6318. case "application/xml"_t:
  6319. case "application/xhtml+xml"_t:
  6320. case "application/rss+xml"_t:
  6321. case "application/atom+xml"_t:
  6322. case "application/xslt+xml"_t:
  6323. case "application/protobuf"_t: return true;
  6324. case "text/event-stream"_t: return false;
  6325. default: return !mime_type.rfind("text/", 0);
  6326. }
  6327. }
  6328. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6329. double &quality) {
  6330. quality = 1.0;
  6331. token.clear();
  6332. // Split on first ';': left = token name, right = parameters
  6333. const char *params_b = nullptr;
  6334. std::size_t params_len = 0;
  6335. divide(
  6336. b, static_cast<std::size_t>(e - b), ';',
  6337. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6338. auto r = trim(lb, lb + llen, 0, llen);
  6339. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6340. params_b = rb;
  6341. params_len = rlen;
  6342. });
  6343. if (token.empty()) { return false; }
  6344. if (params_len == 0) { return true; }
  6345. // Scan parameters for q= (stops on first match)
  6346. bool invalid = false;
  6347. split_find(params_b, params_b + params_len, ';',
  6348. (std::numeric_limits<size_t>::max)(),
  6349. [&](const char *pb, const char *pe) -> bool {
  6350. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6351. auto len = static_cast<size_t>(pe - pb);
  6352. if (len < 2) { return false; }
  6353. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6354. return false;
  6355. }
  6356. // Trim the value portion
  6357. auto r = trim(pb, pe, 2, len);
  6358. if (r.first >= r.second) {
  6359. invalid = true;
  6360. return true;
  6361. }
  6362. double v = 0.0;
  6363. auto res = from_chars(pb + r.first, pb + r.second, v);
  6364. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6365. v < 0.0 || v > 1.0) {
  6366. invalid = true;
  6367. return true;
  6368. }
  6369. quality = v;
  6370. return true;
  6371. });
  6372. return !invalid;
  6373. }
  6374. inline EncodingType encoding_type(const Request &req,
  6375. const std::string &content_type) {
  6376. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6377. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6378. if (s.empty()) { return EncodingType::None; }
  6379. // Single-pass: iterate tokens and track the best supported encoding.
  6380. // Server preference breaks ties (br > gzip > zstd).
  6381. EncodingType best = EncodingType::None;
  6382. double best_q = 0.0; // q=0 means "not acceptable"
  6383. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6384. auto priority = [](EncodingType t) -> int {
  6385. switch (t) {
  6386. case EncodingType::Brotli: return 0;
  6387. case EncodingType::Gzip: return 1;
  6388. case EncodingType::Zstd: return 2;
  6389. default: return 3;
  6390. }
  6391. };
  6392. std::string name;
  6393. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6394. double quality = 1.0;
  6395. if (!parse_quality(b, e, name, quality)) { return; }
  6396. if (quality <= 0.0) { return; }
  6397. EncodingType type = EncodingType::None;
  6398. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6399. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6400. #endif
  6401. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6402. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6403. type = EncodingType::Gzip;
  6404. }
  6405. #endif
  6406. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6407. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6408. type = EncodingType::Zstd;
  6409. }
  6410. #endif
  6411. if (type == EncodingType::None) { return; }
  6412. // Higher q-value wins; for equal q, server preference breaks ties
  6413. if (quality > best_q ||
  6414. (quality == best_q && priority(type) < priority(best))) {
  6415. best_q = quality;
  6416. best = type;
  6417. }
  6418. });
  6419. return best;
  6420. }
  6421. // `content_type` is taken separately because a file-backed response has not
  6422. // been given one yet when its coding has to be decided.
  6423. inline EncodingType encoding_type(const Request &req, const Response &res,
  6424. const std::string &content_type) {
  6425. // The response already names a content coding of its own: a handler serving
  6426. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6427. // point whose headers name the coding its files are stored in. Applying one
  6428. // on top of that would double-encode the body and append a second
  6429. // `Content-Encoding` field line.
  6430. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6431. return encoding_type(req, content_type);
  6432. }
  6433. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6434. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6435. }
  6436. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6437. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6438. if (type == EncodingType::Gzip) {
  6439. return detail::make_unique<gzip_compressor>();
  6440. }
  6441. #endif
  6442. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6443. if (type == EncodingType::Brotli) {
  6444. return detail::make_unique<brotli_compressor>();
  6445. }
  6446. #endif
  6447. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6448. if (type == EncodingType::Zstd) {
  6449. return detail::make_unique<zstd_compressor>();
  6450. }
  6451. #endif
  6452. (void)type;
  6453. return nullptr;
  6454. }
  6455. inline const char *encoding_name(EncodingType type) {
  6456. switch (type) {
  6457. case EncodingType::Gzip: return "gzip";
  6458. case EncodingType::Brotli: return "br";
  6459. case EncodingType::Zstd: return "zstd";
  6460. default: return "";
  6461. }
  6462. }
  6463. inline bool nocompressor::compress(const char *data, size_t data_length,
  6464. bool /*last*/, Callback callback) {
  6465. if (!data_length) { return true; }
  6466. return callback(data, data_length);
  6467. }
  6468. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6469. inline gzip_compressor::gzip_compressor() {
  6470. std::memset(&strm_, 0, sizeof(strm_));
  6471. strm_.zalloc = Z_NULL;
  6472. strm_.zfree = Z_NULL;
  6473. strm_.opaque = Z_NULL;
  6474. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6475. Z_DEFAULT_STRATEGY) == Z_OK;
  6476. }
  6477. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6478. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6479. bool last, Callback callback) {
  6480. assert(is_valid_);
  6481. do {
  6482. constexpr size_t max_avail_in =
  6483. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6484. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6485. (std::min)(data_length, max_avail_in));
  6486. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6487. data_length -= strm_.avail_in;
  6488. data += strm_.avail_in;
  6489. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6490. auto ret = Z_OK;
  6491. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6492. do {
  6493. strm_.avail_out = static_cast<uInt>(buff.size());
  6494. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6495. ret = deflate(&strm_, flush);
  6496. if (ret == Z_STREAM_ERROR) { return false; }
  6497. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6498. return false;
  6499. }
  6500. } while (strm_.avail_out == 0);
  6501. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6502. (flush == Z_NO_FLUSH && ret == Z_OK));
  6503. assert(strm_.avail_in == 0);
  6504. } while (data_length > 0);
  6505. return true;
  6506. }
  6507. inline gzip_decompressor::gzip_decompressor() {
  6508. std::memset(&strm_, 0, sizeof(strm_));
  6509. strm_.zalloc = Z_NULL;
  6510. strm_.zfree = Z_NULL;
  6511. strm_.opaque = Z_NULL;
  6512. // 15 is the value of wbits, which should be at the maximum possible value
  6513. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6514. // that the stream type should be automatically detected either gzip or
  6515. // deflate.
  6516. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6517. }
  6518. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6519. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6520. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6521. Callback callback) {
  6522. assert(is_valid_);
  6523. auto ret = Z_OK;
  6524. do {
  6525. constexpr size_t max_avail_in =
  6526. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6527. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6528. (std::min)(data_length, max_avail_in));
  6529. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6530. data_length -= strm_.avail_in;
  6531. data += strm_.avail_in;
  6532. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6533. while (strm_.avail_in > 0 && ret == Z_OK) {
  6534. strm_.avail_out = static_cast<uInt>(buff.size());
  6535. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6536. ret = inflate(&strm_, Z_NO_FLUSH);
  6537. assert(ret != Z_STREAM_ERROR);
  6538. switch (ret) {
  6539. case Z_NEED_DICT:
  6540. case Z_DATA_ERROR:
  6541. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6542. }
  6543. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6544. return false;
  6545. }
  6546. }
  6547. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6548. } while (data_length > 0);
  6549. return true;
  6550. }
  6551. #endif
  6552. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6553. inline brotli_compressor::brotli_compressor() {
  6554. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6555. }
  6556. inline brotli_compressor::~brotli_compressor() {
  6557. BrotliEncoderDestroyInstance(state_);
  6558. }
  6559. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6560. bool last, Callback callback) {
  6561. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6562. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6563. auto available_in = data_length;
  6564. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6565. for (;;) {
  6566. if (last) {
  6567. if (BrotliEncoderIsFinished(state_)) { break; }
  6568. } else {
  6569. if (!available_in) { break; }
  6570. }
  6571. auto available_out = buff.size();
  6572. auto next_out = buff.data();
  6573. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6574. &available_out, &next_out, nullptr)) {
  6575. return false;
  6576. }
  6577. auto output_bytes = buff.size() - available_out;
  6578. if (output_bytes) {
  6579. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6580. }
  6581. }
  6582. return true;
  6583. }
  6584. inline brotli_decompressor::brotli_decompressor() {
  6585. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6586. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6587. : BROTLI_DECODER_RESULT_ERROR;
  6588. }
  6589. inline brotli_decompressor::~brotli_decompressor() {
  6590. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6591. }
  6592. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6593. inline bool brotli_decompressor::decompress(const char *data,
  6594. size_t data_length,
  6595. Callback callback) {
  6596. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6597. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6598. return 0;
  6599. }
  6600. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6601. size_t avail_in = data_length;
  6602. size_t total_out;
  6603. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6604. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6605. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6606. char *next_out = buff.data();
  6607. size_t avail_out = buff.size();
  6608. decoder_r = BrotliDecoderDecompressStream(
  6609. decoder_s, &avail_in, &next_in, &avail_out,
  6610. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6611. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6612. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6613. }
  6614. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6615. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6616. }
  6617. #endif
  6618. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6619. inline zstd_compressor::zstd_compressor() {
  6620. ctx_ = ZSTD_createCCtx();
  6621. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6622. }
  6623. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6624. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6625. bool last, Callback callback) {
  6626. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6627. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6628. ZSTD_inBuffer input = {data, data_length, 0};
  6629. bool finished;
  6630. do {
  6631. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6632. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6633. if (ZSTD_isError(remaining)) { return false; }
  6634. if (!callback(buff.data(), output.pos)) { return false; }
  6635. finished = last ? (remaining == 0) : (input.pos == input.size);
  6636. } while (!finished);
  6637. return true;
  6638. }
  6639. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6640. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6641. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6642. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6643. Callback callback) {
  6644. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6645. ZSTD_inBuffer input = {data, data_length, 0};
  6646. while (input.pos < input.size) {
  6647. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6648. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6649. if (ZSTD_isError(remaining)) { return false; }
  6650. if (!callback(buff.data(), output.pos)) { return false; }
  6651. }
  6652. return true;
  6653. }
  6654. #endif
  6655. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6656. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6657. // unknown coding, and its payload would be handed back still compressed.
  6658. inline bool is_zlib_encoding(const std::string &encoding) {
  6659. return case_ignore::equal(encoding, "gzip") ||
  6660. case_ignore::equal(encoding, "deflate");
  6661. }
  6662. inline bool is_brotli_encoding(const std::string &encoding) {
  6663. return case_ignore::equal(encoding, "br");
  6664. }
  6665. inline bool is_zstd_encoding(const std::string &encoding) {
  6666. return case_ignore::equal(encoding, "zstd");
  6667. }
  6668. // Returns true if the content coding is one cpp-httplib is able to decompress
  6669. // when the corresponding support is compiled in.
  6670. inline bool is_known_content_encoding(const std::string &encoding) {
  6671. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6672. is_zstd_encoding(encoding);
  6673. }
  6674. inline std::unique_ptr<decompressor>
  6675. create_decompressor(const std::string &encoding) {
  6676. std::unique_ptr<decompressor> decompressor;
  6677. if (is_zlib_encoding(encoding)) {
  6678. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6679. decompressor = detail::make_unique<gzip_decompressor>();
  6680. #endif
  6681. } else if (is_brotli_encoding(encoding)) {
  6682. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6683. decompressor = detail::make_unique<brotli_decompressor>();
  6684. #endif
  6685. } else if (is_zstd_encoding(encoding)) {
  6686. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6687. decompressor = detail::make_unique<zstd_decompressor>();
  6688. #endif
  6689. }
  6690. return decompressor;
  6691. }
  6692. // Returns the best available compressor and its Content-Encoding name.
  6693. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6694. inline std::pair<std::unique_ptr<compressor>, const char *>
  6695. create_compressor() {
  6696. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6697. return {detail::make_unique<brotli_compressor>(), "br"};
  6698. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6699. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6700. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6701. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6702. #else
  6703. return {nullptr, nullptr};
  6704. #endif
  6705. }
  6706. inline bool is_prohibited_header_name(const std::string &name) {
  6707. using udl::operator""_t;
  6708. switch (str2tag(name)) {
  6709. case "REMOTE_ADDR"_t:
  6710. case "REMOTE_PORT"_t:
  6711. case "LOCAL_ADDR"_t:
  6712. case "LOCAL_PORT"_t: return true;
  6713. default: return false;
  6714. }
  6715. }
  6716. inline bool has_header(const Headers &headers, const std::string &key) {
  6717. if (is_prohibited_header_name(key)) { return false; }
  6718. return headers.find(key) != headers.end();
  6719. }
  6720. inline const char *get_header_value(const Headers &headers,
  6721. const std::string &key, const char *def,
  6722. size_t id) {
  6723. if (is_prohibited_header_name(key)) {
  6724. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6725. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6726. throw std::invalid_argument(msg);
  6727. #else
  6728. return "";
  6729. #endif
  6730. }
  6731. auto rng = headers.equal_range(key);
  6732. auto it = rng.first;
  6733. std::advance(it, static_cast<ssize_t>(id));
  6734. if (it != rng.second) { return it->second.c_str(); }
  6735. return def;
  6736. }
  6737. inline size_t get_header_value_count(const Headers &headers,
  6738. const std::string &key) {
  6739. return headers.count(key);
  6740. }
  6741. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6742. // list may be sent as several field lines, and the combined field value is
  6743. // those values joined by commas in the order they were received. Callers that
  6744. // parse such a list must work on the combined value; reading only the first
  6745. // occurrence silently drops whatever the later field lines carry.
  6746. inline std::string get_combined_header_value(const Headers &headers,
  6747. const std::string &key) {
  6748. std::string combined;
  6749. auto rng = headers.equal_range(key);
  6750. for (auto it = rng.first; it != rng.second; ++it) {
  6751. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6752. // elements, so an empty field line must not contribute a bare comma to the
  6753. // combined value.
  6754. if (it->second.empty()) { continue; }
  6755. if (!combined.empty()) { combined += ", "; }
  6756. combined += it->second;
  6757. }
  6758. return combined;
  6759. }
  6760. inline bool has_header_token(const Headers &headers, const std::string &key,
  6761. const std::string &token) {
  6762. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6763. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6764. // several lines. Match complete tokens rather than searching the raw value,
  6765. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6766. auto rng = headers.equal_range(key);
  6767. for (auto it = rng.first; it != rng.second; ++it) {
  6768. const auto &value = it->second;
  6769. if (split_find(value.data(), value.data() + value.size(), ',',
  6770. [&](const char *b, const char *e) {
  6771. return case_ignore::equal(std::string(b, e), token);
  6772. })) {
  6773. return true;
  6774. }
  6775. }
  6776. return false;
  6777. }
  6778. template <typename Map>
  6779. inline typename Map::mapped_type
  6780. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6781. auto rng = m.equal_range(key);
  6782. auto it = rng.first;
  6783. std::advance(it, static_cast<ssize_t>(id));
  6784. if (it != rng.second) { return it->second; }
  6785. return typename Map::mapped_type();
  6786. }
  6787. inline void set_header(Headers &headers, const std::string &key,
  6788. const std::string &val) {
  6789. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6790. }
  6791. inline bool read_headers(Stream &strm, Headers &headers) {
  6792. const auto bufsiz = 2048;
  6793. char buf[bufsiz];
  6794. stream_line_reader line_reader(strm, buf, bufsiz);
  6795. size_t header_count = 0;
  6796. for (;;) {
  6797. if (!line_reader.getline()) { return false; }
  6798. // Check if the line ends with CRLF.
  6799. auto line_terminator_len = 2;
  6800. if (line_reader.end_with_crlf()) {
  6801. // Blank line indicates end of headers.
  6802. if (line_reader.size() == 2) { break; }
  6803. } else {
  6804. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6805. // Blank line indicates end of headers.
  6806. if (line_reader.size() == 1) { break; }
  6807. line_terminator_len = 1;
  6808. #else
  6809. continue; // Skip invalid line.
  6810. #endif
  6811. }
  6812. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6813. // Check header count limit
  6814. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6815. // Exclude line terminator
  6816. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6817. if (!parse_header(line_reader.ptr(), end,
  6818. [&](const std::string &key, const std::string &val) {
  6819. headers.emplace(key, val);
  6820. })) {
  6821. return false;
  6822. }
  6823. header_count++;
  6824. }
  6825. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6826. // headers that have different values to prevent request smuggling.
  6827. auto cl_range = headers.equal_range("Content-Length");
  6828. if (cl_range.first != cl_range.second) {
  6829. const auto &first_val = cl_range.first->second;
  6830. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6831. if (it->second != first_val) { return false; }
  6832. }
  6833. }
  6834. return true;
  6835. }
  6836. inline bool parse_status_line(const char *line, std::string &version,
  6837. int &status, std::string &reason) {
  6838. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6839. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6840. #else
  6841. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6842. #endif
  6843. std::cmatch m;
  6844. if (!std::regex_match(line, m, re)) { return false; }
  6845. version = std::string(m[1]);
  6846. status = std::stoi(std::string(m[2]));
  6847. reason = std::string(m[3]);
  6848. return true;
  6849. }
  6850. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6851. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6852. struct WebSocketUpgradeResponse {
  6853. Error error = Error::Success;
  6854. int status = -1;
  6855. Headers headers;
  6856. std::string selected_subprotocol;
  6857. };
  6858. inline bool read_websocket_upgrade_response(Stream &strm,
  6859. const std::string &expected_accept,
  6860. WebSocketUpgradeResponse &upgrade) {
  6861. // Read status line
  6862. const auto bufsiz = 2048;
  6863. char buf[bufsiz];
  6864. stream_line_reader line_reader(strm, buf, bufsiz);
  6865. if (!line_reader.getline()) {
  6866. upgrade.error = Error::Read;
  6867. return false;
  6868. }
  6869. std::string version;
  6870. std::string reason;
  6871. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6872. upgrade.error = Error::WebSocketHandshake;
  6873. return false;
  6874. }
  6875. // Read the headers even for a rejection so the caller can see why the
  6876. // server refused the upgrade. A non-101 response may carry a body; it is
  6877. // deliberately left unread since the caller closes the socket right away.
  6878. if (!read_headers(strm, upgrade.headers)) {
  6879. upgrade.error = Error::Read;
  6880. return false;
  6881. }
  6882. const auto &headers = upgrade.headers;
  6883. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6884. upgrade.error = Error::WebSocketHandshake;
  6885. return false;
  6886. }
  6887. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6888. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6889. upgrade.error = Error::WebSocketHandshake;
  6890. return false;
  6891. }
  6892. // Verify Connection: Upgrade
  6893. if (!has_header_token(headers, "Connection", "upgrade")) {
  6894. upgrade.error = Error::WebSocketHandshake;
  6895. return false;
  6896. }
  6897. // Verify Sec-WebSocket-Accept header value
  6898. auto it = headers.find("Sec-WebSocket-Accept");
  6899. if (it == headers.end() || it->second != expected_accept) {
  6900. upgrade.error = Error::WebSocketHandshake;
  6901. return false;
  6902. }
  6903. // Extract negotiated subprotocol
  6904. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6905. if (proto_it != headers.end()) {
  6906. upgrade.selected_subprotocol = proto_it->second;
  6907. }
  6908. return true;
  6909. }
  6910. enum class ReadContentResult {
  6911. Success, // Successfully read the content
  6912. PayloadTooLarge, // The content exceeds the specified payload limit
  6913. Error // An error occurred while reading the content
  6914. };
  6915. inline ReadContentResult read_content_with_length(
  6916. Stream &strm, size_t len, DownloadProgress progress,
  6917. ContentReceiverWithProgress out,
  6918. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6919. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6920. detail::BodyReader br;
  6921. br.stream = &strm;
  6922. br.has_content_length = true;
  6923. br.content_length = len;
  6924. br.payload_max_length = payload_max_length;
  6925. br.chunked = false;
  6926. br.bytes_read = 0;
  6927. br.last_error = Error::Success;
  6928. size_t r = 0;
  6929. while (r < len) {
  6930. auto read_len = static_cast<size_t>(len - r);
  6931. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6932. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6933. if (n <= 0) {
  6934. // Check if it was a payload size error
  6935. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6936. return ReadContentResult::PayloadTooLarge;
  6937. }
  6938. return ReadContentResult::Error;
  6939. }
  6940. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6941. return ReadContentResult::Error;
  6942. }
  6943. r += static_cast<size_t>(n);
  6944. if (progress) {
  6945. if (!progress(r, len)) { return ReadContentResult::Error; }
  6946. }
  6947. }
  6948. return ReadContentResult::Success;
  6949. }
  6950. inline ReadContentResult
  6951. read_content_without_length(Stream &strm, size_t payload_max_length,
  6952. ContentReceiverWithProgress out) {
  6953. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6954. size_t r = 0;
  6955. for (;;) {
  6956. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6957. if (n == 0) { return ReadContentResult::Success; }
  6958. if (n < 0) { return ReadContentResult::Error; }
  6959. // Check if adding this data would exceed the payload limit
  6960. if (r > payload_max_length ||
  6961. payload_max_length - r < static_cast<size_t>(n)) {
  6962. return ReadContentResult::PayloadTooLarge;
  6963. }
  6964. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6965. return ReadContentResult::Error;
  6966. }
  6967. r += static_cast<size_t>(n);
  6968. }
  6969. return ReadContentResult::Success;
  6970. }
  6971. template <typename T>
  6972. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6973. size_t payload_max_length,
  6974. ContentReceiverWithProgress out) {
  6975. detail::ChunkedDecoder dec(strm);
  6976. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6977. size_t total_len = 0;
  6978. for (;;) {
  6979. size_t chunk_offset = 0;
  6980. size_t chunk_total = 0;
  6981. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6982. if (n < 0) { return ReadContentResult::Error; }
  6983. if (n == 0) {
  6984. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6985. return ReadContentResult::Error;
  6986. }
  6987. return ReadContentResult::Success;
  6988. }
  6989. if (total_len > payload_max_length ||
  6990. payload_max_length - total_len < static_cast<size_t>(n)) {
  6991. return ReadContentResult::PayloadTooLarge;
  6992. }
  6993. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6994. return ReadContentResult::Error;
  6995. }
  6996. total_len += static_cast<size_t>(n);
  6997. }
  6998. }
  6999. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7000. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7001. // is the final transfer coding. A single field value may list several
  7002. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7003. // several Transfer-Encoding lines, which combine into one comma-separated
  7004. // list in the order the lines were received. Headers preserves that order,
  7005. // so the final coding is the last token of the last line. Match it
  7006. // case-insensitively rather than comparing the whole value against
  7007. // "chunked".
  7008. //
  7009. // Security: reading a chunked message as unframed leaves its body in the
  7010. // socket, where a keep-alive connection parses it as a smuggled request.
  7011. // Server::process_request() answers 400 and closes when the final coding is
  7012. // not chunked, so a request whose framing cannot be determined never
  7013. // reaches the "no body" path.
  7014. auto rng = headers.equal_range("Transfer-Encoding");
  7015. if (rng.first == rng.second) { return false; }
  7016. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7017. // combined list ending in nothing rather than inheriting the line before it.
  7018. std::string last_coding;
  7019. for (auto it = rng.first; it != rng.second; ++it) {
  7020. const auto &value = it->second;
  7021. last_coding.clear();
  7022. split(value.data(), value.data() + value.size(), ',',
  7023. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7024. }
  7025. return case_ignore::equal(last_coding, "chunked");
  7026. }
  7027. inline bool has_conflicting_content_length(const Headers &headers) {
  7028. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7029. // Content-Length is framed ambiguously. The body readers here delimit it by
  7030. // the transfer coding and drop Content-Length, while an intermediary may do
  7031. // the reverse, so the two disagree on where the body ends and a reused
  7032. // connection is desynchronised (request/response smuggling). Content-Length:
  7033. // 0 is tolerated for compatibility with existing peers.
  7034. return has_header(headers, "Transfer-Encoding") &&
  7035. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7036. }
  7037. template <typename T, typename U>
  7038. bool prepare_content_receiver(T &x, int &status,
  7039. ContentReceiverWithProgress receiver,
  7040. bool decompress, size_t payload_max_length,
  7041. bool &exceed_payload_max_length, U callback) {
  7042. if (decompress) {
  7043. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7044. std::unique_ptr<decompressor> decompressor;
  7045. if (!encoding.empty()) {
  7046. // A coding we know about but were not built with is an error. An
  7047. // unrecognized coding (including "identity") is left alone and the
  7048. // payload is passed through as-is, since some servers misuse the header,
  7049. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7050. decompressor = detail::create_decompressor(encoding);
  7051. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7052. status = StatusCode::UnsupportedMediaType_415;
  7053. return false;
  7054. }
  7055. }
  7056. if (decompressor) {
  7057. if (decompressor->is_valid()) {
  7058. size_t decompressed_size = 0;
  7059. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7060. size_t off, size_t len) {
  7061. return decompressor->decompress(
  7062. buf, n, [&](const char *buf2, size_t n2) {
  7063. // Guard against zip-bomb: check
  7064. // decompressed size against limit.
  7065. if (payload_max_length > 0 &&
  7066. (decompressed_size >= payload_max_length ||
  7067. n2 > payload_max_length - decompressed_size)) {
  7068. exceed_payload_max_length = true;
  7069. return false;
  7070. }
  7071. decompressed_size += n2;
  7072. return receiver(buf2, n2, off, len);
  7073. });
  7074. };
  7075. return callback(std::move(out));
  7076. } else {
  7077. status = StatusCode::InternalServerError_500;
  7078. return false;
  7079. }
  7080. }
  7081. }
  7082. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7083. size_t len) {
  7084. return receiver(buf, n, off, len);
  7085. };
  7086. return callback(std::move(out));
  7087. }
  7088. template <typename T>
  7089. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7090. DownloadProgress progress,
  7091. ContentReceiverWithProgress receiver, bool decompress) {
  7092. bool exceed_payload_max_length = false;
  7093. return prepare_content_receiver(
  7094. x, status, std::move(receiver), decompress, payload_max_length,
  7095. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7096. auto ret = true;
  7097. // Note: exceed_payload_max_length may also be set by the decompressor
  7098. // wrapper in prepare_content_receiver when the decompressed payload
  7099. // size exceeds the limit.
  7100. if (is_chunked_transfer_encoding(x.headers)) {
  7101. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7102. if (result == ReadContentResult::Success) {
  7103. ret = true;
  7104. } else if (result == ReadContentResult::PayloadTooLarge) {
  7105. exceed_payload_max_length = true;
  7106. ret = false;
  7107. } else {
  7108. ret = false;
  7109. }
  7110. } else if (!has_header(x.headers, "Content-Length")) {
  7111. auto result =
  7112. read_content_without_length(strm, payload_max_length, out);
  7113. if (result == ReadContentResult::Success) {
  7114. ret = true;
  7115. } else if (result == ReadContentResult::PayloadTooLarge) {
  7116. exceed_payload_max_length = true;
  7117. ret = false;
  7118. } else {
  7119. ret = false;
  7120. }
  7121. } else {
  7122. auto is_invalid_value = false;
  7123. auto len = get_header_value_u64(x.headers, "Content-Length",
  7124. (std::numeric_limits<size_t>::max)(),
  7125. 0, is_invalid_value);
  7126. if (is_invalid_value) {
  7127. ret = false;
  7128. } else if (len > 0) {
  7129. auto result = read_content_with_length(
  7130. strm, len, std::move(progress), out, payload_max_length);
  7131. ret = (result == ReadContentResult::Success);
  7132. if (result == ReadContentResult::PayloadTooLarge) {
  7133. exceed_payload_max_length = true;
  7134. }
  7135. }
  7136. }
  7137. if (!ret) {
  7138. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7139. : StatusCode::BadRequest_400;
  7140. }
  7141. return ret;
  7142. });
  7143. }
  7144. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7145. const std::string &path) {
  7146. // Neither the method nor the request target may carry CR/LF, SP or other
  7147. // control octets; otherwise a value smuggled into either splits the request
  7148. // line and injects headers or a whole request.
  7149. if (!fields::is_token(method)) { return -1; }
  7150. if (!fields::is_request_target(path)) { return -1; }
  7151. std::string s = method;
  7152. s += ' ';
  7153. s += path;
  7154. s += " HTTP/1.1\r\n";
  7155. return strm.write(s.data(), s.size());
  7156. }
  7157. inline ssize_t write_response_line(Stream &strm, int status) {
  7158. std::string s = "HTTP/1.1 ";
  7159. s += std::to_string(status);
  7160. s += ' ';
  7161. s += httplib::status_message(status);
  7162. s += "\r\n";
  7163. return strm.write(s.data(), s.size());
  7164. }
  7165. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7166. ssize_t write_len = 0;
  7167. for (const auto &x : headers) {
  7168. // Skip fields with invalid names or values to prevent response splitting
  7169. // via CR/LF injection, matching set_header(). The client validates request
  7170. // headers up front in check_and_write_headers, but the server passes
  7171. // res.headers straight to this writer, and res.headers is a public field
  7172. // an application can populate directly with request-derived values.
  7173. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7174. std::string s;
  7175. s = x.first;
  7176. s += ": ";
  7177. s += x.second;
  7178. s += "\r\n";
  7179. auto len = strm.write(s.data(), s.size());
  7180. if (len < 0) { return len; }
  7181. write_len += len;
  7182. }
  7183. auto len = strm.write("\r\n");
  7184. if (len < 0) { return len; }
  7185. write_len += len;
  7186. return write_len;
  7187. }
  7188. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7189. size_t offset = 0;
  7190. while (offset < l) {
  7191. auto length = strm.write(d + offset, l - offset);
  7192. if (length < 0) { return false; }
  7193. offset += static_cast<size_t>(length);
  7194. }
  7195. return true;
  7196. }
  7197. template <typename T>
  7198. inline bool write_content_with_progress(Stream &strm,
  7199. const ContentProvider &content_provider,
  7200. size_t offset, size_t length,
  7201. T is_shutting_down,
  7202. const UploadProgress &upload_progress,
  7203. Error &error) {
  7204. size_t end_offset = offset + length;
  7205. size_t start_offset = offset;
  7206. auto ok = true;
  7207. auto finished = false;
  7208. DataSink data_sink;
  7209. data_sink.write = [&](const char *d, size_t l) -> bool {
  7210. if (ok) {
  7211. if (write_data(strm, d, l)) {
  7212. offset += l;
  7213. if (upload_progress && length > 0) {
  7214. size_t current_written = offset - start_offset;
  7215. if (!upload_progress(current_written, length)) {
  7216. ok = false;
  7217. return false;
  7218. }
  7219. }
  7220. } else {
  7221. ok = false;
  7222. }
  7223. }
  7224. return ok;
  7225. };
  7226. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7227. // The body is framed by `length`, so a provider that reports itself done
  7228. // early has truncated it. Record that and let the short-body check below
  7229. // fail the write, rather than calling the provider again forever.
  7230. data_sink.done = [&]() { finished = true; };
  7231. while (offset < end_offset && !finished && !is_shutting_down()) {
  7232. auto last_offset = offset;
  7233. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7234. error = Error::Write;
  7235. return false;
  7236. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7237. error = Error::Canceled;
  7238. return false;
  7239. } else if (!ok) {
  7240. error = Error::Write;
  7241. return false;
  7242. }
  7243. // A provider that reports success without writing anything and without
  7244. // reporting itself done gets handed the same offset and length again on
  7245. // the next pass, so it would spin here for as long as the peer stays
  7246. // connected. Treat making no progress as a short body, like done() early.
  7247. if (!finished && offset == last_offset) {
  7248. error = Error::Write;
  7249. return false;
  7250. }
  7251. }
  7252. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7253. error = Error::Write;
  7254. return false;
  7255. }
  7256. error = Error::Success;
  7257. return true;
  7258. }
  7259. template <typename T>
  7260. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7261. size_t offset, size_t length, T is_shutting_down,
  7262. Error &error) {
  7263. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7264. is_shutting_down, nullptr, error);
  7265. }
  7266. template <typename T>
  7267. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7268. size_t offset, size_t length,
  7269. const T &is_shutting_down) {
  7270. auto error = Error::Success;
  7271. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7272. error);
  7273. }
  7274. template <typename T>
  7275. inline bool
  7276. write_content_without_length(Stream &strm,
  7277. const ContentProvider &content_provider,
  7278. const T &is_shutting_down) {
  7279. size_t offset = 0;
  7280. auto data_available = true;
  7281. auto ok = true;
  7282. DataSink data_sink;
  7283. data_sink.write = [&](const char *d, size_t l) -> bool {
  7284. if (ok) {
  7285. offset += l;
  7286. if (!write_data(strm, d, l)) { ok = false; }
  7287. }
  7288. return ok;
  7289. };
  7290. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7291. data_sink.done = [&](void) { data_available = false; };
  7292. while (data_available && !is_shutting_down()) {
  7293. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7294. return false;
  7295. } else if (!content_provider(offset, 0, data_sink)) {
  7296. return false;
  7297. } else if (!ok) {
  7298. return false;
  7299. }
  7300. }
  7301. return !data_available; // true only if done() was called, false if shutting
  7302. // down
  7303. }
  7304. // Runs a known-length content provider to completion and compresses what it
  7305. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7306. // by an mmap hands the compressor a pointer straight into the mapping.
  7307. inline bool compress_content_provider(const ContentProvider &content_provider,
  7308. size_t length, compressor &cmp,
  7309. std::string &out) {
  7310. size_t offset = 0;
  7311. auto ok = true;
  7312. auto finished = false;
  7313. DataSink data_sink;
  7314. auto append = [&](const char *data, size_t data_len) {
  7315. out.append(data, data_len);
  7316. return true;
  7317. };
  7318. data_sink.write = [&](const char *d, size_t l) -> bool {
  7319. if (!ok) { return false; }
  7320. offset += l;
  7321. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7322. return ok;
  7323. };
  7324. // The body is framed by `length`, so a provider that reports itself done
  7325. // early has truncated it; the short-body check below turns that into a
  7326. // failure rather than calling the provider again forever.
  7327. data_sink.done = [&]() { finished = true; };
  7328. while (offset < length && !finished) {
  7329. auto prev_offset = offset;
  7330. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7331. return false;
  7332. }
  7333. // No Stream to block on here, so a provider that keeps returning true
  7334. // without writing would spin. Treat a pass that made no progress as a
  7335. // failure.
  7336. if (offset == prev_offset) { return false; }
  7337. }
  7338. if (offset != length) { return false; }
  7339. return cmp.compress(nullptr, 0, true, append);
  7340. }
  7341. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7342. // and the file flag, so recording them has to come after; keeping all of it
  7343. // here means a third file-serving path cannot get that order wrong.
  7344. inline void set_file_content_provider(Response &res,
  7345. const std::shared_ptr<mmap> &m,
  7346. const std::string &content_type,
  7347. EncodingType encoding) {
  7348. res.set_content_provider(
  7349. m->size(), content_type,
  7350. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7351. sink.write(m->data() + offset, length);
  7352. return true;
  7353. });
  7354. res.is_file_content_provider_ = true;
  7355. res.content_coding_ = encoding;
  7356. }
  7357. template <typename T, typename U>
  7358. inline bool
  7359. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7360. const T &is_shutting_down, U &compressor, Error &error) {
  7361. size_t offset = 0;
  7362. auto data_available = true;
  7363. auto ok = true;
  7364. DataSink data_sink;
  7365. data_sink.write = [&](const char *d, size_t l) -> bool {
  7366. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7367. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7368. // zero-length chunk is the terminator, so it must not be emitted here.
  7369. if (ok && l > 0) {
  7370. offset += l;
  7371. std::string payload;
  7372. if (compressor.compress(d, l, false,
  7373. [&](const char *data, size_t data_len) {
  7374. payload.append(data, data_len);
  7375. return true;
  7376. })) {
  7377. if (!payload.empty()) {
  7378. // Emit chunked response header and footer for each chunk
  7379. auto chunk =
  7380. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7381. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7382. }
  7383. } else {
  7384. ok = false;
  7385. }
  7386. }
  7387. return ok;
  7388. };
  7389. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7390. auto done_with_trailer = [&](const Headers *trailer) {
  7391. if (!ok) { return; }
  7392. data_available = false;
  7393. std::string payload;
  7394. if (!compressor.compress(nullptr, 0, true,
  7395. [&](const char *data, size_t data_len) {
  7396. payload.append(data, data_len);
  7397. return true;
  7398. })) {
  7399. ok = false;
  7400. return;
  7401. }
  7402. if (!payload.empty()) {
  7403. // Emit chunked response header and footer for each chunk
  7404. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7405. if (!write_data(strm, chunk.data(), chunk.size())) {
  7406. ok = false;
  7407. return;
  7408. }
  7409. }
  7410. constexpr const char done_marker[] = "0\r\n";
  7411. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7412. // Trailer
  7413. if (trailer) {
  7414. for (const auto &kv : *trailer) {
  7415. // Skip fields with invalid names or values to prevent response
  7416. // splitting via CR/LF injection, matching set_header().
  7417. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7418. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7419. if (!write_data(strm, field_line.data(), field_line.size())) {
  7420. ok = false;
  7421. }
  7422. }
  7423. }
  7424. constexpr const char crlf[] = "\r\n";
  7425. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7426. };
  7427. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7428. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7429. done_with_trailer(&trailer);
  7430. };
  7431. while (data_available && !is_shutting_down()) {
  7432. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7433. error = Error::Write;
  7434. return false;
  7435. } else if (!content_provider(offset, 0, data_sink)) {
  7436. error = Error::Canceled;
  7437. return false;
  7438. } else if (!ok) {
  7439. error = Error::Write;
  7440. return false;
  7441. }
  7442. }
  7443. if (data_available) { // exited due to is_shutting_down(), not done()
  7444. error = Error::Write;
  7445. return false;
  7446. }
  7447. error = Error::Success;
  7448. return true;
  7449. }
  7450. template <typename T, typename U>
  7451. inline bool write_content_chunked(Stream &strm,
  7452. const ContentProvider &content_provider,
  7453. const T &is_shutting_down, U &compressor) {
  7454. auto error = Error::Success;
  7455. return write_content_chunked(strm, content_provider, is_shutting_down,
  7456. compressor, error);
  7457. }
  7458. template <typename T>
  7459. inline bool redirect(T &cli, Request &req, Response &res,
  7460. const std::string &path, const std::string &location,
  7461. Error &error) {
  7462. Request new_req = req;
  7463. new_req.path = path;
  7464. new_req.redirect_count_ -= 1;
  7465. if (res.status == StatusCode::SeeOther_303 &&
  7466. (req.method != "GET" && req.method != "HEAD")) {
  7467. new_req.method = "GET";
  7468. new_req.body.clear();
  7469. new_req.headers.clear();
  7470. }
  7471. Response new_res;
  7472. auto ret = cli.send(new_req, new_res, error);
  7473. if (ret) {
  7474. req = std::move(new_req);
  7475. res = std::move(new_res);
  7476. if (res.location.empty()) { res.location = location; }
  7477. }
  7478. return ret;
  7479. }
  7480. inline std::string params_to_query_str(const Params &params) {
  7481. std::string query;
  7482. for (auto it = params.begin(); it != params.end(); ++it) {
  7483. if (it != params.begin()) { query += '&'; }
  7484. query += encode_query_component(it->first);
  7485. query += '=';
  7486. query += encode_query_component(it->second);
  7487. }
  7488. return query;
  7489. }
  7490. // Splits one "key=value" span of a query string at its first '='. A span with
  7491. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7492. // "?flag" keeps its name.
  7493. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7494. std::string &val) {
  7495. divide(b, static_cast<std::size_t>(e - b), '=',
  7496. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7497. std::size_t rhs_size) {
  7498. key.assign(lhs_data, lhs_size);
  7499. val.assign(rhs_data, rhs_size);
  7500. });
  7501. }
  7502. inline void parse_query_text(const char *data, std::size_t size,
  7503. Params &params) {
  7504. std::set<std::string> cache;
  7505. split(data, data + size, '&', [&](const char *b, const char *e) {
  7506. std::string kv(b, e);
  7507. if (cache.find(kv) != cache.end()) { return; }
  7508. cache.insert(std::move(kv));
  7509. std::string key;
  7510. std::string val;
  7511. divide_query_pair(b, e, key, val);
  7512. if (!key.empty()) {
  7513. params.emplace(decode_query_component(key), decode_query_component(val));
  7514. }
  7515. });
  7516. }
  7517. inline void parse_query_text(const std::string &s, Params &params) {
  7518. parse_query_text(s.data(), s.size(), params);
  7519. }
  7520. // Normalize a query string by decoding and re-encoding each key/value pair
  7521. // while preserving the original parameter order. This avoids double-encoding
  7522. // and ensures consistent encoding. It works on the raw string rather than
  7523. // parsing into Params and re-serializing, because that round trip cannot
  7524. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7525. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7526. // duplicated pairs.
  7527. inline std::string normalize_query_string(const std::string &query) {
  7528. std::string result;
  7529. split(query.data(), query.data() + query.size(), '&',
  7530. [&](const char *b, const char *e) {
  7531. std::string key;
  7532. std::string val;
  7533. divide_query_pair(b, e, key, val);
  7534. if (!key.empty()) {
  7535. auto dec_key = decode_query_component(key);
  7536. auto dec_val = decode_query_component(val);
  7537. if (!result.empty()) { result += '&'; }
  7538. result += encode_query_component(dec_key);
  7539. if (!val.empty() || std::find(b, e, '=') != e) {
  7540. result += '=';
  7541. result += encode_query_component(dec_val);
  7542. }
  7543. }
  7544. });
  7545. return result;
  7546. }
  7547. // Build the request target that goes on the wire from a caller-supplied path.
  7548. // Shared by the buffered send path and the streaming API so that both put the
  7549. // same bytes in the request line for the same input.
  7550. inline std::string encode_request_target(const std::string &target,
  7551. bool path_encode) {
  7552. // `substr(0, npos)` yields the whole string, which is what the no-query
  7553. // case needs.
  7554. auto query_pos = target.find('?');
  7555. auto path_part = target.substr(0, query_pos);
  7556. std::string query_part;
  7557. if (query_pos != std::string::npos) {
  7558. query_part = target.substr(query_pos + 1);
  7559. }
  7560. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7561. if (!query_part.empty()) {
  7562. // When path encoding is disabled the caller has supplied an already-encoded
  7563. // target and expects the exact bytes to be sent on the wire, so skip
  7564. // normalization for the query too. Normalizing would decode-then-re-encode
  7565. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7566. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7567. if (path_encode) {
  7568. auto normalized = normalize_query_string(query_part);
  7569. if (!normalized.empty()) {
  7570. result += '?';
  7571. result += normalized;
  7572. }
  7573. } else {
  7574. result += '?';
  7575. result += query_part;
  7576. }
  7577. }
  7578. return result;
  7579. }
  7580. inline bool parse_multipart_boundary(const std::string &content_type,
  7581. std::string &boundary) {
  7582. std::map<std::string, std::string> params;
  7583. extract_media_type(content_type, &params);
  7584. auto it = params.find("boundary");
  7585. if (it == params.end()) { return false; }
  7586. boundary = it->second;
  7587. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7588. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7589. // bytes costs a nearly full comparison at nearly every position: the
  7590. // boundary's length multiplies the worst-case cost of scanning a body.
  7591. return !boundary.empty() && boundary.size() <= 70;
  7592. }
  7593. inline void parse_disposition_params(const std::string &s, Params &params) {
  7594. std::set<std::string> cache;
  7595. split_unquoted(s.data(), s.data() + s.size(), ';',
  7596. [&](const char *b, const char *e) {
  7597. std::string kv(b, e);
  7598. if (cache.find(kv) != cache.end()) { return; }
  7599. cache.insert(kv);
  7600. std::string key;
  7601. std::string val;
  7602. divide_param_pair(b, e, key, val);
  7603. if (!key.empty()) {
  7604. params.emplace(trim_double_quotes_copy(key),
  7605. trim_double_quotes_copy(val));
  7606. }
  7607. });
  7608. }
  7609. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7610. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7611. #else
  7612. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7613. #endif
  7614. auto is_valid = [](const std::string &str) {
  7615. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7616. };
  7617. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7618. const auto pos = static_cast<size_t>(6);
  7619. const auto len = static_cast<size_t>(s.size() - 6);
  7620. auto all_valid_ranges = true;
  7621. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7622. if (!all_valid_ranges) { return; }
  7623. const auto it = std::find(b, e, '-');
  7624. if (it == e) {
  7625. all_valid_ranges = false;
  7626. return;
  7627. }
  7628. const auto lhs = std::string(b, it);
  7629. const auto rhs = std::string(it + 1, e);
  7630. if (!is_valid(lhs) || !is_valid(rhs)) {
  7631. all_valid_ranges = false;
  7632. return;
  7633. }
  7634. ssize_t first = -1;
  7635. if (!lhs.empty()) {
  7636. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7637. // would turn the range into a suffix range.
  7638. auto res =
  7639. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7640. if (res.ec != std::errc{}) {
  7641. all_valid_ranges = false;
  7642. return;
  7643. }
  7644. }
  7645. ssize_t last = -1;
  7646. if (!rhs.empty()) {
  7647. // An overflowing last-byte-pos is past any content length, so keeping
  7648. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7649. ssize_t v;
  7650. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7651. if (res.ec == std::errc{}) { last = v; }
  7652. }
  7653. if ((first == -1 && last == -1) ||
  7654. (first != -1 && last != -1 && first > last)) {
  7655. all_valid_ranges = false;
  7656. return;
  7657. }
  7658. ranges.emplace_back(first, last);
  7659. });
  7660. return all_valid_ranges && !ranges.empty();
  7661. }
  7662. return false;
  7663. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7664. }
  7665. #else
  7666. } catch (...) { return false; }
  7667. #endif
  7668. inline bool parse_accept_header(const std::string &s,
  7669. std::vector<std::string> &content_types) {
  7670. content_types.clear();
  7671. // Empty string is considered valid (no preference)
  7672. if (s.empty()) { return true; }
  7673. struct AcceptEntry {
  7674. std::string media_type;
  7675. double quality;
  7676. int order;
  7677. };
  7678. std::vector<AcceptEntry> entries;
  7679. int order = 0;
  7680. bool has_invalid_entry = false;
  7681. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7682. // has to parse and ignore empty list elements, so a leading, trailing or
  7683. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7684. // split() skips them, and the header length limit bounds how many a sender
  7685. // can send, so ignoring all of them cannot be used as a denial-of-service
  7686. // vector.
  7687. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7688. std::string entry(b, e);
  7689. entry = trim_copy(entry);
  7690. AcceptEntry accept_entry;
  7691. accept_entry.order = order++;
  7692. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7693. accept_entry.media_type, accept_entry.quality)) {
  7694. has_invalid_entry = true;
  7695. return;
  7696. }
  7697. // Remove additional parameters from media type
  7698. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7699. // Basic validation of media type format
  7700. if (accept_entry.media_type.empty()) {
  7701. has_invalid_entry = true;
  7702. return;
  7703. }
  7704. // Check for basic media type format (should contain '/' or be '*')
  7705. if (accept_entry.media_type != "*" &&
  7706. accept_entry.media_type.find('/') == std::string::npos) {
  7707. has_invalid_entry = true;
  7708. return;
  7709. }
  7710. entries.push_back(std::move(accept_entry));
  7711. });
  7712. // Return false if any invalid entry was found
  7713. if (has_invalid_entry) { return false; }
  7714. // Sort by quality (descending), then by original order (ascending)
  7715. std::sort(entries.begin(), entries.end(),
  7716. [](const AcceptEntry &a, const AcceptEntry &b) {
  7717. if (a.quality != b.quality) {
  7718. return a.quality > b.quality; // Higher quality first
  7719. }
  7720. return a.order < b.order; // Earlier order first for same quality
  7721. });
  7722. // Extract sorted media types
  7723. content_types.reserve(entries.size());
  7724. for (auto &entry : entries) {
  7725. content_types.push_back(std::move(entry.media_type));
  7726. }
  7727. return true;
  7728. }
  7729. class FormDataParser {
  7730. public:
  7731. FormDataParser() = default;
  7732. void set_boundary(std::string &&boundary) {
  7733. boundary_ = std::move(boundary);
  7734. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7735. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7736. }
  7737. bool is_valid() const { return is_valid_; }
  7738. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7739. const ContentReceiver &content_callback) {
  7740. // Once the close delimiter has been seen the rest of the body is epilogue
  7741. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7742. // spread across reads is not copied in only to be erased right away.
  7743. if (state_ == 5) { return true; }
  7744. buf_append(buf, n);
  7745. while (buf_size() > 0) {
  7746. switch (state_) {
  7747. case 0: { // Initial boundary
  7748. auto pos = buf_find(dash_boundary_crlf_);
  7749. if (pos == buf_size()) {
  7750. // Not found yet: keep only a possible partial boundary at the tail so
  7751. // that a body which never contains the boundary cannot grow the
  7752. // buffer (and get rescanned from the start) without bound.
  7753. auto keep = dash_boundary_crlf_.size() - 1;
  7754. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7755. return true;
  7756. }
  7757. buf_erase(pos + dash_boundary_crlf_.size());
  7758. state_ = 1;
  7759. break;
  7760. }
  7761. case 1: { // New entry
  7762. clear_file_info();
  7763. state_ = 2;
  7764. break;
  7765. }
  7766. case 2: { // Headers
  7767. auto pos = buf_find(crlf_);
  7768. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7769. while (pos < buf_size()) {
  7770. // Empty line
  7771. if (pos == 0) {
  7772. if (!header_callback(file_)) {
  7773. is_valid_ = false;
  7774. return false;
  7775. }
  7776. buf_erase(crlf_.size());
  7777. state_ = 3;
  7778. break;
  7779. }
  7780. // Check header count limit
  7781. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7782. is_valid_ = false;
  7783. return false;
  7784. }
  7785. header_count_++;
  7786. const auto header = buf_head(pos);
  7787. if (!parse_header(header.data(), header.data() + header.size(),
  7788. [&](const std::string &, const std::string &) {})) {
  7789. is_valid_ = false;
  7790. return false;
  7791. }
  7792. // Parse and emplace space trimmed headers into a map
  7793. if (!parse_header(
  7794. header.data(), header.data() + header.size(),
  7795. [&](const std::string &key, const std::string &val) {
  7796. file_.headers.emplace(key, val);
  7797. })) {
  7798. is_valid_ = false;
  7799. return false;
  7800. }
  7801. constexpr const char header_content_type[] = "Content-Type:";
  7802. if (start_with_case_ignore(header, header_content_type)) {
  7803. file_.content_type =
  7804. trim_copy(header.substr(str_len(header_content_type)));
  7805. } else {
  7806. std::string disposition_params;
  7807. if (parse_content_disposition(header, disposition_params)) {
  7808. Params params;
  7809. parse_disposition_params(disposition_params, params);
  7810. auto it = params.find("name");
  7811. if (it != params.end()) {
  7812. file_.name = it->second;
  7813. } else {
  7814. is_valid_ = false;
  7815. return false;
  7816. }
  7817. it = params.find("filename");
  7818. if (it != params.end()) { file_.filename = it->second; }
  7819. it = params.find("filename*");
  7820. if (it != params.end()) {
  7821. // RFC 5987: only UTF-8 encoding is allowed
  7822. const auto &val = it->second;
  7823. constexpr const char utf8_prefix[] = "UTF-8''";
  7824. constexpr size_t prefix_len = str_len(utf8_prefix);
  7825. if (val.size() > prefix_len &&
  7826. start_with_case_ignore(val, utf8_prefix)) {
  7827. file_.filename = decode_path_component(
  7828. val.substr(prefix_len)); // override...
  7829. } else {
  7830. is_valid_ = false;
  7831. return false;
  7832. }
  7833. }
  7834. }
  7835. }
  7836. buf_erase(pos + crlf_.size());
  7837. pos = buf_find(crlf_);
  7838. }
  7839. if (state_ != 3) { return true; }
  7840. break;
  7841. }
  7842. case 3: { // Body
  7843. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7844. auto pos = buf_find(crlf_dash_boundary_);
  7845. if (pos < buf_size()) {
  7846. if (!content_callback(buf_data(), pos)) {
  7847. is_valid_ = false;
  7848. return false;
  7849. }
  7850. buf_erase(pos + crlf_dash_boundary_.size());
  7851. state_ = 4;
  7852. } else {
  7853. auto len = buf_size() - crlf_dash_boundary_.size();
  7854. if (len > 0) {
  7855. if (!content_callback(buf_data(), len)) {
  7856. is_valid_ = false;
  7857. return false;
  7858. }
  7859. buf_erase(len);
  7860. }
  7861. return true;
  7862. }
  7863. break;
  7864. }
  7865. case 4: { // Boundary
  7866. if (crlf_.size() > buf_size()) { return true; }
  7867. if (buf_start_with(crlf_)) {
  7868. buf_erase(crlf_.size());
  7869. state_ = 1;
  7870. } else if (buf_start_with(dash_)) {
  7871. buf_erase(dash_.size());
  7872. is_valid_ = true;
  7873. state_ = 5;
  7874. } else {
  7875. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7876. // accepted after a boundary; RFC 2046 allows transport-padding in
  7877. // between, but this parser has never supported it. Either way the
  7878. // body is already destined to be rejected, so fail now instead of
  7879. // buffering the rest of it. Both are two bytes, so the check above
  7880. // already guarantees enough buffered data to decide.
  7881. is_valid_ = false;
  7882. return false;
  7883. }
  7884. break;
  7885. }
  7886. case 5: { // Epilogue
  7887. buf_erase(buf_size());
  7888. break;
  7889. }
  7890. }
  7891. }
  7892. return true;
  7893. }
  7894. private:
  7895. void clear_file_info() {
  7896. file_.name.clear();
  7897. file_.filename.clear();
  7898. file_.content_type.clear();
  7899. file_.headers.clear();
  7900. header_count_ = 0;
  7901. }
  7902. bool start_with_case_ignore(const std::string &a, const char *b,
  7903. size_t offset = 0) const {
  7904. const auto b_len = strlen(b);
  7905. if (a.size() < offset + b_len) { return false; }
  7906. for (size_t i = 0; i < b_len; i++) {
  7907. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7908. return false;
  7909. }
  7910. }
  7911. return true;
  7912. }
  7913. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7914. // Returns true if header matches, with the params portion in `params_out`.
  7915. bool parse_content_disposition(const std::string &header,
  7916. std::string &params_out) const {
  7917. constexpr const char prefix[] = "Content-Disposition:";
  7918. constexpr size_t prefix_len = str_len(prefix);
  7919. if (!start_with_case_ignore(header, prefix)) { return false; }
  7920. // Skip whitespace after "Content-Disposition:"
  7921. auto pos = prefix_len;
  7922. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7923. pos++;
  7924. }
  7925. // Match "form-data;" (case-insensitive)
  7926. constexpr const char form_data[] = "form-data;";
  7927. constexpr size_t form_data_len = str_len(form_data);
  7928. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7929. pos += form_data_len;
  7930. // Skip whitespace after "form-data;"
  7931. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7932. pos++;
  7933. }
  7934. params_out = header.substr(pos);
  7935. return true;
  7936. }
  7937. const std::string dash_ = "--";
  7938. const std::string crlf_ = "\r\n";
  7939. std::string boundary_;
  7940. std::string dash_boundary_crlf_;
  7941. std::string crlf_dash_boundary_;
  7942. size_t state_ = 0;
  7943. bool is_valid_ = false;
  7944. FormData file_;
  7945. size_t header_count_ = 0;
  7946. // Buffer
  7947. bool start_with(const std::string &a, size_t spos, size_t epos,
  7948. const std::string &b) const {
  7949. if (epos - spos < b.size()) { return false; }
  7950. for (size_t i = 0; i < b.size(); i++) {
  7951. if (a[i + spos] != b[i]) { return false; }
  7952. }
  7953. return true;
  7954. }
  7955. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7956. const char *buf_data() const { return &buf_[buf_spos_]; }
  7957. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7958. bool buf_start_with(const std::string &s) const {
  7959. return start_with(buf_, buf_spos_, buf_epos_, s);
  7960. }
  7961. size_t buf_find(const std::string &s) const {
  7962. auto c = s.front();
  7963. size_t off = buf_spos_;
  7964. while (off < buf_epos_) {
  7965. auto pos = off;
  7966. while (true) {
  7967. if (pos == buf_epos_) { return buf_size(); }
  7968. if (buf_[pos] == c) { break; }
  7969. pos++;
  7970. }
  7971. auto remaining_size = buf_epos_ - pos;
  7972. if (s.size() > remaining_size) { return buf_size(); }
  7973. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7974. off = pos + 1;
  7975. }
  7976. return buf_size();
  7977. }
  7978. void buf_append(const char *data, size_t n) {
  7979. auto remaining_size = buf_size();
  7980. if (remaining_size > 0 && buf_spos_ > 0) {
  7981. for (size_t i = 0; i < remaining_size; i++) {
  7982. buf_[i] = buf_[buf_spos_ + i];
  7983. }
  7984. }
  7985. buf_spos_ = 0;
  7986. buf_epos_ = remaining_size;
  7987. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7988. for (size_t i = 0; i < n; i++) {
  7989. buf_[buf_epos_ + i] = data[i];
  7990. }
  7991. buf_epos_ += n;
  7992. }
  7993. void buf_erase(size_t size) { buf_spos_ += size; }
  7994. std::string buf_;
  7995. size_t buf_spos_ = 0;
  7996. size_t buf_epos_ = 0;
  7997. };
  7998. inline std::string random_string(size_t length) {
  7999. constexpr const char data[] =
  8000. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8001. thread_local auto engine([]() {
  8002. // std::random_device might actually be deterministic on some
  8003. // platforms, but due to lack of support in the c++ standard library,
  8004. // doing better requires either some ugly hacks or breaking portability.
  8005. std::random_device seed_gen;
  8006. // Request 128 bits of entropy for initialization
  8007. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8008. return std::mt19937(seed_sequence);
  8009. }());
  8010. std::string result;
  8011. for (size_t i = 0; i < length; i++) {
  8012. result += data[engine() % (sizeof(data) - 1)];
  8013. }
  8014. return result;
  8015. }
  8016. inline std::string make_multipart_data_boundary() {
  8017. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8018. }
  8019. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8020. auto valid = true;
  8021. for (size_t i = 0; i < boundary.size(); i++) {
  8022. auto c = boundary[i];
  8023. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8024. valid = false;
  8025. break;
  8026. }
  8027. }
  8028. return valid;
  8029. }
  8030. // Escape a multipart field name/filename following the WHATWG HTML standard
  8031. // ("escape a multipart form-data name"), which is what browsers send:
  8032. // '"' -> %22, CR -> %0D, LF -> %0A
  8033. // With escape_quote = false, only CR and LF are escaped; this is for header
  8034. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8035. inline std::string escape_multipart_field(const std::string &s,
  8036. bool escape_quote = true) {
  8037. std::string result;
  8038. result.reserve(s.size());
  8039. for (auto c : s) {
  8040. switch (c) {
  8041. case '"':
  8042. if (escape_quote) {
  8043. result += "%22";
  8044. } else {
  8045. result += c;
  8046. }
  8047. break;
  8048. case '\r': result += "%0D"; break;
  8049. case '\n': result += "%0A"; break;
  8050. default: result += c; break;
  8051. }
  8052. }
  8053. return result;
  8054. }
  8055. template <typename T>
  8056. inline std::string
  8057. serialize_multipart_formdata_item_begin(const T &item,
  8058. const std::string &boundary) {
  8059. std::string body = "--" + boundary + "\r\n";
  8060. body += "Content-Disposition: form-data; name=\"" +
  8061. escape_multipart_field(item.name) + "\"";
  8062. if (!item.filename.empty()) {
  8063. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8064. }
  8065. body += "\r\n";
  8066. if (!item.content_type.empty()) {
  8067. body +=
  8068. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8069. "\r\n";
  8070. }
  8071. body += "\r\n";
  8072. return body;
  8073. }
  8074. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8075. inline std::string
  8076. serialize_multipart_formdata_finish(const std::string &boundary) {
  8077. return "--" + boundary + "--\r\n";
  8078. }
  8079. inline std::string
  8080. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8081. return "multipart/form-data; boundary=" + boundary;
  8082. }
  8083. inline std::string
  8084. serialize_multipart_formdata(const UploadFormDataItems &items,
  8085. const std::string &boundary, bool finish = true) {
  8086. std::string body;
  8087. for (const auto &item : items) {
  8088. body += serialize_multipart_formdata_item_begin(item, boundary);
  8089. body += item.content + serialize_multipart_formdata_item_end();
  8090. }
  8091. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8092. return body;
  8093. }
  8094. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8095. const std::string &boundary) {
  8096. size_t total = 0;
  8097. for (const auto &item : items) {
  8098. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8099. total += item.content.size();
  8100. total += serialize_multipart_formdata_item_end().size();
  8101. }
  8102. total += serialize_multipart_formdata_finish(boundary).size();
  8103. return total;
  8104. }
  8105. struct MultipartSegment {
  8106. const char *data;
  8107. size_t size;
  8108. };
  8109. // NOTE: items must outlive the returned ContentProvider
  8110. // (safe for synchronous use inside Post/Put/Patch)
  8111. inline ContentProvider
  8112. make_multipart_content_provider(const UploadFormDataItems &items,
  8113. const std::string &boundary) {
  8114. // Own the per-item header strings and the finish string
  8115. std::vector<std::string> owned;
  8116. owned.reserve(items.size() + 1);
  8117. for (const auto &item : items)
  8118. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8119. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8120. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8121. std::vector<MultipartSegment> segs;
  8122. segs.reserve(items.size() * 3 + 1);
  8123. static const char crlf[] = "\r\n";
  8124. for (size_t i = 0; i < items.size(); i++) {
  8125. segs.push_back({owned[i].data(), owned[i].size()});
  8126. segs.push_back({items[i].content.data(), items[i].content.size()});
  8127. segs.push_back({crlf, 2});
  8128. }
  8129. segs.push_back({owned.back().data(), owned.back().size()});
  8130. struct MultipartState {
  8131. std::vector<std::string> owned;
  8132. std::vector<MultipartSegment> segs;
  8133. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8134. };
  8135. auto state = std::make_shared<MultipartState>();
  8136. state->owned = std::move(owned);
  8137. // `segs` holds raw pointers into owned strings; std::string move preserves
  8138. // the data pointer, so these pointers remain valid after the move above.
  8139. state->segs = std::move(segs);
  8140. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8141. // Buffer multiple small segments into fewer, larger writes to avoid
  8142. // excessive TCP packets when there are many form data items (#2410)
  8143. auto &buf = state->buf;
  8144. auto buf_size = buf.size();
  8145. size_t buf_len = 0;
  8146. size_t remaining = length;
  8147. // Find the first segment containing 'offset'
  8148. size_t pos = 0;
  8149. size_t seg_idx = 0;
  8150. for (; seg_idx < state->segs.size(); seg_idx++) {
  8151. const auto &seg = state->segs[seg_idx];
  8152. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8153. pos += seg.size;
  8154. }
  8155. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8156. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8157. const auto &seg = state->segs[seg_idx];
  8158. size_t available = seg.size - seg_offset;
  8159. size_t to_copy = (std::min)(available, remaining);
  8160. const char *src = seg.data + seg_offset;
  8161. seg_offset = 0; // only the first segment has a non-zero offset
  8162. while (to_copy > 0) {
  8163. size_t space = buf_size - buf_len;
  8164. size_t chunk = (std::min)(to_copy, space);
  8165. std::memcpy(buf.data() + buf_len, src, chunk);
  8166. buf_len += chunk;
  8167. src += chunk;
  8168. to_copy -= chunk;
  8169. remaining -= chunk;
  8170. if (buf_len == buf_size) {
  8171. if (!sink.write(buf.data(), buf_len)) { return false; }
  8172. buf_len = 0;
  8173. }
  8174. }
  8175. }
  8176. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8177. return true;
  8178. };
  8179. }
  8180. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8181. if (ranges.size() <= 1) return;
  8182. // Sort ranges by start position
  8183. std::sort(ranges.begin(), ranges.end(),
  8184. [](const Range &a, const Range &b) { return a.first < b.first; });
  8185. Ranges coalesced;
  8186. coalesced.reserve(ranges.size());
  8187. for (auto &r : ranges) {
  8188. auto first_pos = r.first;
  8189. auto last_pos = r.second;
  8190. // Handle special cases like in range_error
  8191. if (first_pos == -1 && last_pos == -1) {
  8192. first_pos = 0;
  8193. last_pos = static_cast<ssize_t>(content_length);
  8194. }
  8195. if (first_pos == -1) {
  8196. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8197. last_pos = static_cast<ssize_t>(content_length) - 1;
  8198. }
  8199. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8200. last_pos = static_cast<ssize_t>(content_length) - 1;
  8201. }
  8202. // Skip invalid ranges
  8203. if (!(0 <= first_pos && first_pos <= last_pos &&
  8204. last_pos < static_cast<ssize_t>(content_length))) {
  8205. continue;
  8206. }
  8207. // Coalesce with previous range if overlapping or adjacent (but not
  8208. // identical)
  8209. if (!coalesced.empty()) {
  8210. auto &prev = coalesced.back();
  8211. // Check if current range overlaps or is adjacent to previous range
  8212. // but don't coalesce identical ranges (allow duplicates)
  8213. if (first_pos <= prev.second + 1 &&
  8214. !(first_pos == prev.first && last_pos == prev.second)) {
  8215. // Extend the previous range
  8216. prev.second = (std::max)(prev.second, last_pos);
  8217. continue;
  8218. }
  8219. }
  8220. // Add new range
  8221. coalesced.emplace_back(first_pos, last_pos);
  8222. }
  8223. ranges = std::move(coalesced);
  8224. }
  8225. inline bool range_error(Request &req, Response &res) {
  8226. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8227. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8228. req.ranges.clear();
  8229. if (res.status == StatusCode::PartialContent_206) {
  8230. res.status = StatusCode::OK_200;
  8231. }
  8232. return false;
  8233. }
  8234. ssize_t content_len = static_cast<ssize_t>(
  8235. res.content_length_ ? res.content_length_ : res.body.size());
  8236. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8237. size_t overwrapping_count = 0;
  8238. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8239. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8240. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8241. // Too many ranges
  8242. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8243. for (auto &r : req.ranges) {
  8244. auto &first_pos = r.first;
  8245. auto &last_pos = r.second;
  8246. if (first_pos == -1 && last_pos == -1) {
  8247. first_pos = 0;
  8248. last_pos = content_len;
  8249. }
  8250. if (first_pos == -1) {
  8251. first_pos = content_len - last_pos;
  8252. last_pos = content_len - 1;
  8253. }
  8254. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8255. // A client can limit the number of bytes requested without knowing the
  8256. // size of the selected representation. If the last-pos value is absent,
  8257. // or if the value is greater than or equal to the current length of the
  8258. // representation data, the byte range is interpreted as the remainder of
  8259. // the representation (i.e., the server replaces the value of last-pos
  8260. // with a value that is one less than the current length of the selected
  8261. // representation).
  8262. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8263. if (last_pos == -1 || last_pos >= content_len) {
  8264. last_pos = content_len - 1;
  8265. }
  8266. // Range must be within content length
  8267. if (!(0 <= first_pos && first_pos <= last_pos &&
  8268. last_pos <= content_len - 1)) {
  8269. return true;
  8270. }
  8271. // Request must not have more than two overlapping ranges
  8272. for (const auto &processed_range : processed_ranges) {
  8273. if (!(last_pos < processed_range.first ||
  8274. first_pos > processed_range.second)) {
  8275. overwrapping_count++;
  8276. if (overwrapping_count > 2) { return true; }
  8277. break; // Only count once per range
  8278. }
  8279. }
  8280. processed_ranges.emplace_back(first_pos, last_pos);
  8281. }
  8282. // After validation, coalesce overlapping ranges as per RFC 9110
  8283. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8284. }
  8285. return false;
  8286. }
  8287. inline std::pair<size_t, size_t>
  8288. get_range_offset_and_length(Range r, size_t content_length) {
  8289. assert(r.first != -1 && r.second != -1);
  8290. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8291. assert(r.first <= r.second &&
  8292. r.second < static_cast<ssize_t>(content_length));
  8293. (void)(content_length);
  8294. return std::make_pair(static_cast<size_t>(r.first),
  8295. static_cast<size_t>(r.second - r.first) + 1);
  8296. }
  8297. inline std::string make_content_range_header_field(
  8298. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8299. auto st = offset_and_length.first;
  8300. auto ed = st + offset_and_length.second - 1;
  8301. std::string field = "bytes ";
  8302. field += std::to_string(st);
  8303. field += '-';
  8304. field += std::to_string(ed);
  8305. field += '/';
  8306. field += std::to_string(content_length);
  8307. return field;
  8308. }
  8309. template <typename SToken, typename CToken, typename Content>
  8310. bool process_multipart_ranges_data(const Request &req,
  8311. const std::string &boundary,
  8312. const std::string &content_type,
  8313. size_t content_length, SToken stoken,
  8314. CToken ctoken, Content content) {
  8315. for (size_t i = 0; i < req.ranges.size(); i++) {
  8316. ctoken("--");
  8317. stoken(boundary);
  8318. ctoken("\r\n");
  8319. if (!content_type.empty()) {
  8320. ctoken("Content-Type: ");
  8321. stoken(content_type);
  8322. ctoken("\r\n");
  8323. }
  8324. auto offset_and_length =
  8325. get_range_offset_and_length(req.ranges[i], content_length);
  8326. ctoken("Content-Range: ");
  8327. stoken(make_content_range_header_field(offset_and_length, content_length));
  8328. ctoken("\r\n");
  8329. ctoken("\r\n");
  8330. if (!content(offset_and_length.first, offset_and_length.second)) {
  8331. return false;
  8332. }
  8333. ctoken("\r\n");
  8334. }
  8335. ctoken("--");
  8336. stoken(boundary);
  8337. ctoken("--");
  8338. return true;
  8339. }
  8340. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8341. const std::string &boundary,
  8342. const std::string &content_type,
  8343. size_t content_length,
  8344. std::string &data) {
  8345. process_multipart_ranges_data(
  8346. req, boundary, content_type, content_length,
  8347. [&](const std::string &token) { data += token; },
  8348. [&](const std::string &token) { data += token; },
  8349. [&](size_t offset, size_t length) {
  8350. assert(offset + length <= content_length);
  8351. data += res.body.substr(offset, length);
  8352. return true;
  8353. });
  8354. }
  8355. inline size_t get_multipart_ranges_data_length(const Request &req,
  8356. const std::string &boundary,
  8357. const std::string &content_type,
  8358. size_t content_length) {
  8359. size_t data_length = 0;
  8360. process_multipart_ranges_data(
  8361. req, boundary, content_type, content_length,
  8362. [&](const std::string &token) { data_length += token.size(); },
  8363. [&](const std::string &token) { data_length += token.size(); },
  8364. [&](size_t /*offset*/, size_t length) {
  8365. data_length += length;
  8366. return true;
  8367. });
  8368. return data_length;
  8369. }
  8370. template <typename T>
  8371. inline bool
  8372. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8373. const std::string &boundary,
  8374. const std::string &content_type,
  8375. size_t content_length, const T &is_shutting_down) {
  8376. return process_multipart_ranges_data(
  8377. req, boundary, content_type, content_length,
  8378. [&](const std::string &token) { strm.write(token); },
  8379. [&](const std::string &token) { strm.write(token); },
  8380. [&](size_t offset, size_t length) {
  8381. return write_content(strm, res.content_provider_, offset, length,
  8382. is_shutting_down);
  8383. });
  8384. }
  8385. inline bool has_framed_body(const Request &req) {
  8386. return is_chunked_transfer_encoding(req.headers) ||
  8387. req.get_header_value_u64("Content-Length") > 0;
  8388. }
  8389. inline bool is_connection_persistent(const Request &req) {
  8390. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8391. if (req.version == "HTTP/1.0" &&
  8392. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8393. return false;
  8394. }
  8395. return true;
  8396. }
  8397. inline bool expect_content(const Request &req) {
  8398. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8399. req.method == "DELETE") {
  8400. return true;
  8401. }
  8402. return has_framed_body(req);
  8403. }
  8404. #ifdef _WIN32
  8405. class WSInit {
  8406. public:
  8407. WSInit() {
  8408. WSADATA wsaData;
  8409. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8410. }
  8411. ~WSInit() {
  8412. if (is_valid_) WSACleanup();
  8413. }
  8414. bool is_valid_ = false;
  8415. };
  8416. static WSInit wsinit_;
  8417. #endif
  8418. // RFC 9110 Section 11.6.1 defines a challenge list as
  8419. // WWW-Authenticate = #challenge
  8420. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8421. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8422. // so a server may offer several schemes, each with its own comma-separated
  8423. // auth-param list, in either order and either as separate field lines or
  8424. // packed into one. Splitting on every comma would break apart a challenge's
  8425. // own param list; splitting only on the first space would miss a Digest
  8426. // challenge that isn't first. Split on commas that aren't inside a
  8427. // quoted-string instead, then track which scheme each resulting segment
  8428. // belongs to: a segment whose text before "=" contains whitespace (or that
  8429. // has no "=" at all) starts a new challenge named by its leading token.
  8430. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8431. std::vector<std::string> segments;
  8432. size_t start = 0;
  8433. auto in_quotes = false;
  8434. for (size_t i = 0; i < s.size(); i++) {
  8435. auto c = s[i];
  8436. if (in_quotes) {
  8437. if (c == '\\' && i + 1 < s.size()) {
  8438. i++;
  8439. } else if (c == '"') {
  8440. in_quotes = false;
  8441. }
  8442. } else if (c == '"') {
  8443. in_quotes = true;
  8444. } else if (c == ',') {
  8445. segments.push_back(s.substr(start, i - start));
  8446. start = i + 1;
  8447. }
  8448. }
  8449. segments.push_back(s.substr(start));
  8450. return segments;
  8451. }
  8452. inline std::string unescape_quoted_pairs(const std::string &s) {
  8453. std::string out;
  8454. out.reserve(s.size());
  8455. for (size_t i = 0; i < s.size(); i++) {
  8456. if (s[i] == '\\' && i + 1 < s.size()) {
  8457. out += s[++i];
  8458. } else {
  8459. out += s[i];
  8460. }
  8461. }
  8462. return out;
  8463. }
  8464. inline bool parse_www_authenticate(const Response &res,
  8465. std::map<std::string, std::string> &auth,
  8466. bool is_proxy) {
  8467. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8468. auto combined = get_combined_header_value(res.headers, auth_key);
  8469. if (combined.empty()) { return false; }
  8470. auto found_digest = false;
  8471. auto in_digest_challenge = false;
  8472. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8473. auto segment = trim_copy(raw_segment);
  8474. if (segment.empty()) { continue; }
  8475. auto eq_pos = segment.find('=');
  8476. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8477. // for the first segment of a challenge, "<scheme> <key>") must be
  8478. // trimmed before its boundaries are inspected.
  8479. auto key_part = trim_copy(
  8480. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8481. auto space_pos = key_part.find_last_of(" \t");
  8482. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8483. // "<scheme>[ <key>]" starts a new challenge.
  8484. auto scheme_end =
  8485. space_pos == std::string::npos ? key_part.size() : space_pos;
  8486. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8487. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8488. // from one challenge is never paired with another's algorithm.
  8489. in_digest_challenge =
  8490. !found_digest &&
  8491. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8492. if (in_digest_challenge) { found_digest = true; }
  8493. if (space_pos == std::string::npos) {
  8494. // Bare scheme (or a token68), no auth-param on this segment.
  8495. continue;
  8496. }
  8497. key_part = key_part.substr(space_pos + 1);
  8498. }
  8499. if (!in_digest_challenge) { continue; }
  8500. auto val = trim_copy(segment.substr(eq_pos + 1));
  8501. auto unquoted = trim_double_quotes_copy(val);
  8502. if (unquoted.size() != val.size()) {
  8503. unquoted = unescape_quoted_pairs(unquoted);
  8504. }
  8505. auth[std::move(key_part)] = std::move(unquoted);
  8506. }
  8507. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8508. // make_digest_authentication_header() dereferences both unconditionally, so
  8509. // a challenge missing either can't produce a usable Authorization header.
  8510. // Treat it the same as no Digest challenge at all.
  8511. return found_digest && auth.find("realm") != auth.end() &&
  8512. auth.find("nonce") != auth.end();
  8513. }
  8514. class ContentProviderAdapter {
  8515. public:
  8516. explicit ContentProviderAdapter(
  8517. ContentProviderWithoutLength &&content_provider)
  8518. : content_provider_(std::move(content_provider)) {}
  8519. bool operator()(size_t offset, size_t, DataSink &sink) {
  8520. return content_provider_(offset, sink);
  8521. }
  8522. private:
  8523. ContentProviderWithoutLength content_provider_;
  8524. };
  8525. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8526. namespace fields {
  8527. inline bool is_token_char(char c) {
  8528. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8529. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8530. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8531. }
  8532. inline bool is_token(const std::string &s) {
  8533. if (s.empty()) { return false; }
  8534. for (auto c : s) {
  8535. if (!is_token_char(c)) { return false; }
  8536. }
  8537. return true;
  8538. }
  8539. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8540. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8541. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8542. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8543. inline bool is_field_content(const std::string &s) {
  8544. if (s.empty()) { return true; }
  8545. if (s.size() == 1) {
  8546. return is_field_vchar(s[0]);
  8547. } else if (s.size() == 2) {
  8548. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8549. } else {
  8550. size_t i = 0;
  8551. if (!is_field_vchar(s[i])) { return false; }
  8552. i++;
  8553. while (i < s.size() - 1) {
  8554. auto c = s[i++];
  8555. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8556. } else {
  8557. return false;
  8558. }
  8559. }
  8560. return is_field_vchar(s[i]);
  8561. }
  8562. }
  8563. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8564. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8565. return is_field_name(name) && is_field_value(value);
  8566. }
  8567. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8568. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8569. inline bool is_request_target(const std::string &s) {
  8570. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8571. }
  8572. } // namespace fields
  8573. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8574. WebSocketUpgradeResponse &upgrade) {
  8575. // Generate random Sec-WebSocket-Key
  8576. thread_local std::mt19937 rng(std::random_device{}());
  8577. std::string key_bytes(16, '\0');
  8578. for (size_t i = 0; i < 16; i += 4) {
  8579. auto r = rng();
  8580. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8581. }
  8582. auto client_key = base64_encode(key_bytes);
  8583. req.headers.erase("Upgrade");
  8584. req.headers.erase("Connection");
  8585. req.headers.erase("Sec-WebSocket-Key");
  8586. req.headers.erase("Sec-WebSocket-Version");
  8587. req.headers.emplace("Upgrade", "websocket");
  8588. req.headers.emplace("Connection", "Upgrade");
  8589. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8590. req.headers.emplace("Sec-WebSocket-Version", "13");
  8591. // Build the request in memory first, like ClientImpl::write_request does.
  8592. // Writing straight to the socket would leak a request line onto the wire
  8593. // before check_and_write_headers gets a chance to reject an invalid header,
  8594. // and would emit one small write per header.
  8595. BufferStream bstrm;
  8596. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8597. upgrade.error = Error::Write;
  8598. return false;
  8599. }
  8600. auto error = Error::Success;
  8601. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8602. upgrade.error = error;
  8603. return false;
  8604. }
  8605. const auto &data = bstrm.get_buffer();
  8606. if (!write_data(strm, data.data(), data.size())) {
  8607. upgrade.error = Error::Write;
  8608. return false;
  8609. }
  8610. // Verify 101 response and Sec-WebSocket-Accept header
  8611. auto expected_accept = websocket_accept_key(client_key);
  8612. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8613. }
  8614. inline bool is_ip_address(const std::string &host) {
  8615. struct in_addr addr4;
  8616. struct in6_addr addr6;
  8617. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8618. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8619. }
  8620. // Resolve where a client should connect for `host`, honoring a user-supplied
  8621. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8622. // supplying the Host header and SNI; only the connection target changes.
  8623. //
  8624. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8625. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8626. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8627. // absent or empty mapping leaves `host` as the connection target; without the
  8628. // empty check the value would reach getaddrinfo as a null node and silently
  8629. // resolve to loopback.
  8630. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8631. const std::string &host, std::string &connect_host,
  8632. std::string &ip) {
  8633. connect_host = host;
  8634. ip.clear();
  8635. auto it = addr_map.find(host);
  8636. if (it == addr_map.end() || it->second.empty()) { return; }
  8637. if (is_ip_address(it->second)) {
  8638. ip = it->second;
  8639. } else {
  8640. connect_host = it->second;
  8641. }
  8642. }
  8643. } // namespace detail
  8644. /*
  8645. * Group 2: detail namespace - SSL common utilities
  8646. */
  8647. #ifdef CPPHTTPLIB_SSL_ENABLED
  8648. namespace detail {
  8649. class SSLSocketStream final : public Stream {
  8650. public:
  8651. SSLSocketStream(
  8652. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8653. time_t read_timeout_usec, time_t write_timeout_sec,
  8654. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8655. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8656. (std::chrono::steady_clock::time_point::min)());
  8657. ~SSLSocketStream() override;
  8658. bool is_readable() const override;
  8659. bool wait_readable() const override;
  8660. bool wait_writable() const override;
  8661. bool is_peer_alive() const override;
  8662. ssize_t read(char *ptr, size_t size) override;
  8663. ssize_t write(const char *ptr, size_t size) override;
  8664. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8665. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8666. socket_t socket() const override;
  8667. time_t duration() const override;
  8668. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8669. // See SocketStream::set_readable_hint().
  8670. void set_readable_hint() { readable_hint_ = true; }
  8671. private:
  8672. bool ensure_readable();
  8673. socket_t sock_;
  8674. tls::session_t session_;
  8675. time_t read_timeout_sec_;
  8676. time_t read_timeout_usec_;
  8677. time_t write_timeout_sec_;
  8678. time_t write_timeout_usec_;
  8679. time_t max_timeout_msec_;
  8680. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8681. bool readable_hint_ = false;
  8682. };
  8683. // A TLS stream for WebSocket connections, where the receive path and the
  8684. // send path (application send() plus the heartbeat ping thread) run on
  8685. // different threads. A single TLS session must never be entered
  8686. // concurrently, so every call into the session is serialized by one mutex.
  8687. //
  8688. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8689. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8690. // call under the lock, then waits for readiness with select() outside the
  8691. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8692. // blocked waiting for data never stalls a concurrent sender.
  8693. //
  8694. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8695. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8696. class WebSocketSSLStream final : public Stream {
  8697. public:
  8698. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8699. time_t read_timeout_sec, time_t read_timeout_usec,
  8700. time_t write_timeout_sec, time_t write_timeout_usec);
  8701. ~WebSocketSSLStream() override;
  8702. bool is_readable() const override;
  8703. bool wait_readable() const override;
  8704. bool wait_writable() const override;
  8705. ssize_t read(char *ptr, size_t size) override;
  8706. ssize_t write(const char *ptr, size_t size) override;
  8707. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8708. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8709. socket_t socket() const override;
  8710. time_t duration() const override;
  8711. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8712. private:
  8713. mutable std::mutex session_mutex_;
  8714. socket_t sock_;
  8715. tls::session_t session_;
  8716. // WebSocket::close() shortens the read timeout from the closing thread
  8717. // while the receive thread is inside wait_readable(), so these two are read
  8718. // and written concurrently. The write timeouts are never mutated.
  8719. std::atomic<time_t> read_timeout_sec_;
  8720. std::atomic<time_t> read_timeout_usec_;
  8721. time_t write_timeout_sec_;
  8722. time_t write_timeout_usec_;
  8723. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8724. };
  8725. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8726. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8727. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8728. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8729. unsigned int hash_length = 0;
  8730. unsigned char hash[EVP_MAX_MD_SIZE];
  8731. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8732. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8733. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8734. std::stringstream ss;
  8735. for (auto i = 0u; i < hash_length; ++i) {
  8736. ss << std::hex << std::setw(2) << std::setfill('0')
  8737. << static_cast<unsigned int>(hash[i]);
  8738. }
  8739. return ss.str();
  8740. }
  8741. inline std::string MD5(const std::string &s) {
  8742. return message_digest(s, EVP_md5());
  8743. }
  8744. inline std::string SHA_256(const std::string &s) {
  8745. return message_digest(s, EVP_sha256());
  8746. }
  8747. inline std::string SHA_512(const std::string &s) {
  8748. return message_digest(s, EVP_sha512());
  8749. }
  8750. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8751. namespace {
  8752. template <size_t N>
  8753. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8754. std::stringstream ss;
  8755. for (size_t i = 0; i < N; ++i) {
  8756. ss << std::hex << std::setw(2) << std::setfill('0')
  8757. << static_cast<unsigned int>(hash[i]);
  8758. }
  8759. return ss.str();
  8760. }
  8761. } // namespace
  8762. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8763. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8764. // initialized once. PSA state is process-global; do not free it.
  8765. inline bool ensure_mbedtls_psa_crypto() {
  8766. static std::once_flag once;
  8767. static bool ok = false;
  8768. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8769. return ok;
  8770. }
  8771. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8772. unsigned char *out, size_t out_size) {
  8773. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8774. size_t olen = 0;
  8775. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8776. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8777. olen == out_size;
  8778. }
  8779. #endif
  8780. inline std::string MD5(const std::string &s) {
  8781. unsigned char hash[16];
  8782. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8783. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8784. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8785. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8786. hash);
  8787. #else
  8788. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8789. hash);
  8790. #endif
  8791. return hash_to_hex(hash);
  8792. }
  8793. inline std::string SHA_256(const std::string &s) {
  8794. unsigned char hash[32];
  8795. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8796. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8797. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8798. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8799. hash, 0);
  8800. #else
  8801. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8802. s.size(), hash, 0);
  8803. #endif
  8804. return hash_to_hex(hash);
  8805. }
  8806. inline std::string SHA_512(const std::string &s) {
  8807. unsigned char hash[64];
  8808. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8809. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8810. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8811. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8812. hash, 0);
  8813. #else
  8814. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8815. s.size(), hash, 0);
  8816. #endif
  8817. return hash_to_hex(hash);
  8818. }
  8819. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8820. namespace {
  8821. template <size_t N>
  8822. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8823. std::stringstream ss;
  8824. for (size_t i = 0; i < N; ++i) {
  8825. ss << std::hex << std::setw(2) << std::setfill('0')
  8826. << static_cast<unsigned int>(hash[i]);
  8827. }
  8828. return ss.str();
  8829. }
  8830. } // namespace
  8831. inline std::string MD5(const std::string &s) {
  8832. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8833. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8834. static_cast<word32>(s.size()), hash);
  8835. return hash_to_hex(hash);
  8836. }
  8837. inline std::string SHA_256(const std::string &s) {
  8838. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8839. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8840. static_cast<word32>(s.size()), hash);
  8841. return hash_to_hex(hash);
  8842. }
  8843. inline std::string SHA_512(const std::string &s) {
  8844. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8845. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8846. static_cast<word32>(s.size()), hash);
  8847. return hash_to_hex(hash);
  8848. }
  8849. #endif
  8850. template <typename T>
  8851. inline bool process_server_socket_ssl(
  8852. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8853. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8854. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8855. time_t write_timeout_usec, T callback) {
  8856. return process_server_socket_core(
  8857. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8858. [&](bool close_connection, bool &connection_closed) {
  8859. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8860. write_timeout_sec, write_timeout_usec);
  8861. // See the non-TLS path in process_server_socket().
  8862. strm.set_readable_hint();
  8863. return callback(strm, close_connection, connection_closed);
  8864. });
  8865. }
  8866. template <typename T>
  8867. inline bool process_client_socket_ssl(
  8868. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8869. time_t read_timeout_usec, time_t write_timeout_sec,
  8870. time_t write_timeout_usec, time_t max_timeout_msec,
  8871. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8872. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8873. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8874. start_time);
  8875. return callback(strm);
  8876. }
  8877. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8878. const Request &req, const std::map<std::string, std::string> &auth,
  8879. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8880. const std::string &password, bool is_proxy = false) {
  8881. std::string nc;
  8882. {
  8883. std::stringstream ss;
  8884. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8885. nc = ss.str();
  8886. }
  8887. std::string qop;
  8888. if (auth.find("qop") != auth.end()) {
  8889. qop = auth.at("qop");
  8890. if (qop.find("auth-int") != std::string::npos) {
  8891. qop = "auth-int";
  8892. } else if (qop.find("auth") != std::string::npos) {
  8893. qop = "auth";
  8894. } else {
  8895. qop.clear();
  8896. }
  8897. }
  8898. std::string algo = "MD5";
  8899. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8900. std::string response;
  8901. {
  8902. auto H = algo == "SHA-256" ? detail::SHA_256
  8903. : algo == "SHA-512" ? detail::SHA_512
  8904. : detail::MD5;
  8905. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8906. auto A2 = req.method + ":" + req.path;
  8907. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8908. if (qop.empty()) {
  8909. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8910. } else {
  8911. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8912. ":" + qop + ":" + H(A2));
  8913. }
  8914. }
  8915. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8916. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8917. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8918. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8919. (qop.empty() ? ", response=\""
  8920. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8921. cnonce + "\", response=\"") +
  8922. response + "\"" +
  8923. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8924. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8925. return std::make_pair(key, field);
  8926. }
  8927. inline bool match_hostname(const std::string &pattern,
  8928. const std::string &hostname) {
  8929. // Exact match (case-insensitive)
  8930. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8931. // Split both pattern and hostname into components by '.'
  8932. std::vector<std::string> pattern_components;
  8933. if (!pattern.empty()) {
  8934. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8935. [&](const char *b, const char *e) {
  8936. pattern_components.emplace_back(b, e);
  8937. });
  8938. }
  8939. std::vector<std::string> host_components;
  8940. if (!hostname.empty()) {
  8941. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8942. [&](const char *b, const char *e) {
  8943. host_components.emplace_back(b, e);
  8944. });
  8945. }
  8946. // Component count must match
  8947. if (host_components.size() != pattern_components.size()) { return false; }
  8948. // Compare each component with wildcard support
  8949. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8950. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8951. auto itr = pattern_components.begin();
  8952. for (const auto &h : host_components) {
  8953. auto &p = *itr;
  8954. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8955. bool partial_match = false;
  8956. if (!p.empty() && p[p.size() - 1] == '*') {
  8957. const auto prefix_length = p.size() - 1;
  8958. if (prefix_length == 0) {
  8959. partial_match = true;
  8960. } else if (h.size() >= prefix_length) {
  8961. partial_match =
  8962. std::equal(p.begin(),
  8963. p.begin() + static_cast<std::string::difference_type>(
  8964. prefix_length),
  8965. h.begin(), [](const char ca, const char cb) {
  8966. return detail::case_ignore::to_lower(ca) ==
  8967. detail::case_ignore::to_lower(cb);
  8968. });
  8969. }
  8970. }
  8971. if (!partial_match) { return false; }
  8972. }
  8973. ++itr;
  8974. }
  8975. return true;
  8976. }
  8977. #ifdef _WIN32
  8978. // Verify certificate using Windows CertGetCertificateChain API.
  8979. // This provides real-time certificate validation with Windows Update
  8980. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8981. inline bool verify_cert_with_windows_schannel(
  8982. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  8983. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  8984. if (der_cert.empty()) { return false; }
  8985. out_error = 0;
  8986. // Create Windows certificate context from DER data
  8987. auto cert_context = CertCreateCertificateContext(
  8988. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8989. static_cast<DWORD>(der_cert.size()));
  8990. if (!cert_context) {
  8991. out_error = GetLastError();
  8992. return false;
  8993. }
  8994. auto cert_guard =
  8995. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8996. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8997. // Add the intermediates the server sent. Without them CryptoAPI follows the
  8998. // leaf's AIA URL, which may lead to an issuer under an untrusted root.
  8999. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9000. auto store_guard = scope_exit([&] { CertCloseStore(store, 0); });
  9001. auto sk = SSL_get_peer_cert_chain(static_cast<const SSL *>(session));
  9002. for (int i = 1; sk && i < sk_X509_num(sk); i++) {
  9003. std::vector<unsigned char> der;
  9004. tls::get_cert_der(sk_X509_value(sk, i), der);
  9005. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9006. static_cast<DWORD>(der.size()),
  9007. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9008. }
  9009. #else
  9010. (void)session;
  9011. auto store = cert_context->hCertStore;
  9012. #endif
  9013. // Setup chain parameters
  9014. CERT_CHAIN_PARA chain_para = {};
  9015. chain_para.cbSize = sizeof(chain_para);
  9016. // Build certificate chain with revocation checking
  9017. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9018. auto chain_result = CertGetCertificateChain(
  9019. nullptr, cert_context, nullptr, store, &chain_para,
  9020. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9021. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9022. nullptr, &chain_context);
  9023. if (!chain_result || !chain_context) {
  9024. out_error = GetLastError();
  9025. return false;
  9026. }
  9027. auto chain_guard =
  9028. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9029. // Check if chain has errors
  9030. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  9031. out_error = chain_context->TrustStatus.dwErrorStatus;
  9032. return false;
  9033. }
  9034. // Verify SSL policy
  9035. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9036. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9037. #ifdef AUTHTYPE_SERVER
  9038. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9039. #endif
  9040. std::wstring whost;
  9041. if (verify_hostname) {
  9042. whost = u8string_to_wstring(hostname.c_str());
  9043. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9044. }
  9045. CERT_CHAIN_POLICY_PARA policy_para = {};
  9046. policy_para.cbSize = sizeof(policy_para);
  9047. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9048. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9049. #else
  9050. policy_para.dwFlags = 0;
  9051. #endif
  9052. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9053. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9054. policy_status.cbSize = sizeof(policy_status);
  9055. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9056. &policy_para, &policy_status)) {
  9057. out_error = GetLastError();
  9058. return false;
  9059. }
  9060. if (policy_status.dwError != 0) {
  9061. out_error = policy_status.dwError;
  9062. return false;
  9063. }
  9064. return true;
  9065. }
  9066. #endif // _WIN32
  9067. // Loads CA file/dir configuration and applies the system CA policy to a
  9068. // client TLS context. PEM data and native stores are applied to the context
  9069. // directly at set time; has_custom_store reflects them for the Auto policy
  9070. // decision.
  9071. inline bool load_client_ca_config(tls::ctx_t ctx,
  9072. const std::string &ca_cert_file_path,
  9073. const std::string &ca_cert_dir_path,
  9074. bool has_custom_store, SystemCAMode mode,
  9075. uint64_t &backend_error) {
  9076. auto ret = true;
  9077. if (!ca_cert_file_path.empty()) {
  9078. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9079. backend_error = tls::get_error();
  9080. ret = false;
  9081. }
  9082. } else if (!ca_cert_dir_path.empty()) {
  9083. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9084. backend_error = tls::get_error();
  9085. ret = false;
  9086. }
  9087. }
  9088. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9089. !ca_cert_dir_path.empty() || has_custom_store;
  9090. if (mode == SystemCAMode::Enabled ||
  9091. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9092. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9093. }
  9094. return ret;
  9095. }
  9096. // The parts of session setup that only SSLClient needs, plus the handful
  9097. // WebSocketClient also exposes; everything else takes the defaults, which is
  9098. // what keeps the two clients on one implementation.
  9099. struct ClientTlsSessionOptions {
  9100. // Both SSLClient and WebSocketClient expose this independently of
  9101. // certificate verification.
  9102. bool server_hostname_verification = true;
  9103. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9104. // When non-null, guards session creation against concurrent use of the
  9105. // context. A WebSocketClient is not safe to use from several threads to
  9106. // begin with, so it passes nothing.
  9107. std::mutex *ctx_mutex = nullptr;
  9108. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9109. // The caller decides whether Schannel has anything to say about this
  9110. // connection; see SSLClient::initialize_ssl().
  9111. bool windows_cert_verification = false;
  9112. #endif
  9113. };
  9114. // Filled in on failure for callers that report error details.
  9115. struct ClientTlsSessionError {
  9116. Error error = Error::Success;
  9117. int ssl_error = 0;
  9118. uint64_t backend_error = 0;
  9119. };
  9120. // Establishes a client TLS session on an already connected socket. On failure
  9121. // the session is left for the caller to free: SSLClient frees it right away,
  9122. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9123. inline bool setup_client_tls_session(
  9124. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9125. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9126. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9127. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9128. using namespace tls;
  9129. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9130. if (out_error) {
  9131. out_error->error = error;
  9132. out_error->ssl_error = ssl_error;
  9133. out_error->backend_error = backend_error;
  9134. }
  9135. return false;
  9136. };
  9137. if (!ctx) {
  9138. session = nullptr;
  9139. return fail(Error::SSLConnection, 0, 0);
  9140. }
  9141. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9142. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9143. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9144. // verification happens during the handshake even for IP hosts; the
  9145. // certificate identity is verified post-handshake via verify_hostname().
  9146. set_verify_client(ctx, server_certificate_verification);
  9147. #endif
  9148. {
  9149. std::unique_lock<std::mutex> guard;
  9150. if (options.ctx_mutex) {
  9151. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9152. }
  9153. session = create_session(ctx, sock);
  9154. }
  9155. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9156. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9157. // their identity is checked post-handshake below instead. On Mbed TLS and
  9158. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9159. // options.server_hostname_verification is threaded through here.
  9160. if (!is_ip_address(host)) {
  9161. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9162. return fail(Error::SSLConnection, 0, get_error());
  9163. }
  9164. }
  9165. TlsError tls_err;
  9166. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9167. &tls_err)) {
  9168. auto error = Error::SSLConnection;
  9169. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9170. error = Error::SSLServerVerification;
  9171. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9172. error = Error::SSLServerHostnameVerification;
  9173. }
  9174. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9175. }
  9176. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9177. if (options.session_verifier) {
  9178. verification_status = options.session_verifier(session);
  9179. }
  9180. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9181. return fail(Error::SSLServerVerification, 0, get_error());
  9182. }
  9183. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9184. server_certificate_verification) {
  9185. auto verify_result = get_verify_result(session);
  9186. if (verify_result != 0) {
  9187. return fail(Error::SSLServerVerification, 0,
  9188. static_cast<uint64_t>(verify_result));
  9189. }
  9190. auto server_cert = get_peer_cert(session);
  9191. if (!server_cert) {
  9192. return fail(Error::SSLServerVerification, 0, get_error());
  9193. }
  9194. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9195. // Identity check against the peer certificate, post-handshake for all
  9196. // backends. For IP hosts this is the only identity verification, since no
  9197. // hostname is bound during the handshake.
  9198. if (options.server_hostname_verification) {
  9199. if (!verify_hostname(server_cert, host.c_str())) {
  9200. return fail(Error::SSLServerHostnameVerification, 0,
  9201. hostname_mismatch_code());
  9202. }
  9203. }
  9204. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9205. // Additional Windows Schannel verification.
  9206. // This provides real-time certificate validation with Windows Update
  9207. // integration, working with both OpenSSL and MbedTLS backends.
  9208. if (options.windows_cert_verification) {
  9209. std::vector<unsigned char> der;
  9210. if (get_cert_der(server_cert, der)) {
  9211. uint64_t wincrypt_error = 0;
  9212. if (!verify_cert_with_windows_schannel(
  9213. der, host, options.server_hostname_verification, wincrypt_error,
  9214. session)) {
  9215. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9216. }
  9217. }
  9218. }
  9219. #endif
  9220. }
  9221. return true;
  9222. }
  9223. } // namespace detail
  9224. #endif // CPPHTTPLIB_SSL_ENABLED
  9225. /*
  9226. * Group 3: httplib namespace - Non-SSL public API implementations
  9227. */
  9228. inline void default_socket_options(socket_t sock) {
  9229. set_socket_opt(sock, SOL_SOCKET,
  9230. #ifdef SO_REUSEPORT
  9231. SO_REUSEPORT,
  9232. #else
  9233. SO_REUSEADDR,
  9234. #endif
  9235. 1);
  9236. }
  9237. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9238. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9239. sizeof(optval));
  9240. }
  9241. inline std::string get_bearer_token_auth(const Request &req) {
  9242. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9243. // than the prefix carries no token.
  9244. constexpr const char bearer_prefix[] = "Bearer ";
  9245. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9246. auto value = req.get_header_value("Authorization");
  9247. if (value.size() >= bearer_prefix_len &&
  9248. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9249. bearer_prefix)) {
  9250. return value.substr(bearer_prefix_len);
  9251. }
  9252. return "";
  9253. }
  9254. inline const char *status_message(int status) {
  9255. switch (status) {
  9256. case StatusCode::Continue_100: return "Continue";
  9257. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9258. case StatusCode::Processing_102: return "Processing";
  9259. case StatusCode::EarlyHints_103: return "Early Hints";
  9260. case StatusCode::OK_200: return "OK";
  9261. case StatusCode::Created_201: return "Created";
  9262. case StatusCode::Accepted_202: return "Accepted";
  9263. case StatusCode::NonAuthoritativeInformation_203:
  9264. return "Non-Authoritative Information";
  9265. case StatusCode::NoContent_204: return "No Content";
  9266. case StatusCode::ResetContent_205: return "Reset Content";
  9267. case StatusCode::PartialContent_206: return "Partial Content";
  9268. case StatusCode::MultiStatus_207: return "Multi-Status";
  9269. case StatusCode::AlreadyReported_208: return "Already Reported";
  9270. case StatusCode::IMUsed_226: return "IM Used";
  9271. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9272. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9273. case StatusCode::Found_302: return "Found";
  9274. case StatusCode::SeeOther_303: return "See Other";
  9275. case StatusCode::NotModified_304: return "Not Modified";
  9276. case StatusCode::UseProxy_305: return "Use Proxy";
  9277. case StatusCode::unused_306: return "unused";
  9278. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9279. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9280. case StatusCode::BadRequest_400: return "Bad Request";
  9281. case StatusCode::Unauthorized_401: return "Unauthorized";
  9282. case StatusCode::PaymentRequired_402: return "Payment Required";
  9283. case StatusCode::Forbidden_403: return "Forbidden";
  9284. case StatusCode::NotFound_404: return "Not Found";
  9285. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9286. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9287. case StatusCode::ProxyAuthenticationRequired_407:
  9288. return "Proxy Authentication Required";
  9289. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9290. case StatusCode::Conflict_409: return "Conflict";
  9291. case StatusCode::Gone_410: return "Gone";
  9292. case StatusCode::LengthRequired_411: return "Length Required";
  9293. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9294. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9295. case StatusCode::UriTooLong_414: return "URI Too Long";
  9296. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9297. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9298. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9299. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9300. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9301. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9302. case StatusCode::Locked_423: return "Locked";
  9303. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9304. case StatusCode::TooEarly_425: return "Too Early";
  9305. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9306. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9307. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9308. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9309. return "Request Header Fields Too Large";
  9310. case StatusCode::UnavailableForLegalReasons_451:
  9311. return "Unavailable For Legal Reasons";
  9312. case StatusCode::NotImplemented_501: return "Not Implemented";
  9313. case StatusCode::BadGateway_502: return "Bad Gateway";
  9314. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9315. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9316. case StatusCode::HttpVersionNotSupported_505:
  9317. return "HTTP Version Not Supported";
  9318. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9319. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9320. case StatusCode::LoopDetected_508: return "Loop Detected";
  9321. case StatusCode::NotExtended_510: return "Not Extended";
  9322. case StatusCode::NetworkAuthenticationRequired_511:
  9323. return "Network Authentication Required";
  9324. default:
  9325. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9326. }
  9327. }
  9328. inline std::string to_string(const Error error) {
  9329. switch (error) {
  9330. case Error::Success: return "Success (no error)";
  9331. case Error::Unknown: return "Unknown";
  9332. case Error::Connection: return "Could not establish connection";
  9333. case Error::BindIPAddress: return "Failed to bind IP address";
  9334. case Error::Read: return "Failed to read connection";
  9335. case Error::Write: return "Failed to write connection";
  9336. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9337. case Error::Canceled: return "Connection handling canceled";
  9338. case Error::SSLConnection: return "SSL connection failed";
  9339. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9340. case Error::SSLServerVerification: return "SSL server verification failed";
  9341. case Error::SSLServerHostnameVerification:
  9342. return "SSL server hostname verification failed";
  9343. case Error::UnsupportedMultipartBoundaryChars:
  9344. return "Unsupported HTTP multipart boundary characters";
  9345. case Error::Compression: return "Compression failed";
  9346. case Error::ConnectionTimeout: return "Connection timed out";
  9347. case Error::ProxyConnection: return "Proxy connection failed";
  9348. case Error::ConnectionClosed: return "Connection closed by server";
  9349. case Error::Timeout: return "Read timeout";
  9350. case Error::ResourceExhaustion: return "Resource exhaustion";
  9351. case Error::TooManyFormDataFiles: return "Too many form data files";
  9352. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9353. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9354. case Error::ExceedMaxSocketDescriptorCount:
  9355. return "Exceeded maximum socket descriptor count";
  9356. case Error::InvalidRequestLine: return "Invalid request line";
  9357. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9358. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9359. case Error::InvalidHeaders: return "Invalid headers";
  9360. case Error::MultipartParsing: return "Multipart parsing failed";
  9361. case Error::OpenFile: return "Failed to open file";
  9362. case Error::Listen: return "Failed to listen on socket";
  9363. case Error::GetSockName: return "Failed to get socket name";
  9364. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9365. case Error::HTTPParsing: return "HTTP parsing failed";
  9366. case Error::InvalidRangeHeader: return "Invalid Range header";
  9367. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9368. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9369. case Error::UserCallbackException: return "User callback threw an exception";
  9370. default: break;
  9371. }
  9372. return "Invalid";
  9373. }
  9374. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9375. os << to_string(obj);
  9376. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9377. return os;
  9378. }
  9379. inline std::string hosted_at(const std::string &hostname) {
  9380. std::vector<std::string> addrs;
  9381. hosted_at(hostname, addrs);
  9382. if (addrs.empty()) { return std::string(); }
  9383. return addrs[0];
  9384. }
  9385. inline void hosted_at(const std::string &hostname,
  9386. std::vector<std::string> &addrs) {
  9387. struct addrinfo hints;
  9388. struct addrinfo *result;
  9389. memset(&hints, 0, sizeof(struct addrinfo));
  9390. hints.ai_family = AF_UNSPEC;
  9391. hints.ai_socktype = SOCK_STREAM;
  9392. hints.ai_protocol = 0;
  9393. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9394. &result, 0)) {
  9395. #if defined __linux__ && !defined __ANDROID__
  9396. res_init();
  9397. #endif
  9398. return;
  9399. }
  9400. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9401. for (auto rp = result; rp; rp = rp->ai_next) {
  9402. const auto &addr =
  9403. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9404. std::string ip;
  9405. auto dummy = -1;
  9406. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9407. dummy)) {
  9408. addrs.emplace_back(std::move(ip));
  9409. }
  9410. }
  9411. }
  9412. inline std::string encode_uri_component(const std::string &value) {
  9413. std::ostringstream escaped;
  9414. escaped.fill('0');
  9415. escaped << std::hex;
  9416. for (auto c : value) {
  9417. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9418. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9419. escaped << c;
  9420. } else {
  9421. escaped << std::uppercase;
  9422. escaped << '%' << std::setw(2)
  9423. << static_cast<int>(static_cast<unsigned char>(c));
  9424. escaped << std::nouppercase;
  9425. }
  9426. }
  9427. return escaped.str();
  9428. }
  9429. inline std::string encode_uri(const std::string &value) {
  9430. std::ostringstream escaped;
  9431. escaped.fill('0');
  9432. escaped << std::hex;
  9433. for (auto c : value) {
  9434. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9435. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9436. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9437. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9438. escaped << c;
  9439. } else {
  9440. escaped << std::uppercase;
  9441. escaped << '%' << std::setw(2)
  9442. << static_cast<int>(static_cast<unsigned char>(c));
  9443. escaped << std::nouppercase;
  9444. }
  9445. }
  9446. return escaped.str();
  9447. }
  9448. inline std::string decode_uri_component(const std::string &value) {
  9449. std::string result;
  9450. for (size_t i = 0; i < value.size(); i++) {
  9451. if (value[i] == '%' && i + 2 < value.size()) {
  9452. auto val = 0;
  9453. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9454. result += static_cast<char>(val);
  9455. i += 2;
  9456. } else {
  9457. result += value[i];
  9458. }
  9459. } else {
  9460. result += value[i];
  9461. }
  9462. }
  9463. return result;
  9464. }
  9465. inline std::string decode_uri(const std::string &value) {
  9466. std::string result;
  9467. for (size_t i = 0; i < value.size(); i++) {
  9468. if (value[i] == '%' && i + 2 < value.size()) {
  9469. auto val = 0;
  9470. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9471. auto c = static_cast<char>(val);
  9472. // Keep escapes of the reserved characters that encode_uri leaves
  9473. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9474. // delimiter is not promoted into a real one (as with JS decodeURI).
  9475. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9476. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9477. c == '#') {
  9478. result += value[i];
  9479. result += value[i + 1];
  9480. result += value[i + 2];
  9481. } else {
  9482. result += c;
  9483. }
  9484. i += 2;
  9485. } else {
  9486. result += value[i];
  9487. }
  9488. } else {
  9489. result += value[i];
  9490. }
  9491. }
  9492. return result;
  9493. }
  9494. inline std::string encode_path_component(const std::string &component) {
  9495. std::string result;
  9496. result.reserve(component.size() * 3);
  9497. for (size_t i = 0; i < component.size(); i++) {
  9498. auto c = static_cast<unsigned char>(component[i]);
  9499. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9500. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9501. c == '_' || c == '~') {
  9502. result += static_cast<char>(c);
  9503. }
  9504. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9505. // "," / ";" / "="
  9506. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9507. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9508. c == '=') {
  9509. result += static_cast<char>(c);
  9510. }
  9511. // Colon is allowed in path segments except first segment
  9512. else if (c == ':') {
  9513. result += static_cast<char>(c);
  9514. }
  9515. // @ is allowed in path
  9516. else if (c == '@') {
  9517. result += static_cast<char>(c);
  9518. } else {
  9519. result += '%';
  9520. char hex[3];
  9521. snprintf(hex, sizeof(hex), "%02X", c);
  9522. result.append(hex, 2);
  9523. }
  9524. }
  9525. return result;
  9526. }
  9527. inline std::string decode_path_component(const std::string &component) {
  9528. std::string result;
  9529. result.reserve(component.size());
  9530. for (size_t i = 0; i < component.size(); i++) {
  9531. if (component[i] == '%' && i + 1 < component.size()) {
  9532. if (component[i + 1] == 'u') {
  9533. // Unicode %uXXXX encoding
  9534. auto val = 0;
  9535. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9536. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9537. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9538. char buff[4];
  9539. size_t len = detail::to_utf8(val, buff);
  9540. if (len > 0) { result.append(buff, len); }
  9541. i += 5; // 'u0000'
  9542. } else {
  9543. result += component[i];
  9544. }
  9545. } else {
  9546. // Standard %XX encoding
  9547. auto val = 0;
  9548. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9549. // 2 digits hex codes
  9550. result += static_cast<char>(val);
  9551. i += 2; // 'XX'
  9552. } else {
  9553. result += component[i];
  9554. }
  9555. }
  9556. } else {
  9557. result += component[i];
  9558. }
  9559. }
  9560. return result;
  9561. }
  9562. inline std::string encode_query_component(const std::string &component,
  9563. bool space_as_plus) {
  9564. std::string result;
  9565. result.reserve(component.size() * 3);
  9566. for (size_t i = 0; i < component.size(); i++) {
  9567. auto c = static_cast<unsigned char>(component[i]);
  9568. // Unreserved characters per RFC 3986
  9569. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9570. c == '_' || c == '~') {
  9571. result += static_cast<char>(c);
  9572. }
  9573. // Space handling
  9574. else if (c == ' ') {
  9575. if (space_as_plus) {
  9576. result += '+';
  9577. } else {
  9578. result += "%20";
  9579. }
  9580. }
  9581. // Plus sign handling
  9582. else if (c == '+') {
  9583. if (space_as_plus) {
  9584. result += "%2B";
  9585. } else {
  9586. result += static_cast<char>(c);
  9587. }
  9588. }
  9589. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9590. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9591. c == '*' || c == ',' || c == ';') {
  9592. result += static_cast<char>(c);
  9593. }
  9594. // Colon and @ are allowed in query
  9595. else if (c == ':' || c == '@') {
  9596. result += static_cast<char>(c);
  9597. }
  9598. // Forward slash is allowed in query values
  9599. else if (c == '/') {
  9600. result += static_cast<char>(c);
  9601. }
  9602. // Question mark is allowed in query values (after first ?)
  9603. else if (c == '?') {
  9604. result += static_cast<char>(c);
  9605. } else {
  9606. result += '%';
  9607. char hex[3];
  9608. snprintf(hex, sizeof(hex), "%02X", c);
  9609. result.append(hex, 2);
  9610. }
  9611. }
  9612. return result;
  9613. }
  9614. inline std::string decode_query_component(const std::string &component,
  9615. bool plus_as_space) {
  9616. std::string result;
  9617. result.reserve(component.size());
  9618. for (size_t i = 0; i < component.size(); i++) {
  9619. if (component[i] == '%' && i + 2 < component.size()) {
  9620. auto val = 0;
  9621. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9622. result += static_cast<char>(val);
  9623. i += 2;
  9624. } else {
  9625. result += component[i];
  9626. }
  9627. } else if (component[i] == '+' && plus_as_space) {
  9628. result += ' '; // + becomes space in form-urlencoded
  9629. } else {
  9630. result += component[i];
  9631. }
  9632. }
  9633. return result;
  9634. }
  9635. inline std::string sanitize_filename(const std::string &filename) {
  9636. // Extract basename: find the last path separator (/ or \)
  9637. auto pos = filename.find_last_of("/\\");
  9638. auto result =
  9639. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9640. // Strip null bytes
  9641. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9642. // Trim whitespace
  9643. {
  9644. auto start = result.find_first_not_of(" \t");
  9645. auto end = result.find_last_not_of(" \t");
  9646. result = (start == std::string::npos)
  9647. ? ""
  9648. : result.substr(start, end - start + 1);
  9649. }
  9650. // Reject . and ..
  9651. if (result == "." || result == "..") { return ""; }
  9652. return result;
  9653. }
  9654. inline std::string append_query_params(const std::string &path,
  9655. const Params &params) {
  9656. std::string path_with_query = path;
  9657. thread_local const std::regex re("[^?]+\\?.*");
  9658. auto delm = std::regex_match(path, re) ? '&' : '?';
  9659. path_with_query += delm + detail::params_to_query_str(params);
  9660. return path_with_query;
  9661. }
  9662. // Header utilities
  9663. inline std::pair<std::string, std::string>
  9664. make_range_header(const Ranges &ranges) {
  9665. std::string field = "bytes=";
  9666. auto i = 0;
  9667. for (const auto &r : ranges) {
  9668. if (i != 0) { field += ", "; }
  9669. if (r.first != -1) { field += std::to_string(r.first); }
  9670. field += '-';
  9671. if (r.second != -1) { field += std::to_string(r.second); }
  9672. i++;
  9673. }
  9674. return std::make_pair("Range", std::move(field));
  9675. }
  9676. inline std::pair<std::string, std::string>
  9677. make_basic_authentication_header(const std::string &username,
  9678. const std::string &password, bool is_proxy) {
  9679. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9680. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9681. return std::make_pair(key, std::move(field));
  9682. }
  9683. inline std::pair<std::string, std::string>
  9684. make_bearer_token_authentication_header(const std::string &token,
  9685. bool is_proxy = false) {
  9686. auto field = "Bearer " + token;
  9687. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9688. return std::make_pair(key, std::move(field));
  9689. }
  9690. // Request implementation
  9691. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9692. size_t id) const {
  9693. return detail::get_header_value_u64(headers, key, def, id);
  9694. }
  9695. inline bool Request::has_header(const std::string &key) const {
  9696. return detail::has_header(headers, key);
  9697. }
  9698. inline std::string Request::get_header_value(const std::string &key,
  9699. const char *def, size_t id) const {
  9700. return detail::get_header_value(headers, key, def, id);
  9701. }
  9702. inline size_t Request::get_header_value_count(const std::string &key) const {
  9703. return detail::get_header_value_count(headers, key);
  9704. }
  9705. inline void Request::set_header(const std::string &key,
  9706. const std::string &val) {
  9707. detail::set_header(headers, key, val);
  9708. }
  9709. inline bool Request::has_trailer(const std::string &key) const {
  9710. return trailers.find(key) != trailers.end();
  9711. }
  9712. inline std::string Request::get_trailer_value(const std::string &key,
  9713. size_t id) const {
  9714. return detail::get_multimap_value(trailers, key, id);
  9715. }
  9716. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9717. return trailers.count(key);
  9718. }
  9719. inline bool Request::has_param(const std::string &key) const {
  9720. return params.find(key) != params.end();
  9721. }
  9722. inline std::string Request::get_param_value(const std::string &key,
  9723. size_t id) const {
  9724. return detail::get_multimap_value(params, key, id);
  9725. }
  9726. inline std::vector<std::string>
  9727. Request::get_param_values(const std::string &key) const {
  9728. auto rng = params.equal_range(key);
  9729. std::vector<std::string> values;
  9730. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9731. for (auto it = rng.first; it != rng.second; ++it) {
  9732. values.push_back(it->second);
  9733. }
  9734. return values;
  9735. }
  9736. inline size_t Request::get_param_value_count(const std::string &key) const {
  9737. return params.count(key);
  9738. }
  9739. inline bool Request::is_multipart_form_data() const {
  9740. const auto &content_type = get_header_value("Content-Type");
  9741. return detail::extract_media_type(content_type) == "multipart/form-data";
  9742. }
  9743. // Multipart FormData implementation
  9744. inline std::string MultipartFormData::get_field(const std::string &key,
  9745. size_t id) const {
  9746. auto rng = fields.equal_range(key);
  9747. auto it = rng.first;
  9748. std::advance(it, static_cast<ssize_t>(id));
  9749. if (it != rng.second) { return it->second.content; }
  9750. return std::string();
  9751. }
  9752. inline std::vector<std::string>
  9753. MultipartFormData::get_fields(const std::string &key) const {
  9754. std::vector<std::string> values;
  9755. auto rng = fields.equal_range(key);
  9756. for (auto it = rng.first; it != rng.second; it++) {
  9757. values.push_back(it->second.content);
  9758. }
  9759. return values;
  9760. }
  9761. inline bool MultipartFormData::has_field(const std::string &key) const {
  9762. return fields.find(key) != fields.end();
  9763. }
  9764. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9765. return fields.count(key);
  9766. }
  9767. inline FormData MultipartFormData::get_file(const std::string &key,
  9768. size_t id) const {
  9769. return detail::get_multimap_value(files, key, id);
  9770. }
  9771. inline std::vector<FormData>
  9772. MultipartFormData::get_files(const std::string &key) const {
  9773. std::vector<FormData> values;
  9774. auto rng = files.equal_range(key);
  9775. for (auto it = rng.first; it != rng.second; it++) {
  9776. values.push_back(it->second);
  9777. }
  9778. return values;
  9779. }
  9780. inline bool MultipartFormData::has_file(const std::string &key) const {
  9781. return files.find(key) != files.end();
  9782. }
  9783. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9784. return files.count(key);
  9785. }
  9786. // Multipart FormData writer implementation
  9787. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9788. return detail::is_multipart_boundary_chars_valid(boundary);
  9789. }
  9790. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9791. : boundary_(detail::make_multipart_data_boundary()) {}
  9792. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9793. : boundary_(std::move(boundary)) {}
  9794. inline const std::string &MultipartFormDataWriter::boundary() const {
  9795. return boundary_;
  9796. }
  9797. inline std::string MultipartFormDataWriter::content_type() const {
  9798. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9799. }
  9800. inline std::string
  9801. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9802. return detail::serialize_multipart_formdata(items, boundary_);
  9803. }
  9804. inline size_t MultipartFormDataWriter::content_length(
  9805. const UploadFormDataItems &items) const {
  9806. return detail::get_multipart_content_length(items, boundary_);
  9807. }
  9808. inline std::string
  9809. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9810. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9811. }
  9812. inline std::string MultipartFormDataWriter::item_end() {
  9813. return detail::serialize_multipart_formdata_item_end();
  9814. }
  9815. inline std::string MultipartFormDataWriter::finish() const {
  9816. return detail::serialize_multipart_formdata_finish(boundary_);
  9817. }
  9818. // Response implementation
  9819. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9820. size_t id) const {
  9821. return detail::get_header_value_u64(headers, key, def, id);
  9822. }
  9823. inline bool Response::has_header(const std::string &key) const {
  9824. return headers.find(key) != headers.end();
  9825. }
  9826. inline std::string Response::get_header_value(const std::string &key,
  9827. const char *def,
  9828. size_t id) const {
  9829. return detail::get_header_value(headers, key, def, id);
  9830. }
  9831. inline size_t Response::get_header_value_count(const std::string &key) const {
  9832. return detail::get_header_value_count(headers, key);
  9833. }
  9834. inline void Response::set_header(const std::string &key,
  9835. const std::string &val) {
  9836. detail::set_header(headers, key, val);
  9837. }
  9838. inline bool Response::has_trailer(const std::string &key) const {
  9839. return trailers.find(key) != trailers.end();
  9840. }
  9841. inline std::string Response::get_trailer_value(const std::string &key,
  9842. size_t id) const {
  9843. return detail::get_multimap_value(trailers, key, id);
  9844. }
  9845. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9846. return trailers.count(key);
  9847. }
  9848. inline void Response::set_redirect(const std::string &url, int stat) {
  9849. if (detail::fields::is_field_value(url)) {
  9850. set_header("Location", url);
  9851. if (300 <= stat && stat < 400) {
  9852. this->status = stat;
  9853. } else {
  9854. this->status = StatusCode::Found_302;
  9855. }
  9856. }
  9857. }
  9858. inline void Response::set_content(const char *s, size_t n,
  9859. const std::string &content_type) {
  9860. body.assign(s, n);
  9861. auto rng = headers.equal_range("Content-Type");
  9862. headers.erase(rng.first, rng.second);
  9863. set_header("Content-Type", content_type);
  9864. content_coding_ = detail::EncodingType::None;
  9865. }
  9866. inline void Response::set_content(const std::string &s,
  9867. const std::string &content_type) {
  9868. set_content(s.data(), s.size(), content_type);
  9869. }
  9870. inline void Response::set_content(std::string &&s,
  9871. const std::string &content_type) {
  9872. body = std::move(s);
  9873. auto rng = headers.equal_range("Content-Type");
  9874. headers.erase(rng.first, rng.second);
  9875. set_header("Content-Type", content_type);
  9876. content_coding_ = detail::EncodingType::None;
  9877. }
  9878. inline void Response::set_content_provider(
  9879. size_t in_length, const std::string &content_type, ContentProvider provider,
  9880. ContentProviderResourceReleaser resource_releaser) {
  9881. set_header("Content-Type", content_type);
  9882. content_length_ = in_length;
  9883. if (in_length > 0) { content_provider_ = std::move(provider); }
  9884. content_provider_resource_releaser_ = std::move(resource_releaser);
  9885. is_chunked_content_provider_ = false;
  9886. is_file_content_provider_ = false;
  9887. content_coding_ = detail::EncodingType::None;
  9888. }
  9889. inline void Response::set_content_provider(
  9890. const std::string &content_type, ContentProviderWithoutLength provider,
  9891. ContentProviderResourceReleaser resource_releaser) {
  9892. set_header("Content-Type", content_type);
  9893. content_length_ = 0;
  9894. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9895. content_provider_resource_releaser_ = std::move(resource_releaser);
  9896. is_chunked_content_provider_ = false;
  9897. is_file_content_provider_ = false;
  9898. content_coding_ = detail::EncodingType::None;
  9899. }
  9900. inline void Response::set_chunked_content_provider(
  9901. const std::string &content_type, ContentProviderWithoutLength provider,
  9902. ContentProviderResourceReleaser resource_releaser) {
  9903. set_header("Content-Type", content_type);
  9904. content_length_ = 0;
  9905. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9906. content_provider_resource_releaser_ = std::move(resource_releaser);
  9907. is_chunked_content_provider_ = true;
  9908. is_file_content_provider_ = false;
  9909. content_coding_ = detail::EncodingType::None;
  9910. }
  9911. inline void Response::set_file_content(const std::string &path,
  9912. const std::string &content_type) {
  9913. file_content_path_ = path;
  9914. file_content_content_type_ = content_type;
  9915. }
  9916. inline void Response::set_file_content(const std::string &path) {
  9917. file_content_path_ = path;
  9918. }
  9919. // Result implementation
  9920. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9921. size_t def,
  9922. size_t id) const {
  9923. return detail::get_header_value_u64(request_headers_, key, def, id);
  9924. }
  9925. inline bool Result::has_request_header(const std::string &key) const {
  9926. return request_headers_.find(key) != request_headers_.end();
  9927. }
  9928. inline std::string Result::get_request_header_value(const std::string &key,
  9929. const char *def,
  9930. size_t id) const {
  9931. return detail::get_header_value(request_headers_, key, def, id);
  9932. }
  9933. inline size_t
  9934. Result::get_request_header_value_count(const std::string &key) const {
  9935. return request_headers_.count(key);
  9936. }
  9937. // Stream implementation
  9938. inline ssize_t Stream::write(const char *ptr) {
  9939. return write(ptr, strlen(ptr));
  9940. }
  9941. inline ssize_t Stream::write(const std::string &s) {
  9942. return write(s.data(), s.size());
  9943. }
  9944. // BodyReader implementation
  9945. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9946. if (!stream) {
  9947. last_error = Error::Connection;
  9948. return -1;
  9949. }
  9950. if (eof) { return 0; }
  9951. if (!chunked) {
  9952. // Content-Length based reading
  9953. if (has_content_length && bytes_read >= content_length) {
  9954. eof = true;
  9955. return 0;
  9956. }
  9957. auto to_read = len;
  9958. if (has_content_length) {
  9959. auto remaining = content_length - bytes_read;
  9960. to_read = (std::min)(len, remaining);
  9961. }
  9962. auto n = stream->read(buf, to_read);
  9963. if (n < 0) {
  9964. last_error = stream->get_error();
  9965. if (last_error == Error::Success) { last_error = Error::Read; }
  9966. eof = true;
  9967. return n;
  9968. }
  9969. if (n == 0) {
  9970. // Unexpected EOF before content_length
  9971. last_error = stream->get_error();
  9972. if (last_error == Error::Success) { last_error = Error::Read; }
  9973. eof = true;
  9974. return 0;
  9975. }
  9976. bytes_read += static_cast<size_t>(n);
  9977. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9978. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9979. last_error = Error::ExceedMaxPayloadSize;
  9980. eof = true;
  9981. return -1;
  9982. }
  9983. return n;
  9984. }
  9985. // Chunked transfer encoding: delegate to shared decoder instance.
  9986. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9987. size_t chunk_offset = 0;
  9988. size_t chunk_total = 0;
  9989. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9990. if (n < 0) {
  9991. last_error = stream->get_error();
  9992. if (last_error == Error::Success) { last_error = Error::Read; }
  9993. eof = true;
  9994. return n;
  9995. }
  9996. if (n == 0) {
  9997. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9998. eof = true;
  9999. return 0;
  10000. }
  10001. bytes_read += static_cast<size_t>(n);
  10002. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10003. last_error = Error::ExceedMaxPayloadSize;
  10004. eof = true;
  10005. return -1;
  10006. }
  10007. return n;
  10008. }
  10009. // ThreadPool implementation
  10010. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10011. time_t idle_timeout_sec)
  10012. : base_thread_count_(n), max_queued_requests_(mqr),
  10013. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10014. shutdown_(false) {
  10015. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10016. if (max_n != 0 && max_n < n) {
  10017. std::string msg = "max_threads must be >= base_threads";
  10018. throw std::invalid_argument(msg);
  10019. }
  10020. #endif
  10021. max_thread_count_ = max_n == 0 ? n : max_n;
  10022. threads_.reserve(base_thread_count_);
  10023. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10024. try {
  10025. #endif
  10026. for (size_t i = 0; i < base_thread_count_; i++) {
  10027. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10028. }
  10029. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10030. } catch (...) {
  10031. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10032. // signal the workers we already spawned to exit and join them so the
  10033. // vector destructor does not see joinable threads (which would call
  10034. // std::terminate). Then rethrow so the caller learns of the failure.
  10035. {
  10036. std::unique_lock<std::mutex> lock(mutex_);
  10037. shutdown_ = true;
  10038. }
  10039. cond_.notify_all();
  10040. for (auto &t : threads_) {
  10041. if (t.joinable()) { t.join(); }
  10042. }
  10043. throw;
  10044. }
  10045. #endif
  10046. }
  10047. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10048. {
  10049. std::unique_lock<std::mutex> lock(mutex_);
  10050. if (shutdown_) { return false; }
  10051. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10052. return false;
  10053. }
  10054. jobs_.push_back(std::move(fn));
  10055. // Spawn a dynamic thread if no idle threads and under max
  10056. if (idle_thread_count_ == 0 &&
  10057. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10058. cleanup_finished_threads();
  10059. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10060. }
  10061. }
  10062. cond_.notify_one();
  10063. return true;
  10064. }
  10065. inline void ThreadPool::shutdown() {
  10066. {
  10067. std::unique_lock<std::mutex> lock(mutex_);
  10068. shutdown_ = true;
  10069. }
  10070. cond_.notify_all();
  10071. for (auto &t : threads_) {
  10072. if (t.joinable()) { t.join(); }
  10073. }
  10074. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10075. // with worker threads that call move_to_finished() concurrently.
  10076. std::list<std::thread> remaining_dynamic;
  10077. {
  10078. std::unique_lock<std::mutex> lock(mutex_);
  10079. remaining_dynamic = std::move(dynamic_threads_);
  10080. }
  10081. for (auto &t : remaining_dynamic) {
  10082. if (t.joinable()) { t.join(); }
  10083. }
  10084. std::unique_lock<std::mutex> lock(mutex_);
  10085. cleanup_finished_threads();
  10086. }
  10087. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10088. // Must be called with mutex_ held
  10089. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10090. if (it->get_id() == id) {
  10091. finished_threads_.push_back(std::move(*it));
  10092. dynamic_threads_.erase(it);
  10093. return;
  10094. }
  10095. }
  10096. }
  10097. inline void ThreadPool::cleanup_finished_threads() {
  10098. // Must be called with mutex_ held
  10099. for (auto &t : finished_threads_) {
  10100. if (t.joinable()) { t.join(); }
  10101. }
  10102. finished_threads_.clear();
  10103. }
  10104. inline void ThreadPool::worker(bool is_dynamic) {
  10105. for (;;) {
  10106. std::function<void()> fn;
  10107. {
  10108. std::unique_lock<std::mutex> lock(mutex_);
  10109. idle_thread_count_++;
  10110. if (is_dynamic) {
  10111. auto has_work =
  10112. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10113. [&] { return !jobs_.empty() || shutdown_; });
  10114. if (!has_work) {
  10115. // Timed out with no work - exit this dynamic thread
  10116. idle_thread_count_--;
  10117. move_to_finished(std::this_thread::get_id());
  10118. break;
  10119. }
  10120. } else {
  10121. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10122. }
  10123. idle_thread_count_--;
  10124. if (shutdown_ && jobs_.empty()) { break; }
  10125. fn = std::move(jobs_.front());
  10126. jobs_.pop_front();
  10127. }
  10128. assert(true == static_cast<bool>(fn));
  10129. fn();
  10130. }
  10131. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10132. !defined(LIBRESSL_VERSION_NUMBER)
  10133. OPENSSL_thread_stop();
  10134. #endif
  10135. }
  10136. /*
  10137. * Group 1 (continued): detail namespace - Stream implementations
  10138. */
  10139. namespace detail {
  10140. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10141. time_t timeout_sec, time_t timeout_usec,
  10142. time_t &actual_timeout_sec,
  10143. time_t &actual_timeout_usec) {
  10144. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10145. auto actual_timeout_msec =
  10146. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10147. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10148. actual_timeout_sec = actual_timeout_msec / 1000;
  10149. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10150. }
  10151. // Socket stream implementation
  10152. inline SocketStream::SocketStream(
  10153. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10154. time_t write_timeout_sec, time_t write_timeout_usec,
  10155. time_t max_timeout_msec,
  10156. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10157. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10158. read_timeout_usec_(read_timeout_usec),
  10159. write_timeout_sec_(write_timeout_sec),
  10160. write_timeout_usec_(write_timeout_usec),
  10161. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10162. read_buff_(read_buff_size_, 0) {}
  10163. inline SocketStream::~SocketStream() = default;
  10164. inline bool SocketStream::is_readable() const {
  10165. return read_buff_off_ < read_buff_content_size_;
  10166. }
  10167. inline bool SocketStream::wait_readable() const {
  10168. if (max_timeout_msec_ <= 0) {
  10169. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10170. }
  10171. time_t read_timeout_sec;
  10172. time_t read_timeout_usec;
  10173. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10174. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10175. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10176. }
  10177. inline bool SocketStream::wait_writable() const {
  10178. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10179. }
  10180. inline bool SocketStream::ensure_readable() {
  10181. if (readable_hint_) {
  10182. readable_hint_ = false;
  10183. return true;
  10184. }
  10185. return wait_readable();
  10186. }
  10187. inline const char *SocketStream::buffered_data(size_t &size) const {
  10188. size = read_buff_content_size_ - read_buff_off_;
  10189. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10190. }
  10191. inline void SocketStream::consume_buffered(size_t size) {
  10192. assert(size <= read_buff_content_size_ - read_buff_off_);
  10193. read_buff_off_ += size;
  10194. }
  10195. inline bool SocketStream::is_peer_alive() const {
  10196. return detail::is_socket_alive(sock_);
  10197. }
  10198. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10199. #ifdef _WIN32
  10200. size =
  10201. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10202. #else
  10203. size = (std::min)(size,
  10204. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10205. #endif
  10206. if (read_buff_off_ < read_buff_content_size_) {
  10207. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10208. if (size <= remaining_size) {
  10209. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10210. read_buff_off_ += size;
  10211. return static_cast<ssize_t>(size);
  10212. } else {
  10213. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10214. read_buff_off_ += remaining_size;
  10215. return static_cast<ssize_t>(remaining_size);
  10216. }
  10217. }
  10218. if (!ensure_readable()) {
  10219. error_ = Error::Timeout;
  10220. return -1;
  10221. }
  10222. read_buff_off_ = 0;
  10223. read_buff_content_size_ = 0;
  10224. if (size < read_buff_size_) {
  10225. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10226. CPPHTTPLIB_RECV_FLAGS);
  10227. if (n <= 0) {
  10228. if (n == 0) {
  10229. error_ = Error::ConnectionClosed;
  10230. } else {
  10231. error_ = Error::Read;
  10232. }
  10233. return n;
  10234. } else if (n <= static_cast<ssize_t>(size)) {
  10235. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10236. return n;
  10237. } else {
  10238. memcpy(ptr, read_buff_.data(), size);
  10239. read_buff_off_ = size;
  10240. read_buff_content_size_ = static_cast<size_t>(n);
  10241. return static_cast<ssize_t>(size);
  10242. }
  10243. } else {
  10244. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10245. if (n <= 0) {
  10246. if (n == 0) {
  10247. error_ = Error::ConnectionClosed;
  10248. } else {
  10249. error_ = Error::Read;
  10250. }
  10251. }
  10252. return n;
  10253. }
  10254. }
  10255. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10256. if (!wait_writable()) { return -1; }
  10257. #if defined(_WIN32) && !defined(_WIN64)
  10258. size =
  10259. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10260. #endif
  10261. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10262. }
  10263. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10264. int &port) const {
  10265. return detail::get_remote_ip_and_port(sock_, ip, port);
  10266. }
  10267. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10268. int &port) const {
  10269. return detail::get_local_ip_and_port(sock_, ip, port);
  10270. }
  10271. inline socket_t SocketStream::socket() const { return sock_; }
  10272. inline time_t SocketStream::duration() const {
  10273. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10274. std::chrono::steady_clock::now() - start_time_)
  10275. .count();
  10276. }
  10277. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10278. read_timeout_sec_ = sec;
  10279. read_timeout_usec_ = usec;
  10280. }
  10281. // Buffer stream implementation
  10282. inline bool BufferStream::is_readable() const { return true; }
  10283. inline bool BufferStream::wait_readable() const { return true; }
  10284. inline bool BufferStream::wait_writable() const { return true; }
  10285. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10286. #if defined(_MSC_VER) && _MSC_VER < 1910
  10287. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10288. #else
  10289. auto len_read = buffer.copy(ptr, size, position);
  10290. #endif
  10291. position += static_cast<size_t>(len_read);
  10292. return static_cast<ssize_t>(len_read);
  10293. }
  10294. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10295. buffer.append(ptr, size);
  10296. return static_cast<ssize_t>(size);
  10297. }
  10298. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10299. int & /*port*/) const {}
  10300. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10301. int & /*port*/) const {}
  10302. inline socket_t BufferStream::socket() const { return 0; }
  10303. inline time_t BufferStream::duration() const { return 0; }
  10304. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10305. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10306. : MatcherBase(pattern) {
  10307. constexpr const char marker[] = "/:";
  10308. // One past the last ending position of a path param substring
  10309. std::size_t last_param_end = 0;
  10310. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10311. // Needed to ensure that parameter names are unique during matcher
  10312. // construction
  10313. // If exceptions are disabled, only last duplicate path
  10314. // parameter will be set
  10315. std::unordered_set<std::string> param_name_set;
  10316. #endif
  10317. while (true) {
  10318. const auto marker_pos = pattern.find(
  10319. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10320. if (marker_pos == std::string::npos) { break; }
  10321. static_fragments_.push_back(
  10322. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10323. const auto param_name_start = marker_pos + str_len(marker);
  10324. auto sep_pos = pattern.find(separator, param_name_start);
  10325. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10326. auto param_name =
  10327. pattern.substr(param_name_start, sep_pos - param_name_start);
  10328. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10329. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10330. std::string msg = "Encountered path parameter '" + param_name +
  10331. "' multiple times in route pattern '" + pattern + "'.";
  10332. throw std::invalid_argument(msg);
  10333. }
  10334. #endif
  10335. param_names_.push_back(std::move(param_name));
  10336. last_param_end = sep_pos + 1;
  10337. }
  10338. if (last_param_end < pattern.length()) {
  10339. static_fragments_.push_back(pattern.substr(last_param_end));
  10340. }
  10341. }
  10342. inline bool PathParamsMatcher::match(Request &request) const {
  10343. request.matches = std::smatch();
  10344. request.path_params.clear();
  10345. // A pattern without parameters is just a literal path to compare against
  10346. if (param_names_.empty()) { return request.path == pattern(); }
  10347. request.path_params.reserve(param_names_.size());
  10348. // One past the position at which the path matched the pattern last time
  10349. std::size_t starting_pos = 0;
  10350. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10351. const auto &fragment = static_fragments_[i];
  10352. if (starting_pos + fragment.length() > request.path.length()) {
  10353. return false;
  10354. }
  10355. // Avoid unnecessary allocation by using strncmp instead of substr +
  10356. // comparison
  10357. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10358. fragment.length()) != 0) {
  10359. return false;
  10360. }
  10361. starting_pos += fragment.length();
  10362. // Should only happen when we have a static fragment after a param
  10363. // Example: '/users/:id/subscriptions'
  10364. // The 'subscriptions' fragment here does not have a corresponding param
  10365. if (i >= param_names_.size()) { continue; }
  10366. auto sep_pos = request.path.find(separator, starting_pos);
  10367. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10368. const auto &param_name = param_names_[i];
  10369. request.path_params.emplace(
  10370. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10371. // Mark everything up to '/' as matched
  10372. starting_pos = sep_pos + 1;
  10373. }
  10374. // Returns false if the path is longer than the pattern
  10375. return starting_pos >= request.path.length();
  10376. }
  10377. inline bool RegexMatcher::match(Request &request) const {
  10378. request.path_params.clear();
  10379. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10380. // a non-match rather than risking a stack overflow in std::regex_match.
  10381. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10382. return false;
  10383. }
  10384. return std::regex_match(request.path, request.matches, regex_);
  10385. }
  10386. // Enclose IPv6 address in brackets if needed
  10387. inline std::string prepare_host_string(const std::string &host) {
  10388. // Enclose IPv6 address in brackets (but not if already enclosed)
  10389. if (host.find(':') == std::string::npos ||
  10390. (!host.empty() && host[0] == '[')) {
  10391. // IPv4, hostname, or already bracketed IPv6
  10392. return host;
  10393. } else {
  10394. // IPv6 address without brackets
  10395. return "[" + host + "]";
  10396. }
  10397. }
  10398. inline std::string make_host_and_port_string(const std::string &host, int port,
  10399. bool is_ssl) {
  10400. auto result = prepare_host_string(host);
  10401. // Append port if not default
  10402. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10403. ; // do nothing
  10404. } else {
  10405. result += ":" + std::to_string(port);
  10406. }
  10407. return result;
  10408. }
  10409. // Create "host:port" string always including port number (for CONNECT method)
  10410. inline std::string
  10411. make_host_and_port_string_always_port(const std::string &host, int port) {
  10412. return prepare_host_string(host) + ":" + std::to_string(port);
  10413. }
  10414. // Value for the Host header a client sends when the caller supplied none.
  10415. // Only the value: callers decide where in their header list it goes.
  10416. inline std::string make_default_host_header_value(const std::string &host,
  10417. int port, bool is_ssl,
  10418. int address_family) {
  10419. if (address_family == AF_UNIX) { return "localhost"; }
  10420. return make_host_and_port_string(host, port, is_ssl);
  10421. }
  10422. inline void add_default_user_agent_header(Request &req) {
  10423. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10424. if (!req.has_header("User-Agent")) {
  10425. req.set_header("User-Agent",
  10426. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10427. }
  10428. #else
  10429. (void)req;
  10430. #endif
  10431. }
  10432. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10433. NormalizedTarget normalize_target(const std::string &host);
  10434. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10435. bool host_matches_no_proxy(const NormalizedTarget &target,
  10436. const std::vector<NoProxyEntry> &entries);
  10437. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10438. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10439. if (prefix_bits == 0) { return true; }
  10440. int full_bytes = prefix_bits / 8;
  10441. int rem_bits = prefix_bits % 8;
  10442. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10443. static_cast<size_t>(full_bytes)) != 0) {
  10444. return false;
  10445. }
  10446. if (rem_bits == 0) { return true; }
  10447. auto i = static_cast<size_t>(full_bytes);
  10448. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10449. return (ip[i] & mask) == (net[i] & mask);
  10450. }
  10451. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10452. if (token.empty()) { return false; }
  10453. if (token == "*") {
  10454. out.kind = NoProxyKind::Wildcard;
  10455. return true;
  10456. }
  10457. auto slash = token.find('/');
  10458. std::string addr_part =
  10459. (slash == std::string::npos) ? token : token.substr(0, slash);
  10460. std::string prefix_part =
  10461. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10462. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10463. // don't silently treat it as a /32 (or /128).
  10464. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10465. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10466. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10467. // when brackets are present.
  10468. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10469. addr_part.back() == ']';
  10470. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10471. if (!bracketed) {
  10472. struct in_addr v4;
  10473. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10474. int prefix = 32;
  10475. if (!prefix_part.empty()) {
  10476. auto r = from_chars(prefix_part.data(),
  10477. prefix_part.data() + prefix_part.size(), prefix);
  10478. if (r.ec != std::errc{} ||
  10479. r.ptr != prefix_part.data() + prefix_part.size()) {
  10480. return false;
  10481. }
  10482. if (prefix < 0 || prefix > 32) { return false; }
  10483. }
  10484. out.kind = NoProxyKind::IPv4Cidr;
  10485. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10486. out.prefix_bits = prefix;
  10487. return true;
  10488. }
  10489. }
  10490. struct in6_addr v6;
  10491. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10492. int prefix = 128;
  10493. if (!prefix_part.empty()) {
  10494. auto r = from_chars(prefix_part.data(),
  10495. prefix_part.data() + prefix_part.size(), prefix);
  10496. if (r.ec != std::errc{} ||
  10497. r.ptr != prefix_part.data() + prefix_part.size()) {
  10498. return false;
  10499. }
  10500. if (prefix < 0 || prefix > 128) { return false; }
  10501. }
  10502. out.kind = NoProxyKind::IPv6Cidr;
  10503. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10504. out.prefix_bits = prefix;
  10505. return true;
  10506. }
  10507. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10508. // the entry is malformed — don't fall through to the hostname branch.
  10509. if (bracketed) { return false; }
  10510. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10511. if (slash != std::string::npos) { return false; }
  10512. // Port-specific entries (host:port) are not supported.
  10513. if (token.find(':') != std::string::npos) { return false; }
  10514. std::string hostname = case_ignore::to_lower(token);
  10515. while (!hostname.empty() && hostname.front() == '.') {
  10516. hostname.erase(hostname.begin());
  10517. }
  10518. while (!hostname.empty() && hostname.back() == '.') {
  10519. hostname.pop_back();
  10520. }
  10521. if (hostname.empty()) { return false; }
  10522. out.kind = NoProxyKind::HostnameSuffix;
  10523. out.hostname_pattern = std::move(hostname);
  10524. return true;
  10525. }
  10526. inline NormalizedTarget normalize_target(const std::string &host) {
  10527. NormalizedTarget t;
  10528. std::string h = host;
  10529. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10530. h = h.substr(1, h.size() - 2);
  10531. }
  10532. // Strip a single trailing dot so "example.com." canonicalizes to
  10533. // "example.com".
  10534. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10535. t.hostname = case_ignore::to_lower(h);
  10536. if (!t.hostname.empty()) {
  10537. struct in_addr v4;
  10538. struct in6_addr v6;
  10539. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10540. t.is_ipv4 = true;
  10541. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10542. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10543. t.is_ipv6 = true;
  10544. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10545. }
  10546. }
  10547. return t;
  10548. }
  10549. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10550. const std::vector<NoProxyEntry> &entries) {
  10551. if (target.hostname.empty()) { return false; }
  10552. for (const auto &e : entries) {
  10553. switch (e.kind) {
  10554. case NoProxyKind::Wildcard: return true;
  10555. case NoProxyKind::IPv4Cidr:
  10556. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10557. return true;
  10558. }
  10559. break;
  10560. case NoProxyKind::IPv6Cidr:
  10561. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10562. return true;
  10563. }
  10564. break;
  10565. case NoProxyKind::HostnameSuffix:
  10566. if (target.is_ipv4 || target.is_ipv6) { break; }
  10567. if (target.hostname == e.hostname_pattern) { return true; }
  10568. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10569. // an entry of "example.com".
  10570. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10571. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10572. if (target.hostname[offset - 1] == '.' &&
  10573. target.hostname.compare(offset, e.hostname_pattern.size(),
  10574. e.hostname_pattern) == 0) {
  10575. return true;
  10576. }
  10577. }
  10578. break;
  10579. }
  10580. }
  10581. return false;
  10582. }
  10583. template <typename T>
  10584. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10585. T header_writer, Error &error) {
  10586. for (const auto &h : headers) {
  10587. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10588. error = Error::InvalidHeaders;
  10589. return false;
  10590. }
  10591. }
  10592. if (header_writer(strm, headers) <= 0) {
  10593. error = Error::Write;
  10594. return false;
  10595. }
  10596. return true;
  10597. }
  10598. } // namespace detail
  10599. /*
  10600. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10601. */
  10602. #ifdef CPPHTTPLIB_SSL_ENABLED
  10603. namespace detail {
  10604. // SSL socket stream implementation
  10605. inline SSLSocketStream::SSLSocketStream(
  10606. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10607. time_t read_timeout_usec, time_t write_timeout_sec,
  10608. time_t write_timeout_usec, time_t max_timeout_msec,
  10609. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10610. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10611. read_timeout_usec_(read_timeout_usec),
  10612. write_timeout_sec_(write_timeout_sec),
  10613. write_timeout_usec_(write_timeout_usec),
  10614. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10615. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10616. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10617. // Note: create_session() also clears this, but SSLClient currently
  10618. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10619. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10620. // SSL session was created.
  10621. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10622. #endif
  10623. }
  10624. inline SSLSocketStream::~SSLSocketStream() = default;
  10625. inline bool SSLSocketStream::is_readable() const {
  10626. return tls::pending(session_) > 0;
  10627. }
  10628. inline bool SSLSocketStream::wait_readable() const {
  10629. if (max_timeout_msec_ <= 0) {
  10630. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10631. }
  10632. time_t read_timeout_sec;
  10633. time_t read_timeout_usec;
  10634. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10635. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10636. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10637. }
  10638. inline bool SSLSocketStream::wait_writable() const {
  10639. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10640. !tls::is_peer_closed(session_, sock_);
  10641. }
  10642. inline bool SSLSocketStream::ensure_readable() {
  10643. if (readable_hint_) {
  10644. readable_hint_ = false;
  10645. return true;
  10646. }
  10647. return wait_readable();
  10648. }
  10649. inline bool SSLSocketStream::is_peer_alive() const {
  10650. return !tls::is_peer_closed(session_, sock_);
  10651. }
  10652. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10653. if (tls::pending(session_) > 0) {
  10654. tls::TlsError err;
  10655. auto ret = tls::read(session_, ptr, size, err);
  10656. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10657. error_ = Error::ConnectionClosed;
  10658. }
  10659. return ret;
  10660. } else if (ensure_readable()) {
  10661. tls::TlsError err;
  10662. auto ret = tls::read(session_, ptr, size, err);
  10663. if (ret < 0) {
  10664. auto n = 1000;
  10665. #ifdef _WIN32
  10666. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10667. (err.code == tls::ErrorCode::SyscallError &&
  10668. WSAGetLastError() == WSAETIMEDOUT))) {
  10669. #else
  10670. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10671. #endif
  10672. if (tls::pending(session_) > 0) {
  10673. return tls::read(session_, ptr, size, err);
  10674. } else if (wait_readable()) {
  10675. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10676. ret = tls::read(session_, ptr, size, err);
  10677. if (ret >= 0) { return ret; }
  10678. } else {
  10679. break;
  10680. }
  10681. }
  10682. assert(ret < 0);
  10683. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10684. error_ = Error::ConnectionClosed;
  10685. }
  10686. return ret;
  10687. } else {
  10688. error_ = Error::Timeout;
  10689. return -1;
  10690. }
  10691. }
  10692. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10693. if (wait_writable()) {
  10694. auto handle_size =
  10695. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10696. tls::TlsError err;
  10697. auto ret = tls::write(session_, ptr, handle_size, err);
  10698. if (ret < 0) {
  10699. auto n = 1000;
  10700. #ifdef _WIN32
  10701. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10702. (err.code == tls::ErrorCode::SyscallError &&
  10703. WSAGetLastError() == WSAETIMEDOUT))) {
  10704. #else
  10705. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10706. #endif
  10707. if (wait_writable()) {
  10708. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10709. ret = tls::write(session_, ptr, handle_size, err);
  10710. if (ret >= 0) { return ret; }
  10711. } else {
  10712. break;
  10713. }
  10714. }
  10715. assert(ret < 0);
  10716. }
  10717. return ret;
  10718. }
  10719. return -1;
  10720. }
  10721. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10722. int &port) const {
  10723. detail::get_remote_ip_and_port(sock_, ip, port);
  10724. }
  10725. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10726. int &port) const {
  10727. detail::get_local_ip_and_port(sock_, ip, port);
  10728. }
  10729. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10730. inline time_t SSLSocketStream::duration() const {
  10731. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10732. std::chrono::steady_clock::now() - start_time_)
  10733. .count();
  10734. }
  10735. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10736. read_timeout_sec_ = sec;
  10737. read_timeout_usec_ = usec;
  10738. }
  10739. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10740. tls::session_t session,
  10741. time_t read_timeout_sec,
  10742. time_t read_timeout_usec,
  10743. time_t write_timeout_sec,
  10744. time_t write_timeout_usec)
  10745. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10746. read_timeout_usec_(read_timeout_usec),
  10747. write_timeout_sec_(write_timeout_sec),
  10748. write_timeout_usec_(write_timeout_usec),
  10749. start_time_(std::chrono::steady_clock::now()) {
  10750. // The receive and send paths run on different threads, so each TLS call is
  10751. // driven in non-blocking mode and readiness is awaited with select()
  10752. // outside the session lock. Set the socket non-blocking once here; it is
  10753. // never flipped back, so no thread races on the flag.
  10754. detail::set_nonblocking(sock_, true);
  10755. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10756. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10757. #endif
  10758. }
  10759. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10760. inline bool WebSocketSSLStream::is_readable() const {
  10761. std::lock_guard<std::mutex> guard(session_mutex_);
  10762. return tls::pending(session_) > 0;
  10763. }
  10764. inline bool WebSocketSSLStream::wait_readable() const {
  10765. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10766. }
  10767. inline bool WebSocketSSLStream::wait_writable() const {
  10768. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10769. // that probe toggles the socket's blocking flag, which would race with the
  10770. // concurrent reader on a permanently non-blocking socket.
  10771. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10772. }
  10773. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10774. tls::TlsError err;
  10775. auto n = 1000;
  10776. while (--n >= 0) {
  10777. {
  10778. std::lock_guard<std::mutex> guard(session_mutex_);
  10779. auto ret = tls::read(session_, ptr, size, err);
  10780. if (ret > 0) { return ret; }
  10781. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10782. error_ = Error::ConnectionClosed;
  10783. return ret;
  10784. }
  10785. }
  10786. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10787. // direction: the send path shares this session, so output it left pending
  10788. // has to be flushed before more input can be decrypted. Anything else is
  10789. // a hard error.
  10790. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10791. #ifdef _WIN32
  10792. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10793. needs_readable =
  10794. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10795. WSAGetLastError() == WSAETIMEDOUT);
  10796. #endif
  10797. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10798. error_ = Error::Read;
  10799. return -1;
  10800. }
  10801. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10802. error_ = Error::Timeout;
  10803. return -1;
  10804. }
  10805. }
  10806. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10807. // to tell a timeout from a close would otherwise see whatever the previous
  10808. // failure left behind (error_ is never cleared on success).
  10809. error_ = Error::Read;
  10810. return -1;
  10811. }
  10812. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10813. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10814. tls::TlsError err;
  10815. auto n = 1000;
  10816. while (--n >= 0) {
  10817. {
  10818. std::lock_guard<std::mutex> guard(session_mutex_);
  10819. auto ret = tls::write(session_, ptr, handle_size, err);
  10820. if (ret >= 0) { return ret; }
  10821. }
  10822. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10823. // or a post-handshake message must be consumed before the record goes
  10824. // out. Anything else is a hard error.
  10825. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10826. #ifdef _WIN32
  10827. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10828. needs_writable =
  10829. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10830. WSAGetLastError() == WSAETIMEDOUT);
  10831. #endif
  10832. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10833. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10834. }
  10835. return -1;
  10836. }
  10837. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10838. int &port) const {
  10839. detail::get_remote_ip_and_port(sock_, ip, port);
  10840. }
  10841. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10842. int &port) const {
  10843. detail::get_local_ip_and_port(sock_, ip, port);
  10844. }
  10845. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10846. inline time_t WebSocketSSLStream::duration() const {
  10847. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10848. std::chrono::steady_clock::now() - start_time_)
  10849. .count();
  10850. }
  10851. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10852. read_timeout_sec_ = sec;
  10853. read_timeout_usec_ = usec;
  10854. }
  10855. } // namespace detail
  10856. #endif // CPPHTTPLIB_SSL_ENABLED
  10857. /*
  10858. * Group 4: Server implementation
  10859. */
  10860. // HTTP server implementation
  10861. inline Server::Server()
  10862. : new_task_queue([] {
  10863. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10864. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10865. }) {
  10866. #ifndef _WIN32
  10867. signal(SIGPIPE, SIG_IGN);
  10868. #endif
  10869. }
  10870. inline Server::~Server() = default;
  10871. inline std::unique_ptr<detail::MatcherBase>
  10872. Server::make_matcher(const std::string &pattern) {
  10873. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10874. // a path params pattern
  10875. if (pattern.find("/:") != std::string::npos) {
  10876. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10877. }
  10878. // A pattern with no regex metacharacter only has to be compared literally,
  10879. // which is what PathParamsMatcher already does when it captures no
  10880. // parameter, so std::regex is only worth building for the patterns that
  10881. // actually need it
  10882. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10883. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10884. }
  10885. return detail::make_unique<detail::RegexMatcher>(pattern);
  10886. }
  10887. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10888. return add_handler(get_handlers_, pattern, std::move(handler));
  10889. }
  10890. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10891. return add_handler(post_handlers_, pattern, std::move(handler));
  10892. }
  10893. inline Server &Server::Post(const std::string &pattern,
  10894. HandlerWithContentReader handler) {
  10895. return add_handler(post_handlers_for_content_reader_, pattern,
  10896. std::move(handler));
  10897. }
  10898. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10899. return add_handler(put_handlers_, pattern, std::move(handler));
  10900. }
  10901. inline Server &Server::Put(const std::string &pattern,
  10902. HandlerWithContentReader handler) {
  10903. return add_handler(put_handlers_for_content_reader_, pattern,
  10904. std::move(handler));
  10905. }
  10906. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10907. return add_handler(patch_handlers_, pattern, std::move(handler));
  10908. }
  10909. inline Server &Server::Patch(const std::string &pattern,
  10910. HandlerWithContentReader handler) {
  10911. return add_handler(patch_handlers_for_content_reader_, pattern,
  10912. std::move(handler));
  10913. }
  10914. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10915. return add_handler(delete_handlers_, pattern, std::move(handler));
  10916. }
  10917. inline Server &Server::Delete(const std::string &pattern,
  10918. HandlerWithContentReader handler) {
  10919. return add_handler(delete_handlers_for_content_reader_, pattern,
  10920. std::move(handler));
  10921. }
  10922. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10923. return add_handler(options_handlers_, pattern, std::move(handler));
  10924. }
  10925. inline const std::set<std::string> &Server::builtin_methods() {
  10926. thread_local const std::set<std::string> methods{
  10927. "GET", "HEAD", "POST", "PUT", "DELETE",
  10928. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10929. return methods;
  10930. }
  10931. inline Server::CustomHandlerEntry *
  10932. Server::custom_entry_for_registration(const std::string &method) {
  10933. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10934. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10935. // routing() before the custom tables are consulted, so a route registered
  10936. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10937. // there and would be reachable, but they carry protocol-level meaning
  10938. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10939. // library does not route.
  10940. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10941. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10942. has_invalid_registration_ = true;
  10943. return nullptr;
  10944. }
  10945. return &custom_handlers_[method];
  10946. }
  10947. inline Server &Server::CustomRoute(const std::string &method,
  10948. const std::string &pattern,
  10949. Handler handler) {
  10950. auto *entry = custom_entry_for_registration(method);
  10951. if (!entry) { return *this; }
  10952. return add_handler(entry->handlers, pattern, std::move(handler));
  10953. }
  10954. inline Server &Server::CustomRoute(const std::string &method,
  10955. const std::string &pattern,
  10956. HandlerWithContentReader handler) {
  10957. auto *entry = custom_entry_for_registration(method);
  10958. if (!entry) { return *this; }
  10959. return add_handler(entry->handlers_for_content_reader, pattern,
  10960. std::move(handler));
  10961. }
  10962. inline const Server::CustomHandlerEntry *
  10963. Server::find_custom_entry(const std::string &method) const {
  10964. // find() alone would be correct here. The empty() check is what keeps the
  10965. // per-request cost off servers that never call CustomRoute(), which is the
  10966. // overwhelmingly common case; keep it rather than walking into the tree.
  10967. if (custom_handlers_.empty()) { return nullptr; }
  10968. auto it = custom_handlers_.find(method);
  10969. return it == custom_handlers_.end() ? nullptr : &it->second;
  10970. }
  10971. inline Server &Server::WebSocket(const std::string &pattern,
  10972. WebSocketHandler handler) {
  10973. websocket_handlers_.push_back(
  10974. {make_matcher(pattern), std::move(handler), nullptr});
  10975. return *this;
  10976. }
  10977. inline Server &Server::WebSocket(const std::string &pattern,
  10978. WebSocketHandler handler,
  10979. SubProtocolSelector sub_protocol_selector) {
  10980. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10981. std::move(sub_protocol_selector)});
  10982. return *this;
  10983. }
  10984. inline bool Server::set_base_dir(const std::string &dir,
  10985. const std::string &mount_point) {
  10986. return set_mount_point(mount_point, dir);
  10987. }
  10988. inline bool Server::set_mount_point(const std::string &mount_point,
  10989. const std::string &dir, Headers headers) {
  10990. detail::FileStat stat(dir);
  10991. if (stat.is_dir()) {
  10992. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10993. if (!mnt.empty() && mnt[0] == '/') {
  10994. std::string resolved_base;
  10995. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10996. #if defined(_WIN32)
  10997. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10998. resolved_base += '\\';
  10999. }
  11000. #else
  11001. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11002. #endif
  11003. }
  11004. base_dirs_.push_back(
  11005. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11006. return true;
  11007. }
  11008. }
  11009. return false;
  11010. }
  11011. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11012. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11013. if (it->mount_point == mount_point) {
  11014. base_dirs_.erase(it);
  11015. return true;
  11016. }
  11017. }
  11018. return false;
  11019. }
  11020. inline Server &
  11021. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11022. const std::string &mime) {
  11023. file_extension_and_mimetype_map_[ext] = mime;
  11024. return *this;
  11025. }
  11026. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11027. default_file_mimetype_ = mime;
  11028. return *this;
  11029. }
  11030. inline Server &Server::set_file_request_handler(Handler handler) {
  11031. file_request_handler_ = std::move(handler);
  11032. return *this;
  11033. }
  11034. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11035. std::true_type) {
  11036. error_handler_ = std::move(handler);
  11037. return *this;
  11038. }
  11039. inline Server &Server::set_error_handler_core(Handler handler,
  11040. std::false_type) {
  11041. error_handler_ = [handler](const Request &req, Response &res) {
  11042. handler(req, res);
  11043. return HandlerResponse::Handled;
  11044. };
  11045. return *this;
  11046. }
  11047. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11048. exception_handler_ = std::move(handler);
  11049. return *this;
  11050. }
  11051. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11052. pre_routing_handler_ = std::move(handler);
  11053. return *this;
  11054. }
  11055. inline Server &Server::set_post_routing_handler(Handler handler) {
  11056. post_routing_handler_ = std::move(handler);
  11057. return *this;
  11058. }
  11059. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11060. pre_request_handler_ = std::move(handler);
  11061. return *this;
  11062. }
  11063. inline Server &Server::set_logger(Logger logger) {
  11064. logger_ = std::move(logger);
  11065. return *this;
  11066. }
  11067. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11068. error_logger_ = std::move(error_logger);
  11069. return *this;
  11070. }
  11071. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11072. pre_compression_logger_ = std::move(logger);
  11073. return *this;
  11074. }
  11075. inline Server &
  11076. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11077. expect_100_continue_handler_ = std::move(handler);
  11078. return *this;
  11079. }
  11080. inline Server &Server::set_start_handler(StartHandler handler) {
  11081. start_handler_ = std::move(handler);
  11082. return *this;
  11083. }
  11084. inline Server &Server::set_address_family(int family) {
  11085. address_family_ = family;
  11086. return *this;
  11087. }
  11088. inline Server &Server::set_tcp_nodelay(bool on) {
  11089. tcp_nodelay_ = on;
  11090. return *this;
  11091. }
  11092. inline Server &Server::set_ipv6_v6only(bool on) {
  11093. ipv6_v6only_ = on;
  11094. return *this;
  11095. }
  11096. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11097. socket_options_ = std::move(socket_options);
  11098. return *this;
  11099. }
  11100. inline Server &Server::set_default_headers(Headers headers) {
  11101. default_headers_ = std::move(headers);
  11102. return *this;
  11103. }
  11104. inline Server &Server::set_header_writer(
  11105. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11106. header_writer_ = writer;
  11107. return *this;
  11108. }
  11109. inline Server &
  11110. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11111. trusted_proxies_ = proxies;
  11112. return *this;
  11113. }
  11114. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11115. keep_alive_max_count_ = count;
  11116. return *this;
  11117. }
  11118. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11119. keep_alive_timeout_sec_ = sec;
  11120. return *this;
  11121. }
  11122. template <class Rep, class Period>
  11123. inline Server &Server::set_keep_alive_timeout(
  11124. const std::chrono::duration<Rep, Period> &duration) {
  11125. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11126. set_keep_alive_timeout(sec);
  11127. });
  11128. return *this;
  11129. }
  11130. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11131. read_timeout_sec_ = sec;
  11132. read_timeout_usec_ = usec;
  11133. return *this;
  11134. }
  11135. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11136. write_timeout_sec_ = sec;
  11137. write_timeout_usec_ = usec;
  11138. return *this;
  11139. }
  11140. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11141. idle_interval_sec_ = sec;
  11142. idle_interval_usec_ = usec;
  11143. return *this;
  11144. }
  11145. inline Server &Server::set_payload_max_length(size_t length) {
  11146. payload_max_length_ = length;
  11147. return *this;
  11148. }
  11149. inline Server &Server::set_static_file_compression(bool on) {
  11150. static_file_compression_ = on;
  11151. return *this;
  11152. }
  11153. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11154. static_file_compression_min_length_ = length;
  11155. return *this;
  11156. }
  11157. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11158. static_file_compression_max_length_ = length;
  11159. return *this;
  11160. }
  11161. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11162. websocket_max_missed_pongs_ = count;
  11163. return *this;
  11164. }
  11165. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11166. websocket_ping_interval_sec_ = sec;
  11167. return *this;
  11168. }
  11169. template <class Rep, class Period>
  11170. inline Server &Server::set_websocket_ping_interval(
  11171. const std::chrono::duration<Rep, Period> &duration) {
  11172. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11173. set_websocket_ping_interval(sec);
  11174. });
  11175. return *this;
  11176. }
  11177. inline bool Server::bind_to_port(const std::string &host, int port,
  11178. int socket_flags) {
  11179. auto ret = bind_internal(host, port, socket_flags);
  11180. if (ret == -1) { is_decommissioned = true; }
  11181. return ret >= 0;
  11182. }
  11183. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11184. auto ret = bind_internal(host, 0, socket_flags);
  11185. if (ret == -1) { is_decommissioned = true; }
  11186. return ret;
  11187. }
  11188. inline bool Server::listen_after_bind() { return listen_internal(); }
  11189. inline bool Server::listen(const std::string &host, int port,
  11190. int socket_flags) {
  11191. return bind_to_port(host, port, socket_flags) && listen_internal();
  11192. }
  11193. inline bool Server::is_running() const { return is_running_; }
  11194. inline void Server::wait_until_ready() const {
  11195. while (!is_running_ && !is_decommissioned) {
  11196. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11197. }
  11198. }
  11199. inline void Server::stop() noexcept {
  11200. // Release the listening socket whether or not the accept loop is running:
  11201. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11202. // exchange is what makes this safe to call concurrently with the accept loop.
  11203. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11204. if (sock != INVALID_SOCKET) {
  11205. detail::shutdown_socket(sock);
  11206. detail::close_socket(sock);
  11207. }
  11208. is_decommissioned = false;
  11209. }
  11210. inline void Server::decommission() { is_decommissioned = true; }
  11211. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11212. auto len = strlen(s);
  11213. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11214. len -= 2;
  11215. {
  11216. size_t count = 0;
  11217. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11218. switch (count) {
  11219. case 0: req.method = std::string(b, e); break;
  11220. case 1: req.target = std::string(b, e); break;
  11221. case 2: req.version = std::string(b, e); break;
  11222. default: break;
  11223. }
  11224. count++;
  11225. });
  11226. if (count != 3) { return false; }
  11227. }
  11228. // A method outside the built-in set is accepted only when a handler has been
  11229. // registered for it with CustomRoute().
  11230. const auto &methods = builtin_methods();
  11231. if (methods.find(req.method) == methods.end() &&
  11232. !find_custom_entry(req.method)) {
  11233. output_error_log(Error::InvalidHTTPMethod, &req);
  11234. return false;
  11235. }
  11236. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11237. output_error_log(Error::InvalidHTTPVersion, &req);
  11238. return false;
  11239. }
  11240. if (!detail::fields::is_request_target(req.target)) { return false; }
  11241. {
  11242. // Skip URL fragment
  11243. for (size_t i = 0; i < req.target.size(); i++) {
  11244. if (req.target[i] == '#') {
  11245. req.target.erase(i);
  11246. break;
  11247. }
  11248. }
  11249. detail::divide(req.target, '?',
  11250. [&](const char *lhs_data, std::size_t lhs_size,
  11251. const char *rhs_data, std::size_t rhs_size) {
  11252. req.path =
  11253. decode_path_component(std::string(lhs_data, lhs_size));
  11254. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11255. });
  11256. }
  11257. return true;
  11258. }
  11259. inline bool Server::write_response(Stream &strm, bool close_connection,
  11260. Request &req, Response &res) {
  11261. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11262. // incorrectly to the error content.
  11263. req.ranges.clear();
  11264. return write_response_core(strm, close_connection, req, res, false);
  11265. }
  11266. inline bool Server::write_response_with_content(Stream &strm,
  11267. bool close_connection,
  11268. const Request &req,
  11269. Response &res) {
  11270. return write_response_core(strm, close_connection, req, res, true);
  11271. }
  11272. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11273. const Request &req, Response &res,
  11274. bool need_apply_ranges) {
  11275. assert(res.status != -1);
  11276. if (400 <= res.status && error_handler_ &&
  11277. error_handler_(req, res) == HandlerResponse::Handled) {
  11278. need_apply_ranges = true;
  11279. }
  11280. std::string content_type;
  11281. std::string boundary;
  11282. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11283. // Prepare additional headers
  11284. if (close_connection ||
  11285. detail::has_header_token(req.headers, "Connection", "close") ||
  11286. 400 <= res.status || // Don't leave connections open after errors
  11287. // The client withholds the body until `100 Continue`, which was never
  11288. // sent, so whether and when the body follows is unknown.
  11289. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11290. res.set_header("Connection", "close");
  11291. } else {
  11292. std::string s = "timeout=";
  11293. s += std::to_string(keep_alive_timeout_sec_);
  11294. s += ", max=";
  11295. s += std::to_string(keep_alive_max_count_);
  11296. res.set_header("Keep-Alive", s);
  11297. }
  11298. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11299. !res.has_header("Content-Type")) {
  11300. res.set_header("Content-Type", "text/plain");
  11301. }
  11302. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11303. !res.has_header("Content-Length")) {
  11304. res.set_header("Content-Length", "0");
  11305. }
  11306. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11307. res.set_header("Accept-Ranges", "bytes");
  11308. }
  11309. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11310. // Response line and headers
  11311. detail::BufferStream bstrm;
  11312. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11313. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11314. // Combine a small body with the headers so the whole response leaves in a
  11315. // single write. A large body is written on its own instead: a copy of it
  11316. // costs more than the extra write saves.
  11317. auto send_body = req.method != "HEAD";
  11318. auto body_is_separate = false;
  11319. auto provider_done = false;
  11320. if (send_body && !res.body.empty() && !res.content_provider_) {
  11321. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11322. bstrm.write(res.body.data(), res.body.size());
  11323. } else {
  11324. body_is_separate = true;
  11325. }
  11326. } else if (send_body && res.content_provider_ &&
  11327. res.is_file_content_provider_ &&
  11328. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11329. // A small file is read into the same buffer. Other providers may produce
  11330. // their data over time, so they are never held back.
  11331. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11332. return false;
  11333. }
  11334. provider_done = true;
  11335. }
  11336. // Log before writing to avoid race condition with client-side code that
  11337. // accesses logger-captured data immediately after receiving the response.
  11338. output_log(req, res);
  11339. // Flush buffer
  11340. auto &data = bstrm.get_buffer();
  11341. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11342. if (body_is_separate) {
  11343. return detail::write_data(strm, res.body.data(), res.body.size());
  11344. }
  11345. // Streaming body
  11346. if (send_body && res.content_provider_) {
  11347. if (!provider_done &&
  11348. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11349. return false;
  11350. }
  11351. res.content_provider_success_ = true;
  11352. }
  11353. return true;
  11354. }
  11355. inline bool
  11356. Server::write_content_with_provider(Stream &strm, const Request &req,
  11357. Response &res, const std::string &boundary,
  11358. const std::string &content_type) {
  11359. auto is_shutting_down = [this]() {
  11360. return this->svr_sock_ == INVALID_SOCKET;
  11361. };
  11362. if (res.content_length_ > 0) {
  11363. // Only a 206 response is served as a partial representation, matching the
  11364. // condition `apply_ranges()` used to decide the Content-Length and the
  11365. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11366. // only for a 2xx status, slicing under any other status would write a body
  11367. // that disagrees with the header already sent, from an unchecked offset.
  11368. auto is_partial =
  11369. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11370. if (!is_partial) {
  11371. return detail::write_content(strm, res.content_provider_, 0,
  11372. res.content_length_, is_shutting_down);
  11373. } else if (req.ranges.size() == 1) {
  11374. auto offset_and_length = detail::get_range_offset_and_length(
  11375. req.ranges[0], res.content_length_);
  11376. return detail::write_content(strm, res.content_provider_,
  11377. offset_and_length.first,
  11378. offset_and_length.second, is_shutting_down);
  11379. } else {
  11380. return detail::write_multipart_ranges_data(
  11381. strm, req, res, boundary, content_type, res.content_length_,
  11382. is_shutting_down);
  11383. }
  11384. } else {
  11385. if (res.is_chunked_content_provider_) {
  11386. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11387. // re-negotiating here would disagree with them, e.g. once a handler's
  11388. // own Content-Encoding header suppresses the negotiation.
  11389. auto compressor = detail::make_compressor(res.content_coding_);
  11390. if (!compressor) {
  11391. compressor = detail::make_unique<detail::nocompressor>();
  11392. }
  11393. return detail::write_content_chunked(strm, res.content_provider_,
  11394. is_shutting_down, *compressor);
  11395. } else {
  11396. return detail::write_content_without_length(strm, res.content_provider_,
  11397. is_shutting_down);
  11398. }
  11399. }
  11400. }
  11401. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11402. FormFields::iterator cur_field;
  11403. FormFiles::iterator cur_file;
  11404. auto is_text_field = false;
  11405. size_t count = 0;
  11406. if (read_content_core(
  11407. strm, req, res,
  11408. // Regular
  11409. [&](const char *buf, size_t n) {
  11410. // Prevent arithmetic overflow when checking sizes.
  11411. // Avoid computing (req.body.size() + n) directly because
  11412. // adding two unsigned `size_t` values can wrap around and
  11413. // produce a small result instead of indicating overflow.
  11414. // Instead, check using subtraction: ensure `n` does not
  11415. // exceed the remaining capacity `max_size() - size()`.
  11416. if (req.body.size() >= req.body.max_size() ||
  11417. n > req.body.max_size() - req.body.size()) {
  11418. return false;
  11419. }
  11420. // Limit decompressed body size to payload_max_length_ to protect
  11421. // against "zip bomb" attacks where a small compressed payload
  11422. // decompresses to a massive size.
  11423. if (payload_max_length_ > 0 &&
  11424. (req.body.size() >= payload_max_length_ ||
  11425. n > payload_max_length_ - req.body.size())) {
  11426. return false;
  11427. }
  11428. req.body.append(buf, n);
  11429. return true;
  11430. },
  11431. // Multipart FormData
  11432. [&](const FormData &file) {
  11433. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11434. output_error_log(Error::TooManyFormDataFiles, &req);
  11435. return false;
  11436. }
  11437. if (file.filename.empty()) {
  11438. cur_field = req.form.fields.emplace(
  11439. file.name, FormField{file.name, file.content, file.headers});
  11440. is_text_field = true;
  11441. } else {
  11442. cur_file = req.form.files.emplace(file.name, file);
  11443. is_text_field = false;
  11444. }
  11445. return true;
  11446. },
  11447. [&](const char *buf, size_t n) {
  11448. if (is_text_field) {
  11449. auto &content = cur_field->second.content;
  11450. if (content.size() + n > content.max_size()) { return false; }
  11451. content.append(buf, n);
  11452. } else {
  11453. auto &content = cur_file->second.content;
  11454. if (content.size() + n > content.max_size()) { return false; }
  11455. content.append(buf, n);
  11456. }
  11457. return true;
  11458. })) {
  11459. const auto &content_type = req.get_header_value("Content-Type");
  11460. if (detail::extract_media_type(content_type) ==
  11461. "application/x-www-form-urlencoded") {
  11462. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11463. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11464. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11465. return false;
  11466. }
  11467. detail::parse_query_text(req.body, req.params);
  11468. }
  11469. return true;
  11470. }
  11471. return false;
  11472. }
  11473. inline bool Server::read_content_with_content_receiver(
  11474. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11475. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11476. return read_content_core(strm, req, res, std::move(receiver),
  11477. std::move(multipart_header),
  11478. std::move(multipart_receiver));
  11479. }
  11480. inline bool Server::read_content_core(
  11481. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11482. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11483. detail::FormDataParser multipart_form_data_parser;
  11484. ContentReceiverWithProgress out;
  11485. if (req.is_multipart_form_data()) {
  11486. const auto &content_type = req.get_header_value("Content-Type");
  11487. std::string boundary;
  11488. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11489. res.status = StatusCode::BadRequest_400;
  11490. output_error_log(Error::MultipartParsing, &req);
  11491. return false;
  11492. }
  11493. multipart_form_data_parser.set_boundary(std::move(boundary));
  11494. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11495. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11496. multipart_receiver);
  11497. };
  11498. } else {
  11499. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11500. size_t /*len*/) { return receiver(buf, n); };
  11501. }
  11502. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11503. // For non-SSL builds we still scan non-persistent connections for stray
  11504. // body bytes so the payload limit is enforced (413). On keep-alive,
  11505. // pending bytes may be the next request (issue #2450), so skip.
  11506. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11507. if (!req.has_header("Content-Length") &&
  11508. !detail::is_chunked_transfer_encoding(req.headers)) {
  11509. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11510. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11511. auto has_data = strm.is_readable();
  11512. if (!has_data) {
  11513. auto s = strm.socket();
  11514. if (s != INVALID_SOCKET) {
  11515. has_data = detail::select_read(s, 0, 0) > 0;
  11516. }
  11517. }
  11518. if (has_data) {
  11519. // Route through the same decompressing reader used by the
  11520. // length-framed and chunked paths below, so payload_max_length_ is
  11521. // enforced on the decompressed size here too instead of only on the
  11522. // compressed wire bytes.
  11523. return detail::read_content(strm, req, payload_max_length_, res.status,
  11524. nullptr, out, true);
  11525. }
  11526. }
  11527. return true;
  11528. }
  11529. #else
  11530. if (!req.has_header("Content-Length") &&
  11531. !detail::is_chunked_transfer_encoding(req.headers)) {
  11532. return true;
  11533. }
  11534. #endif
  11535. // The client is waiting for this before it sends the body.
  11536. if (req.expect_100_continue_pending_) {
  11537. req.expect_100_continue_pending_ = false;
  11538. detail::write_response_line(strm, StatusCode::Continue_100);
  11539. strm.write("\r\n");
  11540. }
  11541. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11542. out, true)) {
  11543. return false;
  11544. }
  11545. req.body_consumed_ = true;
  11546. if (req.is_multipart_form_data()) {
  11547. if (!multipart_form_data_parser.is_valid()) {
  11548. res.status = StatusCode::BadRequest_400;
  11549. output_error_log(Error::MultipartParsing, &req);
  11550. return false;
  11551. }
  11552. }
  11553. return true;
  11554. }
  11555. inline bool Server::handle_file_request(Request &req, Response &res) {
  11556. for (const auto &entry : base_dirs_) {
  11557. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11558. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11559. // One that already ends in '/' (the root mount among them) carries its own
  11560. // boundary; set_mount_point() guarantees the mount point is not empty.
  11561. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11562. (entry.mount_point.back() == '/' ||
  11563. req.path.size() == entry.mount_point.size() ||
  11564. req.path[entry.mount_point.size()] == '/')) {
  11565. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11566. if (detail::is_valid_path(sub_path)) {
  11567. auto path = entry.base_dir + sub_path;
  11568. if (path.back() == '/') { path += "index.html"; }
  11569. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11570. // but symlinks/junctions can still escape the base directory.
  11571. if (!entry.resolved_base_dir.empty()) {
  11572. std::string resolved_path;
  11573. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11574. !detail::is_path_within_base(resolved_path,
  11575. entry.resolved_base_dir)) {
  11576. res.status = StatusCode::Forbidden_403;
  11577. return true;
  11578. }
  11579. }
  11580. detail::FileStat stat(path);
  11581. if (stat.is_dir()) {
  11582. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11583. return true;
  11584. }
  11585. if (stat.is_file()) {
  11586. for (const auto &kv : entry.headers) {
  11587. res.set_header(kv.first, kv.second);
  11588. }
  11589. auto content_type_of = [&]() {
  11590. return detail::find_content_type(
  11591. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11592. };
  11593. // Only the ETag needs the content type this early, and only to name
  11594. // the coding. Deciding it here would otherwise put a regex in front
  11595. // of the 304 below, which serving a file never used to pay for.
  11596. std::string content_type;
  11597. auto encoding = detail::EncodingType::None;
  11598. if (static_file_compression_) {
  11599. content_type = content_type_of();
  11600. encoding =
  11601. static_file_encoding(req, res, content_type, stat.size());
  11602. }
  11603. // The ETag names the representation actually sent, so a client that
  11604. // cached the compressed form revalidates against the compressed ETag
  11605. // and still gets a 304, while one that took identity keeps the plain
  11606. // ETag.
  11607. auto etag = detail::compute_etag(
  11608. stat, encoding == detail::EncodingType::None
  11609. ? std::string()
  11610. : std::string("-") + detail::encoding_name(encoding));
  11611. if (!etag.empty()) { res.set_header("ETag", etag); }
  11612. auto mtime = stat.mtime();
  11613. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11614. if (!last_modified.empty()) {
  11615. res.set_header("Last-Modified", last_modified);
  11616. }
  11617. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11618. check_if_range(req, etag, mtime);
  11619. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11620. if (!mm->is_open()) {
  11621. output_error_log(Error::OpenFile, &req);
  11622. return false;
  11623. }
  11624. if (!static_file_compression_) { content_type = content_type_of(); }
  11625. detail::set_file_content_provider(res, mm, content_type, encoding);
  11626. if (req.method != "HEAD" && file_request_handler_) {
  11627. file_request_handler_(req, res);
  11628. }
  11629. return true;
  11630. } else {
  11631. output_error_log(Error::OpenFile, &req);
  11632. }
  11633. }
  11634. }
  11635. }
  11636. return false;
  11637. }
  11638. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11639. const std::string &etag,
  11640. time_t mtime) const {
  11641. // Handle conditional GET:
  11642. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11643. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11644. if (req.has_header("If-None-Match")) {
  11645. if (!etag.empty()) {
  11646. auto val =
  11647. detail::get_combined_header_value(req.headers, "If-None-Match");
  11648. // NOTE: We use exact string matching here. This works correctly
  11649. // because our server always generates weak ETags (W/"..."), and
  11650. // clients typically send back the same ETag they received.
  11651. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11652. // If-None-Match, where W/"x" and "x" would match, but this
  11653. // simplified implementation requires exact matches.
  11654. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11655. [&](const char *b, const char *e) {
  11656. auto seg_len = static_cast<size_t>(e - b);
  11657. return (seg_len == 1 && *b == '*') ||
  11658. (seg_len == etag.size() &&
  11659. std::equal(b, e, etag.begin()));
  11660. });
  11661. if (ret) {
  11662. res.status = StatusCode::NotModified_304;
  11663. return true;
  11664. }
  11665. }
  11666. } else if (req.has_header("If-Modified-Since")) {
  11667. auto val = req.get_header_value("If-Modified-Since");
  11668. auto t = detail::parse_http_date(val);
  11669. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11670. res.status = StatusCode::NotModified_304;
  11671. return true;
  11672. }
  11673. }
  11674. return false;
  11675. }
  11676. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11677. time_t mtime) const {
  11678. // Handle If-Range for partial content requests (RFC 9110
  11679. // Section 13.1.5). If-Range is only evaluated when Range header is
  11680. // present. If the validator matches, serve partial content; otherwise
  11681. // serve full content.
  11682. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11683. auto val = req.get_header_value("If-Range");
  11684. auto is_valid_range = [&]() {
  11685. if (detail::is_strong_etag(val)) {
  11686. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11687. // comparison.
  11688. return (!etag.empty() && val == etag);
  11689. } else if (detail::is_weak_etag(val)) {
  11690. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11691. return false;
  11692. } else {
  11693. // HTTP-date comparison
  11694. auto t = detail::parse_http_date(val);
  11695. return (t != static_cast<time_t>(-1) && mtime <= t);
  11696. }
  11697. };
  11698. if (!is_valid_range()) {
  11699. // Validator doesn't match: ignore Range and serve full content
  11700. req.ranges.clear();
  11701. return false;
  11702. }
  11703. }
  11704. return true;
  11705. }
  11706. inline socket_t
  11707. Server::create_server_socket(const std::string &host, int port,
  11708. int socket_flags,
  11709. SocketOptions socket_options) const {
  11710. return detail::create_socket(
  11711. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11712. ipv6_v6only_, std::move(socket_options),
  11713. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11714. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11715. output_error_log(Error::BindIPAddress, nullptr);
  11716. return false;
  11717. }
  11718. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11719. output_error_log(Error::Listen, nullptr);
  11720. return false;
  11721. }
  11722. return true;
  11723. });
  11724. }
  11725. inline int Server::bind_internal(const std::string &host, int port,
  11726. int socket_flags) {
  11727. if (is_decommissioned) { return -1; }
  11728. if (!is_valid()) { return -1; }
  11729. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11730. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11731. if (port == 0) {
  11732. struct sockaddr_storage addr;
  11733. socklen_t addr_len = sizeof(addr);
  11734. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11735. &addr_len) == -1) {
  11736. output_error_log(Error::GetSockName, nullptr);
  11737. return -1;
  11738. }
  11739. if (addr.ss_family == AF_INET) {
  11740. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11741. } else if (addr.ss_family == AF_INET6) {
  11742. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11743. } else {
  11744. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11745. return -1;
  11746. }
  11747. } else {
  11748. return port;
  11749. }
  11750. }
  11751. inline bool Server::listen_internal() {
  11752. // A stop() between bind and listen leaves nothing to accept on. Report
  11753. // failure instead of returning success without ever serving, and mark the
  11754. // server decommissioned the way any failed listen does so that a concurrent
  11755. // wait_until_ready() wakes up instead of spinning forever.
  11756. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11757. is_decommissioned = true;
  11758. return false;
  11759. }
  11760. auto ret = true;
  11761. is_running_ = true;
  11762. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11763. if (start_handler_) { start_handler_(); }
  11764. {
  11765. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11766. while (svr_sock_ != INVALID_SOCKET) {
  11767. #ifndef _WIN32
  11768. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11769. #endif
  11770. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11771. idle_interval_usec_);
  11772. if (val == 0) { // Timeout
  11773. task_queue->on_idle();
  11774. continue;
  11775. }
  11776. #ifndef _WIN32
  11777. }
  11778. #endif
  11779. #if defined _WIN32
  11780. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11781. // OVERLAPPED
  11782. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11783. #elif defined SOCK_CLOEXEC
  11784. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11785. #else
  11786. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11787. #endif
  11788. if (sock == INVALID_SOCKET) {
  11789. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11790. // touches the CRT errno, so the two have to be asked platform by
  11791. // platform rather than by testing errno here.
  11792. if (detail::is_accept_resource_error()) {
  11793. // The per-process descriptor limit or the network stack's buffer
  11794. // space has been reached. Try to accept new connections after a
  11795. // short sleep.
  11796. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11797. continue;
  11798. } else if (detail::is_accept_transient_error()) {
  11799. continue;
  11800. }
  11801. // Take the descriptor out of svr_sock_ before closing it: a later
  11802. // stop() would otherwise shutdown()/close() a value the OS may have
  11803. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11804. // gone. The exchange also settles the race with a concurrent stop(),
  11805. // since whichever side takes the descriptor closes it exactly once.
  11806. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11807. if (listen_sock != INVALID_SOCKET) {
  11808. detail::close_socket(listen_sock);
  11809. ret = false;
  11810. output_error_log(Error::Connection, nullptr);
  11811. } else {
  11812. ; // The server socket was closed by user.
  11813. }
  11814. break;
  11815. }
  11816. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11817. read_timeout_sec_, read_timeout_usec_);
  11818. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11819. write_timeout_sec_, write_timeout_usec_);
  11820. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11821. if (!task_queue->enqueue(
  11822. [this, sock]() { process_and_close_socket(sock); })) {
  11823. output_error_log(Error::ResourceExhaustion, nullptr);
  11824. detail::shutdown_socket(sock);
  11825. detail::close_socket(sock);
  11826. }
  11827. }
  11828. task_queue->shutdown();
  11829. }
  11830. is_decommissioned = !ret;
  11831. return ret;
  11832. }
  11833. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11834. if (pre_routing_handler_ &&
  11835. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11836. return true;
  11837. }
  11838. // File handler
  11839. if ((req.method == "GET" || req.method == "HEAD") &&
  11840. handle_file_request(req, res)) {
  11841. return true;
  11842. }
  11843. const auto *custom = find_custom_entry(req.method);
  11844. // The second clause mirrors what expect_content() does unconditionally for
  11845. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11846. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11847. // `allprop`) would skip its handler and fall through to 404.
  11848. if (detail::expect_content(req) ||
  11849. (custom && !custom->handlers_for_content_reader.empty())) {
  11850. // Content reader handler
  11851. {
  11852. // Track whether the ContentReader was aborted due to the decompressed
  11853. // payload exceeding `payload_max_length_`.
  11854. // The user handler runs after the lambda returns, so we must restore the
  11855. // 413 status if the handler overwrites it.
  11856. bool content_reader_payload_too_large = false;
  11857. ContentReader reader(
  11858. [&](ContentReceiver receiver) {
  11859. auto result = read_content_with_content_receiver(
  11860. strm, req, res, std::move(receiver), nullptr, nullptr);
  11861. if (!result) {
  11862. output_error_log(Error::Read, &req);
  11863. if (res.status == StatusCode::PayloadTooLarge_413) {
  11864. content_reader_payload_too_large = true;
  11865. }
  11866. }
  11867. return result;
  11868. },
  11869. [&](FormDataHeader header, ContentReceiver receiver) {
  11870. auto result = read_content_with_content_receiver(
  11871. strm, req, res, nullptr, std::move(header),
  11872. std::move(receiver));
  11873. if (!result) {
  11874. output_error_log(Error::Read, &req);
  11875. if (res.status == StatusCode::PayloadTooLarge_413) {
  11876. content_reader_payload_too_large = true;
  11877. }
  11878. }
  11879. return result;
  11880. });
  11881. bool dispatched = false;
  11882. if (req.method == "POST") {
  11883. dispatched = dispatch_request_for_content_reader(
  11884. req, res, std::move(reader), post_handlers_for_content_reader_);
  11885. } else if (req.method == "PUT") {
  11886. dispatched = dispatch_request_for_content_reader(
  11887. req, res, std::move(reader), put_handlers_for_content_reader_);
  11888. } else if (req.method == "PATCH") {
  11889. dispatched = dispatch_request_for_content_reader(
  11890. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11891. } else if (req.method == "DELETE") {
  11892. dispatched = dispatch_request_for_content_reader(
  11893. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11894. } else if (custom) {
  11895. dispatched = dispatch_request_for_content_reader(
  11896. req, res, std::move(reader), custom->handlers_for_content_reader);
  11897. }
  11898. if (dispatched) {
  11899. if (content_reader_payload_too_large) {
  11900. // Enforce the limit: override any status the handler may have set
  11901. // and return false so the error path sends a plain 413 response.
  11902. res.status = StatusCode::PayloadTooLarge_413;
  11903. res.body.clear();
  11904. res.content_length_ = 0;
  11905. res.content_provider_ = nullptr;
  11906. return false;
  11907. }
  11908. return true;
  11909. }
  11910. }
  11911. // NOTE: `req.body` is not read here. For a regular handler the body is
  11912. // read inside dispatch_request(), after the route has matched and the
  11913. // pre-request handler has approved the request, so that a rejected
  11914. // request (e.g. failed authentication) never forces us to buffer a
  11915. // potentially large body.
  11916. }
  11917. // Regular handler
  11918. if (req.method == "GET" || req.method == "HEAD") {
  11919. return dispatch_request(req, res, get_handlers_, strm);
  11920. } else if (req.method == "POST") {
  11921. return dispatch_request(req, res, post_handlers_, strm);
  11922. } else if (req.method == "PUT") {
  11923. return dispatch_request(req, res, put_handlers_, strm);
  11924. } else if (req.method == "DELETE") {
  11925. return dispatch_request(req, res, delete_handlers_, strm);
  11926. } else if (req.method == "OPTIONS") {
  11927. return dispatch_request(req, res, options_handlers_, strm);
  11928. } else if (req.method == "PATCH") {
  11929. return dispatch_request(req, res, patch_handlers_, strm);
  11930. } else if (custom) {
  11931. return dispatch_request(req, res, custom->handlers, strm);
  11932. }
  11933. res.status = StatusCode::BadRequest_400;
  11934. return false;
  11935. }
  11936. inline bool Server::dispatch_request(Request &req, Response &res,
  11937. const Handlers &handlers, Stream &strm) {
  11938. for (const auto &x : handlers) {
  11939. const auto &matcher = x.first;
  11940. const auto &handler = x.second;
  11941. if (matcher->match(req)) {
  11942. req.matched_route = matcher->pattern();
  11943. // Run the pre-request handler before reading the body so a rejected
  11944. // request (e.g. failed authentication) never forces us to buffer a
  11945. // potentially large body. `req.matched_route` is available here.
  11946. if (pre_request_handler_ &&
  11947. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11948. return true;
  11949. }
  11950. // The route matched and the request was approved; read the body now.
  11951. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11952. output_error_log(Error::Read, &req);
  11953. return false;
  11954. }
  11955. handler(req, res);
  11956. return true;
  11957. }
  11958. }
  11959. return false;
  11960. }
  11961. // Decides the content coding for a response served straight from a file. Both
  11962. // the ETag, which has to name the representation actually sent, and
  11963. // `apply_static_file_compression()` go through this, so the two cannot drift
  11964. // apart.
  11965. inline detail::EncodingType
  11966. Server::static_file_encoding(const Request &req, const Response &res,
  11967. const std::string &content_type,
  11968. size_t length) const {
  11969. if (!static_file_compression_) { return detail::EncodingType::None; }
  11970. // Nothing to compress, and an empty file already answers with
  11971. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11972. // turn an empty body into a 20-byte gzip stream.
  11973. if (length == 0) { return detail::EncodingType::None; }
  11974. // A file that already fits in a single packet gains nothing from being made
  11975. // smaller, since it still travels in that one segment, and a file of a few
  11976. // bytes comes out larger than it went in.
  11977. if (length < static_file_compression_min_length_) {
  11978. return detail::EncodingType::None;
  11979. }
  11980. // RFC 9110 applies Range to the representation after content coding, so a
  11981. // compressed 206 would mean compressing the whole file and then slicing it.
  11982. // Serve ranges from the identity representation instead.
  11983. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11984. if (static_file_compression_max_length_ > 0 &&
  11985. length > static_file_compression_max_length_) {
  11986. return detail::EncodingType::None;
  11987. }
  11988. return detail::encoding_type(req, res, content_type);
  11989. }
  11990. // Compresses a file-backed content provider into `res.body` and takes over the
  11991. // framing headers. Returns false when the response is left untouched.
  11992. inline bool Server::apply_static_file_compression(const Request &req,
  11993. Response &res) const {
  11994. auto type = res.content_coding_;
  11995. if (type == detail::EncodingType::None || !res.content_provider_) {
  11996. return false;
  11997. }
  11998. auto compressor = detail::make_compressor(type);
  11999. if (!compressor) { return false; }
  12000. output_pre_compression_log(req, res);
  12001. std::string compressed;
  12002. if (!detail::compress_content_provider(res.content_provider_,
  12003. res.content_length_, *compressor,
  12004. compressed)) {
  12005. return false;
  12006. }
  12007. res.body.swap(compressed);
  12008. // The provider was consumed in full, so a resource releaser registered with
  12009. // it should hear about a success when the response goes away.
  12010. res.content_provider_success_ = true;
  12011. res.content_provider_ = nullptr;
  12012. res.content_length_ = 0;
  12013. res.content_coding_ = detail::EncodingType::None;
  12014. res.set_header("Content-Encoding", detail::encoding_name(type));
  12015. res.set_header("Vary", "Accept-Encoding");
  12016. res.set_header("Content-Length", std::to_string(res.body.size()));
  12017. return true;
  12018. }
  12019. inline void Server::apply_ranges(const Request &req, Response &res,
  12020. std::string &content_type,
  12021. std::string &boundary) const {
  12022. // A known-length content provider leaves `res.body` empty, so the compressor
  12023. // at the end of this function never runs for one (issue #2545). A file-backed
  12024. // provider is fully readable right here, so compress it and answer with an
  12025. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12026. // takes the same path as `set_content()` from here on. Range requests never
  12027. // get a content coding, so `Content-Range` still names identity bytes and
  12028. // none of the framing below applies.
  12029. if (apply_static_file_compression(req, res)) { return; }
  12030. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12031. auto it = res.headers.find("Content-Type");
  12032. if (it != res.headers.end()) {
  12033. content_type = it->second;
  12034. res.headers.erase(it);
  12035. }
  12036. boundary = detail::make_multipart_data_boundary();
  12037. res.set_header("Content-Type",
  12038. "multipart/byteranges; boundary=" + boundary);
  12039. }
  12040. auto type = detail::encoding_type(req, res);
  12041. if (res.body.empty()) {
  12042. if (res.content_length_ > 0) {
  12043. size_t length = 0;
  12044. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12045. length = res.content_length_;
  12046. } else if (req.ranges.size() == 1) {
  12047. auto offset_and_length = detail::get_range_offset_and_length(
  12048. req.ranges[0], res.content_length_);
  12049. length = offset_and_length.second;
  12050. auto content_range = detail::make_content_range_header_field(
  12051. offset_and_length, res.content_length_);
  12052. res.set_header("Content-Range", content_range);
  12053. } else {
  12054. length = detail::get_multipart_ranges_data_length(
  12055. req, boundary, content_type, res.content_length_);
  12056. }
  12057. res.set_header("Content-Length", std::to_string(length));
  12058. } else {
  12059. if (res.content_provider_) {
  12060. if (res.is_chunked_content_provider_) {
  12061. res.set_header("Transfer-Encoding", "chunked");
  12062. res.content_coding_ = type;
  12063. if (type != detail::EncodingType::None) {
  12064. res.set_header("Content-Encoding", detail::encoding_name(type));
  12065. res.set_header("Vary", "Accept-Encoding");
  12066. }
  12067. }
  12068. }
  12069. }
  12070. } else {
  12071. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12072. ;
  12073. } else if (req.ranges.size() == 1) {
  12074. auto offset_and_length =
  12075. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12076. auto offset = offset_and_length.first;
  12077. auto length = offset_and_length.second;
  12078. auto content_range = detail::make_content_range_header_field(
  12079. offset_and_length, res.body.size());
  12080. res.set_header("Content-Range", content_range);
  12081. assert(offset + length <= res.body.size());
  12082. res.body = res.body.substr(offset, length);
  12083. } else {
  12084. std::string data;
  12085. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12086. res.body.size(), data);
  12087. res.body.swap(data);
  12088. }
  12089. if (type != detail::EncodingType::None) {
  12090. output_pre_compression_log(req, res);
  12091. if (auto compressor = detail::make_compressor(type)) {
  12092. std::string compressed;
  12093. if (compressor->compress(res.body.data(), res.body.size(), true,
  12094. [&](const char *data, size_t data_len) {
  12095. compressed.append(data, data_len);
  12096. return true;
  12097. })) {
  12098. res.body.swap(compressed);
  12099. res.set_header("Content-Encoding", detail::encoding_name(type));
  12100. res.set_header("Vary", "Accept-Encoding");
  12101. }
  12102. }
  12103. }
  12104. res.content_length_ = res.body.size();
  12105. res.set_header("Content-Length", std::to_string(res.content_length_));
  12106. }
  12107. }
  12108. inline bool Server::dispatch_request_for_content_reader(
  12109. Request &req, Response &res, ContentReader content_reader,
  12110. const HandlersForContentReader &handlers) const {
  12111. for (const auto &x : handlers) {
  12112. const auto &matcher = x.first;
  12113. const auto &handler = x.second;
  12114. if (matcher->match(req)) {
  12115. req.matched_route = matcher->pattern();
  12116. if (!pre_request_handler_ ||
  12117. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12118. handler(req, res, content_reader);
  12119. }
  12120. return true;
  12121. }
  12122. }
  12123. return false;
  12124. }
  12125. inline std::string
  12126. get_client_ip(const std::string &x_forwarded_for,
  12127. const std::vector<std::string> &trusted_proxies) {
  12128. // X-Forwarded-For is a comma-separated list per RFC 7239
  12129. std::vector<std::string> ip_list;
  12130. detail::split(x_forwarded_for.data(),
  12131. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12132. [&](const char *b, const char *e) {
  12133. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12134. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12135. });
  12136. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12137. // no segments. Signal "no client IP derived" with an empty string so the
  12138. // caller can fall back to the connection-level remote address.
  12139. if (ip_list.empty()) { return std::string(); }
  12140. // Each hop appends the address it received the request from, so the rightmost
  12141. // entries are the ones written by our own infrastructure while the leftmost
  12142. // are whatever the original client chose to send. Walk from the right and
  12143. // skip trusted proxies; the first address that is not a trusted proxy is the
  12144. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12145. // from the left instead lets a client forge an arbitrary address by following
  12146. // it with a trusted proxy's address, which the left-to-right scan then
  12147. // returned as the client.
  12148. for (size_t i = ip_list.size(); i-- > 0;) {
  12149. const auto &ip = ip_list[i];
  12150. auto is_trusted_proxy =
  12151. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12152. [&](const std::string &proxy) { return ip == proxy; });
  12153. if (!is_trusted_proxy) { return ip; }
  12154. }
  12155. // Every hop was a trusted proxy; fall back to the first entry.
  12156. return ip_list.front();
  12157. }
  12158. inline bool
  12159. Server::process_request(Stream &strm, const std::string &remote_addr,
  12160. int remote_port, const std::string &local_addr,
  12161. int local_port, bool close_connection,
  12162. bool &connection_closed,
  12163. const std::function<void(Request &)> &setup_request,
  12164. bool *websocket_upgraded) {
  12165. std::array<char, 2048> buf{};
  12166. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12167. // Connection has been closed on client
  12168. if (!line_reader.getline()) { return false; }
  12169. Request req;
  12170. req.start_time_ = std::chrono::steady_clock::now();
  12171. req.remote_addr = remote_addr;
  12172. req.remote_port = remote_port;
  12173. req.local_addr = local_addr;
  12174. req.local_port = local_port;
  12175. Response res;
  12176. res.version = "HTTP/1.1";
  12177. res.headers = default_headers_;
  12178. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12179. // close the connection after that response, whichever path wrote it (an
  12180. // error status, a handler, or a rejected request). Reading on would also
  12181. // parse whatever the client sent next on a connection it considers done.
  12182. auto honor_connection_close = detail::scope_exit([&] {
  12183. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12184. connection_closed = true;
  12185. }
  12186. });
  12187. // Request line and headers. A rejected message leaves the rest of it (and
  12188. // any body) unread, so the connection cannot be reused: the leftover bytes
  12189. // would be parsed as the next request.
  12190. if (!parse_request_line(line_reader.ptr(), req)) {
  12191. connection_closed = true;
  12192. res.status = StatusCode::BadRequest_400;
  12193. output_error_log(Error::InvalidRequestLine, &req);
  12194. return write_response(strm, close_connection, req, res);
  12195. }
  12196. // Request headers
  12197. if (!detail::read_headers(strm, req.headers)) {
  12198. connection_closed = true;
  12199. res.status = StatusCode::BadRequest_400;
  12200. output_error_log(Error::InvalidHeaders, &req);
  12201. return write_response(strm, close_connection, req, res);
  12202. }
  12203. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12204. // which would otherwise let an intermediary and this parser disagree on
  12205. // where the body ends and enable request smuggling. Three cases: a
  12206. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12207. // or empty), which would otherwise be read as "no body"; a non-zero
  12208. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12209. // tolerated for compatibility with existing clients); and a
  12210. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12211. // length undeterminable. None of them may fall through to the "no body"
  12212. // path, or the body bytes are parsed as the next request on a persistent
  12213. // connection.
  12214. auto is_invalid_content_length = false;
  12215. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12216. is_invalid_content_length);
  12217. if (is_invalid_content_length ||
  12218. detail::has_conflicting_content_length(req.headers) ||
  12219. (req.has_header("Transfer-Encoding") &&
  12220. !detail::is_chunked_transfer_encoding(req.headers))) {
  12221. connection_closed = true;
  12222. res.status = StatusCode::BadRequest_400;
  12223. return write_response(strm, close_connection, req, res);
  12224. }
  12225. // Check if the request URI doesn't exceed the limit
  12226. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12227. connection_closed = true;
  12228. res.status = StatusCode::UriTooLong_414;
  12229. output_error_log(Error::ExceedUriMaxLength, &req);
  12230. return write_response(strm, close_connection, req, res);
  12231. }
  12232. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12233. connection_closed = true;
  12234. }
  12235. if (req.version == "HTTP/1.0" &&
  12236. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12237. connection_closed = true;
  12238. }
  12239. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12240. // itself a trusted proxy. Otherwise any direct client could spoof
  12241. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12242. auto is_trusted_peer = std::any_of(
  12243. trusted_proxies_.begin(), trusted_proxies_.end(),
  12244. [&](const std::string &proxy) { return proxy == remote_addr; });
  12245. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12246. // Some proxies append the address they observed as a separate
  12247. // X-Forwarded-For field line instead of extending the one the client sent
  12248. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12249. // be scanned. Reading only the first occurrence would hand back the
  12250. // client-supplied, and therefore forgeable, value.
  12251. auto x_forwarded_for =
  12252. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12253. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12254. req.remote_addr = derived.empty() ? remote_addr : derived;
  12255. } else {
  12256. req.remote_addr = remote_addr;
  12257. }
  12258. req.remote_port = remote_port;
  12259. req.local_addr = local_addr;
  12260. req.local_port = local_port;
  12261. if (req.has_header("Accept")) {
  12262. auto accept_header =
  12263. detail::get_combined_header_value(req.headers, "Accept");
  12264. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12265. connection_closed = true;
  12266. res.status = StatusCode::BadRequest_400;
  12267. output_error_log(Error::HTTPParsing, &req);
  12268. return write_response(strm, close_connection, req, res);
  12269. }
  12270. }
  12271. if (req.has_header("Range")) {
  12272. const auto &range_header_value = req.get_header_value("Range");
  12273. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12274. connection_closed = true;
  12275. res.status = StatusCode::RangeNotSatisfiable_416;
  12276. output_error_log(Error::InvalidRangeHeader, &req);
  12277. return write_response(strm, close_connection, req, res);
  12278. }
  12279. }
  12280. if (setup_request) { setup_request(req); }
  12281. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12282. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12283. // must be ignored. An expectation we do not recognize is left alone; the
  12284. // 417 the section allows for one is a MAY, not a requirement.
  12285. //
  12286. // `100 Continue` itself is deferred until the body is actually read (see
  12287. // read_content_core), so a request rejected by a later handler never
  12288. // invites the client to send a body nobody will read.
  12289. if (req.version != "HTTP/1.0" &&
  12290. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12291. int status = StatusCode::Continue_100;
  12292. if (expect_100_continue_handler_) {
  12293. status = expect_100_continue_handler_(req, res);
  12294. }
  12295. if (status == StatusCode::Continue_100) {
  12296. req.expect_100_continue_pending_ = true;
  12297. } else {
  12298. if (res.status == -1) { res.status = status; }
  12299. connection_closed = true;
  12300. return write_response(strm, true, req, res);
  12301. }
  12302. }
  12303. // Setup `is_connection_closed` method
  12304. auto sock = strm.socket();
  12305. req.is_connection_closed = [sock]() {
  12306. return !detail::is_socket_alive(sock);
  12307. };
  12308. // WebSocket upgrade
  12309. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12310. // that authentication and other middleware can reject the request with an
  12311. // HTTP response (e.g., 401) before the protocol switches.
  12312. if (detail::is_websocket_upgrade(req)) {
  12313. if (pre_routing_handler_ &&
  12314. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12315. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12316. return write_response_with_content(strm, close_connection, req, res);
  12317. }
  12318. // Find matching WebSocket handler
  12319. for (const auto &entry : websocket_handlers_) {
  12320. if (entry.matcher->match(req)) {
  12321. req.matched_route = entry.matcher->pattern();
  12322. if (pre_request_handler_ &&
  12323. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12324. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12325. return write_response_with_content(strm, close_connection, req, res);
  12326. }
  12327. // Compute accept key
  12328. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12329. auto accept_key = detail::websocket_accept_key(client_key);
  12330. // Negotiate subprotocol
  12331. std::string selected_subprotocol;
  12332. if (entry.sub_protocol_selector) {
  12333. auto protocol_header = detail::get_combined_header_value(
  12334. req.headers, "Sec-WebSocket-Protocol");
  12335. if (!protocol_header.empty()) {
  12336. std::vector<std::string> protocols;
  12337. detail::split(protocol_header.data(),
  12338. protocol_header.data() + protocol_header.size(), ',',
  12339. [&](const char *b, const char *e) {
  12340. protocols.emplace_back(b, e);
  12341. });
  12342. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12343. }
  12344. }
  12345. // Send 101 Switching Protocols
  12346. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12347. "Upgrade: websocket\r\n"
  12348. "Connection: Upgrade\r\n"
  12349. "Sec-WebSocket-Accept: " +
  12350. accept_key + "\r\n";
  12351. if (!selected_subprotocol.empty()) {
  12352. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12353. return false;
  12354. }
  12355. handshake_response +=
  12356. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12357. }
  12358. handshake_response += "\r\n";
  12359. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12360. 0) {
  12361. return false;
  12362. }
  12363. connection_closed = true;
  12364. if (websocket_upgraded) { *websocket_upgraded = true; }
  12365. {
  12366. #ifdef CPPHTTPLIB_SSL_ENABLED
  12367. if (req.ssl) {
  12368. // wss: the heartbeat ping thread and the read path enter the same
  12369. // TLS session from different threads. Hand the WebSocket a stream
  12370. // that serializes every TLS call, so the shared SSLSocketStream on
  12371. // the plain HTTP/HTTPS paths stays untouched.
  12372. auto ws_strm =
  12373. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12374. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12375. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12376. write_timeout_sec_, write_timeout_usec_));
  12377. ws::WebSocket ws(std::move(ws_strm), req, true,
  12378. websocket_ping_interval_sec_,
  12379. websocket_max_missed_pongs_);
  12380. entry.handler(req, ws);
  12381. return true;
  12382. }
  12383. #endif
  12384. // Use WebSocket-specific read timeout instead of HTTP timeout
  12385. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12386. 0);
  12387. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12388. websocket_max_missed_pongs_);
  12389. entry.handler(req, ws);
  12390. }
  12391. return true;
  12392. }
  12393. }
  12394. // No matching handler - fall through to 404
  12395. }
  12396. // Routing
  12397. auto routed = false;
  12398. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12399. routed = routing(req, res, strm);
  12400. #else
  12401. try {
  12402. routed = routing(req, res, strm);
  12403. } catch (std::exception &) {
  12404. if (exception_handler_) {
  12405. auto ep = std::current_exception();
  12406. exception_handler_(req, res, ep);
  12407. routed = true;
  12408. } else {
  12409. res.status = StatusCode::InternalServerError_500;
  12410. }
  12411. } catch (...) {
  12412. if (exception_handler_) {
  12413. auto ep = std::current_exception();
  12414. exception_handler_(req, res, ep);
  12415. routed = true;
  12416. } else {
  12417. res.status = StatusCode::InternalServerError_500;
  12418. }
  12419. }
  12420. #endif
  12421. auto ret = false;
  12422. if (routed) {
  12423. if (res.status == -1) {
  12424. res.status = req.ranges.empty() ? StatusCode::OK_200
  12425. : StatusCode::PartialContent_206;
  12426. }
  12427. // Serve file content by using a content provider
  12428. auto file_open_error = false;
  12429. if (!res.file_content_path_.empty()) {
  12430. const auto &path = res.file_content_path_;
  12431. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12432. if (!mm->is_open()) {
  12433. res.body.clear();
  12434. res.content_length_ = 0;
  12435. res.content_provider_ = nullptr;
  12436. res.status = StatusCode::NotFound_404;
  12437. output_error_log(Error::OpenFile, &req);
  12438. file_open_error = true;
  12439. } else {
  12440. auto content_type = res.file_content_content_type_;
  12441. if (content_type.empty()) {
  12442. content_type = detail::find_content_type(
  12443. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12444. }
  12445. detail::set_file_content_provider(
  12446. res, mm, content_type,
  12447. static_file_encoding(req, res, content_type, mm->size()));
  12448. }
  12449. }
  12450. if (file_open_error) {
  12451. ret = write_response(strm, close_connection, req, res);
  12452. } else if (detail::range_error(req, res)) {
  12453. res.body.clear();
  12454. res.content_length_ = 0;
  12455. res.content_provider_ = nullptr;
  12456. res.status = StatusCode::RangeNotSatisfiable_416;
  12457. ret = write_response(strm, close_connection, req, res);
  12458. } else {
  12459. ret = write_response_with_content(strm, close_connection, req, res);
  12460. }
  12461. } else {
  12462. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12463. ret = write_response(strm, close_connection, req, res);
  12464. }
  12465. // Drain any unconsumed framed body to prevent request smuggling on
  12466. // keep-alive. Without framing there is no body to drain — reading would
  12467. // consume the next request (issue #2450). If the response has committed the
  12468. // connection to close, there is no next request to protect.
  12469. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12470. !detail::has_header_token(res.headers, "Connection", "close")) {
  12471. int dummy_status;
  12472. if (!detail::read_content(
  12473. strm, req, payload_max_length_, dummy_status, nullptr,
  12474. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12475. connection_closed = true;
  12476. }
  12477. }
  12478. return ret;
  12479. }
  12480. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12481. inline bool Server::process_and_close_socket(socket_t sock) {
  12482. std::string remote_addr;
  12483. int remote_port = 0;
  12484. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12485. std::string local_addr;
  12486. int local_port = 0;
  12487. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12488. bool websocket_upgraded = false;
  12489. auto ret = serve_guarded([&]() {
  12490. return detail::process_server_socket(
  12491. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12492. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12493. write_timeout_usec_,
  12494. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12495. return process_request(strm, remote_addr, remote_port, local_addr,
  12496. local_port, close_connection,
  12497. connection_closed, nullptr,
  12498. &websocket_upgraded);
  12499. });
  12500. });
  12501. detail::drain_and_close_socket(sock);
  12502. return ret;
  12503. }
  12504. inline void Server::output_log(const Request &req, const Response &res) const {
  12505. if (logger_) {
  12506. std::lock_guard<std::mutex> guard(logger_mutex_);
  12507. logger_(req, res);
  12508. }
  12509. }
  12510. inline void Server::output_pre_compression_log(const Request &req,
  12511. const Response &res) const {
  12512. if (pre_compression_logger_) {
  12513. std::lock_guard<std::mutex> guard(logger_mutex_);
  12514. pre_compression_logger_(req, res);
  12515. }
  12516. }
  12517. inline void Server::output_error_log(const Error &err,
  12518. const Request *req) const {
  12519. if (error_logger_) {
  12520. std::lock_guard<std::mutex> guard(logger_mutex_);
  12521. error_logger_(err, req);
  12522. }
  12523. }
  12524. /*
  12525. * Group 5: ClientImpl and Client (Universal) implementation
  12526. */
  12527. // HTTP client implementation
  12528. inline ClientImpl::ClientImpl(const std::string &host)
  12529. : ClientImpl(host, 80, std::string(), std::string()) {}
  12530. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12531. : ClientImpl(host, port, std::string(), std::string()) {}
  12532. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12533. const std::string &client_cert_path,
  12534. const std::string &client_key_path)
  12535. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12536. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12537. inline ClientImpl::~ClientImpl() {
  12538. // Wait until all the requests in flight are handled.
  12539. size_t retry_count = 10;
  12540. while (retry_count-- > 0) {
  12541. {
  12542. std::lock_guard<std::mutex> guard(socket_mutex_);
  12543. if (socket_requests_in_flight_ == 0) { break; }
  12544. }
  12545. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12546. }
  12547. std::lock_guard<std::mutex> guard(socket_mutex_);
  12548. shutdown_socket(socket_);
  12549. close_socket(socket_);
  12550. }
  12551. inline bool ClientImpl::is_valid() const { return true; }
  12552. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12553. client_cert_path_ = rhs.client_cert_path_;
  12554. client_key_path_ = rhs.client_key_path_;
  12555. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12556. read_timeout_sec_ = rhs.read_timeout_sec_;
  12557. read_timeout_usec_ = rhs.read_timeout_usec_;
  12558. write_timeout_sec_ = rhs.write_timeout_sec_;
  12559. write_timeout_usec_ = rhs.write_timeout_usec_;
  12560. max_timeout_msec_ = rhs.max_timeout_msec_;
  12561. basic_auth_username_ = rhs.basic_auth_username_;
  12562. basic_auth_password_ = rhs.basic_auth_password_;
  12563. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12564. keep_alive_ = rhs.keep_alive_;
  12565. follow_location_ = rhs.follow_location_;
  12566. path_encode_ = rhs.path_encode_;
  12567. address_family_ = rhs.address_family_;
  12568. tcp_nodelay_ = rhs.tcp_nodelay_;
  12569. ipv6_v6only_ = rhs.ipv6_v6only_;
  12570. socket_options_ = rhs.socket_options_;
  12571. compress_ = rhs.compress_;
  12572. decompress_ = rhs.decompress_;
  12573. payload_max_length_ = rhs.payload_max_length_;
  12574. has_payload_max_length_ = rhs.has_payload_max_length_;
  12575. interface_ = rhs.interface_;
  12576. proxy_host_ = rhs.proxy_host_;
  12577. proxy_port_ = rhs.proxy_port_;
  12578. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12579. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12580. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12581. no_proxy_entries_ = rhs.no_proxy_entries_;
  12582. logger_ = rhs.logger_;
  12583. error_logger_ = rhs.error_logger_;
  12584. #ifdef CPPHTTPLIB_SSL_ENABLED
  12585. digest_auth_username_ = rhs.digest_auth_username_;
  12586. digest_auth_password_ = rhs.digest_auth_password_;
  12587. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12588. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12589. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12590. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12591. server_certificate_verification_ = rhs.server_certificate_verification_;
  12592. server_hostname_verification_ = rhs.server_hostname_verification_;
  12593. system_ca_mode_ = rhs.system_ca_mode_;
  12594. #endif
  12595. }
  12596. inline bool
  12597. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12598. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12599. if (no_proxy_entries_.empty()) { return true; }
  12600. // host_ is const so its normalized form is invariant; cache it. The
  12601. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12602. if (host == host_) {
  12603. if (!host_normalized_valid_) {
  12604. host_normalized_ = detail::normalize_target(host_);
  12605. host_normalized_valid_ = true;
  12606. }
  12607. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12608. }
  12609. auto target = detail::normalize_target(host);
  12610. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12611. }
  12612. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12613. if (is_proxy_enabled_for_host(host_)) {
  12614. return detail::create_client_socket(
  12615. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12616. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12617. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12618. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12619. }
  12620. // Check is custom IP or hostname specified for host_
  12621. std::string connect_host;
  12622. std::string ip;
  12623. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12624. return detail::create_client_socket(
  12625. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12626. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12627. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12628. write_timeout_usec_, interface_, error);
  12629. }
  12630. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12631. Error &error) {
  12632. auto sock = create_client_socket(error);
  12633. if (sock == INVALID_SOCKET) { return false; }
  12634. socket.sock = sock;
  12635. return true;
  12636. }
  12637. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12638. return create_and_connect_socket(socket, error);
  12639. }
  12640. inline bool ClientImpl::setup_proxy_connection(
  12641. Socket & /*socket*/,
  12642. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12643. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12644. return true;
  12645. }
  12646. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12647. bool /*shutdown_gracefully*/) {
  12648. // If there are any requests in flight from threads other than us, then it's
  12649. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12650. assert(socket_requests_in_flight_ == 0 ||
  12651. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12652. }
  12653. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12654. if (socket.sock == INVALID_SOCKET) { return; }
  12655. detail::shutdown_socket(socket.sock);
  12656. }
  12657. inline void ClientImpl::close_socket(Socket &socket) {
  12658. // If there are requests in flight in another thread, usually closing
  12659. // the socket will be fine and they will simply receive an error when
  12660. // using the closed socket, but it is still a bug since rarely the OS
  12661. // may reassign the socket id to be used for a new socket, and then
  12662. // suddenly they will be operating on a live socket that is different
  12663. // than the one they intended!
  12664. assert(socket_requests_in_flight_ == 0 ||
  12665. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12666. // It is also a bug if this happens while SSL is still active
  12667. #ifdef CPPHTTPLIB_SSL_ENABLED
  12668. assert(socket.ssl == nullptr);
  12669. #endif
  12670. if (socket.sock == INVALID_SOCKET) { return; }
  12671. detail::close_socket(socket.sock);
  12672. socket.sock = INVALID_SOCKET;
  12673. }
  12674. inline void ClientImpl::disconnect(bool gracefully) {
  12675. shutdown_ssl(socket_, gracefully);
  12676. shutdown_socket(socket_);
  12677. close_socket(socket_);
  12678. }
  12679. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12680. Response &res,
  12681. bool skip_100_continue) const {
  12682. std::array<char, 2048> buf{};
  12683. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12684. if (!line_reader.getline()) { return false; }
  12685. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12686. res.reason)) {
  12687. return req.method == "CONNECT";
  12688. }
  12689. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12690. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12691. if (!line_reader.getline()) { return false; } // CRLF
  12692. if (!line_reader.getline()) { return false; } // next response line
  12693. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12694. res.reason)) {
  12695. return false;
  12696. }
  12697. }
  12698. return true;
  12699. }
  12700. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12701. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12702. auto ret = send_(req, res, error);
  12703. if (error == Error::SSLPeerCouldBeClosed_) {
  12704. assert(!ret);
  12705. ret = send_(req, res, error);
  12706. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12707. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12708. }
  12709. return ret;
  12710. }
  12711. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12712. {
  12713. std::lock_guard<std::mutex> guard(socket_mutex_);
  12714. // Set this to false immediately - if it ever gets set to true by the end
  12715. // of the request, we know another thread instructed us to close the
  12716. // socket.
  12717. socket_should_be_closed_when_request_is_done_ = false;
  12718. auto is_alive = false;
  12719. if (socket_.is_open()) {
  12720. is_alive = detail::is_socket_alive(socket_.sock);
  12721. #ifdef CPPHTTPLIB_SSL_ENABLED
  12722. if (is_alive && is_ssl()) {
  12723. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12724. is_alive = false;
  12725. }
  12726. }
  12727. #endif
  12728. if (!is_alive) {
  12729. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12730. disconnect(/*gracefully=*/false);
  12731. }
  12732. }
  12733. if (!is_alive) {
  12734. if (!ensure_socket_connection(socket_, error)) {
  12735. output_error_log(error, &req);
  12736. return false;
  12737. }
  12738. {
  12739. auto success = true;
  12740. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12741. error)) {
  12742. if (!success) { output_error_log(error, &req); }
  12743. return success;
  12744. }
  12745. }
  12746. }
  12747. // Mark the current socket as being in use so that it cannot be closed by
  12748. // anyone else while this request is ongoing, even though we will be
  12749. // releasing the mutex.
  12750. if (socket_requests_in_flight_ > 1) {
  12751. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12752. }
  12753. socket_requests_in_flight_ += 1;
  12754. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12755. }
  12756. for (const auto &header : default_headers_) {
  12757. if (req.headers.find(header.first) == req.headers.end()) {
  12758. req.headers.insert(header);
  12759. }
  12760. }
  12761. auto ret = false;
  12762. auto close_connection = !keep_alive_;
  12763. auto se = detail::scope_exit([&]() {
  12764. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12765. std::lock_guard<std::mutex> guard(socket_mutex_);
  12766. socket_requests_in_flight_ -= 1;
  12767. if (socket_requests_in_flight_ <= 0) {
  12768. assert(socket_requests_in_flight_ == 0);
  12769. socket_requests_are_from_thread_ = std::thread::id();
  12770. }
  12771. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12772. !ret) {
  12773. disconnect(/*gracefully=*/true);
  12774. }
  12775. });
  12776. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12777. return handle_request(strm, req, res, close_connection, error);
  12778. });
  12779. if (!ret) {
  12780. if (error == Error::Success) {
  12781. error = Error::Unknown;
  12782. output_error_log(error, &req);
  12783. }
  12784. }
  12785. return ret;
  12786. }
  12787. inline Result ClientImpl::send(const Request &req) {
  12788. auto req2 = req;
  12789. return send_(std::move(req2));
  12790. }
  12791. inline Result ClientImpl::send_(Request &&req) {
  12792. auto res = detail::make_unique<Response>();
  12793. auto error = Error::Success;
  12794. auto ret = send(req, *res, error);
  12795. #ifdef CPPHTTPLIB_SSL_ENABLED
  12796. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12797. last_ssl_error_, last_backend_error_};
  12798. #else
  12799. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12800. #endif
  12801. }
  12802. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12803. const std::string &ct) {
  12804. (void)for_stream;
  12805. // Default headers are meant for the origin and may carry its credentials, so
  12806. // keep them off the CONNECT request the proxy reads.
  12807. if (r.method != "CONNECT") {
  12808. for (const auto &header : default_headers_) {
  12809. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12810. }
  12811. }
  12812. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12813. // prepend it rather than appending it after the caller's own fields.
  12814. if (!r.has_header("Host")) {
  12815. r.headers.emplace_front(
  12816. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12817. address_family_));
  12818. }
  12819. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12820. if (!r.content_receiver) {
  12821. if (!r.has_header("Accept-Encoding")) {
  12822. std::string accept_encoding;
  12823. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12824. accept_encoding = "br";
  12825. #endif
  12826. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12827. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12828. accept_encoding += "gzip, deflate";
  12829. #endif
  12830. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12831. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12832. accept_encoding += "zstd";
  12833. #endif
  12834. r.set_header("Accept-Encoding", accept_encoding);
  12835. }
  12836. detail::add_default_user_agent_header(r);
  12837. }
  12838. if (!r.body.empty()) {
  12839. if (!ct.empty() && !r.has_header("Content-Type")) {
  12840. r.headers.emplace("Content-Type", ct);
  12841. }
  12842. if (!r.has_header("Content-Length")) {
  12843. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12844. }
  12845. }
  12846. }
  12847. inline ClientImpl::StreamHandle
  12848. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12849. const Params &params, const Headers &headers,
  12850. const std::string &body,
  12851. const std::string &content_type) {
  12852. StreamHandle handle;
  12853. handle.response = detail::make_unique<Response>();
  12854. handle.error = Error::Success;
  12855. // Encode the target exactly like the buffered send path does, so that the
  12856. // same `path` produces the same request line through either API.
  12857. auto raw_query_path =
  12858. params.empty() ? path : append_query_params(path, params);
  12859. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12860. handle.connection_ = detail::make_unique<ClientConnection>();
  12861. {
  12862. std::lock_guard<std::mutex> guard(socket_mutex_);
  12863. auto is_alive = false;
  12864. if (socket_.is_open()) {
  12865. is_alive = detail::is_socket_alive(socket_.sock);
  12866. #ifdef CPPHTTPLIB_SSL_ENABLED
  12867. if (is_alive && is_ssl()) {
  12868. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12869. is_alive = false;
  12870. }
  12871. }
  12872. #endif
  12873. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12874. }
  12875. if (!is_alive) {
  12876. if (!ensure_socket_connection(socket_, handle.error)) {
  12877. handle.response.reset();
  12878. return handle;
  12879. }
  12880. {
  12881. auto success = true;
  12882. auto start_time = std::chrono::steady_clock::now();
  12883. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12884. success, handle.error)) {
  12885. if (!success) { handle.response.reset(); }
  12886. return handle;
  12887. }
  12888. }
  12889. }
  12890. transfer_socket_ownership_to_handle(handle);
  12891. }
  12892. #ifdef CPPHTTPLIB_SSL_ENABLED
  12893. if (is_ssl() && handle.connection_->session) {
  12894. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12895. handle.connection_->sock, handle.connection_->session,
  12896. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12897. write_timeout_usec_);
  12898. } else {
  12899. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12900. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12901. write_timeout_sec_, write_timeout_usec_);
  12902. }
  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. #endif
  12908. handle.stream_ = handle.socket_stream_.get();
  12909. Request req;
  12910. req.method = method;
  12911. req.path = query_path;
  12912. req.headers = headers;
  12913. req.body = body;
  12914. prepare_default_headers(req, true, content_type);
  12915. auto &strm = *handle.stream_;
  12916. // Build the request line and headers in memory first, like write_request()
  12917. // does, so that a rejected header leaves nothing on the wire.
  12918. {
  12919. detail::BufferStream bstrm;
  12920. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12921. handle.error = Error::Write;
  12922. handle.response.reset();
  12923. return handle;
  12924. }
  12925. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12926. handle.error)) {
  12927. handle.response.reset();
  12928. return handle;
  12929. }
  12930. const auto &data = bstrm.get_buffer();
  12931. if (!detail::write_data(strm, data.data(), data.size())) {
  12932. handle.error = Error::Write;
  12933. handle.response.reset();
  12934. return handle;
  12935. }
  12936. }
  12937. if (!body.empty()) {
  12938. if (strm.write(body.data(), body.size()) < 0) {
  12939. handle.error = Error::Write;
  12940. handle.response.reset();
  12941. return handle;
  12942. }
  12943. }
  12944. if (!read_response_line(strm, req, *handle.response) ||
  12945. !detail::read_headers(strm, handle.response->headers)) {
  12946. handle.error = Error::Read;
  12947. handle.response.reset();
  12948. return handle;
  12949. }
  12950. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  12951. // (204/304) response legitimately carries framing headers with no body.
  12952. if (method != "HEAD" &&
  12953. handle.response->status != StatusCode::NoContent_204 &&
  12954. handle.response->status != StatusCode::NotModified_304 &&
  12955. detail::has_conflicting_content_length(handle.response->headers)) {
  12956. handle.error = Error::Read;
  12957. handle.response.reset();
  12958. return handle;
  12959. }
  12960. handle.body_reader_.stream = handle.stream_;
  12961. handle.body_reader_.payload_max_length = payload_max_length_;
  12962. if (handle.response->has_header("Content-Length")) {
  12963. bool is_invalid = false;
  12964. auto content_length = detail::get_header_value_u64(
  12965. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12966. if (is_invalid) {
  12967. handle.error = Error::Read;
  12968. handle.response.reset();
  12969. return handle;
  12970. }
  12971. handle.body_reader_.has_content_length = true;
  12972. handle.body_reader_.content_length = content_length;
  12973. }
  12974. handle.body_reader_.chunked =
  12975. detail::is_chunked_transfer_encoding(handle.response->headers);
  12976. auto content_encoding = detail::get_combined_header_value(
  12977. handle.response->headers, "Content-Encoding");
  12978. if (!content_encoding.empty()) {
  12979. // Same policy as prepare_content_receiver(): reject a coding we know about
  12980. // but were not built with, pass an unrecognized one through as-is.
  12981. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12982. if (!handle.decompressor_) {
  12983. if (detail::is_known_content_encoding(content_encoding)) {
  12984. handle.error = Error::UnsupportedContentEncoding;
  12985. handle.response.reset();
  12986. return handle;
  12987. }
  12988. } else if (!handle.decompressor_->is_valid()) {
  12989. handle.error = Error::Compression;
  12990. handle.response.reset();
  12991. return handle;
  12992. }
  12993. }
  12994. return handle;
  12995. }
  12996. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12997. if (!is_valid() || !response) { return -1; }
  12998. if (decompressor_) { return read_with_decompression(buf, len); }
  12999. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13000. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13001. trailers_parsed_ = true;
  13002. if (body_reader_.chunked_decoder) {
  13003. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13004. response->trailers, response->headers)) {
  13005. return n;
  13006. }
  13007. } else {
  13008. detail::ChunkedDecoder dec(*stream_);
  13009. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13010. return n;
  13011. }
  13012. }
  13013. }
  13014. return n;
  13015. }
  13016. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13017. size_t len) {
  13018. if (decompress_offset_ < decompress_buffer_.size()) {
  13019. auto available = decompress_buffer_.size() - decompress_offset_;
  13020. auto to_copy = (std::min)(len, available);
  13021. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13022. decompress_offset_ += to_copy;
  13023. decompressed_bytes_read_ += to_copy;
  13024. return static_cast<ssize_t>(to_copy);
  13025. }
  13026. decompress_buffer_.clear();
  13027. decompress_offset_ = 0;
  13028. constexpr size_t kDecompressionBufferSize = 8192;
  13029. char compressed_buf[kDecompressionBufferSize];
  13030. while (true) {
  13031. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13032. sizeof(compressed_buf));
  13033. if (n <= 0) { return n; }
  13034. bool decompress_ok = decompressor_->decompress(
  13035. compressed_buf, static_cast<size_t>(n),
  13036. [this](const char *data, size_t data_len) {
  13037. decompress_buffer_.append(data, data_len);
  13038. auto limit = body_reader_.payload_max_length;
  13039. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13040. return false;
  13041. }
  13042. return true;
  13043. });
  13044. if (!decompress_ok) {
  13045. body_reader_.last_error = Error::Read;
  13046. return -1;
  13047. }
  13048. if (!decompress_buffer_.empty()) { break; }
  13049. }
  13050. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13051. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13052. decompress_offset_ = to_copy;
  13053. decompressed_bytes_read_ += to_copy;
  13054. return static_cast<ssize_t>(to_copy);
  13055. }
  13056. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13057. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13058. return;
  13059. }
  13060. trailers_parsed_ = true;
  13061. const auto bufsiz = 128;
  13062. char line_buf[bufsiz];
  13063. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13064. if (!line_reader.getline()) { return; }
  13065. if (!detail::parse_trailers(line_reader, response->trailers,
  13066. response->headers)) {
  13067. return;
  13068. }
  13069. }
  13070. namespace detail {
  13071. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13072. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13073. size_t &out_chunk_offset,
  13074. size_t &out_chunk_total) {
  13075. if (finished) { return 0; }
  13076. if (chunk_remaining == 0) {
  13077. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13078. if (!lr.getline()) { return -1; }
  13079. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13080. // the line terminator is never mistaken for line content.
  13081. const char *eol = lr.ptr() + lr.size();
  13082. if (lr.end_with_crlf()) {
  13083. eol -= 2;
  13084. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13085. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13086. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13087. // has to come off here or the check below would reject the line.
  13088. eol -= 1;
  13089. }
  13090. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13091. const char *p = lr.ptr();
  13092. int v = 0;
  13093. if (p == eol || !is_hex(*p, v)) { return -1; }
  13094. size_t chunk_len = 0;
  13095. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13096. for (; p < eol && is_hex(*p, v); ++p) {
  13097. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13098. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13099. }
  13100. while (p < eol && is_space_or_tab(*p)) {
  13101. ++p;
  13102. }
  13103. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13104. // terminator, and it is built from tokens and quoted-strings, so it never
  13105. // holds a CR, LF or any other control character. getline() reads up to the
  13106. // CRLF, so a bare LF left in here would be swallowed as extension text
  13107. // while an intermediary that ends the line on it delimits the chunks
  13108. // differently, and the two disagree on where the body ends (request
  13109. // smuggling).
  13110. if (p < eol && *p != ';') { return -1; }
  13111. for (; p < eol; ++p) {
  13112. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13113. }
  13114. if (chunk_len == 0) {
  13115. chunk_remaining = 0;
  13116. finished = true;
  13117. out_chunk_offset = 0;
  13118. out_chunk_total = 0;
  13119. return 0;
  13120. }
  13121. chunk_remaining = chunk_len;
  13122. last_chunk_total = chunk_remaining;
  13123. last_chunk_offset = 0;
  13124. }
  13125. auto to_read = (std::min)(chunk_remaining, len);
  13126. auto n = strm.read(buf, to_read);
  13127. if (n <= 0) { return -1; }
  13128. auto offset_before = last_chunk_offset;
  13129. last_chunk_offset += static_cast<size_t>(n);
  13130. chunk_remaining -= static_cast<size_t>(n);
  13131. out_chunk_offset = offset_before;
  13132. out_chunk_total = last_chunk_total;
  13133. if (chunk_remaining == 0) {
  13134. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13135. if (!lr.getline()) { return -1; }
  13136. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13137. }
  13138. return n;
  13139. }
  13140. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13141. const Headers &src_headers) {
  13142. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13143. if (!lr.getline()) { return false; }
  13144. return parse_trailers(lr, dest, src_headers);
  13145. }
  13146. } // namespace detail
  13147. inline void
  13148. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13149. handle.connection_->sock = socket_.sock;
  13150. #ifdef CPPHTTPLIB_SSL_ENABLED
  13151. handle.connection_->session = socket_.ssl;
  13152. socket_.ssl = nullptr;
  13153. #endif
  13154. socket_.sock = INVALID_SOCKET;
  13155. }
  13156. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13157. Response &res, bool close_connection,
  13158. Error &error) {
  13159. if (req.path.empty()) {
  13160. error = Error::Connection;
  13161. output_error_log(error, &req);
  13162. return false;
  13163. }
  13164. auto req_save = req;
  13165. bool ret;
  13166. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13167. auto req2 = req;
  13168. req2.path = "http://" +
  13169. detail::make_host_and_port_string(host_, port_, false) +
  13170. req.path;
  13171. ret = process_request(strm, req2, res, close_connection, error);
  13172. req = std::move(req2);
  13173. req.path = req_save.path;
  13174. } else {
  13175. ret = process_request(strm, req, res, close_connection, error);
  13176. }
  13177. if (!ret) { return false; }
  13178. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13179. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13180. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13181. // for this to be safe.
  13182. // This is safe to call because handle_request is only called by send_
  13183. // which locks the request mutex during the process. It would be a bug
  13184. // to call it from a different thread since it's a thread-safety issue
  13185. // to do these things to the socket if another thread is using the socket.
  13186. std::lock_guard<std::mutex> guard(socket_mutex_);
  13187. disconnect(/*gracefully=*/true);
  13188. }
  13189. if (300 < res.status && res.status < 400 && follow_location_) {
  13190. req = std::move(req_save);
  13191. ret = redirect(req, res, error);
  13192. }
  13193. #ifdef CPPHTTPLIB_SSL_ENABLED
  13194. if ((res.status == StatusCode::Unauthorized_401 ||
  13195. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13196. req.authorization_count_ < 5) {
  13197. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13198. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13199. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13200. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13201. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13202. return ret;
  13203. }
  13204. const auto &username =
  13205. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13206. const auto &password =
  13207. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13208. if (!username.empty() && !password.empty()) {
  13209. std::map<std::string, std::string> auth;
  13210. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13211. Request new_req = req;
  13212. new_req.authorization_count_ += 1;
  13213. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13214. : "Authorization");
  13215. new_req.headers.insert(detail::make_digest_authentication_header(
  13216. req, auth, new_req.authorization_count_, detail::random_string(10),
  13217. username, password, is_proxy));
  13218. Response new_res;
  13219. ret = send(new_req, new_res, error);
  13220. if (ret) { res = std::move(new_res); }
  13221. }
  13222. }
  13223. }
  13224. #endif
  13225. return ret;
  13226. }
  13227. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13228. if (req.redirect_count_ == 0) {
  13229. error = Error::ExceedRedirectCount;
  13230. output_error_log(error, &req);
  13231. return false;
  13232. }
  13233. auto location = res.get_header_value("location");
  13234. if (location.empty()) { return false; }
  13235. detail::UrlComponents uc;
  13236. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13237. uc)) {
  13238. return false;
  13239. }
  13240. // Only follow http/https redirects
  13241. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13242. return false;
  13243. }
  13244. auto scheme = is_ssl() ? "https" : "http";
  13245. auto next_scheme = std::move(uc.scheme);
  13246. auto next_host = std::move(uc.host);
  13247. auto port_str = std::move(uc.port);
  13248. auto next_path = std::move(uc.path);
  13249. auto next_query = std::move(uc.query);
  13250. auto next_port = port_;
  13251. if (!port_str.empty()) {
  13252. if (!detail::parse_port(port_str, next_port)) { return false; }
  13253. } else if (!next_scheme.empty()) {
  13254. next_port = next_scheme == "https" ? 443 : 80;
  13255. }
  13256. if (next_scheme.empty()) { next_scheme = scheme; }
  13257. if (next_host.empty()) { next_host = host_; }
  13258. if (next_path.empty()) { next_path = "/"; }
  13259. auto path = decode_path_component(next_path) + next_query;
  13260. // Same host redirect - use current client
  13261. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13262. return detail::redirect(*this, req, res, path, location, error);
  13263. }
  13264. // Cross-host/scheme redirect - create new client with robust setup
  13265. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13266. path, location, error);
  13267. }
  13268. // New method for robust redirect client creation
  13269. inline bool ClientImpl::create_redirect_client(
  13270. const std::string &scheme, const std::string &host, int port, Request &req,
  13271. Response &res, const std::string &path, const std::string &location,
  13272. Error &error) {
  13273. // Determine if we need SSL
  13274. auto need_ssl = (scheme == "https");
  13275. // Clean up request headers that are host/client specific
  13276. // Remove headers that should not be carried over to new host
  13277. auto headers_to_remove = std::vector<std::string>{
  13278. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13279. for (const auto &header_name : headers_to_remove) {
  13280. auto it = req.headers.find(header_name);
  13281. while (it != req.headers.end()) {
  13282. it = req.headers.erase(it);
  13283. it = req.headers.find(header_name);
  13284. }
  13285. }
  13286. // Create appropriate client type and handle redirect
  13287. if (need_ssl) {
  13288. #ifdef CPPHTTPLIB_SSL_ENABLED
  13289. // Create SSL client for HTTPS redirect
  13290. SSLClient redirect_client(host, port);
  13291. // Setup basic client configuration first
  13292. setup_redirect_client(redirect_client);
  13293. redirect_client.enable_server_certificate_verification(
  13294. server_certificate_verification_);
  13295. redirect_client.enable_server_hostname_verification(
  13296. server_hostname_verification_);
  13297. redirect_client.system_ca_mode_ = system_ca_mode_;
  13298. // Transfer CA certificate to redirect client
  13299. if (!ca_cert_pem_.empty()) {
  13300. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13301. ca_cert_pem_.size());
  13302. }
  13303. if (!ca_cert_file_path_.empty()) {
  13304. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13305. }
  13306. // Client certificates are set through constructor for SSLClient
  13307. // NOTE: SSLClient constructor already takes client_cert_path and
  13308. // client_key_path so we need to create it properly if client certs are
  13309. // needed
  13310. // Execute the redirect
  13311. return detail::redirect(redirect_client, req, res, path, location, error);
  13312. #else
  13313. // SSL not supported - set appropriate error
  13314. error = Error::SSLConnection;
  13315. output_error_log(error, &req);
  13316. return false;
  13317. #endif
  13318. } else {
  13319. // HTTP redirect
  13320. ClientImpl redirect_client(host, port);
  13321. // Setup client with robust configuration
  13322. setup_redirect_client(redirect_client);
  13323. // Execute the redirect
  13324. return detail::redirect(redirect_client, req, res, path, location, error);
  13325. }
  13326. }
  13327. // New method for robust client setup (based on basic_manual_redirect.cpp
  13328. // logic)
  13329. template <typename ClientType>
  13330. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13331. // Copy basic settings first
  13332. client.set_connection_timeout(connection_timeout_sec_);
  13333. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13334. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13335. client.set_keep_alive(keep_alive_);
  13336. client.set_follow_location(
  13337. true); // Enable redirects to handle multi-step redirects
  13338. client.set_path_encode(path_encode_);
  13339. client.set_compress(compress_);
  13340. client.set_decompress(decompress_);
  13341. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13342. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13343. // 15.4, credentials must not be forwarded when redirecting to a different
  13344. // host. This function is only called for cross-host redirects; same-host
  13345. // redirects are handled directly in ClientImpl::redirect().
  13346. // Copy the proxy configuration unconditionally; the per-target bypass is
  13347. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13348. // still use the proxy.
  13349. client.no_proxy_entries_ = no_proxy_entries_;
  13350. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13351. client.set_proxy(proxy_host_, proxy_port_);
  13352. if (!proxy_basic_auth_username_.empty()) {
  13353. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13354. proxy_basic_auth_password_);
  13355. }
  13356. if (!proxy_bearer_token_auth_token_.empty()) {
  13357. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13358. }
  13359. #ifdef CPPHTTPLIB_SSL_ENABLED
  13360. if (!proxy_digest_auth_username_.empty()) {
  13361. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13362. proxy_digest_auth_password_);
  13363. }
  13364. #endif
  13365. }
  13366. // Copy network and socket settings
  13367. client.set_address_family(address_family_);
  13368. client.set_tcp_nodelay(tcp_nodelay_);
  13369. client.set_ipv6_v6only(ipv6_v6only_);
  13370. if (socket_options_) { client.set_socket_options(socket_options_); }
  13371. if (!interface_.empty()) { client.set_interface(interface_); }
  13372. // Copy logging and headers
  13373. if (logger_) { client.set_logger(logger_); }
  13374. if (error_logger_) { client.set_error_logger(error_logger_); }
  13375. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13376. // Each new client should generate its own headers based on its target host
  13377. }
  13378. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13379. const Request &req,
  13380. Error &error) const {
  13381. auto is_shutting_down = []() { return false; };
  13382. if (req.is_chunked_content_provider_) {
  13383. auto compressor = compress_ ? detail::create_compressor().first
  13384. : std::unique_ptr<detail::compressor>();
  13385. if (!compressor) {
  13386. compressor = detail::make_unique<detail::nocompressor>();
  13387. }
  13388. return detail::write_content_chunked(strm, req.content_provider_,
  13389. is_shutting_down, *compressor, error);
  13390. } else {
  13391. return detail::write_content_with_progress(
  13392. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13393. req.upload_progress, error);
  13394. }
  13395. }
  13396. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13397. bool close_connection, Error &error,
  13398. bool skip_body, bool &rejected_locally) {
  13399. rejected_locally = false;
  13400. // Prepare additional headers
  13401. if (close_connection) {
  13402. if (!req.has_header("Connection")) {
  13403. req.set_header("Connection", "close");
  13404. }
  13405. }
  13406. std::string ct_for_defaults;
  13407. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13408. ct_for_defaults = "text/plain";
  13409. }
  13410. prepare_default_headers(req, false, ct_for_defaults);
  13411. if (req.body.empty()) {
  13412. if (req.content_provider_) {
  13413. if (!req.is_chunked_content_provider_) {
  13414. if (!req.has_header("Content-Length")) {
  13415. auto length = std::to_string(req.content_length_);
  13416. req.set_header("Content-Length", length);
  13417. }
  13418. }
  13419. } else {
  13420. if (req.method == "POST" || req.method == "PUT" ||
  13421. req.method == "PATCH") {
  13422. req.set_header("Content-Length", "0");
  13423. }
  13424. }
  13425. }
  13426. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13427. // it opens is read by the origin. Each credential goes only to its own hop.
  13428. auto is_connect = req.method == "CONNECT";
  13429. if (!is_connect && !req.has_header("Authorization")) {
  13430. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13431. req.headers.insert(make_basic_authentication_header(
  13432. basic_auth_username_, basic_auth_password_, false));
  13433. } else if (!bearer_token_auth_token_.empty()) {
  13434. req.headers.insert(make_bearer_token_authentication_header(
  13435. bearer_token_auth_token_, false));
  13436. }
  13437. }
  13438. // Proxy-Authorization is only sent when the proxy reads this message —
  13439. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13440. // would leak proxy credentials to the destination server.
  13441. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13442. if (!proxy_basic_auth_username_.empty() &&
  13443. !proxy_basic_auth_password_.empty() &&
  13444. !req.has_header("Proxy-Authorization")) {
  13445. req.headers.insert(make_basic_authentication_header(
  13446. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13447. }
  13448. if (!proxy_bearer_token_auth_token_.empty() &&
  13449. !req.has_header("Proxy-Authorization")) {
  13450. req.headers.insert(make_bearer_token_authentication_header(
  13451. proxy_bearer_token_auth_token_, true));
  13452. }
  13453. }
  13454. // Request line and headers
  13455. {
  13456. detail::BufferStream bstrm;
  13457. // Extract the query from req.path. The encoding itself is delegated to
  13458. // `encode_request_target`; the raw query is still needed here to decide
  13459. // between populating `req.params` from it and falling back to building a
  13460. // query out of caller-supplied `req.params`.
  13461. auto query_pos = req.path.find('?');
  13462. auto query_part = query_pos == std::string::npos
  13463. ? std::string()
  13464. : req.path.substr(query_pos + 1);
  13465. auto path_with_query =
  13466. detail::encode_request_target(req.path, path_encode_);
  13467. if (!query_part.empty()) {
  13468. // The query already came in through `req.path`; still populate
  13469. // `req.params` for handlers/users who read them.
  13470. detail::parse_query_text(query_part, req.params);
  13471. } else if (!req.params.empty()) {
  13472. // No query in `req.path`; build one from `req.params` so existing
  13473. // callers that pass `Params` separately continue to work.
  13474. path_with_query = append_query_params(path_with_query, req.params);
  13475. }
  13476. // Write request line and headers
  13477. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13478. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13479. // CR/LF smuggled in via a decoded redirect Location under
  13480. // set_path_encode(false)) must fail the request cleanly instead of
  13481. // emitting a request-line-less, header-injecting request.
  13482. error = Error::Write;
  13483. rejected_locally = true;
  13484. output_error_log(error, &req);
  13485. return false;
  13486. }
  13487. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13488. error)) {
  13489. rejected_locally = true;
  13490. output_error_log(error, &req);
  13491. return false;
  13492. }
  13493. // Flush buffer
  13494. auto &data = bstrm.get_buffer();
  13495. if (!detail::write_data(strm, data.data(), data.size())) {
  13496. error = Error::Write;
  13497. output_error_log(error, &req);
  13498. return false;
  13499. }
  13500. }
  13501. // After sending request line and headers, wait briefly for an early server
  13502. // response (e.g. 4xx) and avoid sending a potentially large request body
  13503. // unnecessarily. This workaround is only enabled on Windows because Unix
  13504. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13505. // buffering can accept large writes even when the peer already responded.
  13506. // Check the stream first (which covers SSL via `is_readable()`), then
  13507. // fall back to select on the socket. Only perform the wait for very large
  13508. // request bodies to avoid interfering with normal small requests and
  13509. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13510. // response. Skip this check when using Expect: 100-continue, as the protocol
  13511. // handles early responses properly.
  13512. #if defined(_WIN32)
  13513. if (!skip_body &&
  13514. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13515. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13516. auto start = std::chrono::high_resolution_clock::now();
  13517. for (;;) {
  13518. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13519. // from SSL internals. If the underlying socket is readable, assume an
  13520. // early response may be present.
  13521. auto sock = strm.socket();
  13522. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13523. return false;
  13524. }
  13525. // Fallback to stream-level check for non-socket streams or when the
  13526. // socket isn't reporting readable. Avoid using `is_readable()` for
  13527. // SSL, since `SSL_pending()` may report buffered records that do not
  13528. // indicate a complete application-level response yet.
  13529. if (!is_ssl() && strm.is_readable()) { return false; }
  13530. auto now = std::chrono::high_resolution_clock::now();
  13531. auto elapsed =
  13532. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13533. .count();
  13534. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13535. break;
  13536. }
  13537. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13538. }
  13539. }
  13540. #endif
  13541. // Body
  13542. if (skip_body) { return true; }
  13543. return write_request_body(strm, req, error);
  13544. }
  13545. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13546. Error &error) {
  13547. if (req.body.empty()) {
  13548. return write_content_with_provider(strm, req, error);
  13549. }
  13550. if (req.upload_progress) {
  13551. auto body_size = req.body.size();
  13552. size_t written = 0;
  13553. auto data = req.body.data();
  13554. while (written < body_size) {
  13555. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13556. if (!detail::write_data(strm, data + written, to_write)) {
  13557. error = Error::Write;
  13558. output_error_log(error, &req);
  13559. return false;
  13560. }
  13561. written += to_write;
  13562. if (!req.upload_progress(written, body_size)) {
  13563. error = Error::Canceled;
  13564. output_error_log(error, &req);
  13565. return false;
  13566. }
  13567. }
  13568. } else {
  13569. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13570. error = Error::Write;
  13571. output_error_log(error, &req);
  13572. return false;
  13573. }
  13574. }
  13575. return true;
  13576. }
  13577. inline std::unique_ptr<Response>
  13578. ClientImpl::send_with_content_provider_and_receiver(
  13579. Request &req, const char *body, size_t content_length,
  13580. ContentProvider content_provider,
  13581. ContentProviderWithoutLength content_provider_without_length,
  13582. const std::string &content_type, ContentReceiver content_receiver,
  13583. Error &error) {
  13584. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13585. auto enc = compress_
  13586. ? detail::create_compressor()
  13587. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13588. nullptr, nullptr);
  13589. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13590. if (enc.first && !content_provider_without_length) {
  13591. auto &compressor = enc.first;
  13592. if (content_provider) {
  13593. auto ok = true;
  13594. auto finished = false;
  13595. size_t offset = 0;
  13596. DataSink data_sink;
  13597. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13598. if (ok) {
  13599. auto last = offset + data_len == content_length;
  13600. auto ret = compressor->compress(
  13601. data, data_len, last,
  13602. [&](const char *compressed_data, size_t compressed_data_len) {
  13603. req.body.append(compressed_data, compressed_data_len);
  13604. return true;
  13605. });
  13606. if (ret) {
  13607. offset += data_len;
  13608. } else {
  13609. ok = false;
  13610. }
  13611. }
  13612. return ok;
  13613. };
  13614. // As in detail::write_content_with_progress(): the body is framed by
  13615. // content_length, so a provider that finishes early has truncated it.
  13616. // Stop and report that instead of calling the provider forever.
  13617. data_sink.done = [&]() { finished = true; };
  13618. while (ok && !finished && offset < content_length) {
  13619. if (!content_provider(offset, content_length - offset, data_sink)) {
  13620. error = Error::Canceled;
  13621. output_error_log(error, &req);
  13622. return nullptr;
  13623. }
  13624. }
  13625. // A short body here means either the provider stopped early or the
  13626. // compressor gave up. The branch below reports a failing compressor as
  13627. // Error::Compression, so keep the two distinguishable.
  13628. if (offset < content_length) {
  13629. error = ok ? Error::Write : Error::Compression;
  13630. output_error_log(error, &req);
  13631. return nullptr;
  13632. }
  13633. } else {
  13634. if (!compressor->compress(body, content_length, true,
  13635. [&](const char *data, size_t data_len) {
  13636. req.body.append(data, data_len);
  13637. return true;
  13638. })) {
  13639. error = Error::Compression;
  13640. output_error_log(error, &req);
  13641. return nullptr;
  13642. }
  13643. }
  13644. } else {
  13645. if (content_provider) {
  13646. req.content_length_ = content_length;
  13647. req.content_provider_ = std::move(content_provider);
  13648. req.is_chunked_content_provider_ = false;
  13649. } else if (content_provider_without_length) {
  13650. req.content_length_ = 0;
  13651. req.content_provider_ = detail::ContentProviderAdapter(
  13652. std::move(content_provider_without_length));
  13653. req.is_chunked_content_provider_ = true;
  13654. req.set_header("Transfer-Encoding", "chunked");
  13655. } else {
  13656. req.body.assign(body, content_length);
  13657. }
  13658. }
  13659. if (content_receiver) {
  13660. req.content_receiver =
  13661. [content_receiver](const char *data, size_t data_length,
  13662. size_t /*offset*/, size_t /*total_length*/) {
  13663. return content_receiver(data, data_length);
  13664. };
  13665. }
  13666. auto res = detail::make_unique<Response>();
  13667. return send(req, *res, error) ? std::move(res) : nullptr;
  13668. }
  13669. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13670. const std::string &method, const std::string &path, const Headers &headers,
  13671. const char *body, size_t content_length, ContentProvider content_provider,
  13672. ContentProviderWithoutLength content_provider_without_length,
  13673. const std::string &content_type, ContentReceiver content_receiver,
  13674. UploadProgress progress) {
  13675. Request req;
  13676. req.method = method;
  13677. req.headers = headers;
  13678. req.path = path;
  13679. req.upload_progress = std::move(progress);
  13680. if (max_timeout_msec_ > 0) {
  13681. req.start_time_ = std::chrono::steady_clock::now();
  13682. }
  13683. auto error = Error::Success;
  13684. auto res = send_with_content_provider_and_receiver(
  13685. req, body, content_length, std::move(content_provider),
  13686. std::move(content_provider_without_length), content_type,
  13687. std::move(content_receiver), error);
  13688. #ifdef CPPHTTPLIB_SSL_ENABLED
  13689. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13690. last_backend_error_};
  13691. #else
  13692. return Result{std::move(res), error, std::move(req.headers)};
  13693. #endif
  13694. }
  13695. inline void ClientImpl::output_log(const Request &req,
  13696. const Response &res) const {
  13697. if (logger_) {
  13698. std::lock_guard<std::mutex> guard(logger_mutex_);
  13699. logger_(req, res);
  13700. }
  13701. }
  13702. inline void ClientImpl::output_error_log(const Error &err,
  13703. const Request *req) const {
  13704. if (error_logger_) {
  13705. std::lock_guard<std::mutex> guard(logger_mutex_);
  13706. error_logger_(err, req);
  13707. }
  13708. }
  13709. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13710. Response &res, bool close_connection,
  13711. Error &error) {
  13712. // Auto-add Expect: 100-continue for large bodies
  13713. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13714. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13715. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13716. req.set_header("Expect", "100-continue");
  13717. }
  13718. }
  13719. // Check for Expect: 100-continue
  13720. auto expect_100_continue =
  13721. detail::has_header_token(req.headers, "Expect", "100-continue");
  13722. // Send request (skip body if using Expect: 100-continue)
  13723. auto rejected_locally = false;
  13724. auto write_request_success =
  13725. write_request(strm, req, close_connection, error, expect_100_continue,
  13726. rejected_locally);
  13727. // A failed write normally still reads the response below, since the server
  13728. // may have answered early (e.g. 413/414) and closed while the body was being
  13729. // sent. A request rejected before any byte reached the socket gets no such
  13730. // response, and waiting for one would block until the read timeout.
  13731. if (rejected_locally) { return false; }
  13732. #ifdef CPPHTTPLIB_SSL_ENABLED
  13733. if (is_ssl() && !expect_100_continue) {
  13734. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13735. if (!is_proxy_enabled) {
  13736. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13737. error = Error::SSLPeerCouldBeClosed_;
  13738. output_error_log(error, &req);
  13739. return false;
  13740. }
  13741. }
  13742. }
  13743. #endif
  13744. // Handle Expect: 100-continue.
  13745. //
  13746. // Wait for an interim/early response by attempting to read the status line
  13747. // under a short timeout, instead of trusting raw socket readability. Over
  13748. // TLS, post-handshake records (e.g. session tickets) make the socket
  13749. // readable without any HTTP response being available; relying on
  13750. // `select_read` there caused the body to be withheld forever and the
  13751. // request to fail with `Read` (#2458). If no status line arrives within the
  13752. // timeout, send the body anyway (matching curl's behavior).
  13753. auto status_line_read = false;
  13754. if (expect_100_continue && write_request_success) {
  13755. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13756. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13757. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13758. strm.set_read_timeout(sec, usec);
  13759. status_line_read = read_response_line(strm, req, res, false);
  13760. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13761. }
  13762. if (!status_line_read) {
  13763. // No interim response within the timeout: send the body and handle the
  13764. // response as usual.
  13765. if (!write_request_body(strm, req, error)) { return false; }
  13766. expect_100_continue = false; // Switch to normal response handling
  13767. }
  13768. }
  13769. // Receive response and headers
  13770. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13771. if ((!status_line_read &&
  13772. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13773. !detail::read_headers(strm, res.headers)) {
  13774. if (write_request_success) { error = Error::Read; }
  13775. output_error_log(error, &req);
  13776. return false;
  13777. }
  13778. if (!write_request_success) { return false; }
  13779. // Handle Expect: 100-continue response
  13780. if (expect_100_continue) {
  13781. if (res.status == StatusCode::Continue_100) {
  13782. // Server accepted, send the body
  13783. if (!write_request_body(strm, req, error)) { return false; }
  13784. // Read the actual response
  13785. res.headers.clear();
  13786. res.body.clear();
  13787. if (!read_response_line(strm, req, res) ||
  13788. !detail::read_headers(strm, res.headers)) {
  13789. error = Error::Read;
  13790. output_error_log(error, &req);
  13791. return false;
  13792. }
  13793. }
  13794. // If not 100 Continue, server returned an error; proceed with that response
  13795. }
  13796. // Body
  13797. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13798. req.method != "CONNECT") {
  13799. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13800. // whose final transfer coding is not chunked is not ambiguous: its body
  13801. // runs until the server closes the connection, so it is not rejected.
  13802. // HEAD/204 are excluded above and a 304 carries no body.
  13803. if (res.status != StatusCode::NotModified_304 &&
  13804. detail::has_conflicting_content_length(res.headers)) {
  13805. error = Error::Read;
  13806. output_error_log(error, &req);
  13807. return false;
  13808. }
  13809. auto redirect = 300 < res.status && res.status < 400 &&
  13810. res.status != StatusCode::NotModified_304 &&
  13811. follow_location_;
  13812. if (req.response_handler && !redirect) {
  13813. if (!req.response_handler(res)) {
  13814. error = Error::Canceled;
  13815. output_error_log(error, &req);
  13816. return false;
  13817. }
  13818. }
  13819. auto out =
  13820. req.content_receiver
  13821. ? static_cast<ContentReceiverWithProgress>(
  13822. [&](const char *buf, size_t n, size_t off, size_t len) {
  13823. if (redirect) { return true; }
  13824. auto ret = req.content_receiver(buf, n, off, len);
  13825. if (!ret) {
  13826. error = Error::Canceled;
  13827. output_error_log(error, &req);
  13828. }
  13829. return ret;
  13830. })
  13831. : static_cast<ContentReceiverWithProgress>(
  13832. [&](const char *buf, size_t n, size_t /*off*/,
  13833. size_t /*len*/) {
  13834. assert(res.body.size() + n <= res.body.max_size());
  13835. if (payload_max_length_ > 0 &&
  13836. (res.body.size() >= payload_max_length_ ||
  13837. n > payload_max_length_ - res.body.size())) {
  13838. return false;
  13839. }
  13840. res.body.append(buf, n);
  13841. return true;
  13842. });
  13843. auto progress = [&](size_t current, size_t total) {
  13844. if (!req.download_progress || redirect) { return true; }
  13845. auto ret = req.download_progress(current, total);
  13846. if (!ret) {
  13847. error = Error::Canceled;
  13848. output_error_log(error, &req);
  13849. }
  13850. return ret;
  13851. };
  13852. if (res.has_header("Content-Length")) {
  13853. if (!req.content_receiver) {
  13854. auto len = res.get_header_value_u64("Content-Length");
  13855. if (len > res.body.max_size()) {
  13856. error = Error::Read;
  13857. output_error_log(error, &req);
  13858. return false;
  13859. }
  13860. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13861. // hostile or malformed server sends an enormous Content-Length.
  13862. // The actual body read below is bounded by payload_max_length_,
  13863. // so reserving more than that is never useful.
  13864. auto reserve_len = static_cast<size_t>(len);
  13865. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13866. reserve_len = payload_max_length_;
  13867. }
  13868. res.body.reserve(reserve_len);
  13869. }
  13870. }
  13871. if (res.status != StatusCode::NotModified_304) {
  13872. auto content_status = 0;
  13873. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13874. ? (std::numeric_limits<size_t>::max)()
  13875. : payload_max_length_;
  13876. if (!detail::read_content(strm, res, max_length, content_status,
  13877. std::move(progress), std::move(out),
  13878. decompress_)) {
  13879. if (error != Error::Canceled) {
  13880. // Tell the caller apart from a plain read failure when the body could
  13881. // not be decoded because of its Content-Encoding.
  13882. switch (content_status) {
  13883. case StatusCode::UnsupportedMediaType_415:
  13884. error = Error::UnsupportedContentEncoding;
  13885. break;
  13886. case StatusCode::InternalServerError_500:
  13887. error = Error::Compression;
  13888. break;
  13889. default: error = Error::Read; break;
  13890. }
  13891. }
  13892. output_error_log(error, &req);
  13893. return false;
  13894. }
  13895. }
  13896. }
  13897. // Log
  13898. output_log(req, res);
  13899. return true;
  13900. }
  13901. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13902. const std::string &boundary, const UploadFormDataItems &items,
  13903. const FormDataProviderItems &provider_items) const {
  13904. size_t cur_item = 0;
  13905. size_t cur_start = 0;
  13906. // cur_item and cur_start are copied to within the std::function and
  13907. // maintain state between successive calls
  13908. return [&, cur_item, cur_start](size_t offset,
  13909. DataSink &sink) mutable -> bool {
  13910. if (!offset && !items.empty()) {
  13911. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13912. return true;
  13913. } else if (cur_item < provider_items.size()) {
  13914. if (!cur_start) {
  13915. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13916. provider_items[cur_item], boundary);
  13917. offset += begin.size();
  13918. cur_start = offset;
  13919. sink.os << begin;
  13920. }
  13921. DataSink cur_sink;
  13922. auto has_data = true;
  13923. cur_sink.write = sink.write;
  13924. // Forward is_writable so a provider item asking whether it may keep
  13925. // going gets the outer sink's answer rather than the default `true`.
  13926. cur_sink.is_writable = sink.is_writable;
  13927. cur_sink.done = [&]() { has_data = false; };
  13928. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13929. return false;
  13930. }
  13931. if (!has_data) {
  13932. sink.os << detail::serialize_multipart_formdata_item_end();
  13933. cur_item++;
  13934. cur_start = 0;
  13935. }
  13936. return true;
  13937. } else {
  13938. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13939. sink.done();
  13940. return true;
  13941. }
  13942. };
  13943. }
  13944. inline bool ClientImpl::process_socket(
  13945. const Socket &socket,
  13946. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13947. std::function<bool(Stream &strm)> callback) {
  13948. return detail::process_client_socket(
  13949. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13950. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13951. }
  13952. inline bool ClientImpl::is_ssl() const { return false; }
  13953. inline Result ClientImpl::Get(const std::string &path,
  13954. DownloadProgress progress) {
  13955. return Get(path, Headers(), std::move(progress));
  13956. }
  13957. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13958. DownloadProgress progress) {
  13959. return Get(path, params, Headers(), std::move(progress));
  13960. }
  13961. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13962. const Headers &headers,
  13963. DownloadProgress progress) {
  13964. if (params.empty()) { return Get(path, headers); }
  13965. std::string path_with_query = append_query_params(path, params);
  13966. return Get(path_with_query, headers, std::move(progress));
  13967. }
  13968. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13969. DownloadProgress progress) {
  13970. Request req;
  13971. req.method = "GET";
  13972. req.path = path;
  13973. req.headers = headers;
  13974. req.download_progress = std::move(progress);
  13975. if (max_timeout_msec_ > 0) {
  13976. req.start_time_ = std::chrono::steady_clock::now();
  13977. }
  13978. return send_(std::move(req));
  13979. }
  13980. inline Result ClientImpl::Get(const std::string &path,
  13981. ContentReceiver content_receiver,
  13982. DownloadProgress progress) {
  13983. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13984. std::move(progress));
  13985. }
  13986. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13987. ContentReceiver content_receiver,
  13988. DownloadProgress progress) {
  13989. return Get(path, headers, nullptr, std::move(content_receiver),
  13990. std::move(progress));
  13991. }
  13992. inline Result ClientImpl::Get(const std::string &path,
  13993. ResponseHandler response_handler,
  13994. ContentReceiver content_receiver,
  13995. DownloadProgress progress) {
  13996. return Get(path, Headers(), std::move(response_handler),
  13997. std::move(content_receiver), std::move(progress));
  13998. }
  13999. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14000. ResponseHandler response_handler,
  14001. ContentReceiver content_receiver,
  14002. DownloadProgress progress) {
  14003. Request req;
  14004. req.method = "GET";
  14005. req.path = path;
  14006. req.headers = headers;
  14007. req.response_handler = std::move(response_handler);
  14008. req.content_receiver =
  14009. [content_receiver](const char *data, size_t data_length,
  14010. size_t /*offset*/, size_t /*total_length*/) {
  14011. return content_receiver(data, data_length);
  14012. };
  14013. req.download_progress = std::move(progress);
  14014. if (max_timeout_msec_ > 0) {
  14015. req.start_time_ = std::chrono::steady_clock::now();
  14016. }
  14017. return send_(std::move(req));
  14018. }
  14019. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14020. const Headers &headers,
  14021. ContentReceiver content_receiver,
  14022. DownloadProgress progress) {
  14023. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14024. std::move(progress));
  14025. }
  14026. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14027. const Headers &headers,
  14028. ResponseHandler response_handler,
  14029. ContentReceiver content_receiver,
  14030. DownloadProgress progress) {
  14031. if (params.empty()) {
  14032. return Get(path, headers, std::move(response_handler),
  14033. std::move(content_receiver), std::move(progress));
  14034. }
  14035. std::string path_with_query = append_query_params(path, params);
  14036. return Get(path_with_query, headers, std::move(response_handler),
  14037. std::move(content_receiver), std::move(progress));
  14038. }
  14039. inline Result ClientImpl::Head(const std::string &path) {
  14040. return Head(path, Headers());
  14041. }
  14042. inline Result ClientImpl::Head(const std::string &path,
  14043. const Headers &headers) {
  14044. Request req;
  14045. req.method = "HEAD";
  14046. req.headers = headers;
  14047. req.path = path;
  14048. if (max_timeout_msec_ > 0) {
  14049. req.start_time_ = std::chrono::steady_clock::now();
  14050. }
  14051. return send_(std::move(req));
  14052. }
  14053. inline Result ClientImpl::Post(const std::string &path) {
  14054. return Post(path, std::string(), std::string());
  14055. }
  14056. inline Result ClientImpl::Post(const std::string &path,
  14057. const Headers &headers) {
  14058. return Post(path, headers, nullptr, 0, std::string());
  14059. }
  14060. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14061. size_t content_length,
  14062. const std::string &content_type,
  14063. UploadProgress progress) {
  14064. return Post(path, Headers(), body, content_length, content_type, progress);
  14065. }
  14066. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14067. const std::string &content_type,
  14068. UploadProgress progress) {
  14069. return Post(path, Headers(), body, content_type, progress);
  14070. }
  14071. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14072. return Post(path, Headers(), params);
  14073. }
  14074. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14075. ContentProvider content_provider,
  14076. const std::string &content_type,
  14077. UploadProgress progress) {
  14078. return Post(path, Headers(), content_length, std::move(content_provider),
  14079. content_type, progress);
  14080. }
  14081. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14082. ContentProvider content_provider,
  14083. const std::string &content_type,
  14084. ContentReceiver content_receiver,
  14085. UploadProgress progress) {
  14086. return Post(path, Headers(), content_length, std::move(content_provider),
  14087. content_type, std::move(content_receiver), progress);
  14088. }
  14089. inline Result ClientImpl::Post(const std::string &path,
  14090. ContentProviderWithoutLength content_provider,
  14091. const std::string &content_type,
  14092. UploadProgress progress) {
  14093. return Post(path, Headers(), std::move(content_provider), content_type,
  14094. progress);
  14095. }
  14096. inline Result ClientImpl::Post(const std::string &path,
  14097. ContentProviderWithoutLength content_provider,
  14098. const std::string &content_type,
  14099. ContentReceiver content_receiver,
  14100. UploadProgress progress) {
  14101. return Post(path, Headers(), std::move(content_provider), content_type,
  14102. std::move(content_receiver), progress);
  14103. }
  14104. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14105. const Params &params) {
  14106. auto query = detail::params_to_query_str(params);
  14107. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14108. }
  14109. inline Result ClientImpl::Post(const std::string &path,
  14110. const UploadFormDataItems &items,
  14111. UploadProgress progress) {
  14112. return Post(path, Headers(), items, progress);
  14113. }
  14114. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14115. const UploadFormDataItems &items,
  14116. UploadProgress progress) {
  14117. const auto &boundary = detail::make_multipart_data_boundary();
  14118. const auto &content_type =
  14119. detail::serialize_multipart_formdata_get_content_type(boundary);
  14120. auto content_length = detail::get_multipart_content_length(items, boundary);
  14121. return Post(path, headers, content_length,
  14122. detail::make_multipart_content_provider(items, boundary),
  14123. content_type, progress);
  14124. }
  14125. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14126. const UploadFormDataItems &items,
  14127. const std::string &boundary,
  14128. UploadProgress progress) {
  14129. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14130. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14131. }
  14132. const auto &content_type =
  14133. detail::serialize_multipart_formdata_get_content_type(boundary);
  14134. auto content_length = detail::get_multipart_content_length(items, boundary);
  14135. return Post(path, headers, content_length,
  14136. detail::make_multipart_content_provider(items, boundary),
  14137. content_type, progress);
  14138. }
  14139. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14140. const char *body, size_t content_length,
  14141. const std::string &content_type,
  14142. UploadProgress progress) {
  14143. return send_with_content_provider_and_receiver(
  14144. "POST", path, headers, body, content_length, nullptr, nullptr,
  14145. content_type, nullptr, progress);
  14146. }
  14147. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14148. const std::string &body,
  14149. const std::string &content_type,
  14150. UploadProgress progress) {
  14151. return send_with_content_provider_and_receiver(
  14152. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14153. content_type, nullptr, progress);
  14154. }
  14155. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14156. size_t content_length,
  14157. ContentProvider content_provider,
  14158. const std::string &content_type,
  14159. UploadProgress progress) {
  14160. return send_with_content_provider_and_receiver(
  14161. "POST", path, headers, nullptr, content_length,
  14162. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14163. }
  14164. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14165. size_t content_length,
  14166. ContentProvider content_provider,
  14167. const std::string &content_type,
  14168. ContentReceiver content_receiver,
  14169. DownloadProgress progress) {
  14170. return send_with_content_provider_and_receiver(
  14171. "POST", path, headers, nullptr, content_length,
  14172. std::move(content_provider), nullptr, content_type,
  14173. std::move(content_receiver), std::move(progress));
  14174. }
  14175. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14176. ContentProviderWithoutLength content_provider,
  14177. const std::string &content_type,
  14178. UploadProgress progress) {
  14179. return send_with_content_provider_and_receiver(
  14180. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14181. content_type, nullptr, progress);
  14182. }
  14183. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14184. ContentProviderWithoutLength content_provider,
  14185. const std::string &content_type,
  14186. ContentReceiver content_receiver,
  14187. DownloadProgress progress) {
  14188. return send_with_content_provider_and_receiver(
  14189. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14190. content_type, std::move(content_receiver), std::move(progress));
  14191. }
  14192. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14193. const UploadFormDataItems &items,
  14194. const FormDataProviderItems &provider_items,
  14195. UploadProgress progress) {
  14196. const auto &boundary = detail::make_multipart_data_boundary();
  14197. const auto &content_type =
  14198. detail::serialize_multipart_formdata_get_content_type(boundary);
  14199. return send_with_content_provider_and_receiver(
  14200. "POST", path, headers, nullptr, 0, nullptr,
  14201. get_multipart_content_provider(boundary, items, provider_items),
  14202. content_type, nullptr, progress);
  14203. }
  14204. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14205. const std::string &body,
  14206. const std::string &content_type,
  14207. ContentReceiver content_receiver,
  14208. DownloadProgress progress) {
  14209. Request req;
  14210. req.method = "POST";
  14211. req.path = path;
  14212. req.headers = headers;
  14213. req.body = body;
  14214. req.content_receiver =
  14215. [content_receiver](const char *data, size_t data_length,
  14216. size_t /*offset*/, size_t /*total_length*/) {
  14217. return content_receiver(data, data_length);
  14218. };
  14219. req.download_progress = std::move(progress);
  14220. if (max_timeout_msec_ > 0) {
  14221. req.start_time_ = std::chrono::steady_clock::now();
  14222. }
  14223. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14224. return send_(std::move(req));
  14225. }
  14226. inline Result ClientImpl::Put(const std::string &path) {
  14227. return Put(path, std::string(), std::string());
  14228. }
  14229. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14230. return Put(path, headers, nullptr, 0, std::string());
  14231. }
  14232. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14233. size_t content_length,
  14234. const std::string &content_type,
  14235. UploadProgress progress) {
  14236. return Put(path, Headers(), body, content_length, content_type, progress);
  14237. }
  14238. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14239. const std::string &content_type,
  14240. UploadProgress progress) {
  14241. return Put(path, Headers(), body, content_type, progress);
  14242. }
  14243. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14244. return Put(path, Headers(), params);
  14245. }
  14246. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14247. ContentProvider content_provider,
  14248. const std::string &content_type,
  14249. UploadProgress progress) {
  14250. return Put(path, Headers(), content_length, std::move(content_provider),
  14251. content_type, progress);
  14252. }
  14253. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14254. ContentProvider content_provider,
  14255. const std::string &content_type,
  14256. ContentReceiver content_receiver,
  14257. UploadProgress progress) {
  14258. return Put(path, Headers(), content_length, std::move(content_provider),
  14259. content_type, std::move(content_receiver), progress);
  14260. }
  14261. inline Result ClientImpl::Put(const std::string &path,
  14262. ContentProviderWithoutLength content_provider,
  14263. const std::string &content_type,
  14264. UploadProgress progress) {
  14265. return Put(path, Headers(), std::move(content_provider), content_type,
  14266. progress);
  14267. }
  14268. inline Result ClientImpl::Put(const std::string &path,
  14269. ContentProviderWithoutLength content_provider,
  14270. const std::string &content_type,
  14271. ContentReceiver content_receiver,
  14272. UploadProgress progress) {
  14273. return Put(path, Headers(), std::move(content_provider), content_type,
  14274. std::move(content_receiver), progress);
  14275. }
  14276. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14277. const Params &params) {
  14278. auto query = detail::params_to_query_str(params);
  14279. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14280. }
  14281. inline Result ClientImpl::Put(const std::string &path,
  14282. const UploadFormDataItems &items,
  14283. UploadProgress progress) {
  14284. return Put(path, Headers(), items, progress);
  14285. }
  14286. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14287. const UploadFormDataItems &items,
  14288. UploadProgress progress) {
  14289. const auto &boundary = detail::make_multipart_data_boundary();
  14290. const auto &content_type =
  14291. detail::serialize_multipart_formdata_get_content_type(boundary);
  14292. auto content_length = detail::get_multipart_content_length(items, boundary);
  14293. return Put(path, headers, content_length,
  14294. detail::make_multipart_content_provider(items, boundary),
  14295. content_type, progress);
  14296. }
  14297. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14298. const UploadFormDataItems &items,
  14299. const std::string &boundary,
  14300. UploadProgress progress) {
  14301. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14302. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14303. }
  14304. const auto &content_type =
  14305. detail::serialize_multipart_formdata_get_content_type(boundary);
  14306. auto content_length = detail::get_multipart_content_length(items, boundary);
  14307. return Put(path, headers, content_length,
  14308. detail::make_multipart_content_provider(items, boundary),
  14309. content_type, progress);
  14310. }
  14311. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14312. const char *body, size_t content_length,
  14313. const std::string &content_type,
  14314. UploadProgress progress) {
  14315. return send_with_content_provider_and_receiver(
  14316. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14317. content_type, nullptr, progress);
  14318. }
  14319. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14320. const std::string &body,
  14321. const std::string &content_type,
  14322. UploadProgress progress) {
  14323. return send_with_content_provider_and_receiver(
  14324. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14325. content_type, nullptr, progress);
  14326. }
  14327. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14328. size_t content_length,
  14329. ContentProvider content_provider,
  14330. const std::string &content_type,
  14331. UploadProgress progress) {
  14332. return send_with_content_provider_and_receiver(
  14333. "PUT", path, headers, nullptr, content_length,
  14334. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14335. }
  14336. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14337. size_t content_length,
  14338. ContentProvider content_provider,
  14339. const std::string &content_type,
  14340. ContentReceiver content_receiver,
  14341. UploadProgress progress) {
  14342. return send_with_content_provider_and_receiver(
  14343. "PUT", path, headers, nullptr, content_length,
  14344. std::move(content_provider), nullptr, content_type,
  14345. std::move(content_receiver), progress);
  14346. }
  14347. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14348. ContentProviderWithoutLength content_provider,
  14349. const std::string &content_type,
  14350. UploadProgress progress) {
  14351. return send_with_content_provider_and_receiver(
  14352. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14353. content_type, nullptr, progress);
  14354. }
  14355. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14356. ContentProviderWithoutLength content_provider,
  14357. const std::string &content_type,
  14358. ContentReceiver content_receiver,
  14359. UploadProgress progress) {
  14360. return send_with_content_provider_and_receiver(
  14361. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14362. content_type, std::move(content_receiver), progress);
  14363. }
  14364. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14365. const UploadFormDataItems &items,
  14366. const FormDataProviderItems &provider_items,
  14367. UploadProgress progress) {
  14368. const auto &boundary = detail::make_multipart_data_boundary();
  14369. const auto &content_type =
  14370. detail::serialize_multipart_formdata_get_content_type(boundary);
  14371. return send_with_content_provider_and_receiver(
  14372. "PUT", path, headers, nullptr, 0, nullptr,
  14373. get_multipart_content_provider(boundary, items, provider_items),
  14374. content_type, nullptr, progress);
  14375. }
  14376. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14377. const std::string &body,
  14378. const std::string &content_type,
  14379. ContentReceiver content_receiver,
  14380. DownloadProgress progress) {
  14381. Request req;
  14382. req.method = "PUT";
  14383. req.path = path;
  14384. req.headers = headers;
  14385. req.body = body;
  14386. req.content_receiver =
  14387. [content_receiver](const char *data, size_t data_length,
  14388. size_t /*offset*/, size_t /*total_length*/) {
  14389. return content_receiver(data, data_length);
  14390. };
  14391. req.download_progress = std::move(progress);
  14392. if (max_timeout_msec_ > 0) {
  14393. req.start_time_ = std::chrono::steady_clock::now();
  14394. }
  14395. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14396. return send_(std::move(req));
  14397. }
  14398. inline Result ClientImpl::Patch(const std::string &path) {
  14399. return Patch(path, std::string(), std::string());
  14400. }
  14401. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14402. UploadProgress progress) {
  14403. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14404. }
  14405. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14406. size_t content_length,
  14407. const std::string &content_type,
  14408. UploadProgress progress) {
  14409. return Patch(path, Headers(), body, content_length, content_type, progress);
  14410. }
  14411. inline Result ClientImpl::Patch(const std::string &path,
  14412. const std::string &body,
  14413. const std::string &content_type,
  14414. UploadProgress progress) {
  14415. return Patch(path, Headers(), body, content_type, progress);
  14416. }
  14417. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14418. return Patch(path, Headers(), params);
  14419. }
  14420. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14421. ContentProvider content_provider,
  14422. const std::string &content_type,
  14423. UploadProgress progress) {
  14424. return Patch(path, Headers(), content_length, std::move(content_provider),
  14425. content_type, progress);
  14426. }
  14427. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14428. ContentProvider content_provider,
  14429. const std::string &content_type,
  14430. ContentReceiver content_receiver,
  14431. UploadProgress progress) {
  14432. return Patch(path, Headers(), content_length, std::move(content_provider),
  14433. content_type, std::move(content_receiver), progress);
  14434. }
  14435. inline Result ClientImpl::Patch(const std::string &path,
  14436. ContentProviderWithoutLength content_provider,
  14437. const std::string &content_type,
  14438. UploadProgress progress) {
  14439. return Patch(path, Headers(), std::move(content_provider), content_type,
  14440. progress);
  14441. }
  14442. inline Result ClientImpl::Patch(const std::string &path,
  14443. ContentProviderWithoutLength content_provider,
  14444. const std::string &content_type,
  14445. ContentReceiver content_receiver,
  14446. UploadProgress progress) {
  14447. return Patch(path, Headers(), std::move(content_provider), content_type,
  14448. std::move(content_receiver), progress);
  14449. }
  14450. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14451. const Params &params) {
  14452. auto query = detail::params_to_query_str(params);
  14453. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14454. }
  14455. inline Result ClientImpl::Patch(const std::string &path,
  14456. const UploadFormDataItems &items,
  14457. UploadProgress progress) {
  14458. return Patch(path, Headers(), items, progress);
  14459. }
  14460. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14461. const UploadFormDataItems &items,
  14462. UploadProgress progress) {
  14463. const auto &boundary = detail::make_multipart_data_boundary();
  14464. const auto &content_type =
  14465. detail::serialize_multipart_formdata_get_content_type(boundary);
  14466. auto content_length = detail::get_multipart_content_length(items, boundary);
  14467. return Patch(path, headers, content_length,
  14468. detail::make_multipart_content_provider(items, boundary),
  14469. content_type, progress);
  14470. }
  14471. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14472. const UploadFormDataItems &items,
  14473. const std::string &boundary,
  14474. UploadProgress progress) {
  14475. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14476. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14477. }
  14478. const auto &content_type =
  14479. detail::serialize_multipart_formdata_get_content_type(boundary);
  14480. auto content_length = detail::get_multipart_content_length(items, boundary);
  14481. return Patch(path, headers, content_length,
  14482. detail::make_multipart_content_provider(items, boundary),
  14483. content_type, progress);
  14484. }
  14485. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14486. const char *body, size_t content_length,
  14487. const std::string &content_type,
  14488. UploadProgress progress) {
  14489. return send_with_content_provider_and_receiver(
  14490. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14491. content_type, nullptr, progress);
  14492. }
  14493. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14494. const std::string &body,
  14495. const std::string &content_type,
  14496. UploadProgress progress) {
  14497. return send_with_content_provider_and_receiver(
  14498. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14499. content_type, nullptr, progress);
  14500. }
  14501. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14502. size_t content_length,
  14503. ContentProvider content_provider,
  14504. const std::string &content_type,
  14505. UploadProgress progress) {
  14506. return send_with_content_provider_and_receiver(
  14507. "PATCH", path, headers, nullptr, content_length,
  14508. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14509. }
  14510. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14511. size_t content_length,
  14512. ContentProvider content_provider,
  14513. const std::string &content_type,
  14514. ContentReceiver content_receiver,
  14515. UploadProgress progress) {
  14516. return send_with_content_provider_and_receiver(
  14517. "PATCH", path, headers, nullptr, content_length,
  14518. std::move(content_provider), nullptr, content_type,
  14519. std::move(content_receiver), progress);
  14520. }
  14521. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14522. ContentProviderWithoutLength content_provider,
  14523. const std::string &content_type,
  14524. UploadProgress progress) {
  14525. return send_with_content_provider_and_receiver(
  14526. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14527. content_type, nullptr, progress);
  14528. }
  14529. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14530. ContentProviderWithoutLength content_provider,
  14531. const std::string &content_type,
  14532. ContentReceiver content_receiver,
  14533. UploadProgress progress) {
  14534. return send_with_content_provider_and_receiver(
  14535. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14536. content_type, std::move(content_receiver), progress);
  14537. }
  14538. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14539. const UploadFormDataItems &items,
  14540. const FormDataProviderItems &provider_items,
  14541. UploadProgress progress) {
  14542. const auto &boundary = detail::make_multipart_data_boundary();
  14543. const auto &content_type =
  14544. detail::serialize_multipart_formdata_get_content_type(boundary);
  14545. return send_with_content_provider_and_receiver(
  14546. "PATCH", path, headers, nullptr, 0, nullptr,
  14547. get_multipart_content_provider(boundary, items, provider_items),
  14548. content_type, nullptr, progress);
  14549. }
  14550. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14551. const std::string &body,
  14552. const std::string &content_type,
  14553. ContentReceiver content_receiver,
  14554. DownloadProgress progress) {
  14555. Request req;
  14556. req.method = "PATCH";
  14557. req.path = path;
  14558. req.headers = headers;
  14559. req.body = body;
  14560. req.content_receiver =
  14561. [content_receiver](const char *data, size_t data_length,
  14562. size_t /*offset*/, size_t /*total_length*/) {
  14563. return content_receiver(data, data_length);
  14564. };
  14565. req.download_progress = std::move(progress);
  14566. if (max_timeout_msec_ > 0) {
  14567. req.start_time_ = std::chrono::steady_clock::now();
  14568. }
  14569. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14570. return send_(std::move(req));
  14571. }
  14572. inline Result ClientImpl::Delete(const std::string &path,
  14573. DownloadProgress progress) {
  14574. return Delete(path, Headers(), std::string(), std::string(), progress);
  14575. }
  14576. inline Result ClientImpl::Delete(const std::string &path,
  14577. const Headers &headers,
  14578. DownloadProgress progress) {
  14579. return Delete(path, headers, std::string(), std::string(), progress);
  14580. }
  14581. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14582. size_t content_length,
  14583. const std::string &content_type,
  14584. DownloadProgress progress) {
  14585. return Delete(path, Headers(), body, content_length, content_type, progress);
  14586. }
  14587. inline Result ClientImpl::Delete(const std::string &path,
  14588. const std::string &body,
  14589. const std::string &content_type,
  14590. DownloadProgress progress) {
  14591. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14592. progress);
  14593. }
  14594. inline Result ClientImpl::Delete(const std::string &path,
  14595. const Headers &headers,
  14596. const std::string &body,
  14597. const std::string &content_type,
  14598. DownloadProgress progress) {
  14599. return Delete(path, headers, body.data(), body.size(), content_type,
  14600. progress);
  14601. }
  14602. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14603. DownloadProgress progress) {
  14604. return Delete(path, Headers(), params, progress);
  14605. }
  14606. inline Result ClientImpl::Delete(const std::string &path,
  14607. const Headers &headers, const Params &params,
  14608. DownloadProgress progress) {
  14609. auto query = detail::params_to_query_str(params);
  14610. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14611. progress);
  14612. }
  14613. inline Result ClientImpl::Delete(const std::string &path,
  14614. const Headers &headers, const char *body,
  14615. size_t content_length,
  14616. const std::string &content_type,
  14617. DownloadProgress progress) {
  14618. Request req;
  14619. req.method = "DELETE";
  14620. req.headers = headers;
  14621. req.path = path;
  14622. req.download_progress = std::move(progress);
  14623. if (max_timeout_msec_ > 0) {
  14624. req.start_time_ = std::chrono::steady_clock::now();
  14625. }
  14626. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14627. req.body.assign(body, content_length);
  14628. return send_(std::move(req));
  14629. }
  14630. inline Result ClientImpl::Options(const std::string &path) {
  14631. return Options(path, Headers());
  14632. }
  14633. inline Result ClientImpl::Options(const std::string &path,
  14634. const Headers &headers) {
  14635. Request req;
  14636. req.method = "OPTIONS";
  14637. req.headers = headers;
  14638. req.path = path;
  14639. if (max_timeout_msec_ > 0) {
  14640. req.start_time_ = std::chrono::steady_clock::now();
  14641. }
  14642. return send_(std::move(req));
  14643. }
  14644. inline void ClientImpl::stop() {
  14645. std::lock_guard<std::mutex> guard(socket_mutex_);
  14646. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14647. // do is to shutdown_socket, so that threads using this socket suddenly
  14648. // discover they can't read/write any more and error out. Everything else
  14649. // (closing the socket, shutting ssl down) is unsafe because these actions
  14650. // are not thread-safe.
  14651. if (socket_requests_in_flight_ > 0) {
  14652. shutdown_socket(socket_);
  14653. // Aside from that, we set a flag for the socket to be closed when we're
  14654. // done.
  14655. socket_should_be_closed_when_request_is_done_ = true;
  14656. return;
  14657. }
  14658. disconnect(/*gracefully=*/true);
  14659. }
  14660. inline std::string ClientImpl::host() const { return host_; }
  14661. inline int ClientImpl::port() const { return port_; }
  14662. inline size_t ClientImpl::is_socket_open() const {
  14663. std::lock_guard<std::mutex> guard(socket_mutex_);
  14664. return socket_.is_open();
  14665. }
  14666. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14667. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14668. connection_timeout_sec_ = sec;
  14669. connection_timeout_usec_ = usec;
  14670. }
  14671. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14672. read_timeout_sec_ = sec;
  14673. read_timeout_usec_ = usec;
  14674. }
  14675. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14676. write_timeout_sec_ = sec;
  14677. write_timeout_usec_ = usec;
  14678. }
  14679. inline void ClientImpl::set_max_timeout(time_t msec) {
  14680. max_timeout_msec_ = msec;
  14681. }
  14682. inline void ClientImpl::set_basic_auth(const std::string &username,
  14683. const std::string &password) {
  14684. basic_auth_username_ = username;
  14685. basic_auth_password_ = password;
  14686. }
  14687. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14688. bearer_token_auth_token_ = token;
  14689. }
  14690. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14691. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14692. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14693. inline void
  14694. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14695. addr_map_ = std::move(addr_map);
  14696. }
  14697. inline void ClientImpl::set_default_headers(Headers headers) {
  14698. default_headers_ = std::move(headers);
  14699. }
  14700. inline void ClientImpl::set_header_writer(
  14701. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14702. header_writer_ = writer;
  14703. }
  14704. inline void ClientImpl::set_address_family(int family) {
  14705. address_family_ = family;
  14706. }
  14707. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14708. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14709. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14710. socket_options_ = std::move(socket_options);
  14711. }
  14712. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14713. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14714. inline void ClientImpl::set_payload_max_length(size_t length) {
  14715. payload_max_length_ = length;
  14716. has_payload_max_length_ = true;
  14717. }
  14718. inline void ClientImpl::set_interface(const std::string &intf) {
  14719. interface_ = intf;
  14720. }
  14721. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14722. proxy_host_ = host;
  14723. proxy_port_ = port;
  14724. std::lock_guard<std::mutex> guard(socket_mutex_);
  14725. disconnect(/*gracefully=*/true);
  14726. }
  14727. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14728. const std::string &password) {
  14729. proxy_basic_auth_username_ = username;
  14730. proxy_basic_auth_password_ = password;
  14731. }
  14732. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14733. proxy_bearer_token_auth_token_ = token;
  14734. }
  14735. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14736. std::vector<detail::NoProxyEntry> parsed;
  14737. parsed.reserve(patterns.size());
  14738. for (const auto &p : patterns) {
  14739. auto trimmed = detail::trim_copy(p);
  14740. if (trimmed.empty()) { continue; }
  14741. detail::NoProxyEntry entry;
  14742. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14743. parsed.push_back(std::move(entry));
  14744. }
  14745. }
  14746. no_proxy_entries_ = std::move(parsed);
  14747. std::lock_guard<std::mutex> guard(socket_mutex_);
  14748. disconnect(/*gracefully=*/true);
  14749. }
  14750. #ifdef CPPHTTPLIB_SSL_ENABLED
  14751. inline void ClientImpl::set_digest_auth(const std::string &username,
  14752. const std::string &password) {
  14753. digest_auth_username_ = username;
  14754. digest_auth_password_ = password;
  14755. }
  14756. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14757. const std::string &ca_cert_dir_path) {
  14758. ca_cert_file_path_ = ca_cert_file_path;
  14759. ca_cert_dir_path_ = ca_cert_dir_path;
  14760. }
  14761. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14762. const std::string &password) {
  14763. proxy_digest_auth_username_ = username;
  14764. proxy_digest_auth_password_ = password;
  14765. }
  14766. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14767. server_certificate_verification_ = enabled;
  14768. }
  14769. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14770. server_hostname_verification_ = enabled;
  14771. }
  14772. inline void ClientImpl::enable_system_ca(bool enabled) {
  14773. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14774. }
  14775. #endif
  14776. inline void ClientImpl::set_logger(Logger logger) {
  14777. logger_ = std::move(logger);
  14778. }
  14779. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14780. error_logger_ = std::move(error_logger);
  14781. }
  14782. /*
  14783. * SSL/TLS Common Implementation
  14784. */
  14785. inline ClientConnection::~ClientConnection() {
  14786. #ifdef CPPHTTPLIB_SSL_ENABLED
  14787. if (session) {
  14788. tls::shutdown(session, true);
  14789. tls::free_session(session);
  14790. session = nullptr;
  14791. }
  14792. #endif
  14793. if (sock != INVALID_SOCKET) {
  14794. detail::close_socket(sock);
  14795. sock = INVALID_SOCKET;
  14796. }
  14797. }
  14798. // Universal client implementation
  14799. inline Client::Client(const std::string &scheme_host_port)
  14800. : Client(scheme_host_port, std::string(), std::string()) {}
  14801. inline Client::Client(const std::string &scheme_host_port,
  14802. const std::string &client_cert_path,
  14803. const std::string &client_key_path) {
  14804. detail::UrlComponents uc;
  14805. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14806. auto &scheme = uc.scheme;
  14807. #ifdef CPPHTTPLIB_SSL_ENABLED
  14808. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14809. #else
  14810. if (!scheme.empty() && scheme != "http") {
  14811. #endif
  14812. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14813. std::string msg = "'" + scheme + "' scheme is not supported.";
  14814. throw std::invalid_argument(msg);
  14815. #endif
  14816. return;
  14817. }
  14818. auto is_ssl = scheme == "https";
  14819. auto host = std::move(uc.host);
  14820. auto port = is_ssl ? 443 : 80;
  14821. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14822. if (is_ssl) {
  14823. #ifdef CPPHTTPLIB_SSL_ENABLED
  14824. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14825. client_key_path);
  14826. is_ssl_ = is_ssl;
  14827. #endif
  14828. } else {
  14829. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14830. client_key_path);
  14831. }
  14832. } else {
  14833. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14834. // if port param below changes.
  14835. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14836. client_cert_path, client_key_path);
  14837. }
  14838. }
  14839. inline Client::Client(const std::string &host, int port)
  14840. : Client(host, port, std::string(), std::string()) {}
  14841. inline Client::Client(const std::string &host, int port,
  14842. const std::string &client_cert_path,
  14843. const std::string &client_key_path)
  14844. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14845. client_key_path)) {}
  14846. inline Client::~Client() = default;
  14847. inline bool Client::is_valid() const {
  14848. return cli_ != nullptr && cli_->is_valid();
  14849. }
  14850. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14851. return cli_->Get(path, std::move(progress));
  14852. }
  14853. inline Result Client::Get(const std::string &path, const Headers &headers,
  14854. DownloadProgress progress) {
  14855. return cli_->Get(path, headers, std::move(progress));
  14856. }
  14857. inline Result Client::Get(const std::string &path,
  14858. ContentReceiver content_receiver,
  14859. DownloadProgress progress) {
  14860. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14861. }
  14862. inline Result Client::Get(const std::string &path, const Headers &headers,
  14863. ContentReceiver content_receiver,
  14864. DownloadProgress progress) {
  14865. return cli_->Get(path, headers, std::move(content_receiver),
  14866. std::move(progress));
  14867. }
  14868. inline Result Client::Get(const std::string &path,
  14869. ResponseHandler response_handler,
  14870. ContentReceiver content_receiver,
  14871. DownloadProgress progress) {
  14872. return cli_->Get(path, std::move(response_handler),
  14873. std::move(content_receiver), std::move(progress));
  14874. }
  14875. inline Result Client::Get(const std::string &path, const Headers &headers,
  14876. ResponseHandler response_handler,
  14877. ContentReceiver content_receiver,
  14878. DownloadProgress progress) {
  14879. return cli_->Get(path, headers, std::move(response_handler),
  14880. std::move(content_receiver), std::move(progress));
  14881. }
  14882. inline Result Client::Get(const std::string &path, const Params &params,
  14883. DownloadProgress progress) {
  14884. return cli_->Get(path, params, std::move(progress));
  14885. }
  14886. inline Result Client::Get(const std::string &path, const Params &params,
  14887. const Headers &headers, DownloadProgress progress) {
  14888. return cli_->Get(path, params, headers, std::move(progress));
  14889. }
  14890. inline Result Client::Get(const std::string &path, const Params &params,
  14891. const Headers &headers,
  14892. ContentReceiver content_receiver,
  14893. DownloadProgress progress) {
  14894. return cli_->Get(path, params, headers, std::move(content_receiver),
  14895. std::move(progress));
  14896. }
  14897. inline Result Client::Get(const std::string &path, const Params &params,
  14898. const Headers &headers,
  14899. ResponseHandler response_handler,
  14900. ContentReceiver content_receiver,
  14901. DownloadProgress progress) {
  14902. return cli_->Get(path, params, headers, std::move(response_handler),
  14903. std::move(content_receiver), std::move(progress));
  14904. }
  14905. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14906. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14907. return cli_->Head(path, headers);
  14908. }
  14909. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14910. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14911. return cli_->Post(path, headers);
  14912. }
  14913. inline Result Client::Post(const std::string &path, const char *body,
  14914. size_t content_length,
  14915. const std::string &content_type,
  14916. UploadProgress progress) {
  14917. return cli_->Post(path, body, content_length, content_type, progress);
  14918. }
  14919. inline Result Client::Post(const std::string &path, const Headers &headers,
  14920. const char *body, size_t content_length,
  14921. const std::string &content_type,
  14922. UploadProgress progress) {
  14923. return cli_->Post(path, headers, body, content_length, content_type,
  14924. progress);
  14925. }
  14926. inline Result Client::Post(const std::string &path, const std::string &body,
  14927. const std::string &content_type,
  14928. UploadProgress progress) {
  14929. return cli_->Post(path, body, content_type, progress);
  14930. }
  14931. inline Result Client::Post(const std::string &path, const Headers &headers,
  14932. const std::string &body,
  14933. const std::string &content_type,
  14934. UploadProgress progress) {
  14935. return cli_->Post(path, headers, body, content_type, progress);
  14936. }
  14937. inline Result Client::Post(const std::string &path, size_t content_length,
  14938. ContentProvider content_provider,
  14939. const std::string &content_type,
  14940. UploadProgress progress) {
  14941. return cli_->Post(path, content_length, std::move(content_provider),
  14942. content_type, progress);
  14943. }
  14944. inline Result Client::Post(const std::string &path, size_t content_length,
  14945. ContentProvider content_provider,
  14946. const std::string &content_type,
  14947. ContentReceiver content_receiver,
  14948. UploadProgress progress) {
  14949. return cli_->Post(path, content_length, std::move(content_provider),
  14950. content_type, std::move(content_receiver), progress);
  14951. }
  14952. inline Result Client::Post(const std::string &path,
  14953. ContentProviderWithoutLength content_provider,
  14954. const std::string &content_type,
  14955. UploadProgress progress) {
  14956. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14957. }
  14958. inline Result Client::Post(const std::string &path,
  14959. ContentProviderWithoutLength content_provider,
  14960. const std::string &content_type,
  14961. ContentReceiver content_receiver,
  14962. UploadProgress progress) {
  14963. return cli_->Post(path, std::move(content_provider), content_type,
  14964. std::move(content_receiver), progress);
  14965. }
  14966. inline Result Client::Post(const std::string &path, const Headers &headers,
  14967. size_t content_length,
  14968. ContentProvider content_provider,
  14969. const std::string &content_type,
  14970. UploadProgress progress) {
  14971. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14972. content_type, progress);
  14973. }
  14974. inline Result Client::Post(const std::string &path, const Headers &headers,
  14975. size_t content_length,
  14976. ContentProvider content_provider,
  14977. const std::string &content_type,
  14978. ContentReceiver content_receiver,
  14979. DownloadProgress progress) {
  14980. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14981. content_type, std::move(content_receiver), progress);
  14982. }
  14983. inline Result Client::Post(const std::string &path, const Headers &headers,
  14984. ContentProviderWithoutLength content_provider,
  14985. const std::string &content_type,
  14986. UploadProgress progress) {
  14987. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14988. progress);
  14989. }
  14990. inline Result Client::Post(const std::string &path, const Headers &headers,
  14991. ContentProviderWithoutLength content_provider,
  14992. const std::string &content_type,
  14993. ContentReceiver content_receiver,
  14994. DownloadProgress progress) {
  14995. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14996. std::move(content_receiver), progress);
  14997. }
  14998. inline Result Client::Post(const std::string &path, const Params &params) {
  14999. return cli_->Post(path, params);
  15000. }
  15001. inline Result Client::Post(const std::string &path, const Headers &headers,
  15002. const Params &params) {
  15003. return cli_->Post(path, headers, params);
  15004. }
  15005. inline Result Client::Post(const std::string &path,
  15006. const UploadFormDataItems &items,
  15007. UploadProgress progress) {
  15008. return cli_->Post(path, items, progress);
  15009. }
  15010. inline Result Client::Post(const std::string &path, const Headers &headers,
  15011. const UploadFormDataItems &items,
  15012. UploadProgress progress) {
  15013. return cli_->Post(path, headers, items, progress);
  15014. }
  15015. inline Result Client::Post(const std::string &path, const Headers &headers,
  15016. const UploadFormDataItems &items,
  15017. const std::string &boundary,
  15018. UploadProgress progress) {
  15019. return cli_->Post(path, headers, items, boundary, progress);
  15020. }
  15021. inline Result Client::Post(const std::string &path, const Headers &headers,
  15022. const UploadFormDataItems &items,
  15023. const FormDataProviderItems &provider_items,
  15024. UploadProgress progress) {
  15025. return cli_->Post(path, headers, items, provider_items, progress);
  15026. }
  15027. inline Result Client::Post(const std::string &path, const Headers &headers,
  15028. const std::string &body,
  15029. const std::string &content_type,
  15030. ContentReceiver content_receiver,
  15031. DownloadProgress progress) {
  15032. return cli_->Post(path, headers, body, content_type,
  15033. std::move(content_receiver), progress);
  15034. }
  15035. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15036. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15037. return cli_->Put(path, headers);
  15038. }
  15039. inline Result Client::Put(const std::string &path, const char *body,
  15040. size_t content_length,
  15041. const std::string &content_type,
  15042. UploadProgress progress) {
  15043. return cli_->Put(path, body, content_length, content_type, progress);
  15044. }
  15045. inline Result Client::Put(const std::string &path, const Headers &headers,
  15046. const char *body, size_t content_length,
  15047. const std::string &content_type,
  15048. UploadProgress progress) {
  15049. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15050. }
  15051. inline Result Client::Put(const std::string &path, const std::string &body,
  15052. const std::string &content_type,
  15053. UploadProgress progress) {
  15054. return cli_->Put(path, body, content_type, progress);
  15055. }
  15056. inline Result Client::Put(const std::string &path, const Headers &headers,
  15057. const std::string &body,
  15058. const std::string &content_type,
  15059. UploadProgress progress) {
  15060. return cli_->Put(path, headers, body, content_type, progress);
  15061. }
  15062. inline Result Client::Put(const std::string &path, size_t content_length,
  15063. ContentProvider content_provider,
  15064. const std::string &content_type,
  15065. UploadProgress progress) {
  15066. return cli_->Put(path, content_length, std::move(content_provider),
  15067. content_type, progress);
  15068. }
  15069. inline Result Client::Put(const std::string &path, size_t content_length,
  15070. ContentProvider content_provider,
  15071. const std::string &content_type,
  15072. ContentReceiver content_receiver,
  15073. UploadProgress progress) {
  15074. return cli_->Put(path, content_length, std::move(content_provider),
  15075. content_type, std::move(content_receiver), progress);
  15076. }
  15077. inline Result Client::Put(const std::string &path,
  15078. ContentProviderWithoutLength content_provider,
  15079. const std::string &content_type,
  15080. UploadProgress progress) {
  15081. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15082. }
  15083. inline Result Client::Put(const std::string &path,
  15084. ContentProviderWithoutLength content_provider,
  15085. const std::string &content_type,
  15086. ContentReceiver content_receiver,
  15087. UploadProgress progress) {
  15088. return cli_->Put(path, std::move(content_provider), content_type,
  15089. std::move(content_receiver), progress);
  15090. }
  15091. inline Result Client::Put(const std::string &path, const Headers &headers,
  15092. size_t content_length,
  15093. ContentProvider content_provider,
  15094. const std::string &content_type,
  15095. UploadProgress progress) {
  15096. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15097. content_type, progress);
  15098. }
  15099. inline Result Client::Put(const std::string &path, const Headers &headers,
  15100. size_t content_length,
  15101. ContentProvider content_provider,
  15102. const std::string &content_type,
  15103. ContentReceiver content_receiver,
  15104. UploadProgress progress) {
  15105. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15106. content_type, std::move(content_receiver), progress);
  15107. }
  15108. inline Result Client::Put(const std::string &path, const Headers &headers,
  15109. ContentProviderWithoutLength content_provider,
  15110. const std::string &content_type,
  15111. UploadProgress progress) {
  15112. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15113. progress);
  15114. }
  15115. inline Result Client::Put(const std::string &path, const Headers &headers,
  15116. ContentProviderWithoutLength content_provider,
  15117. const std::string &content_type,
  15118. ContentReceiver content_receiver,
  15119. UploadProgress progress) {
  15120. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15121. std::move(content_receiver), progress);
  15122. }
  15123. inline Result Client::Put(const std::string &path, const Params &params) {
  15124. return cli_->Put(path, params);
  15125. }
  15126. inline Result Client::Put(const std::string &path, const Headers &headers,
  15127. const Params &params) {
  15128. return cli_->Put(path, headers, params);
  15129. }
  15130. inline Result Client::Put(const std::string &path,
  15131. const UploadFormDataItems &items,
  15132. UploadProgress progress) {
  15133. return cli_->Put(path, items, progress);
  15134. }
  15135. inline Result Client::Put(const std::string &path, const Headers &headers,
  15136. const UploadFormDataItems &items,
  15137. UploadProgress progress) {
  15138. return cli_->Put(path, headers, items, progress);
  15139. }
  15140. inline Result Client::Put(const std::string &path, const Headers &headers,
  15141. const UploadFormDataItems &items,
  15142. const std::string &boundary,
  15143. UploadProgress progress) {
  15144. return cli_->Put(path, headers, items, boundary, progress);
  15145. }
  15146. inline Result Client::Put(const std::string &path, const Headers &headers,
  15147. const UploadFormDataItems &items,
  15148. const FormDataProviderItems &provider_items,
  15149. UploadProgress progress) {
  15150. return cli_->Put(path, headers, items, provider_items, progress);
  15151. }
  15152. inline Result Client::Put(const std::string &path, const Headers &headers,
  15153. const std::string &body,
  15154. const std::string &content_type,
  15155. ContentReceiver content_receiver,
  15156. DownloadProgress progress) {
  15157. return cli_->Put(path, headers, body, content_type, content_receiver,
  15158. progress);
  15159. }
  15160. inline Result Client::Patch(const std::string &path) {
  15161. return cli_->Patch(path);
  15162. }
  15163. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15164. return cli_->Patch(path, headers);
  15165. }
  15166. inline Result Client::Patch(const std::string &path, const char *body,
  15167. size_t content_length,
  15168. const std::string &content_type,
  15169. UploadProgress progress) {
  15170. return cli_->Patch(path, body, content_length, content_type, progress);
  15171. }
  15172. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15173. const char *body, size_t content_length,
  15174. const std::string &content_type,
  15175. UploadProgress progress) {
  15176. return cli_->Patch(path, headers, body, content_length, content_type,
  15177. progress);
  15178. }
  15179. inline Result Client::Patch(const std::string &path, const std::string &body,
  15180. const std::string &content_type,
  15181. UploadProgress progress) {
  15182. return cli_->Patch(path, body, content_type, progress);
  15183. }
  15184. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15185. const std::string &body,
  15186. const std::string &content_type,
  15187. UploadProgress progress) {
  15188. return cli_->Patch(path, headers, body, content_type, progress);
  15189. }
  15190. inline Result Client::Patch(const std::string &path, size_t content_length,
  15191. ContentProvider content_provider,
  15192. const std::string &content_type,
  15193. UploadProgress progress) {
  15194. return cli_->Patch(path, content_length, std::move(content_provider),
  15195. content_type, progress);
  15196. }
  15197. inline Result Client::Patch(const std::string &path, size_t content_length,
  15198. ContentProvider content_provider,
  15199. const std::string &content_type,
  15200. ContentReceiver content_receiver,
  15201. UploadProgress progress) {
  15202. return cli_->Patch(path, content_length, std::move(content_provider),
  15203. content_type, std::move(content_receiver), progress);
  15204. }
  15205. inline Result Client::Patch(const std::string &path,
  15206. ContentProviderWithoutLength content_provider,
  15207. const std::string &content_type,
  15208. UploadProgress progress) {
  15209. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15210. }
  15211. inline Result Client::Patch(const std::string &path,
  15212. ContentProviderWithoutLength content_provider,
  15213. const std::string &content_type,
  15214. ContentReceiver content_receiver,
  15215. UploadProgress progress) {
  15216. return cli_->Patch(path, std::move(content_provider), content_type,
  15217. std::move(content_receiver), progress);
  15218. }
  15219. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15220. size_t content_length,
  15221. ContentProvider content_provider,
  15222. const std::string &content_type,
  15223. UploadProgress progress) {
  15224. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15225. content_type, progress);
  15226. }
  15227. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15228. size_t content_length,
  15229. ContentProvider content_provider,
  15230. const std::string &content_type,
  15231. ContentReceiver content_receiver,
  15232. UploadProgress progress) {
  15233. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15234. content_type, std::move(content_receiver), progress);
  15235. }
  15236. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15237. ContentProviderWithoutLength content_provider,
  15238. const std::string &content_type,
  15239. UploadProgress progress) {
  15240. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15241. progress);
  15242. }
  15243. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15244. ContentProviderWithoutLength content_provider,
  15245. const std::string &content_type,
  15246. ContentReceiver content_receiver,
  15247. UploadProgress progress) {
  15248. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15249. std::move(content_receiver), progress);
  15250. }
  15251. inline Result Client::Patch(const std::string &path, const Params &params) {
  15252. return cli_->Patch(path, params);
  15253. }
  15254. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15255. const Params &params) {
  15256. return cli_->Patch(path, headers, params);
  15257. }
  15258. inline Result Client::Patch(const std::string &path,
  15259. const UploadFormDataItems &items,
  15260. UploadProgress progress) {
  15261. return cli_->Patch(path, items, progress);
  15262. }
  15263. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15264. const UploadFormDataItems &items,
  15265. UploadProgress progress) {
  15266. return cli_->Patch(path, headers, items, progress);
  15267. }
  15268. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15269. const UploadFormDataItems &items,
  15270. const std::string &boundary,
  15271. UploadProgress progress) {
  15272. return cli_->Patch(path, headers, items, boundary, progress);
  15273. }
  15274. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15275. const UploadFormDataItems &items,
  15276. const FormDataProviderItems &provider_items,
  15277. UploadProgress progress) {
  15278. return cli_->Patch(path, headers, items, provider_items, progress);
  15279. }
  15280. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15281. const std::string &body,
  15282. const std::string &content_type,
  15283. ContentReceiver content_receiver,
  15284. DownloadProgress progress) {
  15285. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15286. progress);
  15287. }
  15288. inline Result Client::Delete(const std::string &path,
  15289. DownloadProgress progress) {
  15290. return cli_->Delete(path, progress);
  15291. }
  15292. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15293. DownloadProgress progress) {
  15294. return cli_->Delete(path, headers, progress);
  15295. }
  15296. inline Result Client::Delete(const std::string &path, const char *body,
  15297. size_t content_length,
  15298. const std::string &content_type,
  15299. DownloadProgress progress) {
  15300. return cli_->Delete(path, body, content_length, content_type, progress);
  15301. }
  15302. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15303. const char *body, size_t content_length,
  15304. const std::string &content_type,
  15305. DownloadProgress progress) {
  15306. return cli_->Delete(path, headers, body, content_length, content_type,
  15307. progress);
  15308. }
  15309. inline Result Client::Delete(const std::string &path, const std::string &body,
  15310. const std::string &content_type,
  15311. DownloadProgress progress) {
  15312. return cli_->Delete(path, body, content_type, progress);
  15313. }
  15314. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15315. const std::string &body,
  15316. const std::string &content_type,
  15317. DownloadProgress progress) {
  15318. return cli_->Delete(path, headers, body, content_type, progress);
  15319. }
  15320. inline Result Client::Delete(const std::string &path, const Params &params,
  15321. DownloadProgress progress) {
  15322. return cli_->Delete(path, params, progress);
  15323. }
  15324. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15325. const Params &params, DownloadProgress progress) {
  15326. return cli_->Delete(path, headers, params, progress);
  15327. }
  15328. inline Result Client::Options(const std::string &path) {
  15329. return cli_->Options(path);
  15330. }
  15331. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15332. return cli_->Options(path, headers);
  15333. }
  15334. inline ClientImpl::StreamHandle
  15335. Client::open_stream(const std::string &method, const std::string &path,
  15336. const Params &params, const Headers &headers,
  15337. const std::string &body, const std::string &content_type) {
  15338. return cli_->open_stream(method, path, params, headers, body, content_type);
  15339. }
  15340. inline bool Client::send(Request &req, Response &res, Error &error) {
  15341. return cli_->send(req, res, error);
  15342. }
  15343. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15344. inline void Client::stop() { cli_->stop(); }
  15345. inline std::string Client::host() const { return cli_->host(); }
  15346. inline int Client::port() const { return cli_->port(); }
  15347. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15348. inline socket_t Client::socket() const { return cli_->socket(); }
  15349. inline void
  15350. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15351. cli_->set_hostname_addr_map(std::move(addr_map));
  15352. }
  15353. inline void Client::set_default_headers(Headers headers) {
  15354. cli_->set_default_headers(std::move(headers));
  15355. }
  15356. inline void Client::set_header_writer(
  15357. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15358. cli_->set_header_writer(writer);
  15359. }
  15360. inline void Client::set_address_family(int family) {
  15361. cli_->set_address_family(family);
  15362. }
  15363. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15364. inline void Client::set_socket_options(SocketOptions socket_options) {
  15365. cli_->set_socket_options(std::move(socket_options));
  15366. }
  15367. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15368. cli_->set_connection_timeout(sec, usec);
  15369. }
  15370. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15371. cli_->set_read_timeout(sec, usec);
  15372. }
  15373. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15374. cli_->set_write_timeout(sec, usec);
  15375. }
  15376. inline void Client::set_basic_auth(const std::string &username,
  15377. const std::string &password) {
  15378. cli_->set_basic_auth(username, password);
  15379. }
  15380. inline void Client::set_bearer_token_auth(const std::string &token) {
  15381. cli_->set_bearer_token_auth(token);
  15382. }
  15383. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15384. inline void Client::set_follow_location(bool on) {
  15385. cli_->set_follow_location(on);
  15386. }
  15387. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15388. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15389. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15390. inline void Client::set_payload_max_length(size_t length) {
  15391. cli_->set_payload_max_length(length);
  15392. }
  15393. inline void Client::set_interface(const std::string &intf) {
  15394. cli_->set_interface(intf);
  15395. }
  15396. inline void Client::set_proxy(const std::string &host, int port) {
  15397. cli_->set_proxy(host, port);
  15398. }
  15399. inline void Client::set_proxy_basic_auth(const std::string &username,
  15400. const std::string &password) {
  15401. cli_->set_proxy_basic_auth(username, password);
  15402. }
  15403. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15404. cli_->set_proxy_bearer_token_auth(token);
  15405. }
  15406. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15407. cli_->set_no_proxy(patterns);
  15408. }
  15409. inline void Client::set_logger(Logger logger) {
  15410. cli_->set_logger(std::move(logger));
  15411. }
  15412. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15413. cli_->set_error_logger(std::move(error_logger));
  15414. }
  15415. /*
  15416. * Group 6: SSL Server and Client implementation
  15417. */
  15418. #ifdef CPPHTTPLIB_SSL_ENABLED
  15419. // SSL HTTP server implementation
  15420. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15421. const char *client_ca_cert_file_path,
  15422. const char *client_ca_cert_dir_path,
  15423. const char *private_key_password) {
  15424. using namespace tls;
  15425. ctx_ = create_server_context();
  15426. if (!ctx_) { return; }
  15427. // Load server certificate and private key
  15428. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15429. private_key_password)) {
  15430. last_ssl_error_ = static_cast<int>(get_error());
  15431. free_context(ctx_);
  15432. ctx_ = nullptr;
  15433. return;
  15434. }
  15435. // Load client CA certificates for client authentication
  15436. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15437. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15438. client_ca_cert_dir_path)) {
  15439. last_ssl_error_ = static_cast<int>(get_error());
  15440. free_context(ctx_);
  15441. ctx_ = nullptr;
  15442. return;
  15443. }
  15444. // Enable client certificate verification
  15445. set_verify_client(ctx_, true);
  15446. }
  15447. }
  15448. inline SSLServer::SSLServer(const PemMemory &pem) {
  15449. using namespace tls;
  15450. ctx_ = create_server_context();
  15451. if (ctx_) {
  15452. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15453. pem.private_key_password)) {
  15454. last_ssl_error_ = static_cast<int>(get_error());
  15455. free_context(ctx_);
  15456. ctx_ = nullptr;
  15457. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15458. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15459. last_ssl_error_ = static_cast<int>(get_error());
  15460. free_context(ctx_);
  15461. ctx_ = nullptr;
  15462. } else {
  15463. set_verify_client(ctx_, true);
  15464. }
  15465. }
  15466. }
  15467. }
  15468. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15469. using namespace tls;
  15470. ctx_ = create_server_context();
  15471. if (ctx_) {
  15472. if (!setup_callback(ctx_)) {
  15473. free_context(ctx_);
  15474. ctx_ = nullptr;
  15475. }
  15476. }
  15477. }
  15478. inline SSLServer::~SSLServer() {
  15479. if (ctx_) { tls::free_context(ctx_); }
  15480. }
  15481. inline bool SSLServer::is_valid() const {
  15482. return ctx_ != nullptr && Server::is_valid();
  15483. }
  15484. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15485. using namespace tls;
  15486. // Create TLS session with mutex protection
  15487. session_t session = nullptr;
  15488. {
  15489. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15490. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15491. }
  15492. if (!session) {
  15493. last_ssl_error_ = static_cast<int>(get_error());
  15494. detail::shutdown_socket(sock);
  15495. detail::close_socket(sock);
  15496. return false;
  15497. }
  15498. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15499. bool handshake_done = false;
  15500. bool ret = false;
  15501. bool websocket_upgraded = false;
  15502. auto cleanup = detail::scope_exit([&] {
  15503. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15504. free_session(session);
  15505. detail::shutdown_socket(sock);
  15506. detail::close_socket(sock);
  15507. });
  15508. // Perform TLS accept handshake with timeout
  15509. TlsError tls_err;
  15510. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15511. &tls_err)) {
  15512. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15513. // Map TlsError to legacy ssl_error for backward compatibility
  15514. if (tls_err.code == ErrorCode::WantRead) {
  15515. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15516. } else if (tls_err.code == ErrorCode::WantWrite) {
  15517. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15518. } else {
  15519. last_ssl_error_ = SSL_ERROR_SSL;
  15520. }
  15521. #else
  15522. last_ssl_error_ = static_cast<int>(get_error());
  15523. #endif
  15524. return false;
  15525. }
  15526. handshake_done = true;
  15527. std::string remote_addr;
  15528. int remote_port = 0;
  15529. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15530. std::string local_addr;
  15531. int local_port = 0;
  15532. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15533. ret = serve_guarded([&]() {
  15534. return detail::process_server_socket_ssl(
  15535. svr_sock_, session, sock, keep_alive_max_count_,
  15536. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15537. write_timeout_sec_, write_timeout_usec_,
  15538. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15539. return process_request(
  15540. strm, remote_addr, remote_port, local_addr, local_port,
  15541. close_connection, connection_closed,
  15542. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15543. });
  15544. });
  15545. return ret;
  15546. }
  15547. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15548. const char *key_pem,
  15549. const char *client_ca_pem,
  15550. const char *password) {
  15551. if (!ctx_) { return false; }
  15552. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15553. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15554. return false;
  15555. }
  15556. if (client_ca_pem) {
  15557. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15558. }
  15559. return true;
  15560. }
  15561. // SSL HTTP client implementation
  15562. inline SSLClient::~SSLClient() {
  15563. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15564. // base function rather than the derived function once we get to the
  15565. // base class destructor, and won't free the SSL (causing a leak).
  15566. // This must happen before the context is freed below: some backends
  15567. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15568. // context, so freeing the context first leaves close_notify reading
  15569. // freed memory.
  15570. shutdown_ssl_impl(socket_, true);
  15571. if (ctx_) {
  15572. tls::free_context(ctx_);
  15573. ctx_ = nullptr;
  15574. }
  15575. }
  15576. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15577. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15578. shutdown_ssl_impl(socket, shutdown_gracefully);
  15579. }
  15580. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15581. bool shutdown_gracefully) {
  15582. if (socket.sock == INVALID_SOCKET) {
  15583. assert(socket.ssl == nullptr);
  15584. return;
  15585. }
  15586. if (socket.ssl) {
  15587. tls::shutdown(socket.ssl, shutdown_gracefully);
  15588. {
  15589. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15590. tls::free_session(socket.ssl);
  15591. }
  15592. socket.ssl = nullptr;
  15593. }
  15594. assert(socket.ssl == nullptr);
  15595. }
  15596. inline bool SSLClient::process_socket(
  15597. const Socket &socket,
  15598. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15599. std::function<bool(Stream &strm)> callback) {
  15600. assert(socket.ssl);
  15601. return detail::process_client_socket_ssl(
  15602. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15603. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15604. std::move(callback));
  15605. }
  15606. inline bool SSLClient::is_ssl() const { return true; }
  15607. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15608. if (!is_valid()) {
  15609. error = Error::SSLConnection;
  15610. return false;
  15611. }
  15612. return ClientImpl::create_and_connect_socket(socket, error);
  15613. }
  15614. inline bool SSLClient::setup_proxy_connection(
  15615. Socket &socket,
  15616. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15617. Response &res, bool &success, Error &error) {
  15618. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15619. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15620. return false;
  15621. }
  15622. if (!initialize_ssl(socket, error)) {
  15623. success = false;
  15624. return false;
  15625. }
  15626. return true;
  15627. }
  15628. // Assumes that socket_mutex_ is locked and that there are no requests in
  15629. // flight
  15630. inline bool SSLClient::connect_with_proxy(
  15631. Socket &socket,
  15632. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15633. Response &res, bool &success, Error &error) {
  15634. success = true;
  15635. Response proxy_res;
  15636. if (!detail::process_client_socket(
  15637. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15638. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15639. start_time, [&](Stream &strm) {
  15640. Request req2;
  15641. req2.method = "CONNECT";
  15642. req2.path =
  15643. detail::make_host_and_port_string_always_port(host_, port_);
  15644. if (max_timeout_msec_ > 0) {
  15645. req2.start_time_ = std::chrono::steady_clock::now();
  15646. }
  15647. return process_request(strm, req2, proxy_res, false, error);
  15648. })) {
  15649. // Thread-safe to close everything because we are assuming there are no
  15650. // requests in flight
  15651. shutdown_ssl(socket, true);
  15652. shutdown_socket(socket);
  15653. close_socket(socket);
  15654. success = false;
  15655. return false;
  15656. }
  15657. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15658. if (!proxy_digest_auth_username_.empty() &&
  15659. !proxy_digest_auth_password_.empty()) {
  15660. std::map<std::string, std::string> auth;
  15661. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15662. // Close the current socket and create a new one for the authenticated
  15663. // request
  15664. shutdown_ssl(socket, true);
  15665. shutdown_socket(socket);
  15666. close_socket(socket);
  15667. // Create a new socket for the authenticated CONNECT request
  15668. if (!ensure_socket_connection(socket, error)) {
  15669. success = false;
  15670. output_error_log(error, nullptr);
  15671. return false;
  15672. }
  15673. proxy_res = Response();
  15674. if (!detail::process_client_socket(
  15675. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15676. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15677. start_time, [&](Stream &strm) {
  15678. Request req3;
  15679. req3.method = "CONNECT";
  15680. req3.path = detail::make_host_and_port_string_always_port(
  15681. host_, port_);
  15682. req3.headers.insert(detail::make_digest_authentication_header(
  15683. req3, auth, 1, detail::random_string(10),
  15684. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15685. true));
  15686. if (max_timeout_msec_ > 0) {
  15687. req3.start_time_ = std::chrono::steady_clock::now();
  15688. }
  15689. return process_request(strm, req3, proxy_res, false, error);
  15690. })) {
  15691. // Thread-safe to close everything because we are assuming there are
  15692. // no requests in flight
  15693. shutdown_ssl(socket, true);
  15694. shutdown_socket(socket);
  15695. close_socket(socket);
  15696. success = false;
  15697. return false;
  15698. }
  15699. }
  15700. }
  15701. }
  15702. // If status code is not 200, proxy request is failed.
  15703. // Set error to ProxyConnection and return proxy response
  15704. // as the response of the request
  15705. if (proxy_res.status != StatusCode::OK_200) {
  15706. error = Error::ProxyConnection;
  15707. output_error_log(error, nullptr);
  15708. res = std::move(proxy_res);
  15709. // Thread-safe to close everything because we are assuming there are
  15710. // no requests in flight
  15711. shutdown_ssl(socket, true);
  15712. shutdown_socket(socket);
  15713. close_socket(socket);
  15714. return false;
  15715. }
  15716. return true;
  15717. }
  15718. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15719. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15720. if (is_proxy_enabled_for_host(host_)) { return true; }
  15721. if (!initialize_ssl(socket, error)) {
  15722. shutdown_socket(socket);
  15723. close_socket(socket);
  15724. return false;
  15725. }
  15726. return true;
  15727. }
  15728. // SSL HTTP client implementation
  15729. inline SSLClient::SSLClient(const std::string &host)
  15730. : SSLClient(host, 443, std::string(), std::string()) {}
  15731. inline SSLClient::SSLClient(const std::string &host, int port)
  15732. : SSLClient(host, port, std::string(), std::string()) {}
  15733. inline void SSLClient::init_ctx() {
  15734. ctx_ = tls::create_client_context();
  15735. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15736. }
  15737. inline void SSLClient::reset_ctx_on_error() {
  15738. last_backend_error_ = tls::get_error();
  15739. tls::free_context(ctx_);
  15740. ctx_ = nullptr;
  15741. }
  15742. inline SSLClient::SSLClient(const std::string &host, int port,
  15743. const std::string &client_cert_path,
  15744. const std::string &client_key_path,
  15745. const std::string &private_key_password)
  15746. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15747. init_ctx();
  15748. if (!ctx_) { return; }
  15749. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15750. const char *password =
  15751. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15752. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15753. client_key_path.c_str(), password)) {
  15754. reset_ctx_on_error();
  15755. }
  15756. }
  15757. }
  15758. inline SSLClient::SSLClient(const std::string &host, int port,
  15759. const PemMemory &pem)
  15760. : ClientImpl(host, port) {
  15761. init_ctx();
  15762. if (!ctx_) { return; }
  15763. if (pem.cert_pem && pem.key_pem) {
  15764. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15765. pem.private_key_password)) {
  15766. reset_ctx_on_error();
  15767. }
  15768. }
  15769. }
  15770. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15771. if (ca_cert_store && ctx_) {
  15772. // set_ca_store takes ownership of ca_cert_store
  15773. tls::set_ca_store(ctx_, ca_cert_store);
  15774. ca_cert_store_set_ = true;
  15775. } else if (ca_cert_store) {
  15776. tls::free_ca_store(ca_cert_store);
  15777. }
  15778. }
  15779. inline void
  15780. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15781. if (!ctx_) { return; }
  15782. tls::set_verify_callback(ctx_, verifier);
  15783. }
  15784. inline void SSLClient::set_session_verifier(
  15785. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15786. session_verifier_ = std::move(verifier);
  15787. }
  15788. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15789. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15790. enable_windows_cert_verification_ = enabled;
  15791. }
  15792. #endif
  15793. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15794. std::size_t size) {
  15795. if (ctx_ && ca_cert && size > 0) {
  15796. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15797. tls::load_ca_pem(ctx_, ca_cert, size);
  15798. }
  15799. }
  15800. inline bool SSLClient::load_certs() {
  15801. auto ret = true;
  15802. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15803. // one client is shared across concurrent requests here.
  15804. std::call_once(initialize_cert_, [&]() {
  15805. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15806. ret = detail::load_client_ca_config(
  15807. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15808. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15809. last_backend_error_);
  15810. });
  15811. return ret;
  15812. }
  15813. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15814. // Load CA certificates if server verification is enabled
  15815. if (server_certificate_verification_) {
  15816. if (!load_certs()) {
  15817. error = Error::SSLLoadingCerts;
  15818. output_error_log(error, nullptr);
  15819. return false;
  15820. }
  15821. }
  15822. detail::ClientTlsSessionOptions options;
  15823. options.server_hostname_verification = server_hostname_verification_;
  15824. options.session_verifier = session_verifier_;
  15825. options.ctx_mutex = &ctx_mutex_;
  15826. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15827. // Skip Schannel when a custom CA cert is specified, as the Windows
  15828. // certificate store would not know about user-provided CA certificates.
  15829. // Also skip when system CA trust is explicitly disabled.
  15830. options.windows_cert_verification =
  15831. enable_windows_cert_verification_ &&
  15832. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15833. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15834. #endif
  15835. tls::session_t session = nullptr;
  15836. // Use scope_exit to ensure session is freed on error paths
  15837. bool success = false;
  15838. auto session_guard = detail::scope_exit([&] {
  15839. if (!success) { tls::free_session(session); }
  15840. });
  15841. detail::ClientTlsSessionError tls_error;
  15842. if (!detail::setup_client_tls_session(
  15843. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15844. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15845. options)) {
  15846. error = tls_error.error;
  15847. last_ssl_error_ = tls_error.ssl_error;
  15848. last_backend_error_ = tls_error.backend_error;
  15849. output_error_log(error, nullptr);
  15850. return false;
  15851. }
  15852. success = true;
  15853. socket.ssl = session;
  15854. return true;
  15855. }
  15856. inline void Client::set_digest_auth(const std::string &username,
  15857. const std::string &password) {
  15858. cli_->set_digest_auth(username, password);
  15859. }
  15860. inline void Client::set_proxy_digest_auth(const std::string &username,
  15861. const std::string &password) {
  15862. cli_->set_proxy_digest_auth(username, password);
  15863. }
  15864. inline void Client::enable_server_certificate_verification(bool enabled) {
  15865. cli_->enable_server_certificate_verification(enabled);
  15866. }
  15867. inline void Client::enable_server_hostname_verification(bool enabled) {
  15868. cli_->enable_server_hostname_verification(enabled);
  15869. }
  15870. inline void Client::enable_system_ca(bool enabled) {
  15871. cli_->enable_system_ca(enabled);
  15872. }
  15873. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15874. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15875. if (is_ssl_) {
  15876. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15877. enabled);
  15878. }
  15879. }
  15880. #endif
  15881. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15882. const std::string &ca_cert_dir_path) {
  15883. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15884. }
  15885. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15886. if (is_ssl_) {
  15887. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15888. } else if (ca_cert_store) {
  15889. tls::free_ca_store(ca_cert_store);
  15890. }
  15891. }
  15892. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15893. if (is_ssl_) {
  15894. // Use the PEM-based path so the CA data is retained for redirect transfer
  15895. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15896. }
  15897. }
  15898. inline void
  15899. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15900. if (is_ssl_) {
  15901. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15902. std::move(verifier));
  15903. }
  15904. }
  15905. inline void Client::set_session_verifier(
  15906. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15907. if (is_ssl_) {
  15908. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15909. }
  15910. }
  15911. inline tls::ctx_t Client::tls_context() const {
  15912. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15913. return nullptr;
  15914. }
  15915. #endif // CPPHTTPLIB_SSL_ENABLED
  15916. /*
  15917. * Group 7: TLS abstraction layer - Common API
  15918. */
  15919. #ifdef CPPHTTPLIB_SSL_ENABLED
  15920. namespace tls {
  15921. // Helper for PeerCert construction
  15922. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15923. return PeerCert(get_peer_cert(session));
  15924. }
  15925. namespace impl {
  15926. inline VerifyCallback &get_verify_callback() {
  15927. static thread_local VerifyCallback callback;
  15928. return callback;
  15929. }
  15930. inline VerifyCallback &get_mbedtls_verify_callback() {
  15931. static thread_local VerifyCallback callback;
  15932. return callback;
  15933. }
  15934. // Check if a string is an IPv4 address
  15935. inline bool is_ipv4_address(const std::string &str) {
  15936. int dots = 0;
  15937. for (char c : str) {
  15938. if (c == '.') {
  15939. dots++;
  15940. } else if (!detail::is_ascii_digit(c)) {
  15941. return false;
  15942. }
  15943. }
  15944. return dots == 3;
  15945. }
  15946. // Parse IPv4 address string to bytes
  15947. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15948. const char *p = str.c_str();
  15949. for (int i = 0; i < 4; i++) {
  15950. if (i > 0) {
  15951. if (*p != '.') { return false; }
  15952. p++;
  15953. }
  15954. int val = 0;
  15955. int digits = 0;
  15956. while (detail::is_ascii_digit(*p)) {
  15957. val = val * 10 + (*p - '0');
  15958. if (val > 255) { return false; }
  15959. p++;
  15960. digits++;
  15961. }
  15962. if (digits == 0) { return false; }
  15963. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15964. if (digits > 1 && *(p - digits) == '0') { return false; }
  15965. out[i] = static_cast<unsigned char>(val);
  15966. }
  15967. return *p == '\0';
  15968. }
  15969. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15970. // `out` must have room for at least 16 bytes. Returns the address length
  15971. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15972. // literal. Used to match a host against iPAddress SANs the same way the
  15973. // OpenSSL backend does via X509_check_ip.
  15974. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15975. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15976. struct in6_addr addr6 = {};
  15977. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15978. memcpy(out, &addr6, 16);
  15979. return 16;
  15980. }
  15981. return 0;
  15982. }
  15983. #ifdef _WIN32
  15984. // Enumerate Windows system certificates and call callback with DER data
  15985. template <typename Callback>
  15986. inline bool enumerate_windows_system_certs(Callback cb) {
  15987. bool loaded = false;
  15988. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15989. for (auto store_name : store_names) {
  15990. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15991. if (hStore) {
  15992. PCCERT_CONTEXT pContext = nullptr;
  15993. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15994. nullptr) {
  15995. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15996. loaded = true;
  15997. }
  15998. }
  15999. CertCloseStore(hStore, 0);
  16000. }
  16001. }
  16002. return loaded;
  16003. }
  16004. #endif
  16005. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16006. // Enumerate macOS Keychain certificates and call callback with DER data
  16007. template <typename Callback>
  16008. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16009. bool loaded = false;
  16010. const SecTrustSettingsDomain domains[] = {
  16011. kSecTrustSettingsDomainSystem,
  16012. kSecTrustSettingsDomainAdmin,
  16013. kSecTrustSettingsDomainUser,
  16014. };
  16015. for (auto domain : domains) {
  16016. CFArrayRef certs = nullptr;
  16017. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16018. if (status != errSecSuccess || !certs) {
  16019. if (certs) CFRelease(certs);
  16020. continue;
  16021. }
  16022. CFIndex count = CFArrayGetCount(certs);
  16023. for (CFIndex i = 0; i < count; i++) {
  16024. SecCertificateRef cert =
  16025. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16026. CFDataRef data = SecCertificateCopyData(cert);
  16027. if (data) {
  16028. if (cb(CFDataGetBytePtr(data),
  16029. static_cast<size_t>(CFDataGetLength(data)))) {
  16030. loaded = true;
  16031. }
  16032. CFRelease(data);
  16033. }
  16034. }
  16035. CFRelease(certs);
  16036. }
  16037. return loaded;
  16038. }
  16039. #endif
  16040. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16041. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16042. // Common CA certificate file paths on Linux/Unix
  16043. inline const char **system_ca_paths() {
  16044. static const char *paths[] = {
  16045. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16046. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16047. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16048. "/etc/pki/tls/cacert.pem", // OpenELEC
  16049. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16050. nullptr};
  16051. return paths;
  16052. }
  16053. // Common CA certificate directory paths on Linux/Unix
  16054. inline const char **system_ca_dirs() {
  16055. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16056. "/etc/pki/tls/certs", // RHEL/CentOS
  16057. "/usr/share/ca-certificates", // Other
  16058. nullptr};
  16059. return dirs;
  16060. }
  16061. #endif
  16062. } // namespace impl
  16063. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16064. const char *ca_dir) {
  16065. if (!ctx) { return false; }
  16066. bool success = true;
  16067. if (ca_file && *ca_file) {
  16068. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16069. }
  16070. if (ca_dir && *ca_dir) {
  16071. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16072. }
  16073. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16074. // Set CA list for client certificate request (CertificateRequest message)
  16075. if (ca_file && *ca_file) {
  16076. auto list = SSL_load_client_CA_file(ca_file);
  16077. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16078. }
  16079. #endif
  16080. return success;
  16081. }
  16082. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16083. const char *password) {
  16084. return set_client_cert_pem(ctx, cert, key, password);
  16085. }
  16086. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16087. const char *key_path, const char *password) {
  16088. return set_client_cert_file(ctx, cert_path, key_path, password);
  16089. }
  16090. // PeerCert implementation
  16091. inline PeerCert::PeerCert() = default;
  16092. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16093. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16094. other.cert_ = nullptr;
  16095. }
  16096. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16097. if (this != &other) {
  16098. if (cert_) { free_cert(cert_); }
  16099. cert_ = other.cert_;
  16100. other.cert_ = nullptr;
  16101. }
  16102. return *this;
  16103. }
  16104. inline PeerCert::~PeerCert() {
  16105. if (cert_) { free_cert(cert_); }
  16106. }
  16107. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16108. inline std::string PeerCert::subject_cn() const {
  16109. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16110. }
  16111. inline std::string PeerCert::issuer_name() const {
  16112. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16113. }
  16114. inline bool PeerCert::check_hostname(const char *hostname) const {
  16115. return cert_ ? verify_hostname(cert_, hostname) : false;
  16116. }
  16117. inline std::vector<SanEntry> PeerCert::sans() const {
  16118. std::vector<SanEntry> result;
  16119. if (cert_) { get_cert_sans(cert_, result); }
  16120. return result;
  16121. }
  16122. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16123. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16124. }
  16125. inline std::string PeerCert::serial() const {
  16126. return cert_ ? get_cert_serial(cert_) : std::string();
  16127. }
  16128. // VerifyContext method implementations
  16129. inline std::string VerifyContext::subject_cn() const {
  16130. return cert ? get_cert_subject_cn(cert) : std::string();
  16131. }
  16132. inline std::string VerifyContext::issuer_name() const {
  16133. return cert ? get_cert_issuer_name(cert) : std::string();
  16134. }
  16135. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16136. return cert ? verify_hostname(cert, hostname) : false;
  16137. }
  16138. inline std::vector<SanEntry> VerifyContext::sans() const {
  16139. std::vector<SanEntry> result;
  16140. if (cert) { get_cert_sans(cert, result); }
  16141. return result;
  16142. }
  16143. inline bool VerifyContext::validity(time_t &not_before,
  16144. time_t &not_after) const {
  16145. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16146. }
  16147. inline std::string VerifyContext::serial() const {
  16148. return cert ? get_cert_serial(cert) : std::string();
  16149. }
  16150. // TlsError static method implementation
  16151. inline std::string TlsError::verify_error_to_string(long error_code) {
  16152. return verify_error_string(error_code);
  16153. }
  16154. } // namespace tls
  16155. // Request::peer_cert() implementation
  16156. inline tls::PeerCert Request::peer_cert() const {
  16157. return tls::get_peer_cert_from_session(ssl);
  16158. }
  16159. // Request::sni() implementation
  16160. inline std::string Request::sni() const {
  16161. if (!ssl) { return std::string(); }
  16162. const char *s = tls::get_sni(ssl);
  16163. return s ? std::string(s) : std::string();
  16164. }
  16165. #endif // CPPHTTPLIB_SSL_ENABLED
  16166. /*
  16167. * Group 8: TLS abstraction layer - OpenSSL backend
  16168. */
  16169. /*
  16170. * OpenSSL Backend Implementation
  16171. */
  16172. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16173. namespace tls {
  16174. namespace impl {
  16175. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16176. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16177. switch (ssl_error) {
  16178. case SSL_ERROR_NONE: return ErrorCode::Success;
  16179. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16180. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16181. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16182. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16183. case SSL_ERROR_SSL:
  16184. default: return ErrorCode::Fatal;
  16185. }
  16186. }
  16187. // Helper: Create client CA list from PEM string
  16188. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16189. // Caller takes ownership of returned list
  16190. inline STACK_OF(X509_NAME) *
  16191. create_client_ca_list_from_pem(const char *ca_pem) {
  16192. if (!ca_pem) { return nullptr; }
  16193. auto ca_list = sk_X509_NAME_new_null();
  16194. if (!ca_list) { return nullptr; }
  16195. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16196. if (!bio) {
  16197. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16198. return nullptr;
  16199. }
  16200. X509 *cert = nullptr;
  16201. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16202. nullptr) {
  16203. const X509_NAME *name = X509_get_subject_name(cert);
  16204. if (name) {
  16205. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16206. }
  16207. X509_free(cert);
  16208. }
  16209. BIO_free(bio);
  16210. return ca_list;
  16211. }
  16212. // OpenSSL verify callback wrapper
  16213. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16214. auto &callback = get_verify_callback();
  16215. if (!callback) { return preverify_ok; }
  16216. // Get SSL object from X509_STORE_CTX
  16217. auto ssl = static_cast<SSL *>(
  16218. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16219. if (!ssl) { return preverify_ok; }
  16220. // Get current certificate and depth
  16221. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16222. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16223. int error = X509_STORE_CTX_get_error(ctx);
  16224. // Build context
  16225. VerifyContext verify_ctx;
  16226. verify_ctx.session = static_cast<session_t>(ssl);
  16227. verify_ctx.cert = static_cast<cert_t>(cert);
  16228. verify_ctx.depth = depth;
  16229. verify_ctx.preverify_ok = (preverify_ok != 0);
  16230. verify_ctx.error_code = error;
  16231. verify_ctx.error_string =
  16232. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16233. return callback(verify_ctx) ? 1 : 0;
  16234. }
  16235. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16236. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16237. // that must be released with release_store_objects
  16238. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16239. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16240. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16241. #endif
  16242. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16243. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16244. return X509_STORE_get1_objects(store);
  16245. #else
  16246. return X509_STORE_get0_objects(store);
  16247. #endif
  16248. }
  16249. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16250. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16251. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16252. #else
  16253. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16254. #endif
  16255. }
  16256. } // namespace impl
  16257. inline ctx_t create_client_context() {
  16258. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16259. if (ctx) {
  16260. // Disable auto-retry to properly handle non-blocking I/O
  16261. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16262. // Set minimum TLS version
  16263. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16264. }
  16265. return static_cast<ctx_t>(ctx);
  16266. }
  16267. inline void free_context(ctx_t ctx) {
  16268. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16269. }
  16270. inline bool set_min_version(ctx_t ctx, Version version) {
  16271. if (!ctx) return false;
  16272. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16273. static_cast<int>(version)) == 1;
  16274. }
  16275. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16276. if (!ctx || !pem || len == 0) return false;
  16277. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16278. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16279. if (!store) return false;
  16280. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16281. if (!bio) return false;
  16282. bool ok = true;
  16283. X509 *cert = nullptr;
  16284. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16285. nullptr) {
  16286. if (X509_STORE_add_cert(store, cert) != 1) {
  16287. // Ignore duplicate errors
  16288. auto err = ERR_peek_last_error();
  16289. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16290. ok = false;
  16291. }
  16292. }
  16293. X509_free(cert);
  16294. if (!ok) break;
  16295. }
  16296. BIO_free(bio);
  16297. // Clear any "no more certificates" errors
  16298. ERR_clear_error();
  16299. return ok;
  16300. }
  16301. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16302. if (!ctx || !file_path) return false;
  16303. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16304. nullptr) == 1;
  16305. }
  16306. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16307. if (!ctx || !dir_path) return false;
  16308. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16309. dir_path) == 1;
  16310. }
  16311. inline bool load_system_certs(ctx_t ctx) {
  16312. if (!ctx) return false;
  16313. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16314. #ifdef _WIN32
  16315. // Windows: Load from system certificate store (ROOT and CA)
  16316. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16317. if (!store) return false;
  16318. bool loaded_any = false;
  16319. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16320. for (auto store_name : store_names) {
  16321. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16322. if (!hStore) continue;
  16323. PCCERT_CONTEXT pContext = nullptr;
  16324. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16325. nullptr) {
  16326. const unsigned char *data = pContext->pbCertEncoded;
  16327. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16328. if (x509) {
  16329. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16330. X509_free(x509);
  16331. }
  16332. }
  16333. CertCloseStore(hStore, 0);
  16334. }
  16335. return loaded_any;
  16336. #elif defined(__APPLE__)
  16337. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16338. // macOS: Load from Keychain
  16339. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16340. if (!store) return false;
  16341. bool loaded_any = false;
  16342. const SecTrustSettingsDomain domains[] = {
  16343. kSecTrustSettingsDomainSystem,
  16344. kSecTrustSettingsDomainAdmin,
  16345. kSecTrustSettingsDomainUser,
  16346. };
  16347. for (auto domain : domains) {
  16348. CFArrayRef certs = nullptr;
  16349. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16350. !certs) {
  16351. if (certs) CFRelease(certs);
  16352. continue;
  16353. }
  16354. auto count = CFArrayGetCount(certs);
  16355. for (CFIndex i = 0; i < count; i++) {
  16356. auto cert = reinterpret_cast<SecCertificateRef>(
  16357. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16358. CFDataRef der = SecCertificateCopyData(cert);
  16359. if (der) {
  16360. const unsigned char *data = CFDataGetBytePtr(der);
  16361. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16362. if (x509) {
  16363. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16364. X509_free(x509);
  16365. }
  16366. CFRelease(der);
  16367. }
  16368. }
  16369. CFRelease(certs);
  16370. }
  16371. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16372. #else
  16373. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16374. #endif
  16375. #else
  16376. // Other Unix: use default verify paths
  16377. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16378. #endif
  16379. }
  16380. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16381. const char *password) {
  16382. if (!ctx || !cert || !key) return false;
  16383. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16384. // Load certificate
  16385. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16386. if (!cert_bio) return false;
  16387. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16388. BIO_free(cert_bio);
  16389. if (!x509) return false;
  16390. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16391. X509_free(x509);
  16392. if (!cert_ok) return false;
  16393. // Load private key
  16394. auto key_bio = BIO_new_mem_buf(key, -1);
  16395. if (!key_bio) return false;
  16396. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16397. password ? const_cast<char *>(password)
  16398. : nullptr);
  16399. BIO_free(key_bio);
  16400. if (!pkey) return false;
  16401. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16402. EVP_PKEY_free(pkey);
  16403. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16404. }
  16405. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16406. const char *key_path, const char *password) {
  16407. if (!ctx || !cert_path || !key_path) return false;
  16408. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16409. if (password && password[0] != '\0') {
  16410. SSL_CTX_set_default_passwd_cb_userdata(
  16411. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16412. }
  16413. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16414. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16415. }
  16416. inline ctx_t create_server_context() {
  16417. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16418. if (ctx) {
  16419. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16420. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16421. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16422. }
  16423. return static_cast<ctx_t>(ctx);
  16424. }
  16425. inline void set_verify_client(ctx_t ctx, bool require) {
  16426. if (!ctx) return;
  16427. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16428. require
  16429. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16430. : SSL_VERIFY_NONE,
  16431. nullptr);
  16432. }
  16433. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16434. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16435. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16436. SSL *ssl = SSL_new(ssl_ctx);
  16437. if (!ssl) return nullptr;
  16438. // Disable auto-retry for proper non-blocking I/O handling
  16439. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16440. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16441. if (!bio) {
  16442. SSL_free(ssl);
  16443. return nullptr;
  16444. }
  16445. SSL_set_bio(ssl, bio, bio);
  16446. return static_cast<session_t>(ssl);
  16447. }
  16448. inline void free_session(session_t session) {
  16449. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16450. }
  16451. inline bool set_sni(session_t session, const char *hostname,
  16452. bool /*verify_hostname*/) {
  16453. if (!session || !hostname) return false;
  16454. auto ssl = static_cast<SSL *>(session);
  16455. // Set SNI (Server Name Indication) only - does not enable verification.
  16456. // OpenSSL never binds identity checking to SNI (that happens post-
  16457. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16458. #if defined(OPENSSL_IS_BORINGSSL)
  16459. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16460. #else
  16461. // Direct call instead of macro to suppress -Wold-style-cast warning
  16462. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16463. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16464. #endif
  16465. }
  16466. inline TlsError connect(session_t session) {
  16467. if (!session) { return TlsError(); }
  16468. auto ssl = static_cast<SSL *>(session);
  16469. auto ret = SSL_connect(ssl);
  16470. TlsError err;
  16471. if (ret == 1) {
  16472. err.code = ErrorCode::Success;
  16473. } else {
  16474. auto ssl_err = SSL_get_error(ssl, ret);
  16475. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16476. err.backend_code = ERR_get_error();
  16477. }
  16478. return err;
  16479. }
  16480. inline TlsError accept(session_t session) {
  16481. if (!session) { return TlsError(); }
  16482. auto ssl = static_cast<SSL *>(session);
  16483. auto ret = SSL_accept(ssl);
  16484. TlsError err;
  16485. if (ret == 1) {
  16486. err.code = ErrorCode::Success;
  16487. } else {
  16488. auto ssl_err = SSL_get_error(ssl, ret);
  16489. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16490. err.backend_code = ERR_get_error();
  16491. }
  16492. return err;
  16493. }
  16494. inline bool connect_nonblocking(session_t session, socket_t sock,
  16495. time_t timeout_sec, time_t timeout_usec,
  16496. TlsError *err) {
  16497. if (!session) {
  16498. if (err) { err->code = ErrorCode::Fatal; }
  16499. return false;
  16500. }
  16501. auto ssl = static_cast<SSL *>(session);
  16502. auto bio = SSL_get_rbio(ssl);
  16503. // Set non-blocking mode for handshake
  16504. detail::set_nonblocking(sock, true);
  16505. if (bio) { BIO_set_nbio(bio, 1); }
  16506. auto cleanup = detail::scope_exit([&]() {
  16507. // Restore blocking mode after handshake
  16508. if (bio) { BIO_set_nbio(bio, 0); }
  16509. detail::set_nonblocking(sock, false);
  16510. });
  16511. auto res = 0;
  16512. while ((res = SSL_connect(ssl)) != 1) {
  16513. auto ssl_err = SSL_get_error(ssl, res);
  16514. switch (ssl_err) {
  16515. case SSL_ERROR_WANT_READ:
  16516. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16517. continue;
  16518. }
  16519. break;
  16520. case SSL_ERROR_WANT_WRITE:
  16521. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16522. continue;
  16523. }
  16524. break;
  16525. default: break;
  16526. }
  16527. if (err) {
  16528. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16529. err->backend_code = ERR_get_error();
  16530. }
  16531. return false;
  16532. }
  16533. if (err) { err->code = ErrorCode::Success; }
  16534. return true;
  16535. }
  16536. inline bool accept_nonblocking(session_t session, socket_t sock,
  16537. time_t timeout_sec, time_t timeout_usec,
  16538. TlsError *err) {
  16539. if (!session) {
  16540. if (err) { err->code = ErrorCode::Fatal; }
  16541. return false;
  16542. }
  16543. auto ssl = static_cast<SSL *>(session);
  16544. auto bio = SSL_get_rbio(ssl);
  16545. // Set non-blocking mode for handshake
  16546. detail::set_nonblocking(sock, true);
  16547. if (bio) { BIO_set_nbio(bio, 1); }
  16548. auto cleanup = detail::scope_exit([&]() {
  16549. // Restore blocking mode after handshake
  16550. if (bio) { BIO_set_nbio(bio, 0); }
  16551. detail::set_nonblocking(sock, false);
  16552. });
  16553. auto res = 0;
  16554. while ((res = SSL_accept(ssl)) != 1) {
  16555. auto ssl_err = SSL_get_error(ssl, res);
  16556. switch (ssl_err) {
  16557. case SSL_ERROR_WANT_READ:
  16558. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16559. continue;
  16560. }
  16561. break;
  16562. case SSL_ERROR_WANT_WRITE:
  16563. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16564. continue;
  16565. }
  16566. break;
  16567. default: break;
  16568. }
  16569. if (err) {
  16570. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16571. err->backend_code = ERR_get_error();
  16572. }
  16573. return false;
  16574. }
  16575. if (err) { err->code = ErrorCode::Success; }
  16576. return true;
  16577. }
  16578. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16579. if (!session || !buf) {
  16580. err.code = ErrorCode::Fatal;
  16581. return -1;
  16582. }
  16583. auto ssl = static_cast<SSL *>(session);
  16584. constexpr auto max_len =
  16585. static_cast<size_t>((std::numeric_limits<int>::max)());
  16586. if (len > max_len) { len = max_len; }
  16587. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16588. if (ret > 0) {
  16589. err.code = ErrorCode::Success;
  16590. return ret;
  16591. }
  16592. auto ssl_err = SSL_get_error(ssl, ret);
  16593. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16594. if (err.code == ErrorCode::PeerClosed) {
  16595. return 0;
  16596. } // Gracefully handle the peer closed state.
  16597. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16598. return -1;
  16599. }
  16600. inline ssize_t write(session_t session, const void *buf, size_t len,
  16601. TlsError &err) {
  16602. if (!session || !buf) {
  16603. err.code = ErrorCode::Fatal;
  16604. return -1;
  16605. }
  16606. auto ssl = static_cast<SSL *>(session);
  16607. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16608. if (ret > 0) {
  16609. err.code = ErrorCode::Success;
  16610. return ret;
  16611. }
  16612. auto ssl_err = SSL_get_error(ssl, ret);
  16613. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16614. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16615. return -1;
  16616. }
  16617. inline int pending(const_session_t session) {
  16618. if (!session) return 0;
  16619. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16620. }
  16621. inline void shutdown(session_t session, bool graceful) {
  16622. if (!session) return;
  16623. auto ssl = static_cast<SSL *>(session);
  16624. if (graceful) {
  16625. // Send close_notify without waiting for the peer's. The connection is
  16626. // closed right after this, so a unidirectional shutdown is enough, and an
  16627. // idle peer that never answers would otherwise hold this thread until the
  16628. // read timeout. The other backends do not wait either.
  16629. SSL_shutdown(ssl);
  16630. }
  16631. }
  16632. inline bool is_peer_closed(session_t session, socket_t sock) {
  16633. if (!session) return true;
  16634. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16635. detail::set_nonblocking(sock, true);
  16636. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16637. auto ssl = static_cast<SSL *>(session);
  16638. char buf;
  16639. auto ret = SSL_peek(ssl, &buf, 1);
  16640. if (ret > 0) return false;
  16641. auto err = SSL_get_error(ssl, ret);
  16642. return err == SSL_ERROR_ZERO_RETURN;
  16643. }
  16644. inline cert_t get_peer_cert(const_session_t session) {
  16645. if (!session) return nullptr;
  16646. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16647. static_cast<SSL *>(const_cast<void *>(session))));
  16648. }
  16649. inline void free_cert(cert_t cert) {
  16650. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16651. }
  16652. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16653. if (!cert || !hostname) return false;
  16654. auto x509 = static_cast<X509 *>(cert);
  16655. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16656. if (detail::is_ip_address(hostname)) {
  16657. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16658. }
  16659. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16660. }
  16661. inline uint64_t hostname_mismatch_code() {
  16662. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16663. }
  16664. inline long get_verify_result(const_session_t session) {
  16665. if (!session) return X509_V_ERR_UNSPECIFIED;
  16666. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16667. }
  16668. inline std::string get_cert_subject_cn(cert_t cert) {
  16669. if (!cert) return "";
  16670. auto x509 = static_cast<X509 *>(cert);
  16671. auto subject_name = X509_get_subject_name(x509);
  16672. if (!subject_name) return "";
  16673. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16674. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16675. if (idx < 0) return "";
  16676. auto entry = X509_NAME_get_entry(subject_name, idx);
  16677. if (!entry) return "";
  16678. auto data = X509_NAME_ENTRY_get_data(entry);
  16679. if (!data) return "";
  16680. return std::string(
  16681. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16682. static_cast<size_t>(ASN1_STRING_length(data)));
  16683. }
  16684. inline std::string get_cert_issuer_name(cert_t cert) {
  16685. if (!cert) return "";
  16686. auto x509 = static_cast<X509 *>(cert);
  16687. auto issuer_name = X509_get_issuer_name(x509);
  16688. if (!issuer_name) return "";
  16689. char buf[256];
  16690. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16691. return std::string(buf);
  16692. }
  16693. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16694. sans.clear();
  16695. if (!cert) return false;
  16696. auto x509 = static_cast<X509 *>(cert);
  16697. auto names = static_cast<GENERAL_NAMES *>(
  16698. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16699. if (!names) return true; // No SANs is valid
  16700. auto count = sk_GENERAL_NAME_num(names);
  16701. for (decltype(count) i = 0; i < count; i++) {
  16702. auto gen = sk_GENERAL_NAME_value(names, i);
  16703. if (!gen) continue;
  16704. SanEntry entry;
  16705. switch (gen->type) {
  16706. case GEN_DNS:
  16707. entry.type = SanType::DNS;
  16708. if (gen->d.dNSName) {
  16709. entry.value = std::string(
  16710. reinterpret_cast<const char *>(
  16711. ASN1_STRING_get0_data(gen->d.dNSName)),
  16712. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16713. }
  16714. break;
  16715. case GEN_IPADD:
  16716. entry.type = SanType::IP;
  16717. if (gen->d.iPAddress) {
  16718. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16719. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16720. if (len == 4) {
  16721. // IPv4
  16722. char buf[INET_ADDRSTRLEN];
  16723. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16724. entry.value = buf;
  16725. } else if (len == 16) {
  16726. // IPv6
  16727. char buf[INET6_ADDRSTRLEN];
  16728. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16729. entry.value = buf;
  16730. }
  16731. }
  16732. break;
  16733. case GEN_EMAIL:
  16734. entry.type = SanType::EMAIL;
  16735. if (gen->d.rfc822Name) {
  16736. entry.value = std::string(
  16737. reinterpret_cast<const char *>(
  16738. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16739. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16740. }
  16741. break;
  16742. case GEN_URI:
  16743. entry.type = SanType::URI;
  16744. if (gen->d.uniformResourceIdentifier) {
  16745. entry.value = std::string(
  16746. reinterpret_cast<const char *>(
  16747. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16748. static_cast<size_t>(
  16749. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16750. }
  16751. break;
  16752. default: entry.type = SanType::OTHER; break;
  16753. }
  16754. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16755. }
  16756. GENERAL_NAMES_free(names);
  16757. return true;
  16758. }
  16759. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16760. time_t &not_after) {
  16761. if (!cert) return false;
  16762. auto x509 = static_cast<X509 *>(cert);
  16763. auto nb = X509_get0_notBefore(x509);
  16764. auto na = X509_get0_notAfter(x509);
  16765. if (!nb || !na) return false;
  16766. ASN1_TIME *epoch = ASN1_TIME_new();
  16767. if (!epoch) return false;
  16768. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16769. if (!ASN1_TIME_set(epoch, 0)) return false;
  16770. int pday, psec;
  16771. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16772. not_before = 86400 * (time_t)pday + psec;
  16773. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16774. not_after = 86400 * (time_t)pday + psec;
  16775. return true;
  16776. }
  16777. inline std::string get_cert_serial(cert_t cert) {
  16778. if (!cert) return "";
  16779. auto x509 = static_cast<X509 *>(cert);
  16780. auto serial = X509_get_serialNumber(x509);
  16781. if (!serial) return "";
  16782. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16783. if (!bn) return "";
  16784. auto hex = BN_bn2hex(bn);
  16785. BN_free(bn);
  16786. if (!hex) return "";
  16787. std::string result(hex);
  16788. OPENSSL_free(hex);
  16789. return result;
  16790. }
  16791. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16792. if (!cert) return false;
  16793. auto x509 = static_cast<X509 *>(cert);
  16794. auto len = i2d_X509(x509, nullptr);
  16795. if (len < 0) return false;
  16796. der.resize(static_cast<size_t>(len));
  16797. auto p = der.data();
  16798. i2d_X509(x509, &p);
  16799. return true;
  16800. }
  16801. inline const char *get_sni(const_session_t session) {
  16802. if (!session) return nullptr;
  16803. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16804. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16805. }
  16806. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16807. inline uint64_t get_error() { return ERR_get_error(); }
  16808. inline std::string error_string(uint64_t code) {
  16809. char buf[256];
  16810. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16811. return std::string(buf);
  16812. }
  16813. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16814. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16815. if (!mem) { return nullptr; }
  16816. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16817. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16818. if (!inf) { return nullptr; }
  16819. auto store = X509_STORE_new();
  16820. if (store) {
  16821. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16822. auto itmp = sk_X509_INFO_value(inf, i);
  16823. if (!itmp) { continue; }
  16824. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16825. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16826. }
  16827. }
  16828. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16829. return static_cast<ca_store_t>(store);
  16830. }
  16831. inline void free_ca_store(ca_store_t store) {
  16832. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16833. }
  16834. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16835. if (!ctx || !store) { return false; }
  16836. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16837. auto x509_store = static_cast<X509_STORE *>(store);
  16838. // Check if same store is already set
  16839. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16840. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16841. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16842. return true;
  16843. }
  16844. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16845. certs.clear();
  16846. if (!ctx) { return 0; }
  16847. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16848. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16849. if (!store) { return 0; }
  16850. auto objs = impl::get_store_objects(store);
  16851. if (!objs) { return 0; }
  16852. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16853. auto count = sk_X509_OBJECT_num(objs);
  16854. for (decltype(count) i = 0; i < count; i++) {
  16855. auto obj = sk_X509_OBJECT_value(objs, i);
  16856. if (!obj) { continue; }
  16857. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16858. auto x509 = X509_OBJECT_get0_X509(obj);
  16859. if (x509) {
  16860. // Increment reference count so caller can free it
  16861. X509_up_ref(x509);
  16862. certs.push_back(static_cast<cert_t>(x509));
  16863. }
  16864. }
  16865. }
  16866. return certs.size();
  16867. }
  16868. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16869. std::vector<std::string> names;
  16870. if (!ctx) { return names; }
  16871. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16872. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16873. if (!store) { return names; }
  16874. auto objs = impl::get_store_objects(store);
  16875. if (!objs) { return names; }
  16876. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16877. auto count = sk_X509_OBJECT_num(objs);
  16878. for (decltype(count) i = 0; i < count; i++) {
  16879. auto obj = sk_X509_OBJECT_value(objs, i);
  16880. if (!obj) { continue; }
  16881. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16882. auto x509 = X509_OBJECT_get0_X509(obj);
  16883. if (x509) {
  16884. auto subject = X509_get_subject_name(x509);
  16885. if (subject) {
  16886. char buf[512];
  16887. X509_NAME_oneline(subject, buf, sizeof(buf));
  16888. names.push_back(buf);
  16889. }
  16890. }
  16891. }
  16892. }
  16893. return names;
  16894. }
  16895. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16896. const char *key_pem, const char *password) {
  16897. if (!ctx || !cert_pem || !key_pem) { return false; }
  16898. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16899. // Load certificate from PEM
  16900. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16901. if (!cert_bio) { return false; }
  16902. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16903. BIO_free(cert_bio);
  16904. if (!cert) { return false; }
  16905. // Load private key from PEM
  16906. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16907. if (!key_bio) {
  16908. X509_free(cert);
  16909. return false;
  16910. }
  16911. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16912. password ? const_cast<char *>(password)
  16913. : nullptr);
  16914. BIO_free(key_bio);
  16915. if (!key) {
  16916. X509_free(cert);
  16917. return false;
  16918. }
  16919. // Update certificate and key
  16920. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16921. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16922. X509_free(cert);
  16923. EVP_PKEY_free(key);
  16924. return ret;
  16925. }
  16926. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16927. if (!ctx || !ca_pem) { return false; }
  16928. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16929. // Create new X509_STORE from PEM
  16930. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16931. if (!store) { return false; }
  16932. // SSL_CTX_set_cert_store takes ownership
  16933. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16934. // Set client CA list for client certificate request
  16935. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16936. if (ca_list) {
  16937. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16938. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16939. }
  16940. return true;
  16941. }
  16942. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16943. if (!ctx) { return false; }
  16944. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16945. impl::get_verify_callback() = std::move(callback);
  16946. if (impl::get_verify_callback()) {
  16947. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16948. } else {
  16949. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16950. }
  16951. return true;
  16952. }
  16953. inline long get_verify_error(const_session_t session) {
  16954. if (!session) { return -1; }
  16955. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16956. return SSL_get_verify_result(ssl);
  16957. }
  16958. inline std::string verify_error_string(long error_code) {
  16959. if (error_code == X509_V_OK) { return ""; }
  16960. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16961. return str ? str : "unknown error";
  16962. }
  16963. } // namespace tls
  16964. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16965. /*
  16966. * Group 9: TLS abstraction layer - Mbed TLS backend
  16967. */
  16968. /*
  16969. * Mbed TLS Backend Implementation
  16970. */
  16971. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16972. namespace tls {
  16973. namespace impl {
  16974. // Mbed TLS session wrapper
  16975. struct MbedTlsSession {
  16976. mbedtls_ssl_context ssl;
  16977. socket_t sock = INVALID_SOCKET;
  16978. std::string hostname; // For client: set via set_sni
  16979. std::string sni_hostname; // For server: received from client via SNI callback
  16980. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16981. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16982. // (e.g. a response that arrived while this side was still in its post-write
  16983. // check), the byte is pushed back here and served by the next read().
  16984. unsigned char peeked_byte = 0;
  16985. bool has_peeked_byte = false;
  16986. // Set by set_sni() when the caller disabled hostname verification, so the
  16987. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16988. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16989. // OpenSSL and wolfSSL keep them independent).
  16990. bool suppress_hostname_mismatch = false;
  16991. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16992. // decide which verify callback to install when hostname verification is
  16993. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16994. // wired for this context, or a self-contained one otherwise, so a session
  16995. // that never opted into a callback never consults the process-wide
  16996. // set_verify_callback() slot (which some other, unrelated client may have
  16997. // populated).
  16998. bool has_verify_callback = false;
  16999. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17000. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17001. MbedTlsSession(const MbedTlsSession &) = delete;
  17002. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17003. };
  17004. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17005. // queue)
  17006. inline int &mbedtls_last_error() {
  17007. static thread_local int err = 0;
  17008. return err;
  17009. }
  17010. // Helper to map Mbed TLS error to ErrorCode
  17011. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17012. uint32_t verify_flags) {
  17013. if (ret == 0) { return ErrorCode::Success; }
  17014. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17015. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17016. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17017. return ErrorCode::PeerClosed;
  17018. }
  17019. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17020. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17021. out_errno = errno;
  17022. return ErrorCode::SyscallError;
  17023. }
  17024. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17025. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17026. // the handshake's chain verification (see set_sni()); a mismatch there
  17027. // is reported the same way as any other verify_flags bit. Report it as
  17028. // HostnameMismatch, matching the other backends and the post-handshake
  17029. // identity check below, but only when naming is the sole problem -
  17030. // if the chain itself is also untrusted/expired/etc., that takes
  17031. // priority over the naming detail.
  17032. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17033. return ErrorCode::HostnameMismatch;
  17034. }
  17035. return ErrorCode::CertVerifyFailed;
  17036. }
  17037. return ErrorCode::Fatal;
  17038. }
  17039. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17040. // return value, including the verify-flags-dependent HostnameMismatch
  17041. // mapping; shared by connect() and connect_nonblocking() so the
  17042. // backend_code policy for that mapping only lives in one place.
  17043. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17044. int ret) {
  17045. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17046. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17047. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17048. ? static_cast<uint64_t>(verify_flags)
  17049. : static_cast<uint64_t>(-ret);
  17050. }
  17051. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17052. // non-fatal notification delivered between records, not an error and not
  17053. // application data, so I/O calls that see it should just be retried. Kept in
  17054. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17055. // splitting the closing brace across an #if.
  17056. inline bool mbedtls_is_session_ticket(int ret) {
  17057. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17058. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17059. #else
  17060. (void)ret;
  17061. return false;
  17062. #endif
  17063. }
  17064. // BIO-like send callback for Mbed TLS
  17065. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17066. size_t len) {
  17067. auto sock = *static_cast<socket_t *>(ctx);
  17068. #ifdef _WIN32
  17069. auto ret =
  17070. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17071. if (ret == SOCKET_ERROR) {
  17072. int err = WSAGetLastError();
  17073. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17074. return MBEDTLS_ERR_NET_SEND_FAILED;
  17075. }
  17076. #else
  17077. auto ret = send(sock, buf, len, 0);
  17078. if (ret < 0) {
  17079. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17080. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17081. }
  17082. return MBEDTLS_ERR_NET_SEND_FAILED;
  17083. }
  17084. #endif
  17085. return static_cast<int>(ret);
  17086. }
  17087. // BIO-like recv callback for Mbed TLS
  17088. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17089. auto sock = *static_cast<socket_t *>(ctx);
  17090. #ifdef _WIN32
  17091. auto ret =
  17092. recv(sock, reinterpret_cast<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_READ; }
  17096. return MBEDTLS_ERR_NET_RECV_FAILED;
  17097. }
  17098. #else
  17099. auto ret = recv(sock, buf, len, 0);
  17100. if (ret < 0) {
  17101. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17102. return MBEDTLS_ERR_SSL_WANT_READ;
  17103. }
  17104. return MBEDTLS_ERR_NET_RECV_FAILED;
  17105. }
  17106. #endif
  17107. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17108. return static_cast<int>(ret);
  17109. }
  17110. // MbedTlsContext constructor/destructor implementations
  17111. inline MbedTlsContext::MbedTlsContext() {
  17112. mbedtls_ssl_config_init(&conf);
  17113. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17114. mbedtls_entropy_init(&entropy);
  17115. mbedtls_ctr_drbg_init(&ctr_drbg);
  17116. #endif
  17117. mbedtls_x509_crt_init(&ca_chain);
  17118. mbedtls_x509_crt_init(&own_cert);
  17119. mbedtls_pk_init(&own_key);
  17120. }
  17121. inline MbedTlsContext::~MbedTlsContext() {
  17122. mbedtls_pk_free(&own_key);
  17123. mbedtls_x509_crt_free(&own_cert);
  17124. mbedtls_x509_crt_free(&ca_chain);
  17125. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17126. mbedtls_ctr_drbg_free(&ctr_drbg);
  17127. mbedtls_entropy_free(&entropy);
  17128. #endif
  17129. mbedtls_ssl_config_free(&conf);
  17130. }
  17131. // Thread-local storage for SNI captured during handshake
  17132. // This is needed because the SNI callback doesn't have a way to pass
  17133. // session-specific data before the session is fully set up
  17134. inline std::string &mbedpending_sni() {
  17135. static thread_local std::string sni;
  17136. return sni;
  17137. }
  17138. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17139. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17140. const unsigned char *name, size_t name_len) {
  17141. (void)p_ctx;
  17142. (void)ssl;
  17143. // Store SNI name in thread-local storage
  17144. // It will be retrieved and stored in the session after handshake
  17145. if (name && name_len > 0) {
  17146. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17147. } else {
  17148. mbedpending_sni().clear();
  17149. }
  17150. return 0; // Accept any SNI
  17151. }
  17152. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17153. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17154. }
  17155. // Verify callback used when hostname verification is disabled for a session
  17156. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17157. // has_verify_callback is false). Deliberately does not consult
  17158. // get_verify_callback(): that slot is process-wide, so reading it here would
  17159. // pick up whatever another, unrelated client last installed there.
  17160. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17161. mbedtls_x509_crt *, int,
  17162. uint32_t *flags) {
  17163. (void)data;
  17164. mbedtls_clear_cn_mismatch(flags);
  17165. return 0;
  17166. }
  17167. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17168. int cert_depth, uint32_t *flags);
  17169. // MbedTLS verify callback wrapper
  17170. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17171. int cert_depth, uint32_t *flags) {
  17172. // data points to the MbedTlsSession
  17173. auto *session = static_cast<MbedTlsSession *>(data);
  17174. // set_sni() disabled hostname verification for this session: drop the
  17175. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17176. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17177. // SNI. The final pass/fail decision still comes from the remaining flags
  17178. // (or, below, from the user's own verify callback).
  17179. if (session && session->suppress_hostname_mismatch) {
  17180. mbedtls_clear_cn_mismatch(flags);
  17181. }
  17182. auto &callback = get_verify_callback();
  17183. if (!callback) { return 0; } // Continue with default verification
  17184. // Build context
  17185. VerifyContext verify_ctx;
  17186. verify_ctx.session = static_cast<session_t>(session);
  17187. verify_ctx.cert = static_cast<cert_t>(crt);
  17188. verify_ctx.depth = cert_depth;
  17189. verify_ctx.preverify_ok = (*flags == 0);
  17190. verify_ctx.error_code = static_cast<long>(*flags);
  17191. // Convert Mbed TLS flags to error string
  17192. static thread_local char error_buf[256];
  17193. if (*flags != 0) {
  17194. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17195. verify_ctx.error_string = error_buf;
  17196. } else {
  17197. verify_ctx.error_string = nullptr;
  17198. }
  17199. bool accepted = callback(verify_ctx);
  17200. if (accepted) {
  17201. *flags = 0; // Clear all error flags
  17202. return 0;
  17203. }
  17204. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17205. }
  17206. } // namespace impl
  17207. inline ctx_t create_client_context() {
  17208. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17209. if (!ctx) { return nullptr; }
  17210. ctx->is_server = false;
  17211. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17212. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17213. if (!detail::ensure_mbedtls_psa_crypto()) {
  17214. delete ctx;
  17215. return nullptr;
  17216. }
  17217. int ret;
  17218. #else
  17219. // Seed the random number generator
  17220. const char *pers = "httplib_client";
  17221. int ret = mbedtls_ctr_drbg_seed(
  17222. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17223. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17224. if (ret != 0) {
  17225. impl::mbedtls_last_error() = ret;
  17226. delete ctx;
  17227. return nullptr;
  17228. }
  17229. #endif
  17230. // Set up SSL config for client
  17231. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17232. MBEDTLS_SSL_TRANSPORT_STREAM,
  17233. MBEDTLS_SSL_PRESET_DEFAULT);
  17234. if (ret != 0) {
  17235. impl::mbedtls_last_error() = ret;
  17236. delete ctx;
  17237. return nullptr;
  17238. }
  17239. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17240. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17241. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17242. #endif
  17243. // Default: verify peer certificate
  17244. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17245. // Set minimum TLS version to 1.2
  17246. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17247. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17248. #else
  17249. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17250. MBEDTLS_SSL_MINOR_VERSION_3);
  17251. #endif
  17252. return static_cast<ctx_t>(ctx);
  17253. }
  17254. inline ctx_t create_server_context() {
  17255. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17256. if (!ctx) { return nullptr; }
  17257. ctx->is_server = true;
  17258. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17259. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17260. if (!detail::ensure_mbedtls_psa_crypto()) {
  17261. delete ctx;
  17262. return nullptr;
  17263. }
  17264. int ret;
  17265. #else
  17266. // Seed the random number generator
  17267. const char *pers = "httplib_server";
  17268. int ret = mbedtls_ctr_drbg_seed(
  17269. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17270. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17271. if (ret != 0) {
  17272. impl::mbedtls_last_error() = ret;
  17273. delete ctx;
  17274. return nullptr;
  17275. }
  17276. #endif
  17277. // Set up SSL config for server
  17278. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17279. MBEDTLS_SSL_TRANSPORT_STREAM,
  17280. MBEDTLS_SSL_PRESET_DEFAULT);
  17281. if (ret != 0) {
  17282. impl::mbedtls_last_error() = ret;
  17283. delete ctx;
  17284. return nullptr;
  17285. }
  17286. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17287. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17288. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17289. #endif
  17290. // Default: don't verify client
  17291. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17292. // Set minimum TLS version to 1.2
  17293. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17294. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17295. #else
  17296. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17297. MBEDTLS_SSL_MINOR_VERSION_3);
  17298. #endif
  17299. // Set SNI callback to capture client's SNI hostname
  17300. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17301. return static_cast<ctx_t>(ctx);
  17302. }
  17303. inline void free_context(ctx_t ctx) {
  17304. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17305. }
  17306. inline bool set_min_version(ctx_t ctx, Version version) {
  17307. if (!ctx) { return false; }
  17308. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17309. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17310. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17311. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17312. if (version >= Version::TLS1_3) {
  17313. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17314. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17315. #endif
  17316. }
  17317. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17318. #else
  17319. // Mbed TLS 2.x uses major/minor version numbers
  17320. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17321. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17322. if (version >= Version::TLS1_3) {
  17323. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17324. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17325. #else
  17326. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17327. #endif
  17328. }
  17329. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17330. #endif
  17331. return true;
  17332. }
  17333. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17334. if (!ctx || !pem) { return false; }
  17335. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17336. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17337. // Add null terminator if not present
  17338. std::string pem_str(pem, len);
  17339. int ret = mbedtls_x509_crt_parse(
  17340. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17341. pem_str.size() + 1);
  17342. if (ret != 0) {
  17343. impl::mbedtls_last_error() = ret;
  17344. return false;
  17345. }
  17346. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17347. return true;
  17348. }
  17349. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17350. if (!ctx || !file_path) { return false; }
  17351. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17352. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17353. if (ret != 0) {
  17354. impl::mbedtls_last_error() = ret;
  17355. return false;
  17356. }
  17357. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17358. return true;
  17359. }
  17360. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17361. if (!ctx || !dir_path) { return false; }
  17362. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17363. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17364. if (ret < 0) { // Returns number of certs on success, negative on error
  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_system_certs(ctx_t ctx) {
  17372. if (!ctx) { return false; }
  17373. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17374. bool loaded = false;
  17375. #ifdef _WIN32
  17376. loaded = impl::enumerate_windows_system_certs(
  17377. [&](const unsigned char *data, size_t len) {
  17378. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17379. });
  17380. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17381. loaded = impl::enumerate_macos_keychain_certs(
  17382. [&](const unsigned char *data, size_t len) {
  17383. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17384. });
  17385. #else
  17386. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17387. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17388. loaded = true;
  17389. break;
  17390. }
  17391. }
  17392. if (!loaded) {
  17393. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17394. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17395. loaded = true;
  17396. break;
  17397. }
  17398. }
  17399. }
  17400. #endif
  17401. if (loaded) {
  17402. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17403. }
  17404. return loaded;
  17405. }
  17406. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17407. const char *password) {
  17408. if (!ctx || !cert || !key) { return false; }
  17409. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17410. // Parse certificate
  17411. std::string cert_str(cert);
  17412. int ret = mbedtls_x509_crt_parse(
  17413. &mctx->own_cert,
  17414. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17415. cert_str.size() + 1);
  17416. if (ret != 0) {
  17417. impl::mbedtls_last_error() = ret;
  17418. return false;
  17419. }
  17420. // Parse private key
  17421. std::string key_str(key);
  17422. const unsigned char *pwd =
  17423. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17424. size_t pwd_len = password ? strlen(password) : 0;
  17425. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17426. ret = mbedtls_pk_parse_key(
  17427. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17428. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17429. &mctx->ctr_drbg);
  17430. #else
  17431. ret = mbedtls_pk_parse_key(
  17432. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17433. key_str.size() + 1, pwd, pwd_len);
  17434. #endif
  17435. if (ret != 0) {
  17436. impl::mbedtls_last_error() = ret;
  17437. return false;
  17438. }
  17439. // Verify that the certificate and private key match.
  17440. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17441. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17442. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17443. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17444. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17445. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17446. #else
  17447. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17448. #endif
  17449. if (ret != 0) {
  17450. impl::mbedtls_last_error() = ret;
  17451. return false;
  17452. }
  17453. #endif
  17454. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17455. if (ret != 0) {
  17456. impl::mbedtls_last_error() = ret;
  17457. return false;
  17458. }
  17459. return true;
  17460. }
  17461. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17462. const char *key_path, const char *password) {
  17463. if (!ctx || !cert_path || !key_path) { return false; }
  17464. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17465. // Parse certificate file
  17466. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17467. if (ret != 0) {
  17468. impl::mbedtls_last_error() = ret;
  17469. return false;
  17470. }
  17471. // Parse private key file
  17472. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17473. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17474. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17475. #else
  17476. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17477. #endif
  17478. if (ret != 0) {
  17479. impl::mbedtls_last_error() = ret;
  17480. return false;
  17481. }
  17482. // Verify that the certificate and private key match.
  17483. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17484. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17485. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17486. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17487. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17488. #else
  17489. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17490. #endif
  17491. if (ret != 0) {
  17492. impl::mbedtls_last_error() = ret;
  17493. return false;
  17494. }
  17495. #endif
  17496. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17497. if (ret != 0) {
  17498. impl::mbedtls_last_error() = ret;
  17499. return false;
  17500. }
  17501. return true;
  17502. }
  17503. inline void set_verify_client(ctx_t ctx, bool require) {
  17504. if (!ctx) { return; }
  17505. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17506. mctx->verify_client = require;
  17507. if (require) {
  17508. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17509. } else {
  17510. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17511. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17512. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17513. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17514. : MBEDTLS_SSL_VERIFY_NONE);
  17515. }
  17516. }
  17517. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17518. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17519. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17520. auto session = new (std::nothrow) impl::MbedTlsSession();
  17521. if (!session) { return nullptr; }
  17522. session->sock = sock;
  17523. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17524. if (ret != 0) {
  17525. impl::mbedtls_last_error() = ret;
  17526. delete session;
  17527. return nullptr;
  17528. }
  17529. // Explicitly opt out of in-handshake hostname verification by default;
  17530. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17531. // fails outright when no hostname was set. set_sni() installs the real
  17532. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17533. // caller verifies the certificate identity post-handshake via
  17534. // verify_hostname().
  17535. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17536. // Set BIO callbacks
  17537. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17538. impl::mbedtls_net_recv_cb, nullptr);
  17539. // Set per-session verify callback with session pointer if callback is
  17540. // registered
  17541. session->has_verify_callback = mctx->has_verify_callback;
  17542. if (mctx->has_verify_callback) {
  17543. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17544. session);
  17545. }
  17546. return static_cast<session_t>(session);
  17547. }
  17548. inline void free_session(session_t session) {
  17549. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17550. }
  17551. inline bool set_sni(session_t session, const char *hostname,
  17552. bool verify_hostname) {
  17553. if (!session || !hostname) { return false; }
  17554. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17555. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17556. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17557. // independently, so a disabled hostname check is handled below by masking
  17558. // the resulting mismatch flag instead of skipping this call.
  17559. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17560. if (ret != 0) {
  17561. impl::mbedtls_last_error() = ret;
  17562. return false;
  17563. }
  17564. msession->hostname = hostname;
  17565. if (!verify_hostname) {
  17566. msession->suppress_hostname_mismatch = true;
  17567. // If a user verify callback is already wired for this session,
  17568. // mbedtls_verify_callback() masks the mismatch flag itself before
  17569. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17570. // here would be redundant. Otherwise install the self-contained masking
  17571. // callback, which never touches the process-wide callback slot.
  17572. if (!msession->has_verify_callback) {
  17573. mbedtls_ssl_set_verify(&msession->ssl,
  17574. impl::mbedtls_mask_hostname_mismatch_callback,
  17575. msession);
  17576. }
  17577. }
  17578. return true;
  17579. }
  17580. inline TlsError connect(session_t session) {
  17581. TlsError err;
  17582. if (!session) {
  17583. err.code = ErrorCode::Fatal;
  17584. return err;
  17585. }
  17586. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17587. int ret;
  17588. do {
  17589. ret = mbedtls_ssl_handshake(&msession->ssl);
  17590. } while (impl::mbedtls_is_session_ticket(ret));
  17591. if (ret == 0) {
  17592. err.code = ErrorCode::Success;
  17593. } else {
  17594. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17595. impl::mbedtls_last_error() = ret;
  17596. }
  17597. return err;
  17598. }
  17599. inline TlsError accept(session_t session) {
  17600. // Same as connect for Mbed TLS - handshake works for both client and server
  17601. auto result = connect(session);
  17602. // After successful handshake, capture SNI from thread-local storage
  17603. if (result.code == ErrorCode::Success && session) {
  17604. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17605. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17606. impl::mbedpending_sni().clear();
  17607. }
  17608. return result;
  17609. }
  17610. inline bool connect_nonblocking(session_t session, socket_t sock,
  17611. time_t timeout_sec, time_t timeout_usec,
  17612. TlsError *err) {
  17613. if (!session) {
  17614. if (err) { err->code = ErrorCode::Fatal; }
  17615. return false;
  17616. }
  17617. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17618. // Set socket to non-blocking mode
  17619. detail::set_nonblocking(sock, true);
  17620. auto cleanup =
  17621. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17622. int ret;
  17623. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17624. // Non-fatal TLS 1.3 ticket; retry immediately.
  17625. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17626. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17627. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17628. continue;
  17629. }
  17630. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17631. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17632. continue;
  17633. }
  17634. }
  17635. // TlsError or timeout
  17636. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17637. impl::mbedtls_last_error() = ret;
  17638. return false;
  17639. }
  17640. if (err) { err->code = ErrorCode::Success; }
  17641. return true;
  17642. }
  17643. inline bool accept_nonblocking(session_t session, socket_t sock,
  17644. time_t timeout_sec, time_t timeout_usec,
  17645. TlsError *err) {
  17646. // Same implementation as connect for Mbed TLS
  17647. bool result =
  17648. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17649. // After successful handshake, capture SNI from thread-local storage
  17650. if (result && session) {
  17651. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17652. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17653. impl::mbedpending_sni().clear();
  17654. }
  17655. return result;
  17656. }
  17657. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17658. if (!session || !buf) {
  17659. err.code = ErrorCode::Fatal;
  17660. return -1;
  17661. }
  17662. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17663. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17664. if (msession->has_peeked_byte) {
  17665. if (len == 0) { return 0; }
  17666. auto p = static_cast<unsigned char *>(buf);
  17667. p[0] = msession->peeked_byte;
  17668. msession->has_peeked_byte = false;
  17669. size_t n = 1;
  17670. // Top up with any already-decrypted bytes without risking a block.
  17671. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17672. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17673. if (extra > 0) { n += static_cast<size_t>(extra); }
  17674. }
  17675. err.code = ErrorCode::Success;
  17676. return static_cast<ssize_t>(n);
  17677. }
  17678. int ret;
  17679. do {
  17680. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17681. len);
  17682. } while (impl::mbedtls_is_session_ticket(ret));
  17683. if (ret > 0) {
  17684. err.code = ErrorCode::Success;
  17685. return static_cast<ssize_t>(ret);
  17686. }
  17687. if (ret == 0) {
  17688. err.code = ErrorCode::PeerClosed;
  17689. return 0;
  17690. }
  17691. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17692. err.backend_code = static_cast<uint64_t>(-ret);
  17693. impl::mbedtls_last_error() = ret;
  17694. // mbedTLS signals a clean close_notify via a negative error code rather
  17695. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17696. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17697. return -1;
  17698. }
  17699. inline ssize_t write(session_t session, const void *buf, size_t len,
  17700. TlsError &err) {
  17701. if (!session || !buf) {
  17702. err.code = ErrorCode::Fatal;
  17703. return -1;
  17704. }
  17705. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17706. int ret;
  17707. do {
  17708. ret = mbedtls_ssl_write(&msession->ssl,
  17709. static_cast<const unsigned char *>(buf), len);
  17710. } while (impl::mbedtls_is_session_ticket(ret));
  17711. if (ret > 0) {
  17712. err.code = ErrorCode::Success;
  17713. return static_cast<ssize_t>(ret);
  17714. }
  17715. if (ret == 0) {
  17716. err.code = ErrorCode::PeerClosed;
  17717. return 0;
  17718. }
  17719. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17720. err.backend_code = static_cast<uint64_t>(-ret);
  17721. impl::mbedtls_last_error() = ret;
  17722. return -1;
  17723. }
  17724. inline int pending(const_session_t session) {
  17725. if (!session) { return 0; }
  17726. auto msession =
  17727. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17728. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17729. (msession->has_peeked_byte ? 1 : 0);
  17730. }
  17731. inline void shutdown(session_t session, bool graceful) {
  17732. if (!session) { return; }
  17733. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17734. if (graceful) {
  17735. // Try to send close_notify, but don't block forever
  17736. int ret;
  17737. int attempts = 0;
  17738. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17739. attempts < 3) {
  17740. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17741. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17742. break;
  17743. }
  17744. attempts++;
  17745. }
  17746. }
  17747. }
  17748. inline bool is_peer_closed(session_t session, socket_t sock) {
  17749. if (!session || sock == INVALID_SOCKET) { return true; }
  17750. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17751. // Check if there's already decrypted or pushed-back data available.
  17752. // If so, the connection is definitely alive.
  17753. if (msession->has_peeked_byte ||
  17754. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17755. return false;
  17756. }
  17757. // Set socket to non-blocking to avoid blocking on read
  17758. detail::set_nonblocking(sock, true);
  17759. auto cleanup =
  17760. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17761. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17762. // on application data — e.g. a response that already arrived — push the
  17763. // byte back so the next read() delivers it instead of losing it.
  17764. unsigned char buf;
  17765. int ret;
  17766. do {
  17767. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17768. } while (impl::mbedtls_is_session_ticket(ret));
  17769. // If we got data or WANT_READ (would block), connection is alive
  17770. if (ret > 0) {
  17771. msession->peeked_byte = buf;
  17772. msession->has_peeked_byte = true;
  17773. return false;
  17774. }
  17775. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17776. // If we get a peer close notify or a connection reset, the peer is closed
  17777. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17778. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17779. }
  17780. inline cert_t get_peer_cert(const_session_t session) {
  17781. if (!session) { return nullptr; }
  17782. auto msession =
  17783. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17784. // Mbed TLS returns a pointer to the internal peer cert chain.
  17785. // WARNING: This pointer is only valid while the session is active.
  17786. // Do not use the certificate after calling free_session().
  17787. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17788. return const_cast<mbedtls_x509_crt *>(cert);
  17789. }
  17790. inline void free_cert(cert_t cert) {
  17791. // Mbed TLS: peer certificate is owned by the SSL context.
  17792. // No-op here, but callers should still call this for cross-backend
  17793. // portability.
  17794. (void)cert;
  17795. }
  17796. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17797. if (!cert || !hostname) { return false; }
  17798. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17799. std::string host_str(hostname);
  17800. // Check if hostname is an IP address (IPv4 or IPv6)
  17801. unsigned char ip_bytes[16];
  17802. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17803. auto is_ip = ip_len > 0;
  17804. // Check Subject Alternative Names (SAN)
  17805. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17806. // - DNS names: raw string bytes
  17807. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17808. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17809. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17810. const unsigned char *p = san->buf.p;
  17811. size_t len = san->buf.len;
  17812. if (is_ip) {
  17813. // For an IP host, only a matching iPAddress SAN of the same family
  17814. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17815. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17816. } else {
  17817. // Check if this SAN is a DNS name (printable ASCII string)
  17818. bool is_dns = len > 0;
  17819. for (size_t i = 0; i < len && is_dns; i++) {
  17820. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17821. }
  17822. if (is_dns) {
  17823. std::string san_name(reinterpret_cast<const char *>(p), len);
  17824. if (detail::match_hostname(san_name, host_str)) { return true; }
  17825. }
  17826. }
  17827. san = san->next;
  17828. }
  17829. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17830. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17831. // the OpenSSL backend's X509_check_ip behaves the same way).
  17832. if (!is_ip) {
  17833. char cn[256];
  17834. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17835. if (ret > 0) {
  17836. std::string cn_str(cn);
  17837. // Look for "CN=" in the DN string
  17838. size_t cn_pos = cn_str.find("CN=");
  17839. if (cn_pos != std::string::npos) {
  17840. size_t start = cn_pos + 3;
  17841. size_t end = cn_str.find(',', start);
  17842. std::string cn_value =
  17843. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17844. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17845. }
  17846. }
  17847. }
  17848. return false;
  17849. }
  17850. inline uint64_t hostname_mismatch_code() {
  17851. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17852. }
  17853. inline long get_verify_result(const_session_t session) {
  17854. if (!session) { return -1; }
  17855. auto msession =
  17856. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17857. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17858. // Return 0 (X509_V_OK equivalent) if verification passed
  17859. return flags == 0 ? 0 : static_cast<long>(flags);
  17860. }
  17861. inline std::string get_cert_subject_cn(cert_t cert) {
  17862. if (!cert) return "";
  17863. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17864. // Find the CN in the subject
  17865. const mbedtls_x509_name *name = &x509->subject;
  17866. while (name != nullptr) {
  17867. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17868. return std::string(reinterpret_cast<const char *>(name->val.p),
  17869. name->val.len);
  17870. }
  17871. name = name->next;
  17872. }
  17873. return "";
  17874. }
  17875. inline std::string get_cert_issuer_name(cert_t cert) {
  17876. if (!cert) return "";
  17877. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17878. // Build a human-readable issuer name string
  17879. char buf[512];
  17880. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17881. if (ret < 0) return "";
  17882. return std::string(buf);
  17883. }
  17884. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17885. sans.clear();
  17886. if (!cert) return false;
  17887. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17888. // Parse the Subject Alternative Name extension
  17889. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17890. while (cur != nullptr) {
  17891. if (cur->buf.len > 0) {
  17892. // Mbed TLS stores SAN as ASN.1 sequences
  17893. // The tag byte indicates the type
  17894. const unsigned char *p = cur->buf.p;
  17895. size_t len = cur->buf.len;
  17896. // First byte is the tag
  17897. unsigned char tag = *p;
  17898. p++;
  17899. len--;
  17900. // Parse length (simple single-byte length assumed)
  17901. if (len > 0 && *p < 0x80) {
  17902. size_t value_len = *p;
  17903. p++;
  17904. len--;
  17905. if (value_len <= len) {
  17906. SanEntry entry;
  17907. // ASN.1 context tags for GeneralName
  17908. switch (tag & 0x1F) {
  17909. case 2: // dNSName
  17910. entry.type = SanType::DNS;
  17911. entry.value =
  17912. std::string(reinterpret_cast<const char *>(p), value_len);
  17913. break;
  17914. case 7: // iPAddress
  17915. entry.type = SanType::IP;
  17916. if (value_len == 4) {
  17917. // IPv4
  17918. char buf[16];
  17919. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17920. entry.value = buf;
  17921. } else if (value_len == 16) {
  17922. // IPv6
  17923. char buf[64];
  17924. snprintf(buf, sizeof(buf),
  17925. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17926. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17927. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17928. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17929. entry.value = buf;
  17930. }
  17931. break;
  17932. case 1: // rfc822Name (email)
  17933. entry.type = SanType::EMAIL;
  17934. entry.value =
  17935. std::string(reinterpret_cast<const char *>(p), value_len);
  17936. break;
  17937. case 6: // uniformResourceIdentifier
  17938. entry.type = SanType::URI;
  17939. entry.value =
  17940. std::string(reinterpret_cast<const char *>(p), value_len);
  17941. break;
  17942. default: entry.type = SanType::OTHER; break;
  17943. }
  17944. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17945. }
  17946. }
  17947. }
  17948. cur = cur->next;
  17949. }
  17950. return true;
  17951. }
  17952. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17953. time_t &not_after) {
  17954. if (!cert) return false;
  17955. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17956. // Convert mbedtls_x509_time to time_t
  17957. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17958. struct tm tm_time = {};
  17959. tm_time.tm_year = t.year - 1900;
  17960. tm_time.tm_mon = t.mon - 1;
  17961. tm_time.tm_mday = t.day;
  17962. tm_time.tm_hour = t.hour;
  17963. tm_time.tm_min = t.min;
  17964. tm_time.tm_sec = t.sec;
  17965. #ifdef _WIN32
  17966. return _mkgmtime(&tm_time);
  17967. #else
  17968. return timegm(&tm_time);
  17969. #endif
  17970. };
  17971. not_before = to_time_t(x509->valid_from);
  17972. not_after = to_time_t(x509->valid_to);
  17973. return true;
  17974. }
  17975. inline std::string get_cert_serial(cert_t cert) {
  17976. if (!cert) return "";
  17977. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17978. // Convert serial number to hex string
  17979. std::string result;
  17980. result.reserve(x509->serial.len * 2);
  17981. for (size_t i = 0; i < x509->serial.len; i++) {
  17982. char hex[3];
  17983. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17984. result += hex;
  17985. }
  17986. return result;
  17987. }
  17988. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17989. if (!cert) return false;
  17990. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17991. if (!crt->raw.p || crt->raw.len == 0) return false;
  17992. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17993. return true;
  17994. }
  17995. inline const char *get_sni(const_session_t session) {
  17996. if (!session) return nullptr;
  17997. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17998. // For server: return SNI received from client during handshake
  17999. if (!msession->sni_hostname.empty()) {
  18000. return msession->sni_hostname.c_str();
  18001. }
  18002. // For client: return the hostname set via set_sni
  18003. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18004. return nullptr;
  18005. }
  18006. inline uint64_t peek_error() {
  18007. // Mbed TLS doesn't have an error queue, return the last error
  18008. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18009. }
  18010. inline uint64_t get_error() {
  18011. // Mbed TLS doesn't have an error queue, return and clear the last error
  18012. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18013. impl::mbedtls_last_error() = 0;
  18014. return err;
  18015. }
  18016. inline std::string error_string(uint64_t code) {
  18017. char buf[256];
  18018. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18019. return std::string(buf);
  18020. }
  18021. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18022. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18023. if (!ca_chain) { return nullptr; }
  18024. mbedtls_x509_crt_init(ca_chain);
  18025. // mbedtls_x509_crt_parse expects null-terminated PEM
  18026. int ret = mbedtls_x509_crt_parse(ca_chain,
  18027. reinterpret_cast<const unsigned char *>(pem),
  18028. len + 1); // +1 for null terminator
  18029. if (ret != 0) {
  18030. // Try without +1 in case PEM is already null-terminated
  18031. ret = mbedtls_x509_crt_parse(
  18032. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18033. if (ret != 0) {
  18034. mbedtls_x509_crt_free(ca_chain);
  18035. delete ca_chain;
  18036. return nullptr;
  18037. }
  18038. }
  18039. return static_cast<ca_store_t>(ca_chain);
  18040. }
  18041. inline void free_ca_store(ca_store_t store) {
  18042. if (store) {
  18043. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18044. mbedtls_x509_crt_free(ca_chain);
  18045. delete ca_chain;
  18046. }
  18047. }
  18048. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18049. if (!ctx || !store) { return false; }
  18050. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18051. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18052. // Free existing CA chain
  18053. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18054. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18055. // Copy the CA chain (deep copy)
  18056. // Parse from the raw data of the source cert
  18057. mbedtls_x509_crt *src = ca_chain;
  18058. while (src != nullptr) {
  18059. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18060. src->raw.len);
  18061. if (ret != 0) {
  18062. free_ca_store(store);
  18063. return false;
  18064. }
  18065. src = src->next;
  18066. }
  18067. // This function takes ownership of the store; the chain was deep-copied
  18068. // above, so release the source
  18069. free_ca_store(store);
  18070. // Update the SSL config to use the new CA chain
  18071. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18072. return true;
  18073. }
  18074. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18075. certs.clear();
  18076. if (!ctx) { return 0; }
  18077. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18078. // Iterate through the CA chain
  18079. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18080. while (cert != nullptr && cert->raw.len > 0) {
  18081. // Create a copy of the certificate for the caller
  18082. auto *copy = new mbedtls_x509_crt;
  18083. mbedtls_x509_crt_init(copy);
  18084. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18085. if (ret == 0) {
  18086. certs.push_back(static_cast<cert_t>(copy));
  18087. } else {
  18088. mbedtls_x509_crt_free(copy);
  18089. delete copy;
  18090. }
  18091. cert = cert->next;
  18092. }
  18093. return certs.size();
  18094. }
  18095. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18096. std::vector<std::string> names;
  18097. if (!ctx) { return names; }
  18098. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18099. // Iterate through the CA chain
  18100. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18101. while (cert != nullptr && cert->raw.len > 0) {
  18102. char buf[512];
  18103. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18104. if (ret > 0) { names.push_back(buf); }
  18105. cert = cert->next;
  18106. }
  18107. return names;
  18108. }
  18109. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18110. const char *key_pem, const char *password) {
  18111. if (!ctx || !cert_pem || !key_pem) { return false; }
  18112. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18113. // Free existing certificate and key
  18114. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18115. mbedtls_pk_free(&mbed_ctx->own_key);
  18116. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18117. mbedtls_pk_init(&mbed_ctx->own_key);
  18118. // Parse certificate PEM
  18119. int ret = mbedtls_x509_crt_parse(
  18120. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18121. strlen(cert_pem) + 1);
  18122. if (ret != 0) {
  18123. impl::mbedtls_last_error() = ret;
  18124. return false;
  18125. }
  18126. // Parse private key PEM
  18127. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18128. ret = mbedtls_pk_parse_key(
  18129. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18130. strlen(key_pem) + 1,
  18131. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18132. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18133. &mbed_ctx->ctr_drbg);
  18134. #else
  18135. ret = mbedtls_pk_parse_key(
  18136. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18137. strlen(key_pem) + 1,
  18138. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18139. password ? strlen(password) : 0);
  18140. #endif
  18141. if (ret != 0) {
  18142. impl::mbedtls_last_error() = ret;
  18143. return false;
  18144. }
  18145. // Configure SSL to use the new certificate and key
  18146. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18147. &mbed_ctx->own_key);
  18148. if (ret != 0) {
  18149. impl::mbedtls_last_error() = ret;
  18150. return false;
  18151. }
  18152. return true;
  18153. }
  18154. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18155. if (!ctx || !ca_pem) { return false; }
  18156. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18157. // Free existing CA chain
  18158. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18159. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18160. // Parse CA PEM
  18161. int ret = mbedtls_x509_crt_parse(
  18162. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18163. strlen(ca_pem) + 1);
  18164. if (ret != 0) {
  18165. impl::mbedtls_last_error() = ret;
  18166. return false;
  18167. }
  18168. // Update SSL config to use new CA chain
  18169. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18170. return true;
  18171. }
  18172. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18173. if (!ctx) { return false; }
  18174. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18175. impl::get_verify_callback() = std::move(callback);
  18176. mbed_ctx->has_verify_callback =
  18177. static_cast<bool>(impl::get_verify_callback());
  18178. if (mbed_ctx->has_verify_callback) {
  18179. // Set OPTIONAL mode to ensure callback is called even when verification
  18180. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18181. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18182. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18183. nullptr);
  18184. } else {
  18185. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18186. }
  18187. return true;
  18188. }
  18189. inline long get_verify_error(const_session_t session) {
  18190. if (!session) { return -1; }
  18191. auto *msession =
  18192. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18193. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18194. }
  18195. inline std::string verify_error_string(long error_code) {
  18196. if (error_code == 0) { return ""; }
  18197. char buf[256];
  18198. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18199. static_cast<uint32_t>(error_code));
  18200. // Remove trailing newline if present
  18201. std::string result(buf);
  18202. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18203. result.pop_back();
  18204. }
  18205. return result;
  18206. }
  18207. } // namespace tls
  18208. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18209. /*
  18210. * Group 10: TLS abstraction layer - wolfSSL backend
  18211. */
  18212. /*
  18213. * wolfSSL Backend Implementation
  18214. */
  18215. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18216. namespace tls {
  18217. namespace impl {
  18218. // wolfSSL session wrapper
  18219. struct WolfSSLSession {
  18220. WOLFSSL *ssl = nullptr;
  18221. socket_t sock = INVALID_SOCKET;
  18222. std::string hostname; // For client: set via set_sni
  18223. std::string sni_hostname; // For server: received from client via SNI callback
  18224. WolfSSLSession() = default;
  18225. ~WolfSSLSession() {
  18226. if (ssl) { wolfSSL_free(ssl); }
  18227. }
  18228. WolfSSLSession(const WolfSSLSession &) = delete;
  18229. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18230. };
  18231. // Thread-local error code accessor for wolfSSL
  18232. inline uint64_t &wolfssl_last_error() {
  18233. static thread_local uint64_t err = 0;
  18234. return err;
  18235. }
  18236. // Helper to map wolfSSL error to ErrorCode.
  18237. // ssl_error is the value from wolfSSL_get_error().
  18238. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18239. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18240. int &out_errno) {
  18241. switch (ssl_error) {
  18242. case SSL_ERROR_NONE: return ErrorCode::Success;
  18243. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18244. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18245. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18246. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18247. default:
  18248. if (ssl) {
  18249. // wolfSSL stores the low-level error code as a negative value.
  18250. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18251. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18252. if (low_err == DOMAIN_NAME_MISMATCH) {
  18253. return ErrorCode::HostnameMismatch;
  18254. }
  18255. // Check verify result to distinguish cert verification from generic SSL
  18256. // errors.
  18257. long vr = wolfSSL_get_verify_result(ssl);
  18258. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18259. }
  18260. return ErrorCode::Fatal;
  18261. }
  18262. }
  18263. // WolfSSLContext constructor/destructor implementations
  18264. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18265. inline WolfSSLContext::~WolfSSLContext() {
  18266. if (ctx) { wolfSSL_CTX_free(ctx); }
  18267. }
  18268. // Thread-local storage for SNI captured during handshake
  18269. inline std::string &wolfssl_pending_sni() {
  18270. static thread_local std::string sni;
  18271. return sni;
  18272. }
  18273. // SNI callback for wolfSSL server to capture client's SNI hostname
  18274. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18275. (void)ret;
  18276. (void)exArg;
  18277. void *name_data = nullptr;
  18278. unsigned short name_len =
  18279. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18280. if (name_data && name_len > 0) {
  18281. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18282. name_len);
  18283. } else {
  18284. wolfssl_pending_sni().clear();
  18285. }
  18286. return 0; // Continue regardless
  18287. }
  18288. // wolfSSL verify callback wrapper
  18289. inline int wolfssl_verify_callback(int preverify_ok,
  18290. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18291. auto &callback = get_verify_callback();
  18292. if (!callback) { return preverify_ok; }
  18293. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18294. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18295. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18296. // Get the WOLFSSL object from the X509_STORE_CTX
  18297. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18298. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18299. VerifyContext verify_ctx;
  18300. verify_ctx.session = static_cast<session_t>(ssl);
  18301. verify_ctx.cert = static_cast<cert_t>(cert);
  18302. verify_ctx.depth = depth;
  18303. verify_ctx.preverify_ok = (preverify_ok != 0);
  18304. verify_ctx.error_code = static_cast<long>(err);
  18305. if (err != 0) {
  18306. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18307. } else {
  18308. verify_ctx.error_string = nullptr;
  18309. }
  18310. bool accepted = callback(verify_ctx);
  18311. return accepted ? 1 : 0;
  18312. }
  18313. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18314. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18315. wolfSSL_CTX_set_default_passwd_cb(
  18316. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18317. auto *pwd = static_cast<const char *>(userdata);
  18318. if (!pwd) return 0;
  18319. auto len = static_cast<int>(strlen(pwd));
  18320. if (len > size) len = size;
  18321. memcpy(buf, pwd, static_cast<size_t>(len));
  18322. return len;
  18323. });
  18324. }
  18325. } // namespace impl
  18326. inline ctx_t create_client_context() {
  18327. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18328. if (!ctx) { return nullptr; }
  18329. ctx->is_server = false;
  18330. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18331. if (!method) {
  18332. delete ctx;
  18333. return nullptr;
  18334. }
  18335. ctx->ctx = wolfSSL_CTX_new(method);
  18336. if (!ctx->ctx) {
  18337. delete ctx;
  18338. return nullptr;
  18339. }
  18340. // Default: verify peer certificate
  18341. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18342. return static_cast<ctx_t>(ctx);
  18343. }
  18344. inline ctx_t create_server_context() {
  18345. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18346. if (!ctx) { return nullptr; }
  18347. ctx->is_server = true;
  18348. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18349. if (!method) {
  18350. delete ctx;
  18351. return nullptr;
  18352. }
  18353. ctx->ctx = wolfSSL_CTX_new(method);
  18354. if (!ctx->ctx) {
  18355. delete ctx;
  18356. return nullptr;
  18357. }
  18358. // Default: don't verify client
  18359. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18360. // Enable SNI on server
  18361. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18362. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18363. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18364. return static_cast<ctx_t>(ctx);
  18365. }
  18366. inline void free_context(ctx_t ctx) {
  18367. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18368. }
  18369. inline bool set_min_version(ctx_t ctx, Version version) {
  18370. if (!ctx) { return false; }
  18371. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18372. int min_ver = WOLFSSL_TLSV1_2;
  18373. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18374. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18375. }
  18376. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18377. if (!ctx || !pem) { return false; }
  18378. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18379. int ret = wolfSSL_CTX_load_verify_buffer(
  18380. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18381. static_cast<long>(len), SSL_FILETYPE_PEM);
  18382. if (ret != SSL_SUCCESS) {
  18383. impl::wolfssl_last_error() =
  18384. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18385. return false;
  18386. }
  18387. wctx->ca_pem_data_.append(pem, len);
  18388. return true;
  18389. }
  18390. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18391. if (!ctx || !file_path) { return false; }
  18392. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18393. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18394. if (ret != SSL_SUCCESS) {
  18395. impl::wolfssl_last_error() =
  18396. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18397. return false;
  18398. }
  18399. return true;
  18400. }
  18401. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18402. if (!ctx || !dir_path) { return false; }
  18403. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18404. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18405. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18406. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18407. // immediately. Return true even on failure since the CA file may have
  18408. // already been loaded, matching OpenSSL's lenient behavior.
  18409. (void)ret;
  18410. return true;
  18411. }
  18412. inline bool load_system_certs(ctx_t ctx) {
  18413. if (!ctx) { return false; }
  18414. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18415. bool loaded = false;
  18416. #ifdef _WIN32
  18417. loaded = impl::enumerate_windows_system_certs(
  18418. [&](const unsigned char *data, size_t len) {
  18419. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18420. static_cast<long>(len),
  18421. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18422. });
  18423. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18424. loaded = impl::enumerate_macos_keychain_certs(
  18425. [&](const unsigned char *data, size_t len) {
  18426. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18427. static_cast<long>(len),
  18428. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18429. });
  18430. #else
  18431. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18432. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18433. SSL_SUCCESS) {
  18434. loaded = true;
  18435. break;
  18436. }
  18437. }
  18438. if (!loaded) {
  18439. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18440. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18441. SSL_SUCCESS) {
  18442. loaded = true;
  18443. break;
  18444. }
  18445. }
  18446. }
  18447. #endif
  18448. return loaded;
  18449. }
  18450. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18451. const char *password) {
  18452. if (!ctx || !cert || !key) { return false; }
  18453. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18454. // Load certificate
  18455. int ret = wolfSSL_CTX_use_certificate_buffer(
  18456. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18457. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18458. if (ret != SSL_SUCCESS) {
  18459. impl::wolfssl_last_error() =
  18460. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18461. return false;
  18462. }
  18463. // Set password callback if password is provided
  18464. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18465. // Load private key
  18466. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18467. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18468. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18469. if (ret != SSL_SUCCESS) {
  18470. impl::wolfssl_last_error() =
  18471. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18472. return false;
  18473. }
  18474. // Verify that the certificate and private key match
  18475. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18476. }
  18477. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18478. const char *key_path, const char *password) {
  18479. if (!ctx || !cert_path || !key_path) { return false; }
  18480. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18481. // Load certificate file
  18482. int ret =
  18483. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18484. if (ret != SSL_SUCCESS) {
  18485. impl::wolfssl_last_error() =
  18486. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18487. return false;
  18488. }
  18489. // Set password callback if password is provided
  18490. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18491. // Load private key file
  18492. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18493. if (ret != SSL_SUCCESS) {
  18494. impl::wolfssl_last_error() =
  18495. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18496. return false;
  18497. }
  18498. // Verify that the certificate and private key match
  18499. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18500. }
  18501. inline void set_verify_client(ctx_t ctx, bool require) {
  18502. if (!ctx) { return; }
  18503. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18504. wctx->verify_client = require;
  18505. if (require) {
  18506. wolfSSL_CTX_set_verify(
  18507. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18508. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18509. } else {
  18510. if (wctx->has_verify_callback) {
  18511. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18512. impl::wolfssl_verify_callback);
  18513. } else {
  18514. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18515. }
  18516. }
  18517. }
  18518. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18519. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18520. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18521. auto session = new (std::nothrow) impl::WolfSSLSession();
  18522. if (!session) { return nullptr; }
  18523. session->sock = sock;
  18524. session->ssl = wolfSSL_new(wctx->ctx);
  18525. if (!session->ssl) {
  18526. impl::wolfssl_last_error() =
  18527. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18528. delete session;
  18529. return nullptr;
  18530. }
  18531. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18532. return static_cast<session_t>(session);
  18533. }
  18534. inline void free_session(session_t session) {
  18535. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18536. }
  18537. inline bool set_sni(session_t session, const char *hostname,
  18538. bool verify_hostname) {
  18539. if (!session || !hostname) { return false; }
  18540. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18541. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18542. static_cast<word16>(strlen(hostname)));
  18543. if (ret != WOLFSSL_SUCCESS) {
  18544. impl::wolfssl_last_error() =
  18545. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18546. return false;
  18547. }
  18548. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18549. // separately from the SNI extension sent above; skip it when hostname
  18550. // verification is disabled so only the chain is checked, matching OpenSSL.
  18551. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18552. wsession->hostname = hostname;
  18553. return true;
  18554. }
  18555. inline TlsError connect(session_t session) {
  18556. TlsError err;
  18557. if (!session) {
  18558. err.code = ErrorCode::Fatal;
  18559. return err;
  18560. }
  18561. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18562. int ret = wolfSSL_connect(wsession->ssl);
  18563. if (ret == SSL_SUCCESS) {
  18564. err.code = ErrorCode::Success;
  18565. } else {
  18566. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18567. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18568. err.backend_code = static_cast<uint64_t>(ssl_error);
  18569. impl::wolfssl_last_error() = err.backend_code;
  18570. }
  18571. return err;
  18572. }
  18573. inline TlsError accept(session_t session) {
  18574. TlsError err;
  18575. if (!session) {
  18576. err.code = ErrorCode::Fatal;
  18577. return err;
  18578. }
  18579. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18580. int ret = wolfSSL_accept(wsession->ssl);
  18581. if (ret == SSL_SUCCESS) {
  18582. err.code = ErrorCode::Success;
  18583. // Capture SNI from thread-local storage after successful handshake
  18584. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18585. impl::wolfssl_pending_sni().clear();
  18586. } else {
  18587. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18588. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18589. err.backend_code = static_cast<uint64_t>(ssl_error);
  18590. impl::wolfssl_last_error() = err.backend_code;
  18591. }
  18592. return err;
  18593. }
  18594. inline bool connect_nonblocking(session_t session, socket_t sock,
  18595. time_t timeout_sec, time_t timeout_usec,
  18596. TlsError *err) {
  18597. if (!session) {
  18598. if (err) { err->code = ErrorCode::Fatal; }
  18599. return false;
  18600. }
  18601. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18602. // Set socket to non-blocking mode
  18603. detail::set_nonblocking(sock, true);
  18604. auto cleanup =
  18605. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18606. int ret;
  18607. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18608. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18609. if (ssl_error == SSL_ERROR_WANT_READ) {
  18610. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18611. continue;
  18612. }
  18613. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18614. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18615. continue;
  18616. }
  18617. }
  18618. // Error or timeout
  18619. if (err) {
  18620. err->code =
  18621. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18622. err->backend_code = static_cast<uint64_t>(ssl_error);
  18623. }
  18624. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18625. return false;
  18626. }
  18627. if (err) { err->code = ErrorCode::Success; }
  18628. return true;
  18629. }
  18630. inline bool accept_nonblocking(session_t session, socket_t sock,
  18631. time_t timeout_sec, time_t timeout_usec,
  18632. TlsError *err) {
  18633. if (!session) {
  18634. if (err) { err->code = ErrorCode::Fatal; }
  18635. return false;
  18636. }
  18637. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18638. // Set socket to non-blocking mode
  18639. detail::set_nonblocking(sock, true);
  18640. auto cleanup =
  18641. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18642. int ret;
  18643. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18644. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18645. if (ssl_error == SSL_ERROR_WANT_READ) {
  18646. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18647. continue;
  18648. }
  18649. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18650. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18651. continue;
  18652. }
  18653. }
  18654. // Error or timeout
  18655. if (err) {
  18656. err->code =
  18657. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18658. err->backend_code = static_cast<uint64_t>(ssl_error);
  18659. }
  18660. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18661. return false;
  18662. }
  18663. if (err) { err->code = ErrorCode::Success; }
  18664. // Capture SNI from thread-local storage after successful handshake
  18665. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18666. impl::wolfssl_pending_sni().clear();
  18667. return true;
  18668. }
  18669. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18670. if (!session || !buf) {
  18671. err.code = ErrorCode::Fatal;
  18672. return -1;
  18673. }
  18674. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18675. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18676. if (ret > 0) {
  18677. err.code = ErrorCode::Success;
  18678. return static_cast<ssize_t>(ret);
  18679. }
  18680. if (ret == 0) {
  18681. err.code = ErrorCode::PeerClosed;
  18682. return 0;
  18683. }
  18684. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18685. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18686. err.backend_code = static_cast<uint64_t>(ssl_error);
  18687. impl::wolfssl_last_error() = err.backend_code;
  18688. return -1;
  18689. }
  18690. inline ssize_t write(session_t session, const void *buf, size_t len,
  18691. TlsError &err) {
  18692. if (!session || !buf) {
  18693. err.code = ErrorCode::Fatal;
  18694. return -1;
  18695. }
  18696. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18697. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18698. if (ret > 0) {
  18699. err.code = ErrorCode::Success;
  18700. return static_cast<ssize_t>(ret);
  18701. }
  18702. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18703. // Treat this as an error (return -1) so callers don't spin in a
  18704. // write loop adding zero to the offset.
  18705. if (ret == 0) {
  18706. err.code = ErrorCode::PeerClosed;
  18707. return -1;
  18708. }
  18709. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18710. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18711. err.backend_code = static_cast<uint64_t>(ssl_error);
  18712. impl::wolfssl_last_error() = err.backend_code;
  18713. return -1;
  18714. }
  18715. inline int pending(const_session_t session) {
  18716. if (!session) { return 0; }
  18717. auto wsession =
  18718. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18719. return wolfSSL_pending(wsession->ssl);
  18720. }
  18721. inline void shutdown(session_t session, bool graceful) {
  18722. if (!session) { return; }
  18723. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18724. if (graceful) {
  18725. int ret;
  18726. int attempts = 0;
  18727. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18728. attempts < 3) {
  18729. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18730. if (ssl_error != SSL_ERROR_WANT_READ &&
  18731. ssl_error != SSL_ERROR_WANT_WRITE) {
  18732. break;
  18733. }
  18734. attempts++;
  18735. }
  18736. } else {
  18737. wolfSSL_shutdown(wsession->ssl);
  18738. }
  18739. }
  18740. inline bool is_peer_closed(session_t session, socket_t sock) {
  18741. if (!session || sock == INVALID_SOCKET) { return true; }
  18742. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18743. // Check if there's already decrypted data available
  18744. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18745. // Set socket to non-blocking to avoid blocking on read
  18746. detail::set_nonblocking(sock, true);
  18747. auto cleanup =
  18748. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18749. // Peek 1 byte to check connection status without consuming data
  18750. unsigned char buf;
  18751. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18752. // If we got data or WANT_READ (would block), connection is alive
  18753. if (ret > 0) { return false; }
  18754. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18755. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18756. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18757. ret == 0;
  18758. }
  18759. inline cert_t get_peer_cert(const_session_t session) {
  18760. if (!session) { return nullptr; }
  18761. auto wsession =
  18762. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18763. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18764. return static_cast<cert_t>(cert);
  18765. }
  18766. inline void free_cert(cert_t cert) {
  18767. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18768. }
  18769. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18770. if (!cert || !hostname) { return false; }
  18771. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18772. std::string host_str(hostname);
  18773. // Check if hostname is an IP address (IPv4 or IPv6)
  18774. unsigned char ip_bytes[16];
  18775. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18776. auto is_ip = ip_len > 0;
  18777. // Check Subject Alternative Names
  18778. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18779. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18780. if (san_names) {
  18781. int san_count = wolfSSL_sk_num(san_names);
  18782. for (int i = 0; i < san_count; i++) {
  18783. auto *names =
  18784. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18785. if (!names) continue;
  18786. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18787. // DNS name
  18788. unsigned char *dns_name = nullptr;
  18789. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18790. if (dns_name && dns_len > 0) {
  18791. std::string san_name(reinterpret_cast<char *>(dns_name),
  18792. static_cast<size_t>(dns_len));
  18793. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18794. if (detail::match_hostname(san_name, host_str)) {
  18795. wolfSSL_sk_free(san_names);
  18796. return true;
  18797. }
  18798. }
  18799. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18800. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18801. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18802. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18803. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18804. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18805. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18806. wolfSSL_sk_free(san_names);
  18807. return true;
  18808. }
  18809. }
  18810. }
  18811. wolfSSL_sk_free(san_names);
  18812. }
  18813. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18814. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18815. // the OpenSSL backend's X509_check_ip behaves the same way).
  18816. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18817. if (subject) {
  18818. char cn[256] = {};
  18819. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18820. sizeof(cn));
  18821. if (cn_len > 0) {
  18822. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18823. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18824. }
  18825. }
  18826. return false;
  18827. }
  18828. inline uint64_t hostname_mismatch_code() {
  18829. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18830. }
  18831. inline long get_verify_result(const_session_t session) {
  18832. if (!session) { return -1; }
  18833. auto wsession =
  18834. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18835. long result = wolfSSL_get_verify_result(wsession->ssl);
  18836. return result;
  18837. }
  18838. inline std::string get_cert_subject_cn(cert_t cert) {
  18839. if (!cert) return "";
  18840. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18841. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18842. if (!subject) return "";
  18843. char cn[256] = {};
  18844. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18845. sizeof(cn));
  18846. if (cn_len <= 0) return "";
  18847. return std::string(cn, static_cast<size_t>(cn_len));
  18848. }
  18849. inline std::string get_cert_issuer_name(cert_t cert) {
  18850. if (!cert) return "";
  18851. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18852. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18853. if (!issuer) return "";
  18854. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18855. if (!name_str) return "";
  18856. std::string result(name_str);
  18857. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18858. return result;
  18859. }
  18860. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18861. sans.clear();
  18862. if (!cert) return false;
  18863. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18864. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18865. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18866. if (!san_names) return true; // No SANs is not an error
  18867. int count = wolfSSL_sk_num(san_names);
  18868. for (int i = 0; i < count; i++) {
  18869. auto *name =
  18870. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18871. if (!name) continue;
  18872. SanEntry entry;
  18873. switch (name->type) {
  18874. case WOLFSSL_GEN_DNS: {
  18875. entry.type = SanType::DNS;
  18876. unsigned char *dns_name = nullptr;
  18877. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18878. if (dns_name && dns_len > 0) {
  18879. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18880. static_cast<size_t>(dns_len));
  18881. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18882. }
  18883. break;
  18884. }
  18885. case WOLFSSL_GEN_IPADD: {
  18886. entry.type = SanType::IP;
  18887. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18888. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18889. if (ip_data && ip_len == 4) {
  18890. char buf[16];
  18891. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18892. ip_data[2], ip_data[3]);
  18893. entry.value = buf;
  18894. } else if (ip_data && ip_len == 16) {
  18895. char buf[64];
  18896. snprintf(buf, sizeof(buf),
  18897. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18898. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18899. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18900. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18901. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18902. ip_data[14], ip_data[15]);
  18903. entry.value = buf;
  18904. }
  18905. break;
  18906. }
  18907. case WOLFSSL_GEN_EMAIL:
  18908. entry.type = SanType::EMAIL;
  18909. {
  18910. unsigned char *email = nullptr;
  18911. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18912. if (email && email_len > 0) {
  18913. entry.value = std::string(reinterpret_cast<char *>(email),
  18914. static_cast<size_t>(email_len));
  18915. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18916. }
  18917. }
  18918. break;
  18919. case WOLFSSL_GEN_URI:
  18920. entry.type = SanType::URI;
  18921. {
  18922. unsigned char *uri = nullptr;
  18923. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18924. &uri, name->d.uniformResourceIdentifier);
  18925. if (uri && uri_len > 0) {
  18926. entry.value = std::string(reinterpret_cast<char *>(uri),
  18927. static_cast<size_t>(uri_len));
  18928. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18929. }
  18930. }
  18931. break;
  18932. default: entry.type = SanType::OTHER; break;
  18933. }
  18934. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18935. }
  18936. wolfSSL_sk_free(san_names);
  18937. return true;
  18938. }
  18939. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18940. time_t &not_after) {
  18941. if (!cert) return false;
  18942. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18943. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18944. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18945. if (!nb || !na) return false;
  18946. // wolfSSL_ASN1_TIME_to_tm is available
  18947. struct tm tm_nb = {}, tm_na = {};
  18948. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18949. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18950. #ifdef _WIN32
  18951. not_before = _mkgmtime(&tm_nb);
  18952. not_after = _mkgmtime(&tm_na);
  18953. #else
  18954. not_before = timegm(&tm_nb);
  18955. not_after = timegm(&tm_na);
  18956. #endif
  18957. return true;
  18958. }
  18959. inline std::string get_cert_serial(cert_t cert) {
  18960. if (!cert) return "";
  18961. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18962. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18963. if (!serial_asn1) return "";
  18964. // Get the serial number data
  18965. int len = serial_asn1->length;
  18966. unsigned char *data = serial_asn1->data;
  18967. if (!data || len <= 0) return "";
  18968. std::string result;
  18969. result.reserve(static_cast<size_t>(len) * 2);
  18970. for (int i = 0; i < len; i++) {
  18971. char hex[3];
  18972. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18973. result += hex;
  18974. }
  18975. return result;
  18976. }
  18977. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18978. if (!cert) return false;
  18979. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18980. int der_len = 0;
  18981. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18982. if (!der_data || der_len <= 0) return false;
  18983. der.assign(der_data, der_data + der_len);
  18984. return true;
  18985. }
  18986. inline const char *get_sni(const_session_t session) {
  18987. if (!session) return nullptr;
  18988. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18989. // For server: return SNI received from client during handshake
  18990. if (!wsession->sni_hostname.empty()) {
  18991. return wsession->sni_hostname.c_str();
  18992. }
  18993. // For client: return the hostname set via set_sni
  18994. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18995. return nullptr;
  18996. }
  18997. inline uint64_t peek_error() {
  18998. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18999. }
  19000. inline uint64_t get_error() {
  19001. uint64_t err = impl::wolfssl_last_error();
  19002. impl::wolfssl_last_error() = 0;
  19003. return err;
  19004. }
  19005. inline std::string error_string(uint64_t code) {
  19006. char buf[256];
  19007. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19008. return std::string(buf);
  19009. }
  19010. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19011. if (!pem || len == 0) { return nullptr; }
  19012. // Validate by attempting to load into a temporary ctx
  19013. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19014. if (!tmp_ctx) { return nullptr; }
  19015. int ret = wolfSSL_CTX_load_verify_buffer(
  19016. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19017. static_cast<long>(len), SSL_FILETYPE_PEM);
  19018. wolfSSL_CTX_free(tmp_ctx);
  19019. if (ret != SSL_SUCCESS) { return nullptr; }
  19020. return static_cast<ca_store_t>(
  19021. new impl::WolfSSLCAStore{std::string(pem, len)});
  19022. }
  19023. inline void free_ca_store(ca_store_t store) {
  19024. delete static_cast<impl::WolfSSLCAStore *>(store);
  19025. }
  19026. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19027. if (!ctx || !store) { return false; }
  19028. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19029. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19030. int ret = wolfSSL_CTX_load_verify_buffer(
  19031. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19032. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19033. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19034. // This function takes ownership of the store; the PEM data was copied into
  19035. // the context, so release the source
  19036. free_ca_store(store);
  19037. return ret == SSL_SUCCESS;
  19038. }
  19039. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19040. certs.clear();
  19041. if (!ctx) { return 0; }
  19042. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19043. if (wctx->ca_pem_data_.empty()) { return 0; }
  19044. const std::string &pem = wctx->ca_pem_data_;
  19045. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19046. const std::string end_marker = "-----END CERTIFICATE-----";
  19047. size_t pos = 0;
  19048. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19049. size_t end_pos = pem.find(end_marker, pos);
  19050. if (end_pos == std::string::npos) { break; }
  19051. end_pos += end_marker.size();
  19052. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19053. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19054. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19055. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19056. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19057. pos = end_pos;
  19058. }
  19059. return certs.size();
  19060. }
  19061. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19062. std::vector<std::string> names;
  19063. if (!ctx) { return names; }
  19064. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19065. if (wctx->ca_pem_data_.empty()) { return names; }
  19066. const std::string &pem = wctx->ca_pem_data_;
  19067. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19068. const std::string end_marker = "-----END CERTIFICATE-----";
  19069. size_t pos = 0;
  19070. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19071. size_t end_pos = pem.find(end_marker, pos);
  19072. if (end_pos == std::string::npos) { break; }
  19073. end_pos += end_marker.size();
  19074. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19075. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19076. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19077. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19078. if (x509) {
  19079. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19080. if (subject) {
  19081. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19082. if (name_str) {
  19083. names.push_back(name_str);
  19084. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19085. }
  19086. }
  19087. wolfSSL_X509_free(x509);
  19088. }
  19089. pos = end_pos;
  19090. }
  19091. return names;
  19092. }
  19093. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19094. const char *key_pem, const char *password) {
  19095. if (!ctx || !cert_pem || !key_pem) { return false; }
  19096. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19097. // Load new certificate
  19098. int ret = wolfSSL_CTX_use_certificate_buffer(
  19099. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19100. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19101. if (ret != SSL_SUCCESS) {
  19102. impl::wolfssl_last_error() =
  19103. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19104. return false;
  19105. }
  19106. // Set password if provided
  19107. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19108. // Load new private key
  19109. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19110. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19111. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19112. if (ret != SSL_SUCCESS) {
  19113. impl::wolfssl_last_error() =
  19114. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19115. return false;
  19116. }
  19117. return true;
  19118. }
  19119. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19120. if (!ctx || !ca_pem) { return false; }
  19121. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19122. int ret = wolfSSL_CTX_load_verify_buffer(
  19123. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19124. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19125. if (ret != SSL_SUCCESS) {
  19126. impl::wolfssl_last_error() =
  19127. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19128. return false;
  19129. }
  19130. return true;
  19131. }
  19132. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19133. if (!ctx) { return false; }
  19134. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19135. impl::get_verify_callback() = std::move(callback);
  19136. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19137. if (wctx->has_verify_callback) {
  19138. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19139. impl::wolfssl_verify_callback);
  19140. } else {
  19141. wolfSSL_CTX_set_verify(
  19142. wctx->ctx,
  19143. wctx->verify_client
  19144. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19145. : SSL_VERIFY_NONE,
  19146. nullptr);
  19147. }
  19148. return true;
  19149. }
  19150. inline long get_verify_error(const_session_t session) {
  19151. if (!session) { return -1; }
  19152. auto *wsession =
  19153. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19154. return wolfSSL_get_verify_result(wsession->ssl);
  19155. }
  19156. inline std::string verify_error_string(long error_code) {
  19157. if (error_code == 0) { return ""; }
  19158. const char *str =
  19159. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19160. return str ? std::string(str) : std::string();
  19161. }
  19162. } // namespace tls
  19163. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19164. // WebSocket implementation
  19165. namespace ws {
  19166. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19167. bool fin) {
  19168. std::lock_guard<std::mutex> lock(write_mutex_);
  19169. if (closed_) { return false; }
  19170. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19171. }
  19172. inline ReadResult WebSocket::read(std::string &msg) {
  19173. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19174. while (!closed_) {
  19175. Opcode opcode;
  19176. std::string payload;
  19177. bool fin;
  19178. impl::FrameRead r =
  19179. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19180. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19181. // A timeout landed on a frame boundary: the connection is untouched and
  19182. // still usable, so hand control back without closing it. That is only
  19183. // useful to a caller who asked for the timeout; the compile-time default
  19184. // is a backstop against a peer gone quiet, and elapsing it closes the
  19185. // connection so a plain `while (ws.read(msg))` loop ends.
  19186. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19187. if (r != impl::FrameRead::Ok) {
  19188. closed_ = true;
  19189. return Fail;
  19190. }
  19191. switch (opcode) {
  19192. case Opcode::Ping: {
  19193. std::lock_guard<std::mutex> lock(write_mutex_);
  19194. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19195. payload.size(), true, !is_server_);
  19196. continue;
  19197. }
  19198. case Opcode::Pong: {
  19199. std::lock_guard<std::mutex> lock(ping_mutex_);
  19200. unacked_pings_ = 0;
  19201. continue;
  19202. }
  19203. case Opcode::Close: {
  19204. if (!closed_.exchange(true)) {
  19205. // Echo close frame back
  19206. std::lock_guard<std::mutex> lock(write_mutex_);
  19207. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19208. payload.size(), true, !is_server_);
  19209. }
  19210. return Fail;
  19211. }
  19212. case Opcode::Text:
  19213. case Opcode::Binary: {
  19214. auto result = opcode == Opcode::Text ? Text : Binary;
  19215. msg = std::move(payload);
  19216. // Handle fragmentation
  19217. if (!fin) {
  19218. while (true) {
  19219. Opcode cont_opcode;
  19220. std::string cont_payload;
  19221. bool cont_fin;
  19222. // A timeout is not reportable here: half of a fragmented message is
  19223. // already in `msg` and read() has no way to resume it, so it is a
  19224. // failure like any other. Timeouts are only ever seen on a message
  19225. // boundary.
  19226. if (impl::read_websocket_frame(
  19227. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19228. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19229. impl::FrameRead::Ok) {
  19230. closed_ = true;
  19231. return Fail;
  19232. }
  19233. if (cont_opcode == Opcode::Ping) {
  19234. std::lock_guard<std::mutex> lock(write_mutex_);
  19235. detail::write_websocket_frame(
  19236. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19237. true, !is_server_);
  19238. continue;
  19239. }
  19240. if (cont_opcode == Opcode::Pong) {
  19241. std::lock_guard<std::mutex> lock(ping_mutex_);
  19242. unacked_pings_ = 0;
  19243. continue;
  19244. }
  19245. if (cont_opcode == Opcode::Close) {
  19246. if (!closed_.exchange(true)) {
  19247. std::lock_guard<std::mutex> lock(write_mutex_);
  19248. detail::write_websocket_frame(
  19249. strm_, Opcode::Close, cont_payload.data(),
  19250. cont_payload.size(), true, !is_server_);
  19251. }
  19252. return Fail;
  19253. }
  19254. // RFC 6455: continuation frames must use opcode 0x0
  19255. if (cont_opcode != Opcode::Continuation) {
  19256. closed_ = true;
  19257. return Fail;
  19258. }
  19259. msg += cont_payload;
  19260. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19261. closed_ = true;
  19262. return Fail;
  19263. }
  19264. if (cont_fin) { break; }
  19265. }
  19266. }
  19267. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19268. if (result == Text && !impl::is_valid_utf8(msg)) {
  19269. // close() takes the read lock to wait for the peer's Close reply, so
  19270. // it must not run while this thread still holds it.
  19271. read_lock.unlock();
  19272. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19273. return Fail;
  19274. }
  19275. return result;
  19276. }
  19277. default: closed_ = true; return Fail;
  19278. }
  19279. }
  19280. return Fail;
  19281. }
  19282. inline bool WebSocket::send(const std::string &data) {
  19283. return send_frame(Opcode::Text, data.data(), data.size());
  19284. }
  19285. inline bool WebSocket::send(const char *data, size_t len) {
  19286. return send_frame(Opcode::Binary, data, len);
  19287. }
  19288. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19289. if (closed_.exchange(true)) { return; }
  19290. ping_cv_.notify_all();
  19291. std::string payload;
  19292. auto code = static_cast<uint16_t>(status);
  19293. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19294. payload.push_back(static_cast<char>(code & 0xFF));
  19295. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19296. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19297. payload += reason.substr(0, 123);
  19298. {
  19299. std::lock_guard<std::mutex> lock(write_mutex_);
  19300. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19301. payload.size(), true, !is_server_);
  19302. }
  19303. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19304. // Close response before closing the TCP connection.
  19305. //
  19306. // Wait only when no other thread is parsing frames. When one is, it is the
  19307. // thread positioned to see the peer's reply, and reading here would take
  19308. // bytes out of the message it is assembling. Bailing out also leaves the
  19309. // stream, including its read timeout, entirely to that thread.
  19310. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19311. if (!read_lock.owns_lock()) { return; }
  19312. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19313. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19314. Opcode op;
  19315. std::string resp;
  19316. bool fin;
  19317. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19318. impl::FrameRead::Ok) {
  19319. if (op == Opcode::Close) { break; }
  19320. }
  19321. }
  19322. inline WebSocket::~WebSocket() {
  19323. {
  19324. std::lock_guard<std::mutex> lock(ping_mutex_);
  19325. closed_ = true;
  19326. }
  19327. ping_cv_.notify_all();
  19328. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19329. }
  19330. inline void WebSocket::start_heartbeat() {
  19331. if (ping_interval_sec_ == 0) { return; }
  19332. ping_thread_ = std::thread([this]() {
  19333. std::unique_lock<std::mutex> lock(ping_mutex_);
  19334. while (!closed_) {
  19335. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19336. if (closed_) { break; }
  19337. // If the peer has failed to respond to the previous pings, give up.
  19338. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19339. // opt-in liveness check controlled by max_missed_pongs_.
  19340. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19341. lock.unlock();
  19342. close(CloseStatus::GoingAway, "pong timeout");
  19343. return;
  19344. }
  19345. lock.unlock();
  19346. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19347. lock.lock();
  19348. closed_ = true;
  19349. break;
  19350. }
  19351. lock.lock();
  19352. unacked_pings_++;
  19353. }
  19354. });
  19355. }
  19356. inline const Request &WebSocket::request() const { return req_; }
  19357. inline bool WebSocket::is_open() const { return !closed_; }
  19358. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19359. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19360. // poll(), where 0 would instead mean "return immediately", so hand it the
  19361. // negative poll uses for an unbounded wait.
  19362. if (sec == 0 && usec == 0) { sec = -1; }
  19363. strm_.set_read_timeout(sec, usec);
  19364. read_timeout_set_ = true;
  19365. }
  19366. // WebSocketClient implementation
  19367. inline WebSocketClient::WebSocketClient(
  19368. const std::string &scheme_host_port_path, const Headers &headers)
  19369. : headers_(headers) {
  19370. detail::UrlComponents uc;
  19371. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19372. !uc.host.empty() && !uc.path.empty()) {
  19373. auto &scheme = uc.scheme;
  19374. #ifdef CPPHTTPLIB_SSL_ENABLED
  19375. if (scheme != "ws" && scheme != "wss") {
  19376. #else
  19377. if (scheme != "ws") {
  19378. #endif
  19379. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19380. std::string msg = "'" + scheme + "' scheme is not supported.";
  19381. throw std::invalid_argument(msg);
  19382. #endif
  19383. return;
  19384. }
  19385. auto is_ssl = scheme == "wss";
  19386. host_ = std::move(uc.host);
  19387. port_ = is_ssl ? 443 : 80;
  19388. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19389. path_ = std::move(uc.path);
  19390. if (!uc.query.empty()) { path_ += uc.query; }
  19391. #ifdef CPPHTTPLIB_SSL_ENABLED
  19392. is_ssl_ = is_ssl;
  19393. if (is_ssl_) {
  19394. // The context lives as long as the client so that CA configuration
  19395. // survives reconnects; sessions are created per connection.
  19396. tls_ctx_ = tls::create_client_context();
  19397. if (!tls_ctx_) { return; }
  19398. }
  19399. #else
  19400. if (is_ssl) { return; }
  19401. #endif
  19402. is_valid_ = true;
  19403. }
  19404. }
  19405. #ifdef CPPHTTPLIB_SSL_ENABLED
  19406. inline WebSocketClient::WebSocketClient(
  19407. const std::string &scheme_host_port_path, const PemMemory &pem,
  19408. const Headers &headers)
  19409. : WebSocketClient(scheme_host_port_path, headers) {
  19410. // For ws:// URLs the client certificate is silently ignored, consistent
  19411. // with the TLS-only setters such as set_ca_cert_path().
  19412. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19413. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19414. pem.private_key_password)) {
  19415. tls::free_context(tls_ctx_);
  19416. tls_ctx_ = nullptr;
  19417. is_valid_ = false;
  19418. }
  19419. }
  19420. }
  19421. #endif
  19422. inline WebSocketClient::~WebSocketClient() {
  19423. shutdown_and_close();
  19424. #ifdef CPPHTTPLIB_SSL_ENABLED
  19425. if (tls_ctx_) {
  19426. tls::free_context(tls_ctx_);
  19427. tls_ctx_ = nullptr;
  19428. }
  19429. #endif
  19430. }
  19431. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19432. inline void WebSocketClient::shutdown_and_close() {
  19433. // Send the close frame while the TLS session is still alive: ws_ holds an
  19434. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19435. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19436. if (ws_ && ws_->is_open()) { ws_->close(); }
  19437. ws_.reset();
  19438. #ifdef CPPHTTPLIB_SSL_ENABLED
  19439. if (is_ssl_) {
  19440. if (tls_session_) {
  19441. tls::shutdown(tls_session_, true);
  19442. tls::free_session(tls_session_);
  19443. tls_session_ = nullptr;
  19444. }
  19445. }
  19446. #endif
  19447. if (sock_ != INVALID_SOCKET) {
  19448. detail::shutdown_socket(sock_);
  19449. detail::close_socket(sock_);
  19450. sock_ = INVALID_SOCKET;
  19451. }
  19452. }
  19453. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19454. Error &error, int &ssl_error,
  19455. uint64_t &ssl_backend_error) {
  19456. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19457. // The streams wait with poll(), where 0 instead means "return immediately",
  19458. // so they are given the negative poll uses for an unbounded wait.
  19459. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19460. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19461. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19462. // The handshake belongs to establishing the connection, so an unset read
  19463. // timeout leaves it bounded by the connection timeout instead of forever.
  19464. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19465. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19466. #ifdef CPPHTTPLIB_SSL_ENABLED
  19467. if (is_ssl_) {
  19468. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19469. // is not safe to call concurrently on one client to begin with, since
  19470. // nothing else here is guarded either.
  19471. if (server_certificate_verification_ && !certs_loaded_) {
  19472. uint64_t backend_error = 0;
  19473. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19474. ca_cert_dir_path_, custom_ca_loaded_,
  19475. system_ca_mode_, backend_error);
  19476. certs_loaded_ = true;
  19477. }
  19478. detail::ClientTlsSessionOptions options;
  19479. options.server_hostname_verification = server_hostname_verification_;
  19480. detail::ClientTlsSessionError tls_error;
  19481. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19482. server_certificate_verification_,
  19483. hs_sec, hs_usec, &tls_error,
  19484. options)) {
  19485. error = tls_error.error;
  19486. ssl_error = tls_error.ssl_error;
  19487. ssl_backend_error = tls_error.backend_error;
  19488. return false;
  19489. }
  19490. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19491. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19492. write_timeout_usec_));
  19493. return true;
  19494. }
  19495. #else
  19496. (void)error;
  19497. (void)ssl_error;
  19498. (void)ssl_backend_error;
  19499. (void)hs_sec;
  19500. (void)hs_usec;
  19501. #endif
  19502. strm = std::unique_ptr<Stream>(
  19503. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19504. write_timeout_sec_, write_timeout_usec_));
  19505. return true;
  19506. }
  19507. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19508. #ifdef CPPHTTPLIB_SSL_ENABLED
  19509. auto is_ssl = is_ssl_;
  19510. #else
  19511. auto is_ssl = false;
  19512. #endif
  19513. if (!req.has_header("Host")) {
  19514. req.headers.emplace("Host", detail::make_default_host_header_value(
  19515. host_, port_, is_ssl, address_family_));
  19516. }
  19517. detail::add_default_user_agent_header(req);
  19518. }
  19519. inline Result WebSocketClient::connect() {
  19520. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19521. shutdown_and_close();
  19522. // Check is custom IP or hostname specified for host_
  19523. std::string connect_host;
  19524. std::string ip;
  19525. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19526. auto error = Error::Success;
  19527. sock_ = detail::create_client_socket(
  19528. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19529. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19530. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19531. write_timeout_usec_, interface_, error);
  19532. if (sock_ == INVALID_SOCKET) {
  19533. if (error == Error::Success) { error = Error::Connection; }
  19534. return Result{error, -1, Headers{}};
  19535. }
  19536. std::unique_ptr<Stream> strm;
  19537. auto stream_error = Error::SSLConnection;
  19538. int ssl_error = 0;
  19539. uint64_t ssl_backend_error = 0;
  19540. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19541. shutdown_and_close();
  19542. #ifdef CPPHTTPLIB_SSL_ENABLED
  19543. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19544. #else
  19545. return Result{stream_error, -1, Headers{}};
  19546. #endif
  19547. }
  19548. Request req;
  19549. req.method = "GET";
  19550. req.path = path_;
  19551. req.headers = headers_;
  19552. prepare_default_headers(req);
  19553. detail::WebSocketUpgradeResponse upgrade;
  19554. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19555. shutdown_and_close();
  19556. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19557. }
  19558. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19559. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19560. websocket_ping_interval_sec_,
  19561. websocket_max_missed_pongs_));
  19562. // The stream was created with the timeout already; tell the WebSocket
  19563. // whether it came from the caller, so read() knows to report it as Timeout.
  19564. ws_->read_timeout_set_ = read_timeout_set_;
  19565. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19566. }
  19567. inline ReadResult WebSocketClient::read(std::string &msg) {
  19568. if (!ws_) { return Fail; }
  19569. return ws_->read(msg);
  19570. }
  19571. inline bool WebSocketClient::send(const std::string &data) {
  19572. if (!ws_) { return false; }
  19573. return ws_->send(data);
  19574. }
  19575. inline bool WebSocketClient::send(const char *data, size_t len) {
  19576. if (!ws_) { return false; }
  19577. return ws_->send(data, len);
  19578. }
  19579. inline void WebSocketClient::close(CloseStatus status,
  19580. const std::string &reason) {
  19581. if (ws_) { ws_->close(status, reason); }
  19582. }
  19583. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19584. inline const std::string &WebSocketClient::subprotocol() const {
  19585. return subprotocol_;
  19586. }
  19587. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19588. read_timeout_sec_ = sec;
  19589. read_timeout_usec_ = usec;
  19590. read_timeout_set_ = true;
  19591. // The members above only seed the next connect(); read() consults the
  19592. // stream, so an already-open connection has to be told directly.
  19593. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19594. }
  19595. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19596. write_timeout_sec_ = sec;
  19597. write_timeout_usec_ = usec;
  19598. }
  19599. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19600. websocket_ping_interval_sec_ = sec;
  19601. }
  19602. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19603. websocket_max_missed_pongs_ = count;
  19604. }
  19605. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19606. inline void WebSocketClient::set_address_family(int family) {
  19607. address_family_ = family;
  19608. }
  19609. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19610. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19611. socket_options_ = std::move(socket_options);
  19612. }
  19613. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19614. connection_timeout_sec_ = sec;
  19615. connection_timeout_usec_ = usec;
  19616. }
  19617. inline void WebSocketClient::set_interface(const std::string &intf) {
  19618. interface_ = intf;
  19619. }
  19620. inline void WebSocketClient::set_hostname_addr_map(
  19621. std::map<std::string, std::string> addr_map) {
  19622. addr_map_ = std::move(addr_map);
  19623. }
  19624. #ifdef CPPHTTPLIB_SSL_ENABLED
  19625. inline void
  19626. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19627. const std::string &ca_cert_dir_path) {
  19628. ca_cert_file_path_ = ca_cert_file_path;
  19629. ca_cert_dir_path_ = ca_cert_dir_path;
  19630. }
  19631. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19632. if (store && tls_ctx_) {
  19633. // set_ca_store takes ownership of store
  19634. tls::set_ca_store(tls_ctx_, store);
  19635. custom_ca_loaded_ = true;
  19636. } else if (store) {
  19637. tls::free_ca_store(store);
  19638. }
  19639. }
  19640. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19641. std::size_t size) {
  19642. if (tls_ctx_ && ca_cert && size > 0) {
  19643. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19644. custom_ca_loaded_ = true;
  19645. }
  19646. }
  19647. inline void
  19648. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19649. server_certificate_verification_ = enabled;
  19650. }
  19651. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19652. server_hostname_verification_ = enabled;
  19653. }
  19654. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19655. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19656. }
  19657. #endif // CPPHTTPLIB_SSL_ENABLED
  19658. } // namespace ws
  19659. // ----------------------------------------------------------------------------
  19660. } // namespace httplib
  19661. #endif // CPPHTTPLIB_HTTPLIB_H