httplib.h 800 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425
  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.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  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. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  104. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  105. #endif
  106. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  107. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  108. #endif
  109. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  110. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  111. #endif
  112. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  113. // 1400 rather than a round number: a body that already fits in one 1500-byte
  114. // MTU gains nothing from being made smaller.
  115. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  116. #endif
  117. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  118. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  119. #endif
  120. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  121. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  122. #endif
  123. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  124. // recurses roughly once per matched character for quantified patterns such
  125. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  126. // a default ~8MB thread stack that has been observed to take on the order of
  127. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  128. // margin below that (well under the 8192-byte request URI limit) while still
  129. // fitting any realistic route segment; raise it if a route legitimately needs
  130. // longer paths. Regex routes are never applied to paths longer than this.
  131. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  132. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  133. #endif
  134. #ifndef CPPHTTPLIB_TCP_NODELAY
  135. #define CPPHTTPLIB_TCP_NODELAY false
  136. #endif
  137. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  138. #define CPPHTTPLIB_IPV6_V6ONLY false
  139. #endif
  140. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  141. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  142. #endif
  143. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  144. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  145. #endif
  146. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  147. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  150. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  151. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  152. ? std::thread::hardware_concurrency() - 1 \
  153. : 0))
  154. #endif
  155. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  156. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  157. #endif
  158. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  159. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  160. #endif
  161. #ifndef CPPHTTPLIB_RECV_FLAGS
  162. #define CPPHTTPLIB_RECV_FLAGS 0
  163. #endif
  164. #ifndef CPPHTTPLIB_SEND_FLAGS
  165. #define CPPHTTPLIB_SEND_FLAGS 0
  166. #endif
  167. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  168. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  169. #endif
  170. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  171. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  172. #endif
  173. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  174. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  175. #endif
  176. // One macro used to set the read timeout for both sides. They want different
  177. // defaults: a client's read timeout is the caller's own tool (it waits forever
  178. // until asked not to), while a server keeps a ceiling that reclaims a worker
  179. // from a peer that has gone quiet. The old name still works and sets both.
  180. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #pragma message( \
  182. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  183. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  184. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  185. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  186. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  187. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  188. #endif
  189. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  190. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  191. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  192. #endif
  193. #endif
  194. // 0 waits forever. A read timeout is how a caller gets control back to send on
  195. // the same connection; it is not a liveness check (that is ping/pong). Only a
  196. // timeout set at runtime through set_read_timeout() is reported as
  197. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  198. // ws::Fail and closes the connection.
  199. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  200. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  201. #endif
  202. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  203. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  204. #endif
  205. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  207. #endif
  208. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  209. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  210. #endif
  211. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  212. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  213. #endif
  214. /*
  215. * Headers
  216. */
  217. #ifdef _WIN32
  218. #ifndef _CRT_SECURE_NO_WARNINGS
  219. #define _CRT_SECURE_NO_WARNINGS
  220. #endif //_CRT_SECURE_NO_WARNINGS
  221. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  222. #define _CRT_NONSTDC_NO_DEPRECATE
  223. #endif //_CRT_NONSTDC_NO_DEPRECATE
  224. #if defined(_MSC_VER)
  225. #if _MSC_VER < 1900
  226. #error Sorry, Visual Studio versions prior to 2015 are not supported
  227. #endif
  228. #pragma comment(lib, "ws2_32.lib")
  229. #ifndef _SSIZE_T_DEFINED
  230. using ssize_t = __int64;
  231. #define _SSIZE_T_DEFINED
  232. #endif
  233. #endif // _MSC_VER
  234. #ifndef S_ISREG
  235. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  236. #endif // S_ISREG
  237. #ifndef S_ISDIR
  238. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  239. #endif // S_ISDIR
  240. #ifndef NOMINMAX
  241. #define NOMINMAX
  242. #endif // NOMINMAX
  243. #include <io.h>
  244. #include <winsock2.h>
  245. #include <ws2tcpip.h>
  246. #if defined(__has_include)
  247. #if __has_include(<afunix.h>)
  248. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  249. #include <afunix.h>
  250. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  251. #endif
  252. #endif
  253. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  254. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  255. #endif
  256. using nfds_t = unsigned long;
  257. using socket_t = SOCKET;
  258. using socklen_t = int;
  259. #else // not _WIN32
  260. #include <arpa/inet.h>
  261. #if !defined(_AIX) && !defined(__MVS__)
  262. #include <ifaddrs.h>
  263. #endif
  264. #ifdef __MVS__
  265. #include <strings.h>
  266. #ifndef NI_MAXHOST
  267. #define NI_MAXHOST 1025
  268. #endif
  269. #endif
  270. #include <net/if.h>
  271. #include <netdb.h>
  272. #include <netinet/in.h>
  273. #ifdef __linux__
  274. #include <resolv.h>
  275. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  276. #endif
  277. #include <csignal>
  278. #include <netinet/tcp.h>
  279. #include <poll.h>
  280. #include <pthread.h>
  281. #include <sys/mman.h>
  282. #include <sys/socket.h>
  283. #include <sys/un.h>
  284. #include <unistd.h>
  285. using socket_t = int;
  286. #ifndef INVALID_SOCKET
  287. #define INVALID_SOCKET (-1)
  288. #endif
  289. #endif //_WIN32
  290. #if defined(__APPLE__)
  291. #include <TargetConditionals.h>
  292. #endif
  293. #include <algorithm>
  294. #include <array>
  295. #include <atomic>
  296. #include <cassert>
  297. #include <chrono>
  298. #include <climits>
  299. #include <condition_variable>
  300. #include <cstdlib>
  301. #include <cstring>
  302. #include <errno.h>
  303. #include <exception>
  304. #include <fcntl.h>
  305. #include <fstream>
  306. #include <functional>
  307. #include <iomanip>
  308. #include <iostream>
  309. #include <iterator>
  310. #include <list>
  311. #include <map>
  312. #include <memory>
  313. #include <mutex>
  314. #include <random>
  315. #include <regex>
  316. #include <set>
  317. #include <sstream>
  318. #include <string>
  319. #include <sys/stat.h>
  320. #include <system_error>
  321. #include <thread>
  322. #include <type_traits>
  323. #include <unordered_map>
  324. #include <unordered_set>
  325. #include <utility>
  326. #include <vector>
  327. // On macOS with a TLS backend, enable Keychain root certificates by default
  328. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  329. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  330. // only; on those platforms the user must provide a CA bundle explicitly.
  331. #if defined(__APPLE__) && defined(__clang__) && \
  332. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  333. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  334. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  335. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  336. #if TARGET_OS_OSX
  337. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  338. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  339. #endif
  340. #endif
  341. #endif
  342. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  343. defined(__APPLE__) && !TARGET_OS_OSX
  344. #error \
  345. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  346. #endif
  347. // On Windows, enable Schannel certificate verification by default
  348. // unless the user explicitly opts out.
  349. #if defined(_WIN32) && \
  350. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  351. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  352. #endif
  353. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  354. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  355. #if TARGET_OS_MAC && defined(__clang__)
  356. #include <CFNetwork/CFHost.h>
  357. #include <CoreFoundation/CoreFoundation.h>
  358. #endif
  359. #endif
  360. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  361. #ifdef _WIN32
  362. #include <wincrypt.h>
  363. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  364. // used
  365. #undef X509_NAME
  366. #undef X509_CERT_PAIR
  367. #undef X509_EXTENSIONS
  368. #undef PKCS7_SIGNER_INFO
  369. #ifdef _MSC_VER
  370. #pragma comment(lib, "crypt32.lib")
  371. #endif
  372. #endif // _WIN32
  373. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  374. #if TARGET_OS_OSX
  375. #include <Security/Security.h>
  376. #endif
  377. #endif
  378. #include <openssl/err.h>
  379. #include <openssl/evp.h>
  380. #include <openssl/ssl.h>
  381. #include <openssl/x509v3.h>
  382. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  383. #include <openssl/applink.c>
  384. #endif
  385. #include <iostream>
  386. #include <sstream>
  387. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  388. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  389. #error Please use OpenSSL or a current version of BoringSSL
  390. #endif
  391. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  392. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  393. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  394. #endif
  395. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  396. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  397. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  398. // in with this first include group so the version gating below can use it.
  399. #include <mbedtls/error.h>
  400. #include <mbedtls/net_sockets.h>
  401. #include <mbedtls/oid.h>
  402. #include <mbedtls/pk.h>
  403. #include <mbedtls/ssl.h>
  404. #include <mbedtls/version.h>
  405. #include <mbedtls/x509_crt.h>
  406. #if MBEDTLS_VERSION_MAJOR >= 4
  407. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  408. #include <psa/crypto.h>
  409. #else
  410. #include <mbedtls/ctr_drbg.h>
  411. #include <mbedtls/entropy.h>
  412. #include <mbedtls/md5.h>
  413. #include <mbedtls/sha1.h>
  414. #include <mbedtls/sha256.h>
  415. #include <mbedtls/sha512.h>
  416. #endif
  417. #ifdef _WIN32
  418. #include <wincrypt.h>
  419. #ifdef _MSC_VER
  420. #pragma comment(lib, "crypt32.lib")
  421. #endif
  422. #endif // _WIN32
  423. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  424. #if TARGET_OS_OSX
  425. #include <Security/Security.h>
  426. #endif
  427. #endif
  428. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  429. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  430. #if MBEDTLS_VERSION_MAJOR >= 4
  431. #define CPPHTTPLIB_MBEDTLS_V4
  432. #endif
  433. #if MBEDTLS_VERSION_MAJOR >= 3
  434. #define CPPHTTPLIB_MBEDTLS_V3
  435. #endif
  436. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  437. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  438. #include <wolfssl/options.h>
  439. #include <wolfssl/openssl/x509v3.h>
  440. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  441. #ifndef WOLFSSL_GEN_EMAIL
  442. #define WOLFSSL_GEN_EMAIL 1
  443. #endif
  444. #ifndef WOLFSSL_GEN_DNS
  445. #define WOLFSSL_GEN_DNS 2
  446. #endif
  447. #ifndef WOLFSSL_GEN_URI
  448. #define WOLFSSL_GEN_URI 6
  449. #endif
  450. #ifndef WOLFSSL_GEN_IPADD
  451. #define WOLFSSL_GEN_IPADD 7
  452. #endif
  453. #include <wolfssl/ssl.h>
  454. #include <wolfssl/wolfcrypt/hash.h>
  455. #include <wolfssl/wolfcrypt/md5.h>
  456. #include <wolfssl/wolfcrypt/sha256.h>
  457. #include <wolfssl/wolfcrypt/sha512.h>
  458. #ifdef _WIN32
  459. #include <wincrypt.h>
  460. #ifdef _MSC_VER
  461. #pragma comment(lib, "crypt32.lib")
  462. #endif
  463. #endif // _WIN32
  464. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  465. #if TARGET_OS_OSX
  466. #include <Security/Security.h>
  467. #endif
  468. #endif
  469. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  470. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  471. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  472. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  473. #define CPPHTTPLIB_SSL_ENABLED
  474. #endif
  475. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  476. #include <zlib.h>
  477. #endif
  478. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  479. #include <brotli/decode.h>
  480. #include <brotli/encode.h>
  481. #endif
  482. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  483. #include <zstd.h>
  484. #endif
  485. /*
  486. * Declaration
  487. */
  488. namespace httplib {
  489. namespace ws {
  490. class WebSocket;
  491. } // namespace ws
  492. namespace detail {
  493. /*
  494. * Backport std::make_unique from C++14.
  495. *
  496. * NOTE: This code came up with the following stackoverflow post:
  497. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  498. *
  499. */
  500. template <class T, class... Args>
  501. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  502. make_unique(Args &&...args) {
  503. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  504. }
  505. template <class T>
  506. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  507. make_unique(std::size_t n) {
  508. typedef typename std::remove_extent<T>::type RT;
  509. return std::unique_ptr<T>(new RT[n]);
  510. }
  511. // Locale-independent ASCII character classification. The <cctype>
  512. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  513. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  514. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  515. // classified without regard to the locale.
  516. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  517. inline bool is_ascii_alpha(char c) {
  518. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  519. }
  520. inline bool is_ascii_alnum(char c) {
  521. return is_ascii_digit(c) || is_ascii_alpha(c);
  522. }
  523. namespace case_ignore {
  524. inline unsigned char to_lower(int c) {
  525. const static unsigned char table[256] = {
  526. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  527. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  528. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  529. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  530. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  531. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  532. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  533. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  534. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  535. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  536. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  537. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  538. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  539. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  540. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  541. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  542. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  543. 255,
  544. };
  545. return table[(unsigned char)(char)c];
  546. }
  547. inline std::string to_lower(const std::string &s) {
  548. std::string result = s;
  549. std::transform(
  550. result.begin(), result.end(), result.begin(),
  551. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  552. return result;
  553. }
  554. inline bool equal(const std::string &a, const std::string &b) {
  555. return a.size() == b.size() &&
  556. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  557. return to_lower(ca) == to_lower(cb);
  558. });
  559. }
  560. struct equal_to {
  561. bool operator()(const std::string &a, const std::string &b) const {
  562. return equal(a, b);
  563. }
  564. };
  565. struct hash {
  566. size_t operator()(const std::string &key) const {
  567. return hash_core(key.data(), key.size(), 0);
  568. }
  569. size_t hash_core(const char *s, size_t l, size_t h) const {
  570. return (l == 0) ? h
  571. : hash_core(s + 1, l - 1,
  572. // Unsets the 6 high bits of h, therefore no
  573. // overflow happens
  574. (((std::numeric_limits<size_t>::max)() >> 6) &
  575. h * 33) ^
  576. static_cast<unsigned char>(to_lower(*s)));
  577. }
  578. };
  579. template <typename T>
  580. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  581. detail::case_ignore::equal_to>;
  582. } // namespace case_ignore
  583. // This is based on
  584. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  585. struct scope_exit {
  586. explicit scope_exit(std::function<void(void)> &&f)
  587. : exit_function(std::move(f)), execute_on_destruction{true} {}
  588. scope_exit(scope_exit &&rhs) noexcept
  589. : exit_function(std::move(rhs.exit_function)),
  590. execute_on_destruction{rhs.execute_on_destruction} {
  591. rhs.release();
  592. }
  593. ~scope_exit() {
  594. if (execute_on_destruction) { this->exit_function(); }
  595. }
  596. void release() { this->execute_on_destruction = false; }
  597. private:
  598. scope_exit(const scope_exit &) = delete;
  599. void operator=(const scope_exit &) = delete;
  600. scope_exit &operator=(scope_exit &&) = delete;
  601. std::function<void(void)> exit_function;
  602. bool execute_on_destruction;
  603. };
  604. // Simple from_chars implementation for integer and double types (C++17
  605. // substitute)
  606. template <typename T> struct from_chars_result {
  607. const char *ptr;
  608. std::errc ec;
  609. };
  610. template <typename T>
  611. inline from_chars_result<T> from_chars(const char *first, const char *last,
  612. T &value, int base = 10) {
  613. value = 0;
  614. const char *p = first;
  615. bool negative = false;
  616. if (p != last && *p == '-') {
  617. negative = true;
  618. ++p;
  619. }
  620. if (p == last) { return {first, std::errc::invalid_argument}; }
  621. T result = 0;
  622. for (; p != last; ++p) {
  623. char c = *p;
  624. int digit = -1;
  625. if (is_ascii_digit(c)) {
  626. digit = c - '0';
  627. } else if ('a' <= c && c <= 'z') {
  628. digit = c - 'a' + 10;
  629. } else if ('A' <= c && c <= 'Z') {
  630. digit = c - 'A' + 10;
  631. } else {
  632. break;
  633. }
  634. if (digit < 0 || digit >= base) { break; }
  635. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  636. return {p, std::errc::result_out_of_range};
  637. }
  638. result = result * base + digit;
  639. }
  640. if (p == first || (negative && p == first + 1)) {
  641. return {first, std::errc::invalid_argument};
  642. }
  643. value = negative ? T(0) - result : result;
  644. return {p, std::errc{}};
  645. }
  646. // from_chars for double (hand-written, locale-independent)
  647. //
  648. // The only double consumed by this library is the HTTP quality value, whose
  649. // grammar is (RFC 9110 12.4.2):
  650. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  651. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  652. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  653. // '.' always the decimal separator (std::strtod would instead read it from the
  654. // global C locale, mis-parsing q-values once an embedder calls
  655. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  656. // the result to [0, 1], so inputs outside that range need not be distinguished
  657. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  658. // cases that exponent and wide-range handling would introduce.
  659. inline from_chars_result<double> from_chars(const char *first, const char *last,
  660. double &value) {
  661. value = 0.0;
  662. const char *p = first;
  663. // Each 1eN is exactly representable, so a single final division by the
  664. // matching entry yields a correctly-rounded result.
  665. static const double powers_of_ten[] = {
  666. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  667. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  668. const int max_frac_digits =
  669. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  670. // Accumulate digits into a 64-bit integer and remember how many were
  671. // fractional. Two independent caps keep this bounded and safe:
  672. // * accumulation saturates before mantissa could overflow uint64_t, and
  673. // * frac_digits is capped at max_frac_digits so it is always a valid index
  674. // into powers_of_ten (without this an input like "0.000...0" would never
  675. // grow mantissa, so the saturation cap alone would not bound it).
  676. // Both caps only drop digits far beyond the precision a q-value needs; any
  677. // value they would change is well outside [0, 1] and rejected by the caller.
  678. uint64_t mantissa = 0;
  679. int frac_digits = 0;
  680. bool seen_digit = false;
  681. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  682. auto accumulate = [&](char c) {
  683. if (mantissa <= limit) {
  684. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  685. return true;
  686. }
  687. return false;
  688. };
  689. for (; p != last && is_ascii_digit(*p); ++p) {
  690. seen_digit = true;
  691. accumulate(*p);
  692. }
  693. if (p != last && *p == '.') {
  694. ++p;
  695. for (; p != last && is_ascii_digit(*p); ++p) {
  696. seen_digit = true;
  697. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  698. }
  699. }
  700. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  701. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  702. return {p, std::errc{}};
  703. }
  704. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  705. int &out) {
  706. int val = 0;
  707. auto r = from_chars(s, s + len, val);
  708. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  709. return false;
  710. }
  711. out = val;
  712. return true;
  713. }
  714. inline bool parse_port(const char *s, size_t len, int &port) {
  715. return parse_int_in_range(s, len, 1, 65535, port);
  716. }
  717. inline bool parse_port(const std::string &s, int &port) {
  718. return parse_port(s.data(), s.size(), port);
  719. }
  720. struct UrlComponents {
  721. std::string scheme;
  722. std::string host;
  723. std::string port;
  724. std::string path;
  725. std::string query;
  726. };
  727. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  728. uc = {};
  729. size_t pos = 0;
  730. auto sep = url.find("://");
  731. if (sep != std::string::npos) {
  732. uc.scheme = url.substr(0, sep);
  733. // Scheme must be [a-z]+ only
  734. if (uc.scheme.empty()) { return false; }
  735. for (auto c : uc.scheme) {
  736. if (c < 'a' || c > 'z') { return false; }
  737. }
  738. pos = sep + 3;
  739. } else if (url.compare(0, 2, "//") == 0) {
  740. pos = 2;
  741. }
  742. auto has_authority_prefix = pos > 0;
  743. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  744. url[0] != '?' && url[0] != '#');
  745. if (has_authority) {
  746. if (pos < url.size() && url[pos] == '[') {
  747. auto close = url.find(']', pos);
  748. if (close == std::string::npos) { return false; }
  749. uc.host = url.substr(pos + 1, close - pos - 1);
  750. // IPv6 host must be [a-fA-F0-9:]+ only
  751. if (uc.host.empty()) { return false; }
  752. for (auto c : uc.host) {
  753. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  754. (c >= 'A' && c <= 'F') || c == ':')) {
  755. return false;
  756. }
  757. }
  758. pos = close + 1;
  759. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  760. // path, query or fragment delimiter (or the end of input). Otherwise the
  761. // trailing bytes would be folded into the path while the connection
  762. // still targets the bracketed address.
  763. if (pos < url.size()) {
  764. auto c = url[pos];
  765. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  766. }
  767. } else {
  768. auto end = url.find_first_of(":/?#", pos);
  769. if (end == std::string::npos) { end = url.size(); }
  770. uc.host = url.substr(pos, end - pos);
  771. pos = end;
  772. }
  773. if (pos < url.size() && url[pos] == ':') {
  774. ++pos;
  775. auto end = url.find_first_of("/?#", pos);
  776. if (end == std::string::npos) { end = url.size(); }
  777. uc.port = url.substr(pos, end - pos);
  778. pos = end;
  779. }
  780. // Without :// or //, the entire input must be consumed as host[:port].
  781. // If there is leftover (path, query, etc.), this is not a valid
  782. // host[:port] string — clear and reparse as a plain path.
  783. if (!has_authority_prefix && pos < url.size()) {
  784. uc.host.clear();
  785. uc.port.clear();
  786. pos = 0;
  787. }
  788. }
  789. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  790. auto end = url.find_first_of("?#", pos);
  791. if (end == std::string::npos) { end = url.size(); }
  792. uc.path = url.substr(pos, end - pos);
  793. pos = end;
  794. }
  795. if (pos < url.size() && url[pos] == '?') {
  796. auto end = url.find('#', pos);
  797. if (end == std::string::npos) { end = url.size(); }
  798. uc.query = url.substr(pos, end - pos);
  799. }
  800. return true;
  801. }
  802. // Resolves a relative-path or query-only Location value against the path of
  803. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  804. // references starting with '/' are returned unchanged.
  805. inline std::string resolve_relative_location(const std::string &location,
  806. const std::string &base) {
  807. if (location.empty() || location[0] == '/') { return location; }
  808. // A ':' in the first segment means the value has a scheme.
  809. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  810. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  811. auto base_path = base.substr(0, base.find_first_of("?#"));
  812. if (location[0] == '?') { return base_path + location; }
  813. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  814. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  815. // Remove "." and ".." segments from the merged path.
  816. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  817. std::string path;
  818. size_t i = 0;
  819. while (i < path_end) {
  820. auto next = (std::min)(merged.find('/', i + 1), path_end);
  821. auto segment = merged.substr(i + 1, next - i - 1);
  822. auto is_last = next == path_end;
  823. if (segment == "." || segment == "..") {
  824. if (segment == "..") {
  825. path.erase((std::min)(path.rfind('/'), path.size()));
  826. }
  827. if (is_last) { path += '/'; }
  828. } else {
  829. path += '/';
  830. path += segment;
  831. }
  832. i = next;
  833. }
  834. if (path.empty()) { path = "/"; }
  835. return path + merged.substr(path_end);
  836. }
  837. } // namespace detail
  838. enum class SSLVerifierResponse {
  839. // no decision has been made, use the built-in certificate verifier
  840. NoDecisionMade,
  841. // connection certificate is verified and accepted
  842. CertificateAccepted,
  843. // connection certificate was processed but is rejected
  844. CertificateRejected
  845. };
  846. // System CA loading policy for SSL clients. Auto (the default) loads system
  847. // CA certs only when no custom CA is configured; enable_system_ca() switches
  848. // to an explicit policy.
  849. enum class SystemCAMode { Auto, Enabled, Disabled };
  850. enum StatusCode {
  851. // Information responses
  852. Continue_100 = 100,
  853. SwitchingProtocol_101 = 101,
  854. Processing_102 = 102,
  855. EarlyHints_103 = 103,
  856. // Successful responses
  857. OK_200 = 200,
  858. Created_201 = 201,
  859. Accepted_202 = 202,
  860. NonAuthoritativeInformation_203 = 203,
  861. NoContent_204 = 204,
  862. ResetContent_205 = 205,
  863. PartialContent_206 = 206,
  864. MultiStatus_207 = 207,
  865. AlreadyReported_208 = 208,
  866. IMUsed_226 = 226,
  867. // Redirection messages
  868. MultipleChoices_300 = 300,
  869. MovedPermanently_301 = 301,
  870. Found_302 = 302,
  871. SeeOther_303 = 303,
  872. NotModified_304 = 304,
  873. UseProxy_305 = 305,
  874. unused_306 = 306,
  875. TemporaryRedirect_307 = 307,
  876. PermanentRedirect_308 = 308,
  877. // Client error responses
  878. BadRequest_400 = 400,
  879. Unauthorized_401 = 401,
  880. PaymentRequired_402 = 402,
  881. Forbidden_403 = 403,
  882. NotFound_404 = 404,
  883. MethodNotAllowed_405 = 405,
  884. NotAcceptable_406 = 406,
  885. ProxyAuthenticationRequired_407 = 407,
  886. RequestTimeout_408 = 408,
  887. Conflict_409 = 409,
  888. Gone_410 = 410,
  889. LengthRequired_411 = 411,
  890. PreconditionFailed_412 = 412,
  891. PayloadTooLarge_413 = 413,
  892. UriTooLong_414 = 414,
  893. UnsupportedMediaType_415 = 415,
  894. RangeNotSatisfiable_416 = 416,
  895. ExpectationFailed_417 = 417,
  896. ImATeapot_418 = 418,
  897. MisdirectedRequest_421 = 421,
  898. UnprocessableContent_422 = 422,
  899. Locked_423 = 423,
  900. FailedDependency_424 = 424,
  901. TooEarly_425 = 425,
  902. UpgradeRequired_426 = 426,
  903. PreconditionRequired_428 = 428,
  904. TooManyRequests_429 = 429,
  905. RequestHeaderFieldsTooLarge_431 = 431,
  906. UnavailableForLegalReasons_451 = 451,
  907. // Server error responses
  908. InternalServerError_500 = 500,
  909. NotImplemented_501 = 501,
  910. BadGateway_502 = 502,
  911. ServiceUnavailable_503 = 503,
  912. GatewayTimeout_504 = 504,
  913. HttpVersionNotSupported_505 = 505,
  914. VariantAlsoNegotiates_506 = 506,
  915. InsufficientStorage_507 = 507,
  916. LoopDetected_508 = 508,
  917. NotExtended_510 = 510,
  918. NetworkAuthenticationRequired_511 = 511,
  919. };
  920. namespace detail {
  921. // A multimap that keeps its entries in the order they were inserted.
  922. //
  923. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  924. // fields sharing a field name significant and forbids a proxy from reordering
  925. // them, and a query string's parameters are meaningful in the order the caller
  926. // wrote them. Neither standard container expresses it: std::unordered_multimap
  927. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  928. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  929. // key, which would drop control data such as Host behind whatever else the
  930. // message carries and alphabetise a query string.
  931. //
  932. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  933. // scan, which beats hashing for the handful of entries a message carries
  934. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  935. //
  936. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  937. // Params, whose parameter names are case-sensitive, not.
  938. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  939. public:
  940. using key_type = std::string;
  941. using mapped_type = Mapped;
  942. using value_type = std::pair<std::string, Mapped>;
  943. using size_type = std::size_t;
  944. using difference_type = std::ptrdiff_t;
  945. using reference = value_type &;
  946. using const_reference = const value_type &;
  947. private:
  948. static size_type npos() { return static_cast<size_type>(-1); }
  949. static bool keys_equal(const std::string &a, const std::string &b) {
  950. return KeyEqual()(a, b);
  951. }
  952. // Iterating yields every entry in insertion order, but equal_range() and
  953. // find() have to walk only the entries sharing one key, which are not
  954. // adjacent. Both are the same iterator type: key_idx_ selects between the
  955. // two traversals, and since equality compares only the position, an iterator
  956. // restricted to one key still compares equal to end().
  957. template <typename V> class iterator_t {
  958. public:
  959. using iterator_category = std::bidirectional_iterator_tag;
  960. using value_type = insertion_ordered_multimap::value_type;
  961. using difference_type = insertion_ordered_multimap::difference_type;
  962. using pointer = V *;
  963. using reference = V &;
  964. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  965. template <typename U,
  966. typename std::enable_if<std::is_convertible<U *, V *>::value,
  967. int>::type = 0>
  968. iterator_t(const iterator_t<U> &rhs)
  969. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  970. key_idx_(rhs.key_idx_) {}
  971. reference operator*() const { return data_[idx_]; }
  972. pointer operator->() const { return data_ + idx_; }
  973. iterator_t &operator++() {
  974. // Saturating, so that advancing past the last entry of a key stays at
  975. // end() instead of running off the container.
  976. if (idx_ >= size_) { return *this; }
  977. ++idx_;
  978. if (key_idx_ != npos()) {
  979. while (idx_ < size_ && !matches(idx_)) {
  980. ++idx_;
  981. }
  982. }
  983. return *this;
  984. }
  985. iterator_t operator++(int) {
  986. auto tmp = *this;
  987. ++*this;
  988. return tmp;
  989. }
  990. iterator_t &operator--() {
  991. if (idx_ == 0) { return *this; }
  992. --idx_;
  993. if (key_idx_ != npos()) {
  994. while (idx_ > 0 && !matches(idx_)) {
  995. --idx_;
  996. }
  997. }
  998. return *this;
  999. }
  1000. iterator_t operator--(int) {
  1001. auto tmp = *this;
  1002. --*this;
  1003. return tmp;
  1004. }
  1005. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1006. return idx_ == rhs.idx_;
  1007. }
  1008. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1009. return idx_ != rhs.idx_;
  1010. }
  1011. private:
  1012. friend class insertion_ordered_multimap;
  1013. template <typename> friend class iterator_t;
  1014. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1015. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1016. bool matches(size_type i) const {
  1017. return keys_equal(data_[i].first, data_[key_idx_].first);
  1018. }
  1019. V *data_;
  1020. size_type idx_;
  1021. size_type size_;
  1022. size_type key_idx_;
  1023. };
  1024. public:
  1025. using iterator = iterator_t<value_type>;
  1026. using const_iterator = iterator_t<const value_type>;
  1027. insertion_ordered_multimap() = default;
  1028. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1029. : entries_(il) {}
  1030. template <typename InputIt>
  1031. insertion_ordered_multimap(InputIt first, InputIt last)
  1032. : entries_(first, last) {}
  1033. iterator begin() { return make_iter(0, npos()); }
  1034. iterator end() { return make_iter(entries_.size(), npos()); }
  1035. const_iterator begin() const { return make_citer(0, npos()); }
  1036. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1037. const_iterator cbegin() const { return begin(); }
  1038. const_iterator cend() const { return end(); }
  1039. bool empty() const { return entries_.empty(); }
  1040. size_type size() const { return entries_.size(); }
  1041. void clear() { entries_.clear(); }
  1042. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1043. iterator insert(const value_type &val) {
  1044. entries_.push_back(val);
  1045. return make_iter(entries_.size() - 1, npos());
  1046. }
  1047. iterator insert(value_type &&val) {
  1048. entries_.push_back(std::move(val));
  1049. return make_iter(entries_.size() - 1, npos());
  1050. }
  1051. template <typename... Args> iterator emplace(Args &&...args) {
  1052. entries_.emplace_back(std::forward<Args>(args)...);
  1053. return make_iter(entries_.size() - 1, npos());
  1054. }
  1055. // For entries that have to lead the message, such as the Host header field
  1056. // (RFC 9110 5.3 recommends sending control data first).
  1057. template <typename... Args> iterator emplace_front(Args &&...args) {
  1058. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1059. return make_iter(0, npos());
  1060. }
  1061. iterator find(const std::string &key) {
  1062. auto i = index_of(key);
  1063. return i == npos() ? end() : make_iter(i, i);
  1064. }
  1065. const_iterator find(const std::string &key) const {
  1066. auto i = index_of(key);
  1067. return i == npos() ? end() : make_citer(i, i);
  1068. }
  1069. size_type count(const std::string &key) const {
  1070. size_type n = 0;
  1071. for (const auto &entry : entries_) {
  1072. if (keys_equal(entry.first, key)) { n++; }
  1073. }
  1074. return n;
  1075. }
  1076. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1077. auto i = index_of(key);
  1078. return i == npos() ? std::make_pair(end(), end())
  1079. : std::make_pair(make_iter(i, i), end());
  1080. }
  1081. std::pair<const_iterator, const_iterator>
  1082. equal_range(const std::string &key) const {
  1083. auto i = index_of(key);
  1084. return i == npos() ? std::make_pair(end(), end())
  1085. : std::make_pair(make_citer(i, i), end());
  1086. }
  1087. size_type erase(const std::string &key) {
  1088. auto before = entries_.size();
  1089. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1090. [&](const value_type &entry) {
  1091. return keys_equal(entry.first, key);
  1092. }),
  1093. entries_.end());
  1094. return before - entries_.size();
  1095. }
  1096. iterator erase(const_iterator pos) {
  1097. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1098. return make_iter(pos.idx_, npos());
  1099. }
  1100. // Erases what iterating [first, last) would actually visit, so erasing an
  1101. // equal_range() removes only the entries with that key, not everything
  1102. // positioned between them.
  1103. iterator erase(const_iterator first, const_iterator last) {
  1104. auto from = first.idx_;
  1105. auto to = last.idx_;
  1106. if (from >= to) { return make_iter(from, npos()); }
  1107. auto begin_it = entries_.begin();
  1108. auto from_it = begin_it + static_cast<difference_type>(from);
  1109. auto to_it = begin_it + static_cast<difference_type>(to);
  1110. if (first.key_idx_ == npos()) {
  1111. entries_.erase(from_it, to_it);
  1112. } else {
  1113. auto key = entries_[first.key_idx_].first;
  1114. auto keep = from_it;
  1115. for (auto it = from_it; it != to_it; ++it) {
  1116. if (!keys_equal(it->first, key)) {
  1117. if (keep != it) { *keep = std::move(*it); }
  1118. ++keep;
  1119. }
  1120. }
  1121. if (keep != to_it) {
  1122. keep = std::move(to_it, entries_.end(), keep);
  1123. } else {
  1124. keep = entries_.end();
  1125. }
  1126. entries_.erase(keep, entries_.end());
  1127. }
  1128. return make_iter(from, npos());
  1129. }
  1130. friend bool operator==(const insertion_ordered_multimap &lhs,
  1131. const insertion_ordered_multimap &rhs) {
  1132. return lhs.entries_ == rhs.entries_;
  1133. }
  1134. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1135. const insertion_ordered_multimap &rhs) {
  1136. return !(lhs == rhs);
  1137. }
  1138. private:
  1139. size_type index_of(const std::string &key) const {
  1140. for (size_type i = 0; i < entries_.size(); i++) {
  1141. if (keys_equal(entries_[i].first, key)) { return i; }
  1142. }
  1143. return npos();
  1144. }
  1145. iterator make_iter(size_type idx, size_type key_idx) {
  1146. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1147. }
  1148. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1149. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1150. }
  1151. std::vector<value_type> entries_;
  1152. };
  1153. } // namespace detail
  1154. using Headers =
  1155. detail::insertion_ordered_multimap<std::string,
  1156. detail::case_ignore::equal_to>;
  1157. // Query parameter names are case-sensitive, unlike header field names.
  1158. using Params =
  1159. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1160. using Match = std::smatch;
  1161. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1162. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1163. /*
  1164. * detail: type-erased storage used by UserData.
  1165. * ABI-stable regardless of C++ standard — always uses this custom
  1166. * implementation instead of std::any.
  1167. */
  1168. namespace detail {
  1169. using any_type_id = const void *;
  1170. template <typename T> any_type_id any_typeid() noexcept {
  1171. static const char id = 0;
  1172. return &id;
  1173. }
  1174. struct any_storage {
  1175. virtual ~any_storage() = default;
  1176. virtual std::unique_ptr<any_storage> clone() const = 0;
  1177. virtual any_type_id type_id() const noexcept = 0;
  1178. };
  1179. template <typename T> struct any_value final : any_storage {
  1180. T value;
  1181. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1182. std::unique_ptr<any_storage> clone() const override {
  1183. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1184. }
  1185. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1186. };
  1187. } // namespace detail
  1188. class UserData {
  1189. public:
  1190. UserData() = default;
  1191. UserData(UserData &&) noexcept = default;
  1192. UserData &operator=(UserData &&) noexcept = default;
  1193. UserData(const UserData &o) {
  1194. for (const auto &e : o.entries_) {
  1195. if (e.second) { entries_[e.first] = e.second->clone(); }
  1196. }
  1197. }
  1198. UserData &operator=(const UserData &o) {
  1199. if (this != &o) {
  1200. entries_.clear();
  1201. for (const auto &e : o.entries_) {
  1202. if (e.second) { entries_[e.first] = e.second->clone(); }
  1203. }
  1204. }
  1205. return *this;
  1206. }
  1207. template <typename T> void set(const std::string &key, T &&value) {
  1208. using D = typename std::decay<T>::type;
  1209. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1210. }
  1211. template <typename T> T *get(const std::string &key) noexcept {
  1212. auto it = entries_.find(key);
  1213. if (it == entries_.end() || !it->second) { return nullptr; }
  1214. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1215. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1216. }
  1217. template <typename T> const T *get(const std::string &key) const noexcept {
  1218. auto it = entries_.find(key);
  1219. if (it == entries_.end() || !it->second) { return nullptr; }
  1220. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1221. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1222. }
  1223. bool has(const std::string &key) const noexcept {
  1224. return entries_.find(key) != entries_.end();
  1225. }
  1226. void erase(const std::string &key) { entries_.erase(key); }
  1227. void clear() noexcept { entries_.clear(); }
  1228. private:
  1229. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1230. entries_;
  1231. };
  1232. struct Response;
  1233. using ResponseHandler = std::function<bool(const Response &response)>;
  1234. struct FormData {
  1235. std::string name;
  1236. std::string content;
  1237. std::string filename;
  1238. std::string content_type;
  1239. Headers headers;
  1240. };
  1241. struct FormField {
  1242. std::string name;
  1243. std::string content;
  1244. Headers headers;
  1245. };
  1246. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1247. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1248. // should see the parts as they were sent. A std::multimap sorts by field name
  1249. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1250. // than the case-insensitive predicate Headers uses.
  1251. using FormFields =
  1252. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1253. using FormFiles =
  1254. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1255. struct MultipartFormData {
  1256. FormFields fields; // Text fields from multipart
  1257. FormFiles files; // Files from multipart
  1258. // Text field access
  1259. std::string get_field(const std::string &key, size_t id = 0) const;
  1260. std::vector<std::string> get_fields(const std::string &key) const;
  1261. bool has_field(const std::string &key) const;
  1262. size_t get_field_count(const std::string &key) const;
  1263. // File access
  1264. FormData get_file(const std::string &key, size_t id = 0) const;
  1265. std::vector<FormData> get_files(const std::string &key) const;
  1266. bool has_file(const std::string &key) const;
  1267. size_t get_file_count(const std::string &key) const;
  1268. };
  1269. struct UploadFormData {
  1270. std::string name;
  1271. std::string content;
  1272. std::string filename;
  1273. std::string content_type;
  1274. };
  1275. using UploadFormDataItems = std::vector<UploadFormData>;
  1276. class DataSink {
  1277. public:
  1278. DataSink() : os(&sb_), sb_(*this) {}
  1279. DataSink(const DataSink &) = delete;
  1280. DataSink &operator=(const DataSink &) = delete;
  1281. DataSink(DataSink &&) = delete;
  1282. DataSink &operator=(DataSink &&) = delete;
  1283. std::function<bool(const char *data, size_t data_len)> write;
  1284. // Only `write` is mandatory. The rest are defaulted so that a provider
  1285. // calling one on a writer that does not set it gets sensible behaviour
  1286. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1287. // `this` is safe: DataSink is neither copyable nor movable.
  1288. std::function<bool()> is_writable = []() { return true; };
  1289. std::function<void()> done = []() {};
  1290. std::function<void(const Headers &trailer)> done_with_trailer =
  1291. [this](const Headers & /*trailer*/) { done(); };
  1292. std::ostream os;
  1293. private:
  1294. class data_sink_streambuf final : public std::streambuf {
  1295. public:
  1296. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1297. protected:
  1298. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1299. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1300. return 0;
  1301. }
  1302. private:
  1303. DataSink &sink_;
  1304. };
  1305. data_sink_streambuf sb_;
  1306. };
  1307. using ContentProvider =
  1308. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1309. using ContentProviderWithoutLength =
  1310. std::function<bool(size_t offset, DataSink &sink)>;
  1311. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1312. struct FormDataProvider {
  1313. std::string name;
  1314. ContentProviderWithoutLength provider;
  1315. std::string filename;
  1316. std::string content_type;
  1317. };
  1318. using FormDataProviderItems = std::vector<FormDataProvider>;
  1319. inline FormDataProvider
  1320. make_file_provider(const std::string &name, const std::string &filepath,
  1321. const std::string &filename = std::string(),
  1322. const std::string &content_type = std::string()) {
  1323. FormDataProvider fdp;
  1324. fdp.name = name;
  1325. fdp.filename = filename.empty() ? filepath : filename;
  1326. fdp.content_type = content_type;
  1327. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1328. std::ifstream f(filepath, std::ios::binary);
  1329. if (!f) { return false; }
  1330. if (offset > 0) {
  1331. f.seekg(static_cast<std::streamoff>(offset));
  1332. if (!f.good()) {
  1333. sink.done();
  1334. return true;
  1335. }
  1336. }
  1337. char buf[8192];
  1338. f.read(buf, sizeof(buf));
  1339. auto n = static_cast<size_t>(f.gcount());
  1340. if (n > 0) { return sink.write(buf, n); }
  1341. sink.done(); // EOF
  1342. return true;
  1343. };
  1344. return fdp;
  1345. }
  1346. inline std::pair<size_t, ContentProvider>
  1347. make_file_body(const std::string &filepath) {
  1348. size_t size = 0;
  1349. {
  1350. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1351. if (!f) { return {0, ContentProvider{}}; }
  1352. size = static_cast<size_t>(f.tellg());
  1353. }
  1354. ContentProvider provider = [filepath](size_t offset, size_t length,
  1355. DataSink &sink) -> bool {
  1356. std::ifstream f(filepath, std::ios::binary);
  1357. if (!f) { return false; }
  1358. f.seekg(static_cast<std::streamoff>(offset));
  1359. if (!f.good()) { return false; }
  1360. char buf[8192];
  1361. while (length > 0) {
  1362. auto to_read = (std::min)(sizeof(buf), length);
  1363. f.read(buf, static_cast<std::streamsize>(to_read));
  1364. auto n = static_cast<size_t>(f.gcount());
  1365. // The file is shorter than the size make_file_body() measured, which the
  1366. // caller has already committed to as Content-Length. The body cannot be
  1367. // completed, so fail as every other error here does.
  1368. if (n == 0) { return false; }
  1369. if (!sink.write(buf, n)) { return false; }
  1370. length -= n;
  1371. }
  1372. return true;
  1373. };
  1374. return {size, std::move(provider)};
  1375. }
  1376. using ContentReceiverWithProgress = std::function<bool(
  1377. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1378. using ContentReceiver =
  1379. std::function<bool(const char *data, size_t data_length)>;
  1380. using FormDataHeader = std::function<bool(const FormData &file)>;
  1381. class ContentReader {
  1382. public:
  1383. using Reader = std::function<bool(ContentReceiver receiver)>;
  1384. using FormDataReader =
  1385. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1386. ContentReader(Reader reader, FormDataReader multipart_reader)
  1387. : reader_(std::move(reader)),
  1388. formdata_reader_(std::move(multipart_reader)) {}
  1389. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1390. return formdata_reader_(std::move(header), std::move(receiver));
  1391. }
  1392. bool operator()(ContentReceiver receiver) const {
  1393. return reader_(std::move(receiver));
  1394. }
  1395. Reader reader_;
  1396. FormDataReader formdata_reader_;
  1397. };
  1398. using Range = std::pair<ssize_t, ssize_t>;
  1399. using Ranges = std::vector<Range>;
  1400. #ifdef CPPHTTPLIB_SSL_ENABLED
  1401. // TLS abstraction layer - public type definitions and API
  1402. namespace tls {
  1403. // Opaque handles (defined as void* for abstraction)
  1404. using ctx_t = void *;
  1405. using session_t = void *;
  1406. using const_session_t = const void *; // For read-only session access
  1407. using cert_t = void *;
  1408. using ca_store_t = void *;
  1409. // TLS versions
  1410. enum class Version {
  1411. TLS1_2 = 0x0303,
  1412. TLS1_3 = 0x0304,
  1413. };
  1414. // Subject Alternative Names (SAN) entry types
  1415. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1416. // SAN entry structure
  1417. struct SanEntry {
  1418. SanType type;
  1419. std::string value;
  1420. };
  1421. // Verification context for certificate verification callback
  1422. struct VerifyContext {
  1423. session_t session; // TLS session handle
  1424. cert_t cert; // Current certificate being verified
  1425. int depth; // Certificate chain depth (0 = leaf)
  1426. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1427. long error_code; // Backend-specific error code (0 = no error)
  1428. const char *error_string; // Human-readable error description
  1429. // Certificate introspection methods
  1430. std::string subject_cn() const;
  1431. std::string issuer_name() const;
  1432. bool check_hostname(const char *hostname) const;
  1433. std::vector<SanEntry> sans() const;
  1434. bool validity(time_t &not_before, time_t &not_after) const;
  1435. std::string serial() const;
  1436. };
  1437. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1438. // TlsError codes for TLS operations (backend-independent)
  1439. enum class ErrorCode : int {
  1440. Success = 0,
  1441. WantRead, // Non-blocking: need to wait for read
  1442. WantWrite, // Non-blocking: need to wait for write
  1443. PeerClosed, // Peer closed the connection
  1444. Fatal, // Unrecoverable error
  1445. SyscallError, // System call error (check sys_errno)
  1446. CertVerifyFailed, // Certificate verification failed
  1447. HostnameMismatch, // Hostname verification failed
  1448. };
  1449. // TLS error information
  1450. struct TlsError {
  1451. ErrorCode code = ErrorCode::Fatal;
  1452. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1453. int sys_errno = 0; // errno when SyscallError
  1454. // Convert verification error code to human-readable string
  1455. static std::string verify_error_to_string(long error_code);
  1456. };
  1457. // RAII wrapper for peer certificate
  1458. class PeerCert {
  1459. public:
  1460. PeerCert();
  1461. PeerCert(PeerCert &&other) noexcept;
  1462. PeerCert &operator=(PeerCert &&other) noexcept;
  1463. ~PeerCert();
  1464. PeerCert(const PeerCert &) = delete;
  1465. PeerCert &operator=(const PeerCert &) = delete;
  1466. explicit operator bool() const;
  1467. std::string subject_cn() const;
  1468. std::string issuer_name() const;
  1469. bool check_hostname(const char *hostname) const;
  1470. std::vector<SanEntry> sans() const;
  1471. bool validity(time_t &not_before, time_t &not_after) const;
  1472. std::string serial() const;
  1473. private:
  1474. explicit PeerCert(cert_t cert);
  1475. cert_t cert_ = nullptr;
  1476. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1477. };
  1478. // Callback for TLS context setup (used by SSLServer constructor)
  1479. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1480. } // namespace tls
  1481. #endif
  1482. struct Request {
  1483. std::string method;
  1484. std::string path;
  1485. std::string matched_route;
  1486. Params params;
  1487. Headers headers;
  1488. Headers trailers;
  1489. std::string body;
  1490. std::string remote_addr;
  1491. int remote_port = -1;
  1492. std::string local_addr;
  1493. int local_port = -1;
  1494. // for server
  1495. std::string version;
  1496. std::string target;
  1497. MultipartFormData form;
  1498. Ranges ranges;
  1499. Match matches;
  1500. std::unordered_map<std::string, std::string> path_params;
  1501. std::function<bool()> is_connection_closed = []() { return true; };
  1502. // for client
  1503. std::vector<std::string> accept_content_types;
  1504. ResponseHandler response_handler;
  1505. ContentReceiverWithProgress content_receiver;
  1506. DownloadProgress download_progress;
  1507. UploadProgress upload_progress;
  1508. bool has_header(const std::string &key) const;
  1509. std::string get_header_value(const std::string &key, const char *def = "",
  1510. size_t id = 0) const;
  1511. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1512. size_t id = 0) const;
  1513. size_t get_header_value_count(const std::string &key) const;
  1514. void set_header(const std::string &key, const std::string &val);
  1515. bool has_trailer(const std::string &key) const;
  1516. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1517. size_t get_trailer_value_count(const std::string &key) const;
  1518. bool has_param(const std::string &key) const;
  1519. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1520. std::vector<std::string> get_param_values(const std::string &key) const;
  1521. size_t get_param_value_count(const std::string &key) const;
  1522. bool is_multipart_form_data() const;
  1523. // private members...
  1524. bool body_read_started_ = false;
  1525. bool body_consumed_ = false;
  1526. bool expect_100_continue_pending_ = false;
  1527. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1528. size_t content_length_ = 0;
  1529. ContentProvider content_provider_;
  1530. bool is_chunked_content_provider_ = false;
  1531. size_t authorization_count_ = 0;
  1532. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1533. (std::chrono::steady_clock::time_point::min)();
  1534. #ifdef CPPHTTPLIB_SSL_ENABLED
  1535. tls::const_session_t ssl = nullptr;
  1536. tls::PeerCert peer_cert() const;
  1537. std::string sni() const;
  1538. #endif
  1539. };
  1540. namespace detail {
  1541. // Declared up here, away from the rest of the compression helpers, because
  1542. // `Response` stores one.
  1543. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1544. } // namespace detail
  1545. struct Response {
  1546. std::string version;
  1547. int status = -1;
  1548. std::string reason;
  1549. Headers headers;
  1550. Headers trailers;
  1551. std::string body;
  1552. std::string location; // Redirect location
  1553. // User-defined context — set by pre-routing/pre-request handlers and read
  1554. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1555. UserData user_data;
  1556. bool has_header(const std::string &key) const;
  1557. std::string get_header_value(const std::string &key, const char *def = "",
  1558. size_t id = 0) const;
  1559. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1560. size_t id = 0) const;
  1561. size_t get_header_value_count(const std::string &key) const;
  1562. void set_header(const std::string &key, const std::string &val);
  1563. bool has_trailer(const std::string &key) const;
  1564. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1565. size_t get_trailer_value_count(const std::string &key) const;
  1566. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1567. void set_content(const char *s, size_t n, const std::string &content_type);
  1568. void set_content(const std::string &s, const std::string &content_type);
  1569. void set_content(std::string &&s, const std::string &content_type);
  1570. void set_content_provider(
  1571. size_t length, const std::string &content_type, ContentProvider provider,
  1572. ContentProviderResourceReleaser resource_releaser = nullptr);
  1573. void set_content_provider(
  1574. const std::string &content_type, ContentProviderWithoutLength provider,
  1575. ContentProviderResourceReleaser resource_releaser = nullptr);
  1576. void set_chunked_content_provider(
  1577. const std::string &content_type, ContentProviderWithoutLength provider,
  1578. ContentProviderResourceReleaser resource_releaser = nullptr);
  1579. void set_file_content(const std::string &path,
  1580. const std::string &content_type);
  1581. void set_file_content(const std::string &path);
  1582. Response() = default;
  1583. Response(const Response &) = default;
  1584. Response &operator=(const Response &) = default;
  1585. Response(Response &&) = default;
  1586. Response &operator=(Response &&) = default;
  1587. ~Response() {
  1588. if (content_provider_resource_releaser_) {
  1589. content_provider_resource_releaser_(content_provider_success_);
  1590. }
  1591. }
  1592. // private members...
  1593. size_t content_length_ = 0;
  1594. ContentProvider content_provider_;
  1595. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1596. bool is_chunked_content_provider_ = false;
  1597. bool is_file_content_provider_ = false;
  1598. bool content_provider_success_ = false;
  1599. std::string file_content_path_;
  1600. std::string file_content_content_type_;
  1601. // Content coding chosen for the response body, decided once so that the
  1602. // headers and the body cannot disagree: where the file is opened for a
  1603. // file-backed content provider (keeping the ETag honest), and in
  1604. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1605. // for every other kind of response.
  1606. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1607. };
  1608. enum class Error {
  1609. Success = 0,
  1610. Unknown,
  1611. Connection,
  1612. BindIPAddress,
  1613. Read,
  1614. Write,
  1615. ExceedRedirectCount,
  1616. Canceled,
  1617. SSLConnection,
  1618. SSLLoadingCerts,
  1619. SSLServerVerification,
  1620. SSLServerHostnameVerification,
  1621. UnsupportedMultipartBoundaryChars,
  1622. Compression,
  1623. ConnectionTimeout,
  1624. ProxyConnection,
  1625. ConnectionClosed,
  1626. Timeout,
  1627. ResourceExhaustion,
  1628. TooManyFormDataFiles,
  1629. ExceedMaxPayloadSize,
  1630. ExceedUriMaxLength,
  1631. ExceedMaxSocketDescriptorCount,
  1632. InvalidRequestLine,
  1633. InvalidHTTPMethod,
  1634. InvalidHTTPVersion,
  1635. InvalidHeaders,
  1636. MultipartParsing,
  1637. OpenFile,
  1638. Listen,
  1639. GetSockName,
  1640. UnsupportedAddressFamily,
  1641. HTTPParsing,
  1642. InvalidRangeHeader,
  1643. UnsupportedContentEncoding,
  1644. WebSocketHandshake,
  1645. UserCallbackException,
  1646. // For internal use only
  1647. SSLPeerCouldBeClosed_,
  1648. };
  1649. std::string to_string(Error error);
  1650. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1651. class Stream {
  1652. public:
  1653. virtual ~Stream() = default;
  1654. virtual bool is_readable() const = 0;
  1655. virtual bool wait_readable() const = 0;
  1656. virtual bool wait_writable() const = 0;
  1657. virtual bool is_peer_alive() const { return wait_writable(); }
  1658. virtual ssize_t read(char *ptr, size_t size) = 0;
  1659. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1660. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1661. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1662. virtual socket_t socket() const = 0;
  1663. virtual time_t duration() const = 0;
  1664. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1665. (void)sec;
  1666. (void)usec;
  1667. }
  1668. // Bytes already pulled off the socket and sitting in this stream's own
  1669. // buffer. Exposing them lets a line reader scan for a terminator in one
  1670. // pass instead of asking for a byte at a time. A stream that does no
  1671. // buffering of its own reports none, and readers fall back to read().
  1672. virtual const char *buffered_data(size_t &size) const {
  1673. size = 0;
  1674. return nullptr;
  1675. }
  1676. // Discards `size` bytes previously returned by buffered_data().
  1677. virtual void consume_buffered(size_t size) { (void)size; }
  1678. ssize_t write(const char *ptr);
  1679. ssize_t write(const std::string &s);
  1680. Error get_error() const { return error_; }
  1681. protected:
  1682. Error error_ = Error::Success;
  1683. };
  1684. class TaskQueue {
  1685. public:
  1686. TaskQueue() = default;
  1687. virtual ~TaskQueue() = default;
  1688. virtual bool enqueue(std::function<void()> fn) = 0;
  1689. virtual void shutdown() = 0;
  1690. virtual void on_idle() {}
  1691. };
  1692. class ThreadPool final : public TaskQueue {
  1693. public:
  1694. explicit ThreadPool(
  1695. size_t n, size_t max_n = 0, size_t mqr = 0,
  1696. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1697. ThreadPool(const ThreadPool &) = delete;
  1698. ~ThreadPool() override = default;
  1699. bool enqueue(std::function<void()> fn) override;
  1700. void shutdown() override;
  1701. private:
  1702. void worker(bool is_dynamic);
  1703. void move_to_finished(std::thread::id id);
  1704. void cleanup_finished_threads();
  1705. size_t base_thread_count_;
  1706. size_t max_thread_count_;
  1707. size_t max_queued_requests_;
  1708. time_t idle_timeout_sec_;
  1709. size_t idle_thread_count_;
  1710. bool shutdown_;
  1711. std::list<std::function<void()>> jobs_;
  1712. std::vector<std::thread> threads_; // base threads
  1713. std::list<std::thread> dynamic_threads_; // dynamic threads
  1714. std::vector<std::thread>
  1715. finished_threads_; // exited dynamic threads awaiting join
  1716. std::condition_variable cond_;
  1717. std::mutex mutex_;
  1718. };
  1719. using Logger = std::function<void(const Request &, const Response &)>;
  1720. // Forward declaration for Error type
  1721. enum class Error;
  1722. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1723. using SocketOptions = std::function<void(socket_t sock)>;
  1724. void default_socket_options(socket_t sock);
  1725. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1726. const char *status_message(int status);
  1727. std::string to_string(Error error);
  1728. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1729. std::string get_bearer_token_auth(const Request &req);
  1730. namespace detail {
  1731. class MatcherBase {
  1732. public:
  1733. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1734. virtual ~MatcherBase() = default;
  1735. const std::string &pattern() const { return pattern_; }
  1736. // Match request path and populate its matches and
  1737. virtual bool match(Request &request) const = 0;
  1738. private:
  1739. std::string pattern_;
  1740. };
  1741. /**
  1742. * Captures parameters in request path and stores them in Request::path_params
  1743. *
  1744. * Capture name is a substring of a pattern from : to /.
  1745. * The rest of the pattern is matched against the request path directly
  1746. * Parameters are captured starting from the next character after
  1747. * the end of the last matched static pattern fragment until the next /.
  1748. *
  1749. * Example pattern:
  1750. * "/path/fragments/:capture/more/fragments/:second_capture"
  1751. * Static fragments:
  1752. * "/path/fragments/", "more/fragments/"
  1753. *
  1754. * Given the following request path:
  1755. * "/path/fragments/:1/more/fragments/:2"
  1756. * the resulting capture will be
  1757. * {{"capture", "1"}, {"second_capture", "2"}}
  1758. */
  1759. class PathParamsMatcher final : public MatcherBase {
  1760. public:
  1761. PathParamsMatcher(const std::string &pattern);
  1762. bool match(Request &request) const override;
  1763. private:
  1764. // Treat segment separators as the end of path parameter capture
  1765. // Does not need to handle query parameters as they are parsed before path
  1766. // matching
  1767. static constexpr char separator = '/';
  1768. // Contains static path fragments to match against, excluding the '/' after
  1769. // path params
  1770. // Fragments are separated by path params
  1771. std::vector<std::string> static_fragments_;
  1772. // Stores the names of the path parameters to be used as keys in the
  1773. // Request::path_params map
  1774. std::vector<std::string> param_names_;
  1775. };
  1776. /**
  1777. * Performs std::regex_match on request path
  1778. * and stores the result in Request::matches
  1779. *
  1780. * Note that regex match is performed directly on the whole request.
  1781. * This means that wildcard patterns may match multiple path segments with /:
  1782. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1783. */
  1784. class RegexMatcher final : public MatcherBase {
  1785. public:
  1786. RegexMatcher(const std::string &pattern)
  1787. : MatcherBase(pattern), regex_(pattern) {}
  1788. bool match(Request &request) const override;
  1789. private:
  1790. std::regex regex_;
  1791. };
  1792. int close_socket(socket_t sock) noexcept;
  1793. bool is_accept_resource_error();
  1794. bool is_accept_transient_error();
  1795. ssize_t write_headers(Stream &strm, const Headers &headers);
  1796. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1797. time_t usec);
  1798. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1799. const std::string &boundary);
  1800. ContentProvider
  1801. make_multipart_content_provider(const UploadFormDataItems &items,
  1802. const std::string &boundary);
  1803. } // namespace detail
  1804. bool is_valid_multipart_boundary(const std::string &boundary);
  1805. // Serializer for multipart/form-data request bodies. The boundary is owned
  1806. // by the writer so that per-part framing and the final terminator always
  1807. // agree. Field names and filenames are escaped following the WHATWG HTML
  1808. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1809. // in content types.
  1810. class MultipartFormDataWriter {
  1811. public:
  1812. MultipartFormDataWriter();
  1813. // precondition: is_valid_multipart_boundary(boundary)
  1814. explicit MultipartFormDataWriter(std::string boundary);
  1815. const std::string &boundary() const;
  1816. std::string content_type() const;
  1817. // In-memory items -> whole body (known length)
  1818. std::string serialize(const UploadFormDataItems &items) const;
  1819. size_t content_length(const UploadFormDataItems &items) const;
  1820. // Per-part framing for streaming via a content provider
  1821. std::string item_begin(const UploadFormData &item) const;
  1822. static std::string item_end();
  1823. std::string finish() const;
  1824. private:
  1825. std::string boundary_;
  1826. };
  1827. class Server {
  1828. public:
  1829. using Handler = std::function<void(const Request &, Response &)>;
  1830. using ExceptionHandler =
  1831. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1832. enum class HandlerResponse {
  1833. Handled,
  1834. Unhandled,
  1835. };
  1836. using HandlerWithResponse =
  1837. std::function<HandlerResponse(const Request &, Response &)>;
  1838. using HandlerWithContentReader = std::function<void(
  1839. const Request &, Response &, const ContentReader &content_reader)>;
  1840. using Expect100ContinueHandler =
  1841. std::function<int(const Request &, Response &)>;
  1842. using StartHandler = std::function<void()>;
  1843. using WebSocketHandler =
  1844. std::function<void(const Request &, ws::WebSocket &)>;
  1845. using SubProtocolSelector =
  1846. std::function<std::string(const std::vector<std::string> &protocols)>;
  1847. Server();
  1848. virtual ~Server();
  1849. virtual bool is_valid() const;
  1850. Server &Get(const std::string &pattern, Handler handler);
  1851. Server &Post(const std::string &pattern, Handler handler);
  1852. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1853. Server &Put(const std::string &pattern, Handler handler);
  1854. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1855. Server &Patch(const std::string &pattern, Handler handler);
  1856. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1857. Server &Delete(const std::string &pattern, Handler handler);
  1858. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1859. Server &Options(const std::string &pattern, Handler handler);
  1860. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1861. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1862. // server accept it; an unregistered method is still rejected with 400.
  1863. // `method` must be a valid HTTP method token and must not be one of the
  1864. // built-in methods, which have their own registration functions above. A
  1865. // rejected registration makes is_valid() return false, so listen() fails.
  1866. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1867. Handler handler);
  1868. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1869. HandlerWithContentReader handler);
  1870. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1871. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1872. SubProtocolSelector sub_protocol_selector);
  1873. bool set_base_dir(const std::string &dir,
  1874. const std::string &mount_point = std::string());
  1875. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1876. Headers headers = Headers());
  1877. bool remove_mount_point(const std::string &mount_point);
  1878. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1879. const std::string &mime);
  1880. Server &set_default_file_mimetype(const std::string &mime);
  1881. Server &set_file_request_handler(Handler handler);
  1882. template <class ErrorHandlerFunc>
  1883. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1884. return set_error_handler_core(
  1885. std::forward<ErrorHandlerFunc>(handler),
  1886. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1887. }
  1888. Server &set_exception_handler(ExceptionHandler handler);
  1889. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1890. Server &set_post_routing_handler(Handler handler);
  1891. Server &set_pre_request_handler(HandlerWithResponse handler);
  1892. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1893. Server &set_start_handler(StartHandler handler);
  1894. Server &set_logger(Logger logger);
  1895. Server &set_pre_compression_logger(Logger logger);
  1896. Server &set_error_logger(ErrorLogger error_logger);
  1897. Server &set_address_family(int family);
  1898. Server &set_tcp_nodelay(bool on);
  1899. Server &set_ipv6_v6only(bool on);
  1900. Server &set_socket_options(SocketOptions socket_options);
  1901. Server &set_default_headers(Headers headers);
  1902. Server &
  1903. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1904. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1905. Server &set_keep_alive_max_count(size_t count);
  1906. Server &set_keep_alive_timeout(time_t sec);
  1907. template <class Rep, class Period>
  1908. Server &
  1909. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1910. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1911. template <class Rep, class Period>
  1912. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1913. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1914. template <class Rep, class Period>
  1915. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1916. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1917. template <class Rep, class Period>
  1918. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1919. Server &set_payload_max_length(size_t length);
  1920. Server &set_static_file_compression(bool on);
  1921. Server &set_static_file_compression_min_length(size_t length);
  1922. Server &set_static_file_compression_max_length(size_t length);
  1923. Server &set_websocket_ping_interval(time_t sec);
  1924. template <class Rep, class Period>
  1925. Server &set_websocket_ping_interval(
  1926. const std::chrono::duration<Rep, Period> &duration);
  1927. Server &set_websocket_max_missed_pongs(int count);
  1928. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1929. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1930. bool listen_after_bind();
  1931. bool listen(const std::string &host, int port, int socket_flags = 0);
  1932. bool is_running() const;
  1933. void wait_until_ready() const;
  1934. void stop() noexcept;
  1935. void decommission();
  1936. std::function<TaskQueue *(void)> new_task_queue;
  1937. protected:
  1938. bool process_request(Stream &strm, const std::string &remote_addr,
  1939. int remote_port, const std::string &local_addr,
  1940. int local_port, bool close_connection,
  1941. bool &connection_closed,
  1942. const std::function<void(Request &)> &setup_request,
  1943. bool *websocket_upgraded = nullptr);
  1944. // Runs the per-connection serving loop and stops an exception thrown by a
  1945. // user callback from escaping the worker thread.
  1946. //
  1947. // process_request() wraps only routing() in a try/catch. Content providers,
  1948. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1949. // handlers all run outside it, and the task queue calls the job without a
  1950. // catch, so an exception from any of those would terminate the process.
  1951. //
  1952. // No 500 is possible here: by the time a content provider runs, the status
  1953. // line and headers are already on the wire. Report it through the error
  1954. // logger and drop the connection, which is what the peer observes either
  1955. // way. Other connections are unaffected.
  1956. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1957. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1958. return serve();
  1959. #else
  1960. try {
  1961. return serve();
  1962. } catch (...) {
  1963. // The error logger is a user callback too, so it must not be able to
  1964. // throw the guard back open.
  1965. try {
  1966. output_error_log(Error::UserCallbackException, nullptr);
  1967. } catch (...) {}
  1968. return false;
  1969. }
  1970. #endif
  1971. }
  1972. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1973. std::vector<std::string> trusted_proxies_;
  1974. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1975. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1976. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1977. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1978. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1979. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1980. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1981. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1982. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1983. bool static_file_compression_ = false;
  1984. size_t static_file_compression_min_length_ =
  1985. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1986. size_t static_file_compression_max_length_ =
  1987. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1988. time_t websocket_ping_interval_sec_ =
  1989. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1990. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1991. private:
  1992. using Handlers =
  1993. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1994. using HandlersForContentReader =
  1995. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1996. HandlerWithContentReader>>;
  1997. // Both handler tables for one custom method live in a single entry, so that
  1998. // routing() needs only one map lookup per request to reach either of them.
  1999. struct CustomHandlerEntry {
  2000. Handlers handlers;
  2001. HandlersForContentReader handlers_for_content_reader;
  2002. };
  2003. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2004. static std::unique_ptr<detail::MatcherBase>
  2005. make_matcher(const std::string &pattern);
  2006. static const std::set<std::string> &builtin_methods();
  2007. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2008. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2009. template <typename H>
  2010. Server &add_handler(
  2011. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2012. const std::string &pattern, H handler) {
  2013. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2014. return *this;
  2015. }
  2016. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2017. Server &set_error_handler_core(Handler handler, std::false_type);
  2018. socket_t create_server_socket(const std::string &host, int port,
  2019. int socket_flags,
  2020. SocketOptions socket_options) const;
  2021. int bind_internal(const std::string &host, int port, int socket_flags);
  2022. bool listen_internal();
  2023. bool routing(Request &req, Response &res, Stream &strm);
  2024. bool handle_file_request(Request &req, Response &res);
  2025. bool check_if_not_modified(const Request &req, Response &res,
  2026. const std::string &etag, time_t mtime) const;
  2027. bool check_if_range(Request &req, const std::string &etag,
  2028. time_t mtime) const;
  2029. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2030. Stream &strm);
  2031. bool dispatch_request_for_content_reader(
  2032. Request &req, Response &res, ContentReader content_reader,
  2033. const HandlersForContentReader &handlers) const;
  2034. bool parse_request_line(const char *s, Request &req) const;
  2035. detail::EncodingType static_file_encoding(const Request &req,
  2036. const Response &res,
  2037. const std::string &content_type,
  2038. size_t length) const;
  2039. bool apply_static_file_compression(const Request &req, Response &res) const;
  2040. void apply_ranges(const Request &req, Response &res,
  2041. std::string &content_type, std::string &boundary) const;
  2042. bool write_response(Stream &strm, bool close_connection, Request &req,
  2043. Response &res);
  2044. bool write_response_with_content(Stream &strm, bool close_connection,
  2045. const Request &req, Response &res);
  2046. bool write_response_core(Stream &strm, bool close_connection,
  2047. const Request &req, Response &res,
  2048. bool need_apply_ranges);
  2049. bool write_content_with_provider(Stream &strm, const Request &req,
  2050. Response &res, const std::string &boundary,
  2051. const std::string &content_type);
  2052. bool read_content(Stream &strm, Request &req, Response &res);
  2053. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2054. Response &res,
  2055. ContentReceiver receiver,
  2056. FormDataHeader multipart_header,
  2057. ContentReceiver multipart_receiver);
  2058. bool read_content_core(Stream &strm, Request &req, Response &res,
  2059. ContentReceiver receiver,
  2060. FormDataHeader multipart_header,
  2061. ContentReceiver multipart_receiver) const;
  2062. virtual bool process_and_close_socket(socket_t sock);
  2063. void output_log(const Request &req, const Response &res) const;
  2064. void output_pre_compression_log(const Request &req,
  2065. const Response &res) const;
  2066. void output_error_log(const Error &err, const Request *req) const;
  2067. std::atomic<bool> is_running_{false};
  2068. std::atomic<bool> is_decommissioned{false};
  2069. // Set when CustomRoute() refuses a registration. Written before listen(),
  2070. // read by is_valid() on the same thread, so it needs no synchronization.
  2071. bool has_invalid_registration_ = false;
  2072. struct MountPointEntry {
  2073. std::string mount_point;
  2074. std::string base_dir;
  2075. std::string resolved_base_dir;
  2076. Headers headers;
  2077. };
  2078. std::vector<MountPointEntry> base_dirs_;
  2079. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2080. std::string default_file_mimetype_ = "application/octet-stream";
  2081. Handler file_request_handler_;
  2082. Handlers get_handlers_;
  2083. Handlers post_handlers_;
  2084. HandlersForContentReader post_handlers_for_content_reader_;
  2085. Handlers put_handlers_;
  2086. HandlersForContentReader put_handlers_for_content_reader_;
  2087. Handlers patch_handlers_;
  2088. HandlersForContentReader patch_handlers_for_content_reader_;
  2089. Handlers delete_handlers_;
  2090. HandlersForContentReader delete_handlers_for_content_reader_;
  2091. Handlers options_handlers_;
  2092. CustomHandlers custom_handlers_;
  2093. struct WebSocketHandlerEntry {
  2094. std::unique_ptr<detail::MatcherBase> matcher;
  2095. WebSocketHandler handler;
  2096. SubProtocolSelector sub_protocol_selector;
  2097. };
  2098. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2099. WebSocketHandlers websocket_handlers_;
  2100. HandlerWithResponse error_handler_;
  2101. ExceptionHandler exception_handler_;
  2102. HandlerWithResponse pre_routing_handler_;
  2103. Handler post_routing_handler_;
  2104. HandlerWithResponse pre_request_handler_;
  2105. Expect100ContinueHandler expect_100_continue_handler_;
  2106. StartHandler start_handler_;
  2107. mutable std::mutex logger_mutex_;
  2108. Logger logger_;
  2109. Logger pre_compression_logger_;
  2110. ErrorLogger error_logger_;
  2111. int address_family_ = AF_UNSPEC;
  2112. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2113. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2114. SocketOptions socket_options_ = default_socket_options;
  2115. Headers default_headers_;
  2116. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2117. detail::write_headers;
  2118. };
  2119. class Result {
  2120. public:
  2121. Result() = default;
  2122. Result(std::unique_ptr<Response> &&res, Error err,
  2123. Headers &&request_headers = Headers{})
  2124. : res_(std::move(res)), err_(err),
  2125. request_headers_(std::move(request_headers)) {}
  2126. // Response
  2127. operator bool() const { return res_ != nullptr; }
  2128. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2129. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2130. const Response &value() const { return *res_; }
  2131. Response &value() { return *res_; }
  2132. const Response &operator*() const { return *res_; }
  2133. Response &operator*() { return *res_; }
  2134. const Response *operator->() const { return res_.get(); }
  2135. Response *operator->() { return res_.get(); }
  2136. // Error
  2137. Error error() const { return err_; }
  2138. // Request Headers
  2139. bool has_request_header(const std::string &key) const;
  2140. std::string get_request_header_value(const std::string &key,
  2141. const char *def = "",
  2142. size_t id = 0) const;
  2143. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2144. size_t id = 0) const;
  2145. size_t get_request_header_value_count(const std::string &key) const;
  2146. private:
  2147. std::unique_ptr<Response> res_;
  2148. Error err_ = Error::Unknown;
  2149. Headers request_headers_;
  2150. #ifdef CPPHTTPLIB_SSL_ENABLED
  2151. public:
  2152. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2153. int ssl_error)
  2154. : res_(std::move(res)), err_(err),
  2155. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2156. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2157. int ssl_error, uint64_t ssl_backend_error)
  2158. : res_(std::move(res)), err_(err),
  2159. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2160. ssl_backend_error_(ssl_backend_error) {}
  2161. int ssl_error() const { return ssl_error_; }
  2162. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2163. private:
  2164. int ssl_error_ = 0;
  2165. uint64_t ssl_backend_error_ = 0;
  2166. #endif
  2167. };
  2168. struct ClientConnection {
  2169. socket_t sock = INVALID_SOCKET;
  2170. bool is_open() const { return sock != INVALID_SOCKET; }
  2171. ClientConnection() = default;
  2172. ~ClientConnection();
  2173. ClientConnection(const ClientConnection &) = delete;
  2174. ClientConnection &operator=(const ClientConnection &) = delete;
  2175. ClientConnection(ClientConnection &&other) noexcept
  2176. : sock(other.sock)
  2177. #ifdef CPPHTTPLIB_SSL_ENABLED
  2178. ,
  2179. session(other.session)
  2180. #endif
  2181. {
  2182. other.sock = INVALID_SOCKET;
  2183. #ifdef CPPHTTPLIB_SSL_ENABLED
  2184. other.session = nullptr;
  2185. #endif
  2186. }
  2187. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2188. if (this != &other) {
  2189. sock = other.sock;
  2190. other.sock = INVALID_SOCKET;
  2191. #ifdef CPPHTTPLIB_SSL_ENABLED
  2192. session = other.session;
  2193. other.session = nullptr;
  2194. #endif
  2195. }
  2196. return *this;
  2197. }
  2198. #ifdef CPPHTTPLIB_SSL_ENABLED
  2199. tls::session_t session = nullptr;
  2200. #endif
  2201. };
  2202. namespace detail {
  2203. struct ChunkedDecoder;
  2204. struct BodyReader {
  2205. Stream *stream = nullptr;
  2206. bool has_content_length = false;
  2207. size_t content_length = 0;
  2208. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2209. size_t bytes_read = 0;
  2210. bool chunked = false;
  2211. bool eof = false;
  2212. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2213. Error last_error = Error::Success;
  2214. ssize_t read(char *buf, size_t len);
  2215. bool has_error() const { return last_error != Error::Success; }
  2216. };
  2217. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2218. size_t len) {
  2219. (void)stream;
  2220. return br.read(buf, len);
  2221. }
  2222. class decompressor;
  2223. enum class NoProxyKind {
  2224. Wildcard, // "*"
  2225. HostnameSuffix, // "example.com" or ".example.com"
  2226. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2227. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2228. };
  2229. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2230. // Lets one CIDR matcher cover both families.
  2231. using IPBytes = std::array<uint8_t, 16>;
  2232. struct NoProxyEntry {
  2233. NoProxyKind kind = NoProxyKind::Wildcard;
  2234. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2235. IPBytes net{};
  2236. int prefix_bits = 0;
  2237. };
  2238. struct NormalizedTarget {
  2239. std::string hostname; // lowercase; brackets and trailing dot removed
  2240. bool is_ipv4 = false;
  2241. bool is_ipv6 = false;
  2242. IPBytes ip{};
  2243. };
  2244. } // namespace detail
  2245. class ClientImpl {
  2246. public:
  2247. explicit ClientImpl(const std::string &host);
  2248. explicit ClientImpl(const std::string &host, int port);
  2249. explicit ClientImpl(const std::string &host, int port,
  2250. const std::string &client_cert_path,
  2251. const std::string &client_key_path);
  2252. virtual ~ClientImpl();
  2253. virtual bool is_valid() const;
  2254. struct StreamHandle {
  2255. std::unique_ptr<Response> response;
  2256. Error error = Error::Success;
  2257. StreamHandle() = default;
  2258. StreamHandle(const StreamHandle &) = delete;
  2259. StreamHandle &operator=(const StreamHandle &) = delete;
  2260. StreamHandle(StreamHandle &&) = default;
  2261. StreamHandle &operator=(StreamHandle &&) = default;
  2262. ~StreamHandle() = default;
  2263. bool is_valid() const {
  2264. return response != nullptr && error == Error::Success;
  2265. }
  2266. ssize_t read(char *buf, size_t len);
  2267. void parse_trailers_if_needed();
  2268. Error get_read_error() const { return body_reader_.last_error; }
  2269. bool has_read_error() const { return body_reader_.has_error(); }
  2270. bool trailers_parsed_ = false;
  2271. private:
  2272. friend class ClientImpl;
  2273. ssize_t read_with_decompression(char *buf, size_t len);
  2274. std::unique_ptr<ClientConnection> connection_;
  2275. std::unique_ptr<Stream> socket_stream_;
  2276. Stream *stream_ = nullptr;
  2277. detail::BodyReader body_reader_;
  2278. std::unique_ptr<detail::decompressor> decompressor_;
  2279. std::string decompress_buffer_;
  2280. size_t decompress_offset_ = 0;
  2281. size_t decompressed_bytes_read_ = 0;
  2282. };
  2283. // clang-format off
  2284. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2285. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2286. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2287. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2288. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2289. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2290. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2291. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2292. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2293. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2294. Result Head(const std::string &path);
  2295. Result Head(const std::string &path, const Headers &headers);
  2296. Result Post(const std::string &path);
  2297. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2299. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2301. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2302. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2303. Result Post(const std::string &path, const Params &params);
  2304. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2305. Result Post(const std::string &path, const Headers &headers);
  2306. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2307. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2309. 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);
  2310. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2311. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2312. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2313. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2314. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2315. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2316. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2317. Result Put(const std::string &path);
  2318. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2320. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2321. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2322. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2323. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2324. Result Put(const std::string &path, const Params &params);
  2325. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2326. Result Put(const std::string &path, const Headers &headers);
  2327. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2330. 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);
  2331. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2332. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2333. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2334. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2335. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2336. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2337. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2338. Result Patch(const std::string &path);
  2339. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2342. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2343. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2344. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const Params &params);
  2346. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2347. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2348. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2349. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2351. 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);
  2352. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2353. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2354. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2355. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2356. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2357. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2358. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2359. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2360. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2361. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2362. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2363. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2364. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2365. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2366. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2367. Result Options(const std::string &path);
  2368. Result Options(const std::string &path, const Headers &headers);
  2369. // clang-format on
  2370. // Streaming API: Open a stream for reading response body incrementally
  2371. // Socket ownership is transferred to StreamHandle for true streaming
  2372. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2373. StreamHandle open_stream(const std::string &method, const std::string &path,
  2374. const Params &params = {},
  2375. const Headers &headers = {},
  2376. const std::string &body = {},
  2377. const std::string &content_type = {});
  2378. bool send(Request &req, Response &res, Error &error);
  2379. Result send(const Request &req);
  2380. void stop();
  2381. std::string host() const;
  2382. int port() const;
  2383. size_t is_socket_open() const;
  2384. socket_t socket() const;
  2385. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2386. void set_default_headers(Headers headers);
  2387. void
  2388. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2389. void set_address_family(int family);
  2390. void set_tcp_nodelay(bool on);
  2391. void set_ipv6_v6only(bool on);
  2392. void set_socket_options(SocketOptions socket_options);
  2393. void set_connection_timeout(time_t sec, time_t usec = 0);
  2394. template <class Rep, class Period>
  2395. void
  2396. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2397. void set_read_timeout(time_t sec, time_t usec = 0);
  2398. template <class Rep, class Period>
  2399. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2400. void set_write_timeout(time_t sec, time_t usec = 0);
  2401. template <class Rep, class Period>
  2402. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2403. void set_max_timeout(time_t msec);
  2404. template <class Rep, class Period>
  2405. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2406. void set_basic_auth(const std::string &username, const std::string &password);
  2407. void set_bearer_token_auth(const std::string &token);
  2408. void set_keep_alive(bool on);
  2409. void set_follow_location(bool on);
  2410. void set_path_encode(bool on);
  2411. void set_compress(bool on);
  2412. void set_decompress(bool on);
  2413. void set_payload_max_length(size_t length);
  2414. void set_interface(const std::string &intf);
  2415. void set_proxy(const std::string &host, int port);
  2416. void set_proxy_basic_auth(const std::string &username,
  2417. const std::string &password);
  2418. void set_proxy_bearer_token_auth(const std::string &token);
  2419. void set_no_proxy(const std::vector<std::string> &patterns);
  2420. void set_logger(Logger logger);
  2421. void set_error_logger(ErrorLogger error_logger);
  2422. protected:
  2423. struct Socket {
  2424. socket_t sock = INVALID_SOCKET;
  2425. // For Mbed TLS compatibility: start_time for request timeout tracking
  2426. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2427. bool is_open() const { return sock != INVALID_SOCKET; }
  2428. #ifdef CPPHTTPLIB_SSL_ENABLED
  2429. tls::session_t ssl = nullptr;
  2430. #endif
  2431. };
  2432. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2433. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2434. virtual bool setup_proxy_connection(
  2435. Socket &socket,
  2436. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2437. Response &res, bool &success, Error &error);
  2438. bool is_proxy_enabled_for_host(const std::string &host) const;
  2439. // All of:
  2440. // shutdown_ssl
  2441. // shutdown_socket
  2442. // close_socket
  2443. // disconnect
  2444. // should ONLY be called when socket_mutex_ is locked, and only when
  2445. // no other thread is using the socket.
  2446. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2447. void shutdown_socket(Socket &socket) const;
  2448. void close_socket(Socket &socket);
  2449. void disconnect(bool gracefully);
  2450. bool process_request(Stream &strm, Request &req, Response &res,
  2451. bool close_connection, Error &error);
  2452. bool write_content_with_provider(Stream &strm, const Request &req,
  2453. Error &error) const;
  2454. void copy_settings(const ClientImpl &rhs);
  2455. void output_log(const Request &req, const Response &res) const;
  2456. void output_error_log(const Error &err, const Request *req) const;
  2457. // Socket endpoint information
  2458. const std::string host_;
  2459. const int port_;
  2460. // Current open socket
  2461. Socket socket_;
  2462. mutable std::mutex socket_mutex_;
  2463. std::recursive_mutex request_mutex_;
  2464. // These are all protected under socket_mutex
  2465. size_t socket_requests_in_flight_ = 0;
  2466. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2467. bool socket_should_be_closed_when_request_is_done_ = false;
  2468. // Hostname to connection target map. The value is an IP literal or another
  2469. // hostname; only the connection target changes, never the identity.
  2470. std::map<std::string, std::string> addr_map_;
  2471. // Default headers
  2472. Headers default_headers_;
  2473. // Header writer
  2474. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2475. detail::write_headers;
  2476. // Settings
  2477. std::string client_cert_path_;
  2478. std::string client_key_path_;
  2479. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2480. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2481. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2482. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2483. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2484. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2485. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2486. std::string basic_auth_username_;
  2487. std::string basic_auth_password_;
  2488. std::string bearer_token_auth_token_;
  2489. bool keep_alive_ = false;
  2490. bool follow_location_ = false;
  2491. bool path_encode_ = true;
  2492. int address_family_ = AF_UNSPEC;
  2493. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2494. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2495. SocketOptions socket_options_ = nullptr;
  2496. bool compress_ = false;
  2497. bool decompress_ = true;
  2498. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2499. bool has_payload_max_length_ = false;
  2500. std::string interface_;
  2501. std::string proxy_host_;
  2502. int proxy_port_ = -1;
  2503. std::string proxy_basic_auth_username_;
  2504. std::string proxy_basic_auth_password_;
  2505. std::string proxy_bearer_token_auth_token_;
  2506. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2507. mutable detail::NormalizedTarget host_normalized_;
  2508. mutable bool host_normalized_valid_ = false;
  2509. mutable std::mutex logger_mutex_;
  2510. Logger logger_;
  2511. ErrorLogger error_logger_;
  2512. private:
  2513. bool send_(Request &req, Response &res, Error &error);
  2514. Result send_(Request &&req);
  2515. socket_t create_client_socket(Error &error) const;
  2516. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2517. bool skip_100_continue = true) const;
  2518. bool write_request(Stream &strm, Request &req, bool close_connection,
  2519. Error &error, bool skip_body, bool &rejected_locally);
  2520. bool write_request_body(Stream &strm, Request &req, Error &error);
  2521. void prepare_default_headers(Request &r, bool for_stream,
  2522. const std::string &ct);
  2523. bool redirect(Request &req, Response &res, Error &error);
  2524. bool create_redirect_client(const std::string &scheme,
  2525. const std::string &host, int port, Request &req,
  2526. Response &res, const std::string &path,
  2527. const std::string &location, Error &error);
  2528. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2529. bool handle_request(Stream &strm, Request &req, Response &res,
  2530. bool close_connection, Error &error);
  2531. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2532. Request &req, const char *body, size_t content_length,
  2533. ContentProvider content_provider,
  2534. ContentProviderWithoutLength content_provider_without_length,
  2535. const std::string &content_type, ContentReceiver content_receiver,
  2536. Error &error);
  2537. Result send_with_content_provider_and_receiver(
  2538. const std::string &method, const std::string &path,
  2539. const Headers &headers, const char *body, size_t content_length,
  2540. ContentProvider content_provider,
  2541. ContentProviderWithoutLength content_provider_without_length,
  2542. const std::string &content_type, ContentReceiver content_receiver,
  2543. UploadProgress progress);
  2544. ContentProviderWithoutLength get_multipart_content_provider(
  2545. const std::string &boundary, const UploadFormDataItems &items,
  2546. const FormDataProviderItems &provider_items) const;
  2547. virtual bool
  2548. process_socket(const Socket &socket,
  2549. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2550. std::function<bool(Stream &strm)> callback);
  2551. virtual bool is_ssl() const;
  2552. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2553. #ifdef CPPHTTPLIB_SSL_ENABLED
  2554. public:
  2555. void set_digest_auth(const std::string &username,
  2556. const std::string &password);
  2557. void set_proxy_digest_auth(const std::string &username,
  2558. const std::string &password);
  2559. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2560. const std::string &ca_cert_dir_path = std::string());
  2561. void enable_server_certificate_verification(bool enabled);
  2562. void enable_server_hostname_verification(bool enabled);
  2563. void enable_system_ca(bool enabled);
  2564. protected:
  2565. std::string digest_auth_username_;
  2566. std::string digest_auth_password_;
  2567. std::string proxy_digest_auth_username_;
  2568. std::string proxy_digest_auth_password_;
  2569. std::string ca_cert_file_path_;
  2570. std::string ca_cert_dir_path_;
  2571. bool server_certificate_verification_ = true;
  2572. bool server_hostname_verification_ = true;
  2573. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2574. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2575. int last_ssl_error_ = 0;
  2576. uint64_t last_backend_error_ = 0;
  2577. #endif
  2578. };
  2579. class Client {
  2580. public:
  2581. // Universal interface
  2582. explicit Client(const std::string &scheme_host_port);
  2583. explicit Client(const std::string &scheme_host_port,
  2584. const std::string &client_cert_path,
  2585. const std::string &client_key_path);
  2586. // HTTP only interface
  2587. explicit Client(const std::string &host, int port);
  2588. explicit Client(const std::string &host, int port,
  2589. const std::string &client_cert_path,
  2590. const std::string &client_key_path);
  2591. Client(Client &&) = default;
  2592. Client &operator=(Client &&) = default;
  2593. ~Client();
  2594. bool is_valid() const;
  2595. // clang-format off
  2596. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2597. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2598. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2599. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2600. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2601. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2602. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2603. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2604. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2605. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2606. Result Head(const std::string &path);
  2607. Result Head(const std::string &path, const Headers &headers);
  2608. Result Post(const std::string &path);
  2609. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2611. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2614. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2615. Result Post(const std::string &path, const Params &params);
  2616. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2617. Result Post(const std::string &path, const Headers &headers);
  2618. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2619. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2620. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2621. 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);
  2622. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2623. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2624. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2625. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2626. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2627. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2628. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2629. Result Put(const std::string &path);
  2630. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2632. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2633. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2635. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2636. Result Put(const std::string &path, const Params &params);
  2637. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2638. Result Put(const std::string &path, const Headers &headers);
  2639. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2642. 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);
  2643. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2644. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2645. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2646. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2647. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2648. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2649. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2650. Result Patch(const std::string &path);
  2651. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2653. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2654. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2656. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2657. Result Patch(const std::string &path, const Params &params);
  2658. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2659. Result Patch(const std::string &path, const Headers &headers);
  2660. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2661. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2663. 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);
  2664. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2665. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2666. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2667. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2668. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2669. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2670. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2671. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2672. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2673. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2674. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2675. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2676. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2677. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2678. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2679. Result Options(const std::string &path);
  2680. Result Options(const std::string &path, const Headers &headers);
  2681. // clang-format on
  2682. // Streaming API: Open a stream for reading response body incrementally
  2683. // Socket ownership is transferred to StreamHandle for true streaming
  2684. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2685. ClientImpl::StreamHandle open_stream(const std::string &method,
  2686. const std::string &path,
  2687. const Params &params = {},
  2688. const Headers &headers = {},
  2689. const std::string &body = {},
  2690. const std::string &content_type = {});
  2691. bool send(Request &req, Response &res, Error &error);
  2692. Result send(const Request &req);
  2693. void stop();
  2694. std::string host() const;
  2695. int port() const;
  2696. size_t is_socket_open() const;
  2697. socket_t socket() const;
  2698. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2699. void set_default_headers(Headers headers);
  2700. void
  2701. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2702. void set_address_family(int family);
  2703. void set_tcp_nodelay(bool on);
  2704. void set_socket_options(SocketOptions socket_options);
  2705. void set_connection_timeout(time_t sec, time_t usec = 0);
  2706. template <class Rep, class Period>
  2707. void
  2708. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2709. void set_read_timeout(time_t sec, time_t usec = 0);
  2710. template <class Rep, class Period>
  2711. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2712. void set_write_timeout(time_t sec, time_t usec = 0);
  2713. template <class Rep, class Period>
  2714. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2715. void set_max_timeout(time_t msec);
  2716. template <class Rep, class Period>
  2717. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2718. void set_basic_auth(const std::string &username, const std::string &password);
  2719. void set_bearer_token_auth(const std::string &token);
  2720. void set_keep_alive(bool on);
  2721. void set_follow_location(bool on);
  2722. void set_path_encode(bool on);
  2723. void set_compress(bool on);
  2724. void set_decompress(bool on);
  2725. void set_payload_max_length(size_t length);
  2726. void set_interface(const std::string &intf);
  2727. void set_proxy(const std::string &host, int port);
  2728. void set_proxy_basic_auth(const std::string &username,
  2729. const std::string &password);
  2730. void set_proxy_bearer_token_auth(const std::string &token);
  2731. void set_no_proxy(const std::vector<std::string> &patterns);
  2732. void set_logger(Logger logger);
  2733. void set_error_logger(ErrorLogger error_logger);
  2734. private:
  2735. std::unique_ptr<ClientImpl> cli_;
  2736. #ifdef CPPHTTPLIB_SSL_ENABLED
  2737. public:
  2738. void set_digest_auth(const std::string &username,
  2739. const std::string &password);
  2740. void set_proxy_digest_auth(const std::string &username,
  2741. const std::string &password);
  2742. void enable_server_certificate_verification(bool enabled);
  2743. void enable_server_hostname_verification(bool enabled);
  2744. void enable_system_ca(bool enabled);
  2745. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2746. const std::string &ca_cert_dir_path = std::string());
  2747. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2748. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2749. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2750. void set_session_verifier(
  2751. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2752. tls::ctx_t tls_context() const;
  2753. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2754. void enable_windows_certificate_verification(bool enabled);
  2755. #endif
  2756. private:
  2757. bool is_ssl_ = false;
  2758. #endif
  2759. };
  2760. #ifdef CPPHTTPLIB_SSL_ENABLED
  2761. class SSLServer : public Server {
  2762. public:
  2763. SSLServer(const char *cert_path, const char *private_key_path,
  2764. const char *client_ca_cert_file_path = nullptr,
  2765. const char *client_ca_cert_dir_path = nullptr,
  2766. const char *private_key_password = nullptr);
  2767. struct PemMemory {
  2768. const char *cert_pem;
  2769. size_t cert_pem_len;
  2770. const char *key_pem;
  2771. size_t key_pem_len;
  2772. const char *client_ca_pem;
  2773. size_t client_ca_pem_len;
  2774. const char *private_key_password;
  2775. };
  2776. explicit SSLServer(const PemMemory &pem);
  2777. // The callback receives the ctx_t handle which can be cast to the
  2778. // appropriate backend type (SSL_CTX* for OpenSSL,
  2779. // tls::impl::MbedTlsContext* for Mbed TLS)
  2780. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2781. ~SSLServer() override;
  2782. bool is_valid() const override;
  2783. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2784. const char *client_ca_pem = nullptr,
  2785. const char *password = nullptr);
  2786. tls::ctx_t tls_context() const { return ctx_; }
  2787. int ssl_last_error() const { return last_ssl_error_; }
  2788. private:
  2789. bool process_and_close_socket(socket_t sock) override;
  2790. tls::ctx_t ctx_ = nullptr;
  2791. std::mutex ctx_mutex_;
  2792. int last_ssl_error_ = 0;
  2793. };
  2794. class SSLClient final : public ClientImpl {
  2795. public:
  2796. explicit SSLClient(const std::string &host);
  2797. explicit SSLClient(const std::string &host, int port);
  2798. explicit SSLClient(const std::string &host, int port,
  2799. const std::string &client_cert_path,
  2800. const std::string &client_key_path,
  2801. const std::string &private_key_password = std::string());
  2802. struct PemMemory {
  2803. const char *cert_pem;
  2804. size_t cert_pem_len;
  2805. const char *key_pem;
  2806. size_t key_pem_len;
  2807. const char *private_key_password;
  2808. };
  2809. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2810. ~SSLClient() override;
  2811. bool is_valid() const override;
  2812. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2813. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2814. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2815. // Post-handshake session verifier (backend-independent)
  2816. void set_session_verifier(
  2817. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2818. tls::ctx_t tls_context() const { return ctx_; }
  2819. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2820. void enable_windows_certificate_verification(bool enabled);
  2821. #endif
  2822. private:
  2823. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2824. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2825. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2826. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2827. bool
  2828. process_socket(const Socket &socket,
  2829. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2830. std::function<bool(Stream &strm)> callback) override;
  2831. bool is_ssl() const override;
  2832. bool setup_proxy_connection(
  2833. Socket &socket,
  2834. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2835. Response &res, bool &success, Error &error) override;
  2836. bool connect_with_proxy(
  2837. Socket &sock,
  2838. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2839. Response &res, bool &success, Error &error);
  2840. bool initialize_ssl(Socket &socket, Error &error);
  2841. void init_ctx();
  2842. void reset_ctx_on_error();
  2843. bool load_certs();
  2844. tls::ctx_t ctx_ = nullptr;
  2845. std::mutex ctx_mutex_;
  2846. std::once_flag initialize_cert_;
  2847. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2848. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2849. // Used to keep custom CA configuration exclusive with system CA loading.
  2850. bool ca_cert_store_set_ = false;
  2851. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2852. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2853. // set_server_certificate_verifier() installed there.
  2854. tls::VerifyCallback server_certificate_verifier_;
  2855. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2856. bool enable_windows_cert_verification_ = true;
  2857. #endif
  2858. friend class ClientImpl;
  2859. };
  2860. #endif // CPPHTTPLIB_SSL_ENABLED
  2861. namespace detail {
  2862. template <typename T, typename U>
  2863. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2864. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2865. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2866. duration - std::chrono::seconds(sec))
  2867. .count();
  2868. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2869. }
  2870. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2871. return N - 1;
  2872. }
  2873. inline bool is_numeric(const std::string &str) {
  2874. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2875. }
  2876. // std::ranges::next(first, n, last) for C++11
  2877. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2878. for (; n > 0 && first != last; --n) {
  2879. ++first;
  2880. }
  2881. return first;
  2882. }
  2883. inline size_t get_header_value_u64(const Headers &headers,
  2884. const std::string &key, size_t def,
  2885. size_t id, bool &is_invalid_value) {
  2886. is_invalid_value = false;
  2887. auto rng = headers.equal_range(key);
  2888. auto it = bounded_next(rng.first, id, rng.second);
  2889. if (it != rng.second) {
  2890. if (is_numeric(it->second)) {
  2891. // Parse at size_t width so an out-of-range Content-Length is reported
  2892. // rather than silently saturated/truncated (a value above 2^32 would
  2893. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2894. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2895. size_t val = 0;
  2896. const auto &s = it->second;
  2897. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2898. if (r.ec == std::errc::result_out_of_range) {
  2899. is_invalid_value = true;
  2900. return (std::numeric_limits<size_t>::max)();
  2901. }
  2902. return val;
  2903. } else {
  2904. is_invalid_value = true;
  2905. }
  2906. }
  2907. return def;
  2908. }
  2909. inline size_t get_header_value_u64(const Headers &headers,
  2910. const std::string &key, size_t def,
  2911. size_t id) {
  2912. auto dummy = false;
  2913. return get_header_value_u64(headers, key, def, id, dummy);
  2914. }
  2915. } // namespace detail
  2916. template <class Rep, class Period>
  2917. inline Server &
  2918. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2919. detail::duration_to_sec_and_usec(
  2920. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2921. return *this;
  2922. }
  2923. template <class Rep, class Period>
  2924. inline Server &
  2925. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2926. detail::duration_to_sec_and_usec(
  2927. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2928. return *this;
  2929. }
  2930. template <class Rep, class Period>
  2931. inline Server &
  2932. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2933. detail::duration_to_sec_and_usec(
  2934. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2935. return *this;
  2936. }
  2937. template <class Rep, class Period>
  2938. inline void ClientImpl::set_connection_timeout(
  2939. const std::chrono::duration<Rep, Period> &duration) {
  2940. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2941. set_connection_timeout(sec, usec);
  2942. });
  2943. }
  2944. template <class Rep, class Period>
  2945. inline void ClientImpl::set_read_timeout(
  2946. const std::chrono::duration<Rep, Period> &duration) {
  2947. detail::duration_to_sec_and_usec(
  2948. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2949. }
  2950. template <class Rep, class Period>
  2951. inline void ClientImpl::set_write_timeout(
  2952. const std::chrono::duration<Rep, Period> &duration) {
  2953. detail::duration_to_sec_and_usec(
  2954. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2955. }
  2956. template <class Rep, class Period>
  2957. inline void ClientImpl::set_max_timeout(
  2958. const std::chrono::duration<Rep, Period> &duration) {
  2959. auto msec =
  2960. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2961. set_max_timeout(msec);
  2962. }
  2963. template <class Rep, class Period>
  2964. inline void Client::set_connection_timeout(
  2965. const std::chrono::duration<Rep, Period> &duration) {
  2966. cli_->set_connection_timeout(duration);
  2967. }
  2968. template <class Rep, class Period>
  2969. inline void
  2970. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2971. cli_->set_read_timeout(duration);
  2972. }
  2973. template <class Rep, class Period>
  2974. inline void
  2975. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2976. cli_->set_write_timeout(duration);
  2977. }
  2978. inline void Client::set_max_timeout(time_t msec) {
  2979. cli_->set_max_timeout(msec);
  2980. }
  2981. template <class Rep, class Period>
  2982. inline void
  2983. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2984. cli_->set_max_timeout(duration);
  2985. }
  2986. /*
  2987. * Forward declarations and types that will be part of the .h file if split into
  2988. * .h + .cc.
  2989. */
  2990. std::string hosted_at(const std::string &hostname);
  2991. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2992. // JavaScript-style URL encoding/decoding functions
  2993. std::string encode_uri_component(const std::string &value);
  2994. std::string encode_uri(const std::string &value);
  2995. std::string decode_uri_component(const std::string &value);
  2996. std::string decode_uri(const std::string &value);
  2997. // RFC 3986 compliant URL component encoding/decoding functions
  2998. std::string encode_path_component(const std::string &component);
  2999. std::string decode_path_component(const std::string &component);
  3000. std::string encode_query_component(const std::string &component,
  3001. bool space_as_plus = true);
  3002. std::string decode_query_component(const std::string &component,
  3003. bool plus_as_space = true);
  3004. std::string sanitize_filename(const std::string &filename);
  3005. std::string append_query_params(const std::string &path, const Params &params);
  3006. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3007. std::pair<std::string, std::string>
  3008. make_basic_authentication_header(const std::string &username,
  3009. const std::string &password,
  3010. bool is_proxy = false);
  3011. namespace detail {
  3012. #if defined(_WIN32)
  3013. inline std::wstring u8string_to_wstring(const char *s) {
  3014. if (!s) { return std::wstring(); }
  3015. auto len = static_cast<int>(strlen(s));
  3016. if (!len) { return std::wstring(); }
  3017. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3018. if (!wlen) { return std::wstring(); }
  3019. std::wstring ws;
  3020. ws.resize(wlen);
  3021. wlen = ::MultiByteToWideChar(
  3022. CP_UTF8, 0, s, len,
  3023. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3024. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3025. return ws;
  3026. }
  3027. #endif
  3028. struct FileStat {
  3029. FileStat(const std::string &path);
  3030. bool is_file() const;
  3031. bool is_dir() const;
  3032. time_t mtime() const;
  3033. size_t size() const;
  3034. private:
  3035. #if defined(_WIN32)
  3036. struct _stat st_;
  3037. #else
  3038. struct stat st_;
  3039. #endif
  3040. int ret_ = -1;
  3041. };
  3042. std::string make_host_and_port_string(const std::string &host, int port,
  3043. bool is_ssl);
  3044. template <typename T>
  3045. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3046. Error &error);
  3047. std::string trim_copy(const std::string &s);
  3048. void divide(
  3049. const char *data, std::size_t size, char d,
  3050. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3051. fn);
  3052. void divide(
  3053. const std::string &str, char d,
  3054. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3055. fn);
  3056. void split(const char *b, const char *e, char d,
  3057. std::function<void(const char *, const char *)> fn);
  3058. void split(const char *b, const char *e, char d, size_t m,
  3059. std::function<void(const char *, const char *)> fn);
  3060. bool split_find(const char *b, const char *e, char d,
  3061. std::function<bool(const char *, const char *)> fn);
  3062. bool has_header_token(const Headers &headers, const std::string &key,
  3063. const std::string &token);
  3064. std::string websocket_accept_key(const std::string &client_key);
  3065. bool is_websocket_upgrade(const Request &req);
  3066. bool process_client_socket(
  3067. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3068. time_t write_timeout_sec, time_t write_timeout_usec,
  3069. time_t max_timeout_msec,
  3070. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3071. std::function<bool(Stream &)> callback);
  3072. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3073. int port, int address_family, bool tcp_nodelay,
  3074. bool ipv6_v6only, SocketOptions socket_options,
  3075. time_t connection_timeout_sec,
  3076. time_t connection_timeout_usec,
  3077. time_t read_timeout_sec, time_t read_timeout_usec,
  3078. time_t write_timeout_sec,
  3079. time_t write_timeout_usec,
  3080. const std::string &intf, Error &error);
  3081. const char *get_header_value(const Headers &headers, const std::string &key,
  3082. const char *def, size_t id);
  3083. std::string get_combined_header_value(const Headers &headers,
  3084. const std::string &key);
  3085. std::string params_to_query_str(const Params &params);
  3086. void parse_query_text(const char *data, std::size_t size, Params &params);
  3087. void parse_query_text(const std::string &s, Params &params);
  3088. bool parse_multipart_boundary(const std::string &content_type,
  3089. std::string &boundary);
  3090. bool parse_range_header(const std::string &s, Ranges &ranges);
  3091. bool parse_accept_header(const std::string &s,
  3092. std::vector<std::string> &content_types);
  3093. void parse_disposition_params(const std::string &s, Params &params);
  3094. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3095. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3096. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3097. EncodingType encoding_type(const Request &req, const Response &res,
  3098. const std::string &content_type);
  3099. EncodingType encoding_type(const Request &req, const Response &res);
  3100. class BufferStream final : public Stream {
  3101. public:
  3102. BufferStream() = default;
  3103. ~BufferStream() override = default;
  3104. bool is_readable() const override;
  3105. bool wait_readable() const override;
  3106. bool wait_writable() const override;
  3107. ssize_t read(char *ptr, size_t size) override;
  3108. ssize_t write(const char *ptr, size_t size) override;
  3109. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3110. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3111. socket_t socket() const override;
  3112. time_t duration() const override;
  3113. const std::string &get_buffer() const;
  3114. private:
  3115. std::string buffer;
  3116. size_t position = 0;
  3117. };
  3118. class compressor {
  3119. public:
  3120. virtual ~compressor() = default;
  3121. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3122. virtual bool compress(const char *data, size_t data_length, bool last,
  3123. Callback callback) = 0;
  3124. };
  3125. class decompressor {
  3126. public:
  3127. virtual ~decompressor() = default;
  3128. virtual bool is_valid() const = 0;
  3129. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3130. virtual bool decompress(const char *data, size_t data_length,
  3131. Callback callback) = 0;
  3132. };
  3133. class nocompressor final : public compressor {
  3134. public:
  3135. ~nocompressor() override = default;
  3136. bool compress(const char *data, size_t data_length, bool /*last*/,
  3137. Callback callback) override;
  3138. };
  3139. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3140. class gzip_compressor final : public compressor {
  3141. public:
  3142. gzip_compressor();
  3143. ~gzip_compressor() override;
  3144. bool compress(const char *data, size_t data_length, bool last,
  3145. Callback callback) override;
  3146. private:
  3147. bool is_valid_ = false;
  3148. z_stream strm_;
  3149. };
  3150. class gzip_decompressor final : public decompressor {
  3151. public:
  3152. gzip_decompressor();
  3153. ~gzip_decompressor() override;
  3154. bool is_valid() const override;
  3155. bool decompress(const char *data, size_t data_length,
  3156. Callback callback) override;
  3157. private:
  3158. bool is_valid_ = false;
  3159. z_stream strm_;
  3160. };
  3161. #endif
  3162. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3163. class brotli_compressor final : public compressor {
  3164. public:
  3165. brotli_compressor();
  3166. ~brotli_compressor();
  3167. bool compress(const char *data, size_t data_length, bool last,
  3168. Callback callback) override;
  3169. private:
  3170. BrotliEncoderState *state_ = nullptr;
  3171. };
  3172. class brotli_decompressor final : public decompressor {
  3173. public:
  3174. brotli_decompressor();
  3175. ~brotli_decompressor();
  3176. bool is_valid() const override;
  3177. bool decompress(const char *data, size_t data_length,
  3178. Callback callback) override;
  3179. private:
  3180. BrotliDecoderResult decoder_r;
  3181. BrotliDecoderState *decoder_s = nullptr;
  3182. };
  3183. #endif
  3184. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3185. class zstd_compressor : public compressor {
  3186. public:
  3187. zstd_compressor();
  3188. ~zstd_compressor();
  3189. bool compress(const char *data, size_t data_length, bool last,
  3190. Callback callback) override;
  3191. private:
  3192. ZSTD_CCtx *ctx_ = nullptr;
  3193. };
  3194. class zstd_decompressor : public decompressor {
  3195. public:
  3196. zstd_decompressor();
  3197. ~zstd_decompressor();
  3198. bool is_valid() const override;
  3199. bool decompress(const char *data, size_t data_length,
  3200. Callback callback) override;
  3201. private:
  3202. ZSTD_DCtx *ctx_ = nullptr;
  3203. };
  3204. #endif
  3205. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3206. // to store data. The call can set memory on stack for performance.
  3207. class stream_line_reader {
  3208. public:
  3209. stream_line_reader(Stream &strm, char *fixed_buffer,
  3210. size_t fixed_buffer_size);
  3211. const char *ptr() const;
  3212. size_t size() const;
  3213. bool end_with_crlf() const;
  3214. bool getline();
  3215. private:
  3216. void append(char c);
  3217. void append(const char *data, size_t size);
  3218. Stream &strm_;
  3219. char *fixed_buffer_;
  3220. const size_t fixed_buffer_size_;
  3221. size_t fixed_buffer_used_size_ = 0;
  3222. std::string growable_buffer_;
  3223. };
  3224. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3225. const Headers &src_headers);
  3226. struct ChunkedDecoder {
  3227. Stream &strm;
  3228. size_t chunk_remaining = 0;
  3229. bool finished = false;
  3230. char line_buf[64];
  3231. size_t last_chunk_total = 0;
  3232. size_t last_chunk_offset = 0;
  3233. explicit ChunkedDecoder(Stream &s);
  3234. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3235. size_t &out_chunk_total);
  3236. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3237. };
  3238. class mmap {
  3239. public:
  3240. mmap(const char *path);
  3241. ~mmap();
  3242. bool open(const char *path);
  3243. void close();
  3244. bool is_open() const;
  3245. size_t size() const;
  3246. const char *data() const;
  3247. private:
  3248. #if defined(_WIN32)
  3249. HANDLE hFile_ = NULL;
  3250. HANDLE hMapping_ = NULL;
  3251. #else
  3252. int fd_ = -1;
  3253. #endif
  3254. size_t size_ = 0;
  3255. void *addr_ = nullptr;
  3256. bool is_open_empty_file = false;
  3257. };
  3258. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3259. namespace fields {
  3260. bool is_token_char(char c);
  3261. bool is_token(const std::string &s);
  3262. bool is_field_name(const std::string &s);
  3263. bool is_vchar(char c);
  3264. bool is_obs_text(char c);
  3265. bool is_field_vchar(char c);
  3266. bool is_field_content(const std::string &s);
  3267. bool is_field_value(const std::string &s);
  3268. bool is_field_valid(const std::string &name, const std::string &value);
  3269. bool is_request_target(const std::string &s);
  3270. bool is_host(const std::string &s);
  3271. } // namespace fields
  3272. } // namespace detail
  3273. /*
  3274. * TLS Abstraction Layer Declarations
  3275. */
  3276. #ifdef CPPHTTPLIB_SSL_ENABLED
  3277. // TLS abstraction layer - backend-specific type declarations
  3278. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3279. namespace tls {
  3280. namespace impl {
  3281. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3282. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3283. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3284. struct MbedTlsContext {
  3285. mbedtls_ssl_config conf;
  3286. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3287. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3288. mbedtls_entropy_context entropy;
  3289. mbedtls_ctr_drbg_context ctr_drbg;
  3290. #endif
  3291. mbedtls_x509_crt ca_chain;
  3292. mbedtls_x509_crt own_cert;
  3293. mbedtls_pk_context own_key;
  3294. bool is_server = false;
  3295. bool verify_client = false;
  3296. VerifyCallback verify_callback;
  3297. MbedTlsContext();
  3298. ~MbedTlsContext();
  3299. MbedTlsContext(const MbedTlsContext &) = delete;
  3300. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3301. };
  3302. } // namespace impl
  3303. } // namespace tls
  3304. #endif
  3305. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3306. namespace tls {
  3307. namespace impl {
  3308. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3309. // This struct is accessible via tls::impl for use in SSL context
  3310. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3311. struct WolfSSLContext {
  3312. WOLFSSL_CTX *ctx = nullptr;
  3313. bool is_server = false;
  3314. bool verify_client = false;
  3315. VerifyCallback verify_callback;
  3316. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3317. WolfSSLContext();
  3318. ~WolfSSLContext();
  3319. WolfSSLContext(const WolfSSLContext &) = delete;
  3320. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3321. };
  3322. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3323. struct WolfSSLCAStore {
  3324. std::string pem_data;
  3325. };
  3326. } // namespace impl
  3327. } // namespace tls
  3328. #endif
  3329. #endif // CPPHTTPLIB_SSL_ENABLED
  3330. namespace stream {
  3331. class Result {
  3332. public:
  3333. Result();
  3334. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3335. Result(Result &&other) noexcept;
  3336. Result &operator=(Result &&other) noexcept;
  3337. Result(const Result &) = delete;
  3338. Result &operator=(const Result &) = delete;
  3339. // Response info
  3340. bool is_valid() const;
  3341. explicit operator bool() const;
  3342. int status() const;
  3343. const Headers &headers() const;
  3344. std::string get_header_value(const std::string &key,
  3345. const char *def = "") const;
  3346. bool has_header(const std::string &key) const;
  3347. Error error() const;
  3348. Error read_error() const;
  3349. bool has_read_error() const;
  3350. // Stream reading
  3351. bool next();
  3352. const char *data() const;
  3353. size_t size() const;
  3354. std::string read_all();
  3355. private:
  3356. ClientImpl::StreamHandle handle_;
  3357. std::string buffer_;
  3358. size_t current_size_ = 0;
  3359. size_t chunk_size_;
  3360. bool finished_ = false;
  3361. };
  3362. // GET
  3363. template <typename ClientType>
  3364. inline Result Get(ClientType &cli, const std::string &path,
  3365. size_t chunk_size = 8192) {
  3366. return Result{cli.open_stream("GET", path), chunk_size};
  3367. }
  3368. template <typename ClientType>
  3369. inline Result Get(ClientType &cli, const std::string &path,
  3370. const Headers &headers, size_t chunk_size = 8192) {
  3371. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3372. }
  3373. template <typename ClientType>
  3374. inline Result Get(ClientType &cli, const std::string &path,
  3375. const Params &params, size_t chunk_size = 8192) {
  3376. return Result{cli.open_stream("GET", path, params), chunk_size};
  3377. }
  3378. template <typename ClientType>
  3379. inline Result Get(ClientType &cli, const std::string &path,
  3380. const Params &params, const Headers &headers,
  3381. size_t chunk_size = 8192) {
  3382. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3383. }
  3384. // POST
  3385. template <typename ClientType>
  3386. inline Result Post(ClientType &cli, const std::string &path,
  3387. const std::string &body, const std::string &content_type,
  3388. size_t chunk_size = 8192) {
  3389. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3390. chunk_size};
  3391. }
  3392. template <typename ClientType>
  3393. inline Result Post(ClientType &cli, const std::string &path,
  3394. const Headers &headers, const std::string &body,
  3395. const std::string &content_type, size_t chunk_size = 8192) {
  3396. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3397. chunk_size};
  3398. }
  3399. template <typename ClientType>
  3400. inline Result Post(ClientType &cli, const std::string &path,
  3401. const Params &params, const std::string &body,
  3402. const std::string &content_type, size_t chunk_size = 8192) {
  3403. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3404. chunk_size};
  3405. }
  3406. template <typename ClientType>
  3407. inline Result Post(ClientType &cli, const std::string &path,
  3408. const Params &params, const Headers &headers,
  3409. const std::string &body, const std::string &content_type,
  3410. size_t chunk_size = 8192) {
  3411. return Result{
  3412. cli.open_stream("POST", path, params, headers, body, content_type),
  3413. chunk_size};
  3414. }
  3415. // PUT
  3416. template <typename ClientType>
  3417. inline Result Put(ClientType &cli, const std::string &path,
  3418. const std::string &body, const std::string &content_type,
  3419. size_t chunk_size = 8192) {
  3420. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3421. chunk_size};
  3422. }
  3423. template <typename ClientType>
  3424. inline Result Put(ClientType &cli, const std::string &path,
  3425. const Headers &headers, const std::string &body,
  3426. const std::string &content_type, size_t chunk_size = 8192) {
  3427. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3428. chunk_size};
  3429. }
  3430. template <typename ClientType>
  3431. inline Result Put(ClientType &cli, const std::string &path,
  3432. const Params &params, const std::string &body,
  3433. const std::string &content_type, size_t chunk_size = 8192) {
  3434. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3435. chunk_size};
  3436. }
  3437. template <typename ClientType>
  3438. inline Result Put(ClientType &cli, const std::string &path,
  3439. const Params &params, const Headers &headers,
  3440. const std::string &body, const std::string &content_type,
  3441. size_t chunk_size = 8192) {
  3442. return Result{
  3443. cli.open_stream("PUT", path, params, headers, body, content_type),
  3444. chunk_size};
  3445. }
  3446. // PATCH
  3447. template <typename ClientType>
  3448. inline Result Patch(ClientType &cli, const std::string &path,
  3449. const std::string &body, const std::string &content_type,
  3450. size_t chunk_size = 8192) {
  3451. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3452. chunk_size};
  3453. }
  3454. template <typename ClientType>
  3455. inline Result Patch(ClientType &cli, const std::string &path,
  3456. const Headers &headers, const std::string &body,
  3457. const std::string &content_type, size_t chunk_size = 8192) {
  3458. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3459. chunk_size};
  3460. }
  3461. template <typename ClientType>
  3462. inline Result Patch(ClientType &cli, const std::string &path,
  3463. const Params &params, const std::string &body,
  3464. const std::string &content_type, size_t chunk_size = 8192) {
  3465. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3466. chunk_size};
  3467. }
  3468. template <typename ClientType>
  3469. inline Result Patch(ClientType &cli, const std::string &path,
  3470. const Params &params, const Headers &headers,
  3471. const std::string &body, const std::string &content_type,
  3472. size_t chunk_size = 8192) {
  3473. return Result{
  3474. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3475. chunk_size};
  3476. }
  3477. // DELETE
  3478. template <typename ClientType>
  3479. inline Result Delete(ClientType &cli, const std::string &path,
  3480. size_t chunk_size = 8192) {
  3481. return Result{cli.open_stream("DELETE", path), chunk_size};
  3482. }
  3483. template <typename ClientType>
  3484. inline Result Delete(ClientType &cli, const std::string &path,
  3485. const Headers &headers, size_t chunk_size = 8192) {
  3486. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3487. }
  3488. template <typename ClientType>
  3489. inline Result Delete(ClientType &cli, const std::string &path,
  3490. const std::string &body, const std::string &content_type,
  3491. size_t chunk_size = 8192) {
  3492. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3493. chunk_size};
  3494. }
  3495. template <typename ClientType>
  3496. inline Result Delete(ClientType &cli, const std::string &path,
  3497. const Headers &headers, const std::string &body,
  3498. const std::string &content_type,
  3499. size_t chunk_size = 8192) {
  3500. return Result{
  3501. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3502. chunk_size};
  3503. }
  3504. template <typename ClientType>
  3505. inline Result Delete(ClientType &cli, const std::string &path,
  3506. const Params &params, size_t chunk_size = 8192) {
  3507. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3508. }
  3509. template <typename ClientType>
  3510. inline Result Delete(ClientType &cli, const std::string &path,
  3511. const Params &params, const Headers &headers,
  3512. size_t chunk_size = 8192) {
  3513. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3514. }
  3515. template <typename ClientType>
  3516. inline Result Delete(ClientType &cli, const std::string &path,
  3517. const Params &params, const std::string &body,
  3518. const std::string &content_type,
  3519. size_t chunk_size = 8192) {
  3520. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3521. chunk_size};
  3522. }
  3523. template <typename ClientType>
  3524. inline Result Delete(ClientType &cli, const std::string &path,
  3525. const Params &params, const Headers &headers,
  3526. const std::string &body, const std::string &content_type,
  3527. size_t chunk_size = 8192) {
  3528. return Result{
  3529. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3530. chunk_size};
  3531. }
  3532. // HEAD
  3533. template <typename ClientType>
  3534. inline Result Head(ClientType &cli, const std::string &path,
  3535. size_t chunk_size = 8192) {
  3536. return Result{cli.open_stream("HEAD", path), chunk_size};
  3537. }
  3538. template <typename ClientType>
  3539. inline Result Head(ClientType &cli, const std::string &path,
  3540. const Headers &headers, size_t chunk_size = 8192) {
  3541. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3542. }
  3543. template <typename ClientType>
  3544. inline Result Head(ClientType &cli, const std::string &path,
  3545. const Params &params, size_t chunk_size = 8192) {
  3546. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3547. }
  3548. template <typename ClientType>
  3549. inline Result Head(ClientType &cli, const std::string &path,
  3550. const Params &params, const Headers &headers,
  3551. size_t chunk_size = 8192) {
  3552. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3553. }
  3554. // OPTIONS
  3555. template <typename ClientType>
  3556. inline Result Options(ClientType &cli, const std::string &path,
  3557. size_t chunk_size = 8192) {
  3558. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3559. }
  3560. template <typename ClientType>
  3561. inline Result Options(ClientType &cli, const std::string &path,
  3562. const Headers &headers, size_t chunk_size = 8192) {
  3563. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3564. }
  3565. template <typename ClientType>
  3566. inline Result Options(ClientType &cli, const std::string &path,
  3567. const Params &params, size_t chunk_size = 8192) {
  3568. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3569. }
  3570. template <typename ClientType>
  3571. inline Result Options(ClientType &cli, const std::string &path,
  3572. const Params &params, const Headers &headers,
  3573. size_t chunk_size = 8192) {
  3574. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3575. }
  3576. } // namespace stream
  3577. namespace sse {
  3578. struct SSEMessage {
  3579. std::string event; // Event type (default: "message")
  3580. std::string data; // Event payload
  3581. std::string id; // Event ID for Last-Event-ID header
  3582. SSEMessage();
  3583. void clear();
  3584. };
  3585. class SSEClient {
  3586. public:
  3587. using MessageHandler = std::function<void(const SSEMessage &)>;
  3588. using ErrorHandler = std::function<void(Error)>;
  3589. using OpenHandler = std::function<void()>;
  3590. SSEClient(Client &client, const std::string &path);
  3591. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3592. ~SSEClient();
  3593. SSEClient(const SSEClient &) = delete;
  3594. SSEClient &operator=(const SSEClient &) = delete;
  3595. // Event handlers
  3596. SSEClient &on_message(MessageHandler handler);
  3597. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3598. SSEClient &on_open(OpenHandler handler);
  3599. SSEClient &on_error(ErrorHandler handler);
  3600. SSEClient &set_reconnect_interval(int ms);
  3601. SSEClient &set_max_reconnect_attempts(int n);
  3602. // Update headers (thread-safe)
  3603. SSEClient &set_headers(const Headers &headers);
  3604. // State accessors
  3605. bool is_connected() const;
  3606. const std::string &last_event_id() const;
  3607. // Blocking start - runs event loop with auto-reconnect
  3608. void start();
  3609. // Non-blocking start - runs in background thread
  3610. void start_async();
  3611. // Stop the client (thread-safe)
  3612. void stop();
  3613. private:
  3614. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3615. bool &has_data, bool &has_id);
  3616. void run_event_loop();
  3617. void dispatch_event(const SSEMessage &msg);
  3618. bool should_reconnect(int count) const;
  3619. void wait_for_reconnect();
  3620. // Client and path
  3621. Client &client_;
  3622. std::string path_;
  3623. Headers headers_;
  3624. mutable std::mutex headers_mutex_;
  3625. // Callbacks
  3626. MessageHandler on_message_;
  3627. std::map<std::string, MessageHandler> event_handlers_;
  3628. OpenHandler on_open_;
  3629. ErrorHandler on_error_;
  3630. // Configuration
  3631. int reconnect_interval_ms_ = 3000;
  3632. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3633. // State
  3634. std::atomic<bool> running_{false};
  3635. std::atomic<bool> connected_{false};
  3636. std::string last_event_id_;
  3637. // Async support
  3638. std::thread async_thread_;
  3639. };
  3640. } // namespace sse
  3641. namespace ws {
  3642. class WebSocketClient;
  3643. enum class Opcode : uint8_t {
  3644. Continuation = 0x0,
  3645. Text = 0x1,
  3646. Binary = 0x2,
  3647. Close = 0x8,
  3648. Ping = 0x9,
  3649. Pong = 0xA,
  3650. };
  3651. enum class CloseStatus : uint16_t {
  3652. Normal = 1000,
  3653. GoingAway = 1001,
  3654. ProtocolError = 1002,
  3655. UnsupportedData = 1003,
  3656. NoStatus = 1005,
  3657. Abnormal = 1006,
  3658. InvalidPayload = 1007,
  3659. PolicyViolation = 1008,
  3660. MessageTooBig = 1009,
  3661. MandatoryExtension = 1010,
  3662. InternalError = 1011,
  3663. };
  3664. // Timeout is returned only when a read timeout was set and it elapsed before
  3665. // any byte of a frame arrived: nothing was consumed and the connection is
  3666. // still open, so the caller can send on it and read again. `msg` is left
  3667. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3668. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3669. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3670. // upgrade handshake fully succeeded. On failure error() identifies the
  3671. // failing layer; status()/headers() expose the server's upgrade response
  3672. // when one was received (status() is -1 otherwise).
  3673. class Result {
  3674. public:
  3675. Result() = default;
  3676. Result(Error err, int status, Headers &&headers)
  3677. : err_(err), status_(status), headers_(std::move(headers)) {}
  3678. explicit operator bool() const { return err_ == Error::Success; }
  3679. Error error() const { return err_; }
  3680. // Upgrade response info
  3681. int status() const { return status_; }
  3682. const Headers &headers() const { return headers_; }
  3683. std::string get_header_value(const std::string &key,
  3684. const char *def = "") const {
  3685. return detail::get_header_value(headers_, key, def, 0);
  3686. }
  3687. bool has_header(const std::string &key) const {
  3688. return headers_.find(key) != headers_.end();
  3689. }
  3690. #ifdef CPPHTTPLIB_SSL_ENABLED
  3691. Result(Error err, int status, Headers &&headers, int ssl_error,
  3692. uint64_t ssl_backend_error)
  3693. : err_(err), status_(status), headers_(std::move(headers)),
  3694. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3695. int ssl_error() const { return ssl_error_; }
  3696. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3697. #endif
  3698. private:
  3699. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3700. int status_ = -1;
  3701. Headers headers_;
  3702. #ifdef CPPHTTPLIB_SSL_ENABLED
  3703. int ssl_error_ = 0;
  3704. uint64_t ssl_backend_error_ = 0;
  3705. #endif
  3706. };
  3707. class WebSocket {
  3708. public:
  3709. WebSocket(const WebSocket &) = delete;
  3710. WebSocket &operator=(const WebSocket &) = delete;
  3711. ~WebSocket();
  3712. ReadResult read(std::string &msg);
  3713. bool send(const std::string &data);
  3714. bool send(const char *data, size_t len);
  3715. void close(CloseStatus status = CloseStatus::Normal,
  3716. const std::string &reason = "");
  3717. const Request &request() const;
  3718. bool is_open() const;
  3719. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3720. // A server handler owns its connection's timeout this way; a client sets it
  3721. // through WebSocketClient. Safe to call while another thread is in read().
  3722. //
  3723. // Only a timeout set here is reported as Timeout. The compile-time default
  3724. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3725. // than a request for control, so when it elapses read() returns Fail and
  3726. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3727. void set_read_timeout(time_t sec, time_t usec = 0);
  3728. template <class Rep, class Period>
  3729. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3730. private:
  3731. friend class httplib::Server;
  3732. friend class httplib::ws::WebSocketClient;
  3733. WebSocket(
  3734. Stream &strm, const Request &req, bool is_server,
  3735. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3736. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3737. : strm_(strm), req_(req), is_server_(is_server),
  3738. ping_interval_sec_(ping_interval_sec),
  3739. max_missed_pongs_(max_missed_pongs) {
  3740. start_heartbeat();
  3741. }
  3742. WebSocket(
  3743. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3744. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3745. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3746. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3747. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3748. max_missed_pongs_(max_missed_pongs) {
  3749. start_heartbeat();
  3750. }
  3751. void start_heartbeat();
  3752. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3753. Stream &strm_;
  3754. std::unique_ptr<Stream> owned_strm_;
  3755. Request req_;
  3756. bool is_server_;
  3757. time_t ping_interval_sec_;
  3758. int max_missed_pongs_;
  3759. int unacked_pings_ = 0;
  3760. std::atomic<bool> closed_{false};
  3761. // Set once the caller has bounded read() through set_read_timeout(). Until
  3762. // then the timeout in effect is the compile-time default, and elapsing it
  3763. // is a failure that closes the connection, not a Timeout.
  3764. std::atomic<bool> read_timeout_set_{false};
  3765. std::mutex write_mutex_;
  3766. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3767. // may do so: read_websocket_frame() reads a payload until it has the whole
  3768. // declared length, so a second parser stealing bytes silently corrupts the
  3769. // message the first one is assembling.
  3770. std::mutex read_mutex_;
  3771. std::thread ping_thread_;
  3772. std::mutex ping_mutex_;
  3773. std::condition_variable ping_cv_;
  3774. };
  3775. class WebSocketClient {
  3776. public:
  3777. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3778. const Headers &headers = {});
  3779. ~WebSocketClient();
  3780. WebSocketClient(const WebSocketClient &) = delete;
  3781. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3782. bool is_valid() const;
  3783. Result connect();
  3784. ReadResult read(std::string &msg);
  3785. bool send(const std::string &data);
  3786. bool send(const char *data, size_t len);
  3787. void close(CloseStatus status = CloseStatus::Normal,
  3788. const std::string &reason = "");
  3789. bool is_open() const;
  3790. const std::string &subprotocol() const;
  3791. void set_read_timeout(time_t sec, time_t usec = 0);
  3792. template <class Rep, class Period>
  3793. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3794. void set_write_timeout(time_t sec, time_t usec = 0);
  3795. template <class Rep, class Period>
  3796. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3797. void set_websocket_ping_interval(time_t sec);
  3798. void set_websocket_max_missed_pongs(int count);
  3799. void set_tcp_nodelay(bool on);
  3800. void set_address_family(int family);
  3801. void set_ipv6_v6only(bool on);
  3802. void set_socket_options(SocketOptions socket_options);
  3803. void set_connection_timeout(time_t sec, time_t usec = 0);
  3804. template <class Rep, class Period>
  3805. void
  3806. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3807. void set_interface(const std::string &intf);
  3808. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3809. #ifdef CPPHTTPLIB_SSL_ENABLED
  3810. struct PemMemory {
  3811. const char *cert_pem;
  3812. size_t cert_pem_len;
  3813. const char *key_pem;
  3814. size_t key_pem_len;
  3815. const char *private_key_password;
  3816. };
  3817. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3818. const PemMemory &pem, const Headers &headers = {});
  3819. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3820. const std::string &ca_cert_dir_path = std::string());
  3821. void set_ca_cert_store(tls::ca_store_t store);
  3822. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3823. void enable_server_certificate_verification(bool enabled);
  3824. void enable_server_hostname_verification(bool enabled);
  3825. void enable_system_ca(bool enabled);
  3826. #endif
  3827. private:
  3828. void shutdown_and_close();
  3829. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3830. int &ssl_error, uint64_t &ssl_backend_error);
  3831. void prepare_default_headers(Request &req);
  3832. std::string host_;
  3833. int port_;
  3834. std::string path_;
  3835. Headers headers_;
  3836. std::string subprotocol_;
  3837. bool is_valid_ = false;
  3838. socket_t sock_ = INVALID_SOCKET;
  3839. std::unique_ptr<WebSocket> ws_;
  3840. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3841. time_t read_timeout_usec_ = 0;
  3842. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3843. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3844. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3845. time_t websocket_ping_interval_sec_ =
  3846. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3847. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3848. int address_family_ = AF_UNSPEC;
  3849. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3850. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3851. SocketOptions socket_options_ = nullptr;
  3852. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3853. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3854. std::string interface_;
  3855. // Hostname to connection target map. The value is an IP literal or another
  3856. // hostname; only the connection target changes, never the identity.
  3857. std::map<std::string, std::string> addr_map_;
  3858. #ifdef CPPHTTPLIB_SSL_ENABLED
  3859. bool is_ssl_ = false;
  3860. tls::ctx_t tls_ctx_ = nullptr;
  3861. tls::session_t tls_session_ = nullptr;
  3862. std::string ca_cert_file_path_;
  3863. std::string ca_cert_dir_path_;
  3864. bool custom_ca_loaded_ = false;
  3865. bool certs_loaded_ = false;
  3866. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3867. bool server_certificate_verification_ = true;
  3868. bool server_hostname_verification_ = true;
  3869. #endif
  3870. };
  3871. template <class Rep, class Period>
  3872. inline void WebSocket::set_read_timeout(
  3873. const std::chrono::duration<Rep, Period> &duration) {
  3874. detail::duration_to_sec_and_usec(
  3875. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3876. }
  3877. template <class Rep, class Period>
  3878. inline void WebSocketClient::set_read_timeout(
  3879. const std::chrono::duration<Rep, Period> &duration) {
  3880. detail::duration_to_sec_and_usec(
  3881. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3882. }
  3883. template <class Rep, class Period>
  3884. inline void WebSocketClient::set_write_timeout(
  3885. const std::chrono::duration<Rep, Period> &duration) {
  3886. detail::duration_to_sec_and_usec(
  3887. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3888. }
  3889. template <class Rep, class Period>
  3890. inline void WebSocketClient::set_connection_timeout(
  3891. const std::chrono::duration<Rep, Period> &duration) {
  3892. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3893. set_connection_timeout(sec, usec);
  3894. });
  3895. }
  3896. namespace impl {
  3897. bool is_valid_utf8(const std::string &s);
  3898. // Three states, because a failure that consumed bytes and one that consumed
  3899. // none are not the same thing: the first has left the stream in the middle of
  3900. // a frame and the connection cannot be reused, the second can just be retried.
  3901. enum class FrameRead { Ok, Fail, Timeout };
  3902. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3903. std::string &payload, bool &fin,
  3904. bool expect_masked, size_t max_len);
  3905. } // namespace impl
  3906. } // namespace ws
  3907. // ----------------------------------------------------------------------------
  3908. /*
  3909. * Implementation that will be part of the .cc file if split into .h + .cc.
  3910. */
  3911. namespace stream {
  3912. // stream::Result implementations
  3913. inline Result::Result() : chunk_size_(8192) {}
  3914. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3915. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3916. inline Result::Result(Result &&other) noexcept
  3917. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3918. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3919. finished_(other.finished_) {
  3920. other.current_size_ = 0;
  3921. other.finished_ = true;
  3922. }
  3923. inline Result &Result::operator=(Result &&other) noexcept {
  3924. if (this != &other) {
  3925. handle_ = std::move(other.handle_);
  3926. buffer_ = std::move(other.buffer_);
  3927. current_size_ = other.current_size_;
  3928. chunk_size_ = other.chunk_size_;
  3929. finished_ = other.finished_;
  3930. other.current_size_ = 0;
  3931. other.finished_ = true;
  3932. }
  3933. return *this;
  3934. }
  3935. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3936. inline Result::operator bool() const { return is_valid(); }
  3937. inline int Result::status() const {
  3938. return handle_.response ? handle_.response->status : -1;
  3939. }
  3940. inline const Headers &Result::headers() const {
  3941. static const Headers empty_headers;
  3942. return handle_.response ? handle_.response->headers : empty_headers;
  3943. }
  3944. inline std::string Result::get_header_value(const std::string &key,
  3945. const char *def) const {
  3946. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3947. }
  3948. inline bool Result::has_header(const std::string &key) const {
  3949. return handle_.response ? handle_.response->has_header(key) : false;
  3950. }
  3951. inline Error Result::error() const { return handle_.error; }
  3952. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3953. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3954. inline bool Result::next() {
  3955. if (!handle_.is_valid() || finished_) { return false; }
  3956. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3957. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3958. if (n > 0) {
  3959. current_size_ = static_cast<size_t>(n);
  3960. return true;
  3961. }
  3962. current_size_ = 0;
  3963. finished_ = true;
  3964. return false;
  3965. }
  3966. inline const char *Result::data() const { return buffer_.data(); }
  3967. inline size_t Result::size() const { return current_size_; }
  3968. inline std::string Result::read_all() {
  3969. std::string result;
  3970. while (next()) {
  3971. result.append(data(), size());
  3972. }
  3973. return result;
  3974. }
  3975. } // namespace stream
  3976. namespace sse {
  3977. // SSEMessage implementations
  3978. inline SSEMessage::SSEMessage() : event("message") {}
  3979. inline void SSEMessage::clear() {
  3980. event = "message";
  3981. data.clear();
  3982. id.clear();
  3983. }
  3984. // SSEClient implementations
  3985. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3986. : client_(client), path_(path) {}
  3987. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3988. const Headers &headers)
  3989. : client_(client), path_(path), headers_(headers) {}
  3990. inline SSEClient::~SSEClient() { stop(); }
  3991. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3992. on_message_ = std::move(handler);
  3993. return *this;
  3994. }
  3995. inline SSEClient &SSEClient::on_event(const std::string &type,
  3996. MessageHandler handler) {
  3997. event_handlers_[type] = std::move(handler);
  3998. return *this;
  3999. }
  4000. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4001. on_open_ = std::move(handler);
  4002. return *this;
  4003. }
  4004. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4005. on_error_ = std::move(handler);
  4006. return *this;
  4007. }
  4008. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4009. reconnect_interval_ms_ = ms;
  4010. return *this;
  4011. }
  4012. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4013. max_reconnect_attempts_ = n;
  4014. return *this;
  4015. }
  4016. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4017. std::lock_guard<std::mutex> lock(headers_mutex_);
  4018. headers_ = headers;
  4019. return *this;
  4020. }
  4021. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4022. inline const std::string &SSEClient::last_event_id() const {
  4023. return last_event_id_;
  4024. }
  4025. inline void SSEClient::start() {
  4026. running_.store(true);
  4027. run_event_loop();
  4028. }
  4029. inline void SSEClient::start_async() {
  4030. running_.store(true);
  4031. async_thread_ = std::thread([this]() { run_event_loop(); });
  4032. }
  4033. inline void SSEClient::stop() {
  4034. running_.store(false);
  4035. client_.stop(); // Cancel any pending operations
  4036. if (async_thread_.joinable()) { async_thread_.join(); }
  4037. }
  4038. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4039. int &retry_ms, bool &has_data,
  4040. bool &has_id) {
  4041. // Blank line signals end of event
  4042. if (line.empty()) { return true; }
  4043. // Lines starting with ':' are comments (ignored)
  4044. if (line[0] == ':') { return false; }
  4045. // Find the colon separator
  4046. auto colon_pos = line.find(':');
  4047. auto field = line.substr(0, colon_pos);
  4048. std::string value;
  4049. // Value starts after colon, skip optional single space
  4050. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4051. auto value_start = colon_pos + 1;
  4052. if (line[value_start] == ' ') { value_start++; }
  4053. value = line.substr(value_start);
  4054. }
  4055. // Handle known fields
  4056. if (field == "event") {
  4057. msg.event = value;
  4058. } else if (field == "data") {
  4059. // Multiple data lines are concatenated with newlines
  4060. if (has_data) { msg.data += "\n"; }
  4061. msg.data += value;
  4062. has_data = true;
  4063. } else if (field == "id") {
  4064. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4065. // valid (clears the last event ID)
  4066. if (detail::fields::is_field_value(value)) {
  4067. msg.id = value;
  4068. has_id = true;
  4069. }
  4070. } else if (field == "retry") {
  4071. // Parse retry interval in milliseconds
  4072. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4073. if (detail::is_numeric(value)) {
  4074. int v = 0;
  4075. auto res =
  4076. detail::from_chars(value.data(), value.data() + value.size(), v);
  4077. if (res.ec == std::errc{}) { retry_ms = v; }
  4078. }
  4079. }
  4080. // Unknown fields are ignored per SSE spec
  4081. return false;
  4082. }
  4083. inline void SSEClient::run_event_loop() {
  4084. auto reconnect_count = 0;
  4085. while (running_.load()) {
  4086. // Build headers, including Last-Event-ID if we have one
  4087. Headers request_headers;
  4088. {
  4089. std::lock_guard<std::mutex> lock(headers_mutex_);
  4090. request_headers = headers_;
  4091. }
  4092. if (!last_event_id_.empty()) {
  4093. request_headers.emplace("Last-Event-ID", last_event_id_);
  4094. }
  4095. // Open streaming connection
  4096. auto result = stream::Get(client_, path_, request_headers);
  4097. // Connection error handling
  4098. if (!result) {
  4099. connected_.store(false);
  4100. if (on_error_) { on_error_(result.error()); }
  4101. if (!should_reconnect(reconnect_count)) { break; }
  4102. wait_for_reconnect();
  4103. reconnect_count++;
  4104. continue;
  4105. }
  4106. if (result.status() != StatusCode::OK_200) {
  4107. connected_.store(false);
  4108. if (on_error_) { on_error_(Error::Connection); }
  4109. // For certain errors, don't reconnect.
  4110. // Note: 401 is intentionally absent so that handlers can refresh
  4111. // credentials via set_headers() and let the client reconnect.
  4112. if (result.status() == StatusCode::NoContent_204 ||
  4113. result.status() == StatusCode::NotFound_404 ||
  4114. result.status() == StatusCode::Forbidden_403) {
  4115. break;
  4116. }
  4117. if (!should_reconnect(reconnect_count)) { break; }
  4118. wait_for_reconnect();
  4119. reconnect_count++;
  4120. continue;
  4121. }
  4122. // Connection successful
  4123. connected_.store(true);
  4124. reconnect_count = 0;
  4125. if (on_open_) { on_open_(); }
  4126. // Event receiving loop
  4127. std::string buffer;
  4128. SSEMessage current_msg;
  4129. auto has_data = false;
  4130. auto has_id = false;
  4131. auto first_line = true;
  4132. auto after_cr = false;
  4133. while (running_.load() && result.next()) {
  4134. // What is left in the buffer has no line ending
  4135. auto search_pos = buffer.size();
  4136. buffer.append(result.data(), result.size());
  4137. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4138. // per the SSE spec
  4139. size_t line_start = 0;
  4140. size_t eol_pos;
  4141. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4142. std::string::npos) {
  4143. auto line = buffer.substr(line_start, eol_pos - line_start);
  4144. line_start = eol_pos + 1;
  4145. search_pos = line_start;
  4146. // The \n of a \r\n may arrive in a later chunk than its \r
  4147. auto is_lf_of_crlf =
  4148. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4149. after_cr = buffer[eol_pos] == '\r';
  4150. if (is_lf_of_crlf) { continue; }
  4151. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4152. if (first_line) {
  4153. first_line = false;
  4154. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4155. }
  4156. // Parse the line and check if event is complete
  4157. auto event_complete = parse_sse_line(
  4158. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4159. if (event_complete) {
  4160. // Update last_event_id for reconnection, even for an event that
  4161. // has no data. An empty id clears it.
  4162. if (has_id) { last_event_id_ = current_msg.id; }
  4163. // An event without a data field is not dispatched
  4164. if (has_data) { dispatch_event(current_msg); }
  4165. // Reset the message for the next event either way
  4166. current_msg.clear();
  4167. has_data = false;
  4168. has_id = false;
  4169. }
  4170. }
  4171. // Keep unprocessed data in buffer
  4172. buffer.erase(0, line_start);
  4173. }
  4174. // Connection ended
  4175. connected_.store(false);
  4176. if (!running_.load()) { break; }
  4177. // Check for read errors
  4178. if (result.has_read_error()) {
  4179. if (on_error_) { on_error_(result.read_error()); }
  4180. }
  4181. if (!should_reconnect(reconnect_count)) { break; }
  4182. wait_for_reconnect();
  4183. reconnect_count++;
  4184. }
  4185. connected_.store(false);
  4186. }
  4187. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4188. // Check for specific event type handler first
  4189. auto it = event_handlers_.find(msg.event);
  4190. if (it != event_handlers_.end()) {
  4191. it->second(msg);
  4192. return;
  4193. }
  4194. // Fall back to generic message handler
  4195. if (on_message_) { on_message_(msg); }
  4196. }
  4197. inline bool SSEClient::should_reconnect(int count) const {
  4198. if (!running_.load()) { return false; }
  4199. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4200. return count < max_reconnect_attempts_;
  4201. }
  4202. inline void SSEClient::wait_for_reconnect() {
  4203. // Use small increments to check running_ flag frequently.
  4204. // Always wait at least one increment, so that a zero interval (e.g.
  4205. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4206. const auto step_ms = 100;
  4207. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4208. auto waited = 0;
  4209. while (running_.load() && waited < interval_ms) {
  4210. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4211. waited += step_ms;
  4212. }
  4213. }
  4214. } // namespace sse
  4215. #ifdef CPPHTTPLIB_SSL_ENABLED
  4216. /*
  4217. * TLS abstraction layer - internal function declarations
  4218. * These are implementation details and not part of the public API.
  4219. */
  4220. namespace tls {
  4221. // Client context
  4222. ctx_t create_client_context();
  4223. void free_context(ctx_t ctx);
  4224. bool set_min_version(ctx_t ctx, Version version);
  4225. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4226. bool load_ca_file(ctx_t ctx, const char *file_path);
  4227. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4228. bool load_system_certs(ctx_t ctx);
  4229. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4230. const char *password);
  4231. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4232. const char *key_path, const char *password);
  4233. // Server context
  4234. ctx_t create_server_context();
  4235. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4236. const char *password);
  4237. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4238. const char *key_path, const char *password);
  4239. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4240. void set_verify_client(ctx_t ctx, bool require);
  4241. // Session management
  4242. session_t create_session(ctx_t ctx, socket_t sock);
  4243. void free_session(session_t session);
  4244. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4245. // Handshake (non-blocking capable)
  4246. TlsError connect(session_t session);
  4247. TlsError accept(session_t session);
  4248. // Handshake with timeout (blocking until timeout)
  4249. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4250. time_t timeout_usec, TlsError *err);
  4251. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4252. time_t timeout_usec, TlsError *err);
  4253. // I/O (non-blocking capable)
  4254. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4255. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4256. int pending(const_session_t session);
  4257. void shutdown(session_t session, bool graceful);
  4258. // Connection state
  4259. bool is_peer_closed(session_t session, socket_t sock);
  4260. // Certificate verification
  4261. cert_t get_peer_cert(const_session_t session);
  4262. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4263. // do not use them after free_session(), as with get_peer_cert().
  4264. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4265. void free_cert(cert_t cert);
  4266. bool verify_hostname(cert_t cert, const char *hostname);
  4267. uint64_t hostname_mismatch_code();
  4268. long get_verify_result(const_session_t session);
  4269. // Certificate introspection
  4270. std::string get_cert_subject_cn(cert_t cert);
  4271. std::string get_cert_issuer_name(cert_t cert);
  4272. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4273. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4274. std::string get_cert_serial(cert_t cert);
  4275. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4276. const char *get_sni(const_session_t session);
  4277. // CA store management
  4278. ca_store_t create_ca_store(const char *pem, size_t len);
  4279. void free_ca_store(ca_store_t store);
  4280. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4281. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4282. std::vector<std::string> get_ca_names(ctx_t ctx);
  4283. // Dynamic certificate update (for servers)
  4284. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4285. const char *password);
  4286. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4287. // Certificate verification callback
  4288. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4289. long get_verify_error(const_session_t session);
  4290. std::string verify_error_string(long error_code);
  4291. // TlsError information
  4292. uint64_t peek_error();
  4293. uint64_t get_error();
  4294. std::string error_string(uint64_t code);
  4295. } // namespace tls
  4296. #endif // CPPHTTPLIB_SSL_ENABLED
  4297. /*
  4298. * Group 1: detail namespace - Non-SSL utilities
  4299. */
  4300. namespace detail {
  4301. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4302. const void *optval, socklen_t optlen) {
  4303. return setsockopt(sock, level, optname,
  4304. #ifdef _WIN32
  4305. reinterpret_cast<const char *>(optval),
  4306. #else
  4307. optval,
  4308. #endif
  4309. optlen) == 0;
  4310. }
  4311. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4312. time_t sec, time_t usec) {
  4313. #ifdef _WIN32
  4314. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4315. #else
  4316. timeval timeout;
  4317. timeout.tv_sec = static_cast<long>(sec);
  4318. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4319. #endif
  4320. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4321. }
  4322. inline bool is_hex(char c, int &v) {
  4323. if (is_ascii_digit(c)) {
  4324. v = c - '0';
  4325. return true;
  4326. } else if ('A' <= c && c <= 'F') {
  4327. v = c - 'A' + 10;
  4328. return true;
  4329. } else if ('a' <= c && c <= 'f') {
  4330. v = c - 'a' + 10;
  4331. return true;
  4332. }
  4333. return false;
  4334. }
  4335. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4336. int &val) {
  4337. if (i >= s.size()) { return false; }
  4338. val = 0;
  4339. for (; cnt; i++, cnt--) {
  4340. if (!s[i]) { return false; }
  4341. auto v = 0;
  4342. if (is_hex(s[i], v)) {
  4343. val = val * 16 + v;
  4344. } else {
  4345. return false;
  4346. }
  4347. }
  4348. return true;
  4349. }
  4350. inline std::string from_i_to_hex(size_t n) {
  4351. static const auto charset = "0123456789abcdef";
  4352. std::string ret;
  4353. do {
  4354. ret = charset[n & 15] + ret;
  4355. n >>= 4;
  4356. } while (n > 0);
  4357. return ret;
  4358. }
  4359. inline std::string compute_etag(const FileStat &fs,
  4360. const std::string &suffix = std::string()) {
  4361. if (!fs.is_file()) { return std::string(); }
  4362. // If mtime cannot be determined (negative value indicates an error
  4363. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4364. // value like 0 could collide with a real file that legitimately has
  4365. // mtime == 0 (epoch) and lead to misleading validators.
  4366. auto mtime_raw = fs.mtime();
  4367. if (mtime_raw < 0) { return std::string(); }
  4368. auto mtime = static_cast<size_t>(mtime_raw);
  4369. auto size = fs.size();
  4370. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4371. from_i_to_hex(size) + suffix + "\"";
  4372. }
  4373. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4374. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4375. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4376. inline std::string file_mtime_to_http_date(time_t mtime) {
  4377. if (mtime < 0) { return std::string(); }
  4378. struct tm tm_buf;
  4379. #ifdef _WIN32
  4380. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4381. #else
  4382. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4383. #endif
  4384. char buf[64];
  4385. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4386. return std::string();
  4387. }
  4388. return std::string(buf);
  4389. }
  4390. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4391. inline time_t parse_http_date(const std::string &date_str) {
  4392. struct tm tm_buf;
  4393. // Create a classic locale object once for all parsing attempts
  4394. const std::locale classic_locale = std::locale::classic();
  4395. // Try to parse using std::get_time (C++11, cross-platform)
  4396. auto try_parse = [&](const char *fmt) -> bool {
  4397. std::istringstream ss(date_str);
  4398. ss.imbue(classic_locale);
  4399. memset(&tm_buf, 0, sizeof(tm_buf));
  4400. ss >> std::get_time(&tm_buf, fmt);
  4401. return !ss.fail();
  4402. };
  4403. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4404. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4405. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4406. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4407. // asctime format: "Sun Nov 6 08:49:37 1994"
  4408. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4409. return static_cast<time_t>(-1);
  4410. }
  4411. }
  4412. }
  4413. #ifdef _WIN32
  4414. return _mkgmtime(&tm_buf);
  4415. #elif defined _AIX
  4416. return mktime(&tm_buf);
  4417. #else
  4418. return timegm(&tm_buf);
  4419. #endif
  4420. }
  4421. inline bool is_weak_etag(const std::string &s) {
  4422. // Check if the string is a weak ETag (starts with 'W/"')
  4423. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4424. }
  4425. inline bool is_strong_etag(const std::string &s) {
  4426. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4427. // chars)
  4428. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4429. }
  4430. inline size_t to_utf8(int code, char *buff) {
  4431. if (code < 0x0080) {
  4432. buff[0] = static_cast<char>(code & 0x7F);
  4433. return 1;
  4434. } else if (code < 0x0800) {
  4435. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4436. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4437. return 2;
  4438. } else if (code < 0xD800) {
  4439. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4440. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4441. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4442. return 3;
  4443. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4444. return 0;
  4445. } else if (code < 0x10000) {
  4446. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4447. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4448. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4449. return 3;
  4450. } else if (code < 0x110000) {
  4451. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4452. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4453. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4454. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4455. return 4;
  4456. }
  4457. // NOTREACHED
  4458. return 0;
  4459. }
  4460. } // namespace detail
  4461. namespace ws {
  4462. namespace impl {
  4463. inline bool is_valid_utf8(const std::string &s) {
  4464. size_t i = 0;
  4465. auto n = s.size();
  4466. while (i < n) {
  4467. auto c = static_cast<unsigned char>(s[i]);
  4468. size_t len;
  4469. uint32_t cp;
  4470. if (c < 0x80) {
  4471. i++;
  4472. continue;
  4473. } else if ((c & 0xE0) == 0xC0) {
  4474. len = 2;
  4475. cp = c & 0x1F;
  4476. } else if ((c & 0xF0) == 0xE0) {
  4477. len = 3;
  4478. cp = c & 0x0F;
  4479. } else if ((c & 0xF8) == 0xF0) {
  4480. len = 4;
  4481. cp = c & 0x07;
  4482. } else {
  4483. return false;
  4484. }
  4485. if (i + len > n) { return false; }
  4486. for (size_t j = 1; j < len; j++) {
  4487. auto b = static_cast<unsigned char>(s[i + j]);
  4488. if ((b & 0xC0) != 0x80) { return false; }
  4489. cp = (cp << 6) | (b & 0x3F);
  4490. }
  4491. // Overlong encoding check
  4492. if (len == 2 && cp < 0x80) { return false; }
  4493. if (len == 3 && cp < 0x800) { return false; }
  4494. if (len == 4 && cp < 0x10000) { return false; }
  4495. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4496. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4497. if (cp > 0x10FFFF) { return false; }
  4498. i += len;
  4499. }
  4500. return true;
  4501. }
  4502. } // namespace impl
  4503. } // namespace ws
  4504. namespace detail {
  4505. // NOTE: This code came up with the following stackoverflow post:
  4506. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4507. inline std::string base64_encode(const std::string &in) {
  4508. static const auto lookup =
  4509. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4510. std::string out;
  4511. out.reserve(in.size());
  4512. // Unsigned: the accumulator is never masked, so with a signed int the
  4513. // `val << 8` below overflows once enough bytes are folded in (undefined
  4514. // behaviour before C++20). Only the low bits are ever emitted, so the
  4515. // wrap-around of an unsigned accumulator does not affect the output.
  4516. uint32_t val = 0;
  4517. auto valb = -6;
  4518. for (auto c : in) {
  4519. val = (val << 8) + static_cast<uint8_t>(c);
  4520. valb += 8;
  4521. while (valb >= 0) {
  4522. out.push_back(lookup[(val >> valb) & 0x3F]);
  4523. valb -= 6;
  4524. }
  4525. }
  4526. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4527. while (out.size() % 4) {
  4528. out.push_back('=');
  4529. }
  4530. return out;
  4531. }
  4532. inline std::string sha1(const std::string &input) {
  4533. // RFC 3174 SHA-1 implementation
  4534. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4535. return (x << n) | (x >> (32 - n));
  4536. };
  4537. uint32_t h0 = 0x67452301;
  4538. uint32_t h1 = 0xEFCDAB89;
  4539. uint32_t h2 = 0x98BADCFE;
  4540. uint32_t h3 = 0x10325476;
  4541. uint32_t h4 = 0xC3D2E1F0;
  4542. // Pre-processing: adding padding bits
  4543. std::string msg = input;
  4544. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4545. msg.push_back(static_cast<char>(0x80u));
  4546. while (msg.size() % 64 != 56) {
  4547. msg.push_back(0);
  4548. }
  4549. // Append original length in bits as 64-bit big-endian
  4550. for (int i = 56; i >= 0; i -= 8) {
  4551. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4552. }
  4553. // Process each 512-bit chunk
  4554. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4555. uint32_t w[80];
  4556. for (size_t i = 0; i < 16; i++) {
  4557. w[i] =
  4558. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4559. << 24) |
  4560. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4561. << 16) |
  4562. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4563. << 8) |
  4564. (static_cast<uint32_t>(
  4565. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4566. }
  4567. for (int i = 16; i < 80; i++) {
  4568. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4569. }
  4570. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4571. for (int i = 0; i < 80; i++) {
  4572. uint32_t f, k;
  4573. if (i < 20) {
  4574. f = (b & c) | ((~b) & d);
  4575. k = 0x5A827999;
  4576. } else if (i < 40) {
  4577. f = b ^ c ^ d;
  4578. k = 0x6ED9EBA1;
  4579. } else if (i < 60) {
  4580. f = (b & c) | (b & d) | (c & d);
  4581. k = 0x8F1BBCDC;
  4582. } else {
  4583. f = b ^ c ^ d;
  4584. k = 0xCA62C1D6;
  4585. }
  4586. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4587. e = d;
  4588. d = c;
  4589. c = left_rotate(b, 30);
  4590. b = a;
  4591. a = temp;
  4592. }
  4593. h0 += a;
  4594. h1 += b;
  4595. h2 += c;
  4596. h3 += d;
  4597. h4 += e;
  4598. }
  4599. // Produce the final hash as a 20-byte binary string
  4600. std::string hash(20, '\0');
  4601. for (size_t i = 0; i < 4; i++) {
  4602. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4603. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4604. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4605. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4606. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4607. }
  4608. return hash;
  4609. }
  4610. inline std::string websocket_accept_key(const std::string &client_key) {
  4611. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4612. return base64_encode(sha1(client_key + magic));
  4613. }
  4614. inline bool is_websocket_upgrade(const Request &req) {
  4615. if (req.method != "GET") { return false; }
  4616. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4617. // list of protocols and asks recipients to match each name
  4618. // case-insensitively, so look for the token rather than compare the whole
  4619. // field value.
  4620. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4621. // Check Connection: Upgrade
  4622. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4623. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4624. // RFC 6455 Section 4.2.1
  4625. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4626. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4627. return false;
  4628. }
  4629. static const std::string b64chars =
  4630. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4631. for (size_t i = 0; i < 22; i++) {
  4632. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4633. }
  4634. // Check Sec-WebSocket-Version: 13
  4635. auto version = req.get_header_value("Sec-WebSocket-Version");
  4636. if (version != "13") { return false; }
  4637. return true;
  4638. }
  4639. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4640. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4641. thread_local std::random_device rd;
  4642. size_t filled = 0;
  4643. while (filled < n) {
  4644. auto v = rd();
  4645. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4646. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4647. }
  4648. }
  4649. }
  4650. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4651. const char *data, size_t len, bool fin,
  4652. bool mask) {
  4653. // First byte: FIN + opcode
  4654. uint8_t header[2];
  4655. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4656. (static_cast<uint8_t>(opcode) & 0x0F));
  4657. // Second byte: MASK + payload length
  4658. if (len < 126) {
  4659. header[1] = static_cast<uint8_t>(len);
  4660. if (mask) { header[1] |= 0x80; }
  4661. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4662. } else if (len <= 0xFFFF) {
  4663. header[1] = 126;
  4664. if (mask) { header[1] |= 0x80; }
  4665. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4666. uint8_t ext[2];
  4667. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4668. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4669. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4670. } else {
  4671. header[1] = 127;
  4672. if (mask) { header[1] |= 0x80; }
  4673. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4674. uint8_t ext[8];
  4675. for (int i = 7; i >= 0; i--) {
  4676. ext[7 - i] =
  4677. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4678. }
  4679. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4680. }
  4681. if (mask) {
  4682. // Generate random mask key
  4683. uint8_t mask_key[4];
  4684. fill_random_bytes(mask_key, sizeof(mask_key));
  4685. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4686. // Write masked payload in chunks
  4687. const size_t chunk_size = 4096;
  4688. std::vector<char> buf((std::min)(len, chunk_size));
  4689. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4690. size_t n = (std::min)(chunk_size, len - offset);
  4691. for (size_t i = 0; i < n; i++) {
  4692. buf[i] =
  4693. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4694. }
  4695. if (strm.write(buf.data(), n) < 0) { return false; }
  4696. }
  4697. } else {
  4698. if (len > 0) {
  4699. if (strm.write(data, len) < 0) { return false; }
  4700. }
  4701. }
  4702. return true;
  4703. }
  4704. } // namespace detail
  4705. namespace ws {
  4706. namespace impl {
  4707. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4708. // hands back whatever its buffer already holds -- so every multi-byte field has
  4709. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4710. // header straddles the read buffer's boundary.
  4711. //
  4712. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4713. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4714. // there is a failure like any other. (When read() fails it always records why,
  4715. // so the error belongs to this call and not to an earlier one.)
  4716. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4717. auto p = static_cast<char *>(buf);
  4718. size_t total = 0;
  4719. while (total < size) {
  4720. auto n = strm.read(p + total, size - total);
  4721. if (n <= 0) {
  4722. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4723. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4724. }
  4725. total += static_cast<size_t>(n);
  4726. }
  4727. return FrameRead::Ok;
  4728. }
  4729. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4730. std::string &payload, bool &fin,
  4731. bool expect_masked, size_t max_len) {
  4732. // Read first 2 bytes. This is the only read that may report a timeout: it
  4733. // sits on a frame boundary, where nothing has been consumed yet.
  4734. uint8_t header[2];
  4735. FrameRead first = read_exact(strm, header, 2);
  4736. if (first != FrameRead::Ok) { return first; }
  4737. fin = (header[0] & 0x80) != 0;
  4738. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4739. if (header[0] & 0x70) { return FrameRead::Fail; }
  4740. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4741. bool masked = (header[1] & 0x80) != 0;
  4742. uint64_t payload_len = header[1] & 0x7F;
  4743. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4744. // MUST have a payload length of 125 bytes or less
  4745. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4746. if (is_control) {
  4747. if (!fin) { return FrameRead::Fail; }
  4748. if (payload_len > 125) { return FrameRead::Fail; }
  4749. }
  4750. if (masked != expect_masked) { return FrameRead::Fail; }
  4751. // Extended payload length
  4752. if (payload_len == 126) {
  4753. uint8_t ext[2];
  4754. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4755. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4756. } else if (payload_len == 127) {
  4757. uint8_t ext[8];
  4758. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4759. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4760. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4761. payload_len = 0;
  4762. for (int i = 0; i < 8; i++) {
  4763. payload_len = (payload_len << 8) | ext[i];
  4764. }
  4765. }
  4766. if (payload_len > max_len) { return FrameRead::Fail; }
  4767. // Read mask key if present
  4768. uint8_t mask_key[4] = {0};
  4769. if (masked) {
  4770. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4771. return FrameRead::Fail;
  4772. }
  4773. }
  4774. // Grow the payload only as it arrives, since a header alone can announce
  4775. // max_len bytes that never come.
  4776. payload.clear();
  4777. auto len = static_cast<size_t>(payload_len);
  4778. while (payload.size() < len) {
  4779. auto offset = payload.size();
  4780. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4781. payload.resize(offset + n);
  4782. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4783. return FrameRead::Fail;
  4784. }
  4785. }
  4786. // Unmask if needed
  4787. if (masked) {
  4788. for (size_t i = 0; i < payload.size(); i++) {
  4789. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4790. }
  4791. }
  4792. return FrameRead::Ok;
  4793. }
  4794. } // namespace impl
  4795. } // namespace ws
  4796. namespace detail {
  4797. inline bool is_valid_path(const std::string &path) {
  4798. size_t level = 0;
  4799. size_t i = 0;
  4800. // Skip slash
  4801. while (i < path.size() && path[i] == '/') {
  4802. i++;
  4803. }
  4804. while (i < path.size()) {
  4805. // Read component
  4806. auto beg = i;
  4807. while (i < path.size() && path[i] != '/') {
  4808. if (path[i] == '\0') {
  4809. return false;
  4810. } else if (path[i] == '\\') {
  4811. return false;
  4812. }
  4813. i++;
  4814. }
  4815. auto len = i - beg;
  4816. assert(len > 0);
  4817. if (!path.compare(beg, len, ".")) {
  4818. ;
  4819. } else if (!path.compare(beg, len, "..")) {
  4820. if (level == 0) { return false; }
  4821. level--;
  4822. } else {
  4823. level++;
  4824. }
  4825. // Skip slash
  4826. while (i < path.size() && path[i] == '/') {
  4827. i++;
  4828. }
  4829. }
  4830. return true;
  4831. }
  4832. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4833. #if defined(_WIN32)
  4834. char buf[_MAX_PATH];
  4835. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4836. resolved = buf;
  4837. #elif defined(PATH_MAX)
  4838. char buf[PATH_MAX];
  4839. if (realpath(path, buf) == nullptr) { return false; }
  4840. resolved = buf;
  4841. #else
  4842. auto buf = realpath(path, nullptr);
  4843. auto guard = scope_exit([&]() { std::free(buf); });
  4844. if (buf == nullptr) { return false; }
  4845. resolved = buf;
  4846. #endif
  4847. return true;
  4848. }
  4849. inline bool is_path_within_base(const std::string &resolved_path,
  4850. const std::string &resolved_base) {
  4851. #if defined(_WIN32)
  4852. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4853. resolved_base.size()) == 0;
  4854. #else
  4855. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4856. resolved_base.size()) == 0;
  4857. #endif
  4858. }
  4859. inline FileStat::FileStat(const std::string &path) {
  4860. #if defined(_WIN32)
  4861. auto wpath = u8string_to_wstring(path.c_str());
  4862. ret_ = _wstat(wpath.c_str(), &st_);
  4863. #else
  4864. ret_ = stat(path.c_str(), &st_);
  4865. #endif
  4866. }
  4867. inline bool FileStat::is_file() const {
  4868. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4869. }
  4870. inline bool FileStat::is_dir() const {
  4871. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4872. }
  4873. inline time_t FileStat::mtime() const {
  4874. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4875. : static_cast<time_t>(-1);
  4876. }
  4877. inline size_t FileStat::size() const {
  4878. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4879. }
  4880. inline std::string encode_path(const std::string &s) {
  4881. std::string result;
  4882. result.reserve(s.size());
  4883. for (size_t i = 0; s[i]; i++) {
  4884. switch (s[i]) {
  4885. case ' ': result += "%20"; break;
  4886. case '+': result += "%2B"; break;
  4887. case '\'': result += "%27"; break;
  4888. case ',': result += "%2C"; break;
  4889. // case ':': result += "%3A"; break; // ok? probably...
  4890. case ';': result += "%3B"; break;
  4891. default:
  4892. auto c = static_cast<uint8_t>(s[i]);
  4893. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4894. // in a request-target as-is.
  4895. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4896. result += '%';
  4897. char hex[4];
  4898. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4899. assert(len == 2);
  4900. result.append(hex, static_cast<size_t>(len));
  4901. } else {
  4902. result += s[i];
  4903. }
  4904. break;
  4905. }
  4906. }
  4907. return result;
  4908. }
  4909. inline std::string file_extension(const std::string &path) {
  4910. auto i = path.size();
  4911. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4912. i--;
  4913. }
  4914. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4915. return std::string();
  4916. }
  4917. return path.substr(i);
  4918. }
  4919. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4920. template <typename T>
  4921. inline bool parse_header(const char *beg, const char *end, T fn);
  4922. template <typename T>
  4923. inline bool parse_header(const char *beg, const char *end, T fn) {
  4924. // Skip trailing spaces and tabs.
  4925. while (beg < end && is_space_or_tab(end[-1])) {
  4926. end--;
  4927. }
  4928. auto p = beg;
  4929. while (p < end && *p != ':') {
  4930. p++;
  4931. }
  4932. auto name = std::string(beg, p);
  4933. if (!detail::fields::is_field_name(name)) { return false; }
  4934. if (p == end) { return false; }
  4935. auto key_end = p;
  4936. if (*p++ != ':') { return false; }
  4937. while (p < end && is_space_or_tab(*p)) {
  4938. p++;
  4939. }
  4940. if (p <= end) {
  4941. auto key_len = key_end - beg;
  4942. if (!key_len) { return false; }
  4943. auto key = std::string(beg, key_end);
  4944. auto val = std::string(p, end);
  4945. if (!detail::fields::is_field_value(val)) { return false; }
  4946. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4947. // percent-decoded by the recipient. Applications that need to interpret a
  4948. // value as a URI component should call httplib::decode_uri_component()
  4949. // (or decode_path_component()) explicitly.
  4950. fn(key, val);
  4951. return true;
  4952. }
  4953. return false;
  4954. }
  4955. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4956. const Headers &src_headers) {
  4957. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4958. // transfer coding is complete when a chunk with a chunk-size of zero is
  4959. // received, possibly followed by a trailer section, and finally terminated by
  4960. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4961. //
  4962. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4963. // doesn't care for the existence of the final CRLF. In other words, it seems
  4964. // to be ok whether the final CRLF exists or not in the chunked data.
  4965. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4966. //
  4967. // According to the reference code in RFC 9112, cpp-httplib now allows
  4968. // chunked transfer coding data without the final CRLF.
  4969. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4970. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4971. "transfer-encoding",
  4972. "content-length",
  4973. "host",
  4974. "authorization",
  4975. "www-authenticate",
  4976. "proxy-authenticate",
  4977. "proxy-authorization",
  4978. "cookie",
  4979. "set-cookie",
  4980. "cache-control",
  4981. "expect",
  4982. "max-forwards",
  4983. "pragma",
  4984. "range",
  4985. "te",
  4986. "age",
  4987. "expires",
  4988. "date",
  4989. "location",
  4990. "retry-after",
  4991. "vary",
  4992. "warning",
  4993. "content-encoding",
  4994. "content-type",
  4995. "content-range",
  4996. "trailer"};
  4997. case_ignore::unordered_set<std::string> declared_trailers;
  4998. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4999. if (!trailer_header.empty()) {
  5000. // split() trims each token and skips empty ones, so the name arrives ready
  5001. // to look up.
  5002. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5003. ',', [&](const char *b, const char *e) {
  5004. // A legitimate message declares only a handful of trailers. Cap the
  5005. // set so a peer cannot grow it without bound: an oversized set only
  5006. // arises from an attempt to force many colliding names into
  5007. // quadratic lookups (case_ignore::hash is unkeyed).
  5008. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5009. return;
  5010. }
  5011. std::string key(b, e);
  5012. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5013. declared_trailers.insert(key);
  5014. }
  5015. });
  5016. }
  5017. size_t trailer_header_count = 0;
  5018. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5019. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5020. // Count every received trailer field, not only the declared ones stored in
  5021. // dest, so undeclared fields cannot keep this loop running past the limit.
  5022. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5023. constexpr auto line_terminator_len = 2;
  5024. auto line_beg = line_reader.ptr();
  5025. auto line_end =
  5026. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5027. if (!parse_header(line_beg, line_end,
  5028. [&](const std::string &key, const std::string &val) {
  5029. if (declared_trailers.find(key) !=
  5030. declared_trailers.end()) {
  5031. dest.emplace(key, val);
  5032. }
  5033. })) {
  5034. return false;
  5035. }
  5036. trailer_header_count++;
  5037. if (!line_reader.getline()) { return false; }
  5038. }
  5039. return true;
  5040. }
  5041. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5042. size_t right) {
  5043. while (b + left < e && is_space_or_tab(b[left])) {
  5044. left++;
  5045. }
  5046. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5047. right--;
  5048. }
  5049. return std::make_pair(left, right);
  5050. }
  5051. inline std::string trim_copy(const std::string &s) {
  5052. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5053. return s.substr(r.first, r.second - r.first);
  5054. }
  5055. inline std::string trim_double_quotes_copy(const std::string &s) {
  5056. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5057. return s.substr(1, s.size() - 2);
  5058. }
  5059. return s;
  5060. }
  5061. inline void
  5062. divide(const char *data, std::size_t size, char d,
  5063. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5064. fn) {
  5065. const auto it = std::find(data, data + size, d);
  5066. const auto found = static_cast<std::size_t>(it != data + size);
  5067. const auto lhs_data = data;
  5068. const auto lhs_size = static_cast<std::size_t>(it - data);
  5069. const auto rhs_data = it + found;
  5070. const auto rhs_size = size - lhs_size - found;
  5071. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5072. }
  5073. inline void
  5074. divide(const std::string &str, char d,
  5075. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5076. fn) {
  5077. divide(str.data(), str.size(), d, std::move(fn));
  5078. }
  5079. inline void split(const char *b, const char *e, char d,
  5080. std::function<void(const char *, const char *)> fn) {
  5081. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5082. }
  5083. inline void split(const char *b, const char *e, char d, size_t m,
  5084. std::function<void(const char *, const char *)> fn) {
  5085. size_t i = 0;
  5086. size_t beg = 0;
  5087. size_t count = 1;
  5088. while (e ? (b + i < e) : (b[i] != '\0')) {
  5089. if (b[i] == d && count < m) {
  5090. auto r = trim(b, e, beg, i);
  5091. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5092. beg = i + 1;
  5093. count++;
  5094. }
  5095. i++;
  5096. }
  5097. if (i) {
  5098. auto r = trim(b, e, beg, i);
  5099. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5100. }
  5101. }
  5102. // Same contract as split(), except that a delimiter inside a quoted-string is
  5103. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5104. // quoted-string, and ';' and '=' are legal characters inside one.
  5105. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5106. std::function<void(const char *, const char *)> fn) {
  5107. size_t i = 0;
  5108. size_t beg = 0;
  5109. size_t count = 1;
  5110. auto in_quotes = false;
  5111. while (e ? (b + i < e) : (b[i] != '\0')) {
  5112. if (b[i] == '"') {
  5113. in_quotes = !in_quotes;
  5114. } else if (b[i] == d && !in_quotes && count < m) {
  5115. auto r = trim(b, e, beg, i);
  5116. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5117. beg = i + 1;
  5118. count++;
  5119. }
  5120. i++;
  5121. }
  5122. if (i) {
  5123. auto r = trim(b, e, beg, i);
  5124. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5125. }
  5126. }
  5127. inline void split_unquoted(const char *b, const char *e, char d,
  5128. std::function<void(const char *, const char *)> fn) {
  5129. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5130. std::move(fn));
  5131. }
  5132. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5133. // key a token, so the first '=' is the separator even when the value is a
  5134. // quoted-string carrying more of them.
  5135. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5136. std::string &val) {
  5137. divide(
  5138. b, static_cast<std::size_t>(e - b), '=',
  5139. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5140. const auto kr = trim(kb, kb + klen, 0, klen);
  5141. key.assign(kb + kr.first, kb + kr.second);
  5142. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5143. val.assign(vb + vr.first, vb + vr.second);
  5144. });
  5145. }
  5146. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5147. std::function<bool(const char *, const char *)> fn) {
  5148. size_t i = 0;
  5149. size_t beg = 0;
  5150. size_t count = 1;
  5151. while (e ? (b + i < e) : (b[i] != '\0')) {
  5152. if (b[i] == d && count < m) {
  5153. auto r = trim(b, e, beg, i);
  5154. if (r.first < r.second) {
  5155. auto found = fn(&b[r.first], &b[r.second]);
  5156. if (found) { return true; }
  5157. }
  5158. beg = i + 1;
  5159. count++;
  5160. }
  5161. i++;
  5162. }
  5163. if (i) {
  5164. auto r = trim(b, e, beg, i);
  5165. if (r.first < r.second) {
  5166. auto found = fn(&b[r.first], &b[r.second]);
  5167. if (found) { return true; }
  5168. }
  5169. }
  5170. return false;
  5171. }
  5172. inline bool split_find(const char *b, const char *e, char d,
  5173. std::function<bool(const char *, const char *)> fn) {
  5174. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5175. std::move(fn));
  5176. }
  5177. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5178. size_t fixed_buffer_size)
  5179. : strm_(strm), fixed_buffer_(fixed_buffer),
  5180. fixed_buffer_size_(fixed_buffer_size) {}
  5181. inline const char *stream_line_reader::ptr() const {
  5182. if (growable_buffer_.empty()) {
  5183. return fixed_buffer_;
  5184. } else {
  5185. return growable_buffer_.data();
  5186. }
  5187. }
  5188. inline size_t stream_line_reader::size() const {
  5189. if (growable_buffer_.empty()) {
  5190. return fixed_buffer_used_size_;
  5191. } else {
  5192. return growable_buffer_.size();
  5193. }
  5194. }
  5195. inline bool stream_line_reader::end_with_crlf() const {
  5196. auto end = ptr() + size();
  5197. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5198. }
  5199. inline bool stream_line_reader::getline() {
  5200. fixed_buffer_used_size_ = 0;
  5201. growable_buffer_.clear();
  5202. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5203. char prev_byte = 0;
  5204. #endif
  5205. for (size_t i = 0;; i++) {
  5206. // Fast path: whatever the stream has already buffered can be scanned for
  5207. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5208. // call, a bounds check and a one-byte copy per character of the request.
  5209. size_t buffered_size = 0;
  5210. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5211. auto take = buffered_size;
  5212. auto terminated = false;
  5213. for (size_t at = 0; at < buffered_size;) {
  5214. auto nl = static_cast<const char *>(
  5215. memchr(buffered + at, '\n', buffered_size - at));
  5216. if (!nl) { break; }
  5217. auto pos = static_cast<size_t>(nl - buffered);
  5218. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5219. take = pos + 1;
  5220. terminated = true;
  5221. break;
  5222. #else
  5223. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5224. // be the last byte of an earlier chunk, hence prev_byte.
  5225. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5226. take = pos + 1;
  5227. terminated = true;
  5228. break;
  5229. }
  5230. at = pos + 1;
  5231. #endif
  5232. }
  5233. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5234. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5235. prev_byte = buffered[take - 1];
  5236. #endif
  5237. append(buffered, take);
  5238. strm_.consume_buffered(take);
  5239. i += take;
  5240. if (terminated) { return true; }
  5241. continue;
  5242. }
  5243. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5244. // Treat exceptionally long lines as an error to
  5245. // prevent infinite loops/memory exhaustion
  5246. return false;
  5247. }
  5248. char byte;
  5249. auto n = strm_.read(&byte, 1);
  5250. if (n < 0) {
  5251. return false;
  5252. } else if (n == 0) {
  5253. if (i == 0) {
  5254. return false;
  5255. } else {
  5256. break;
  5257. }
  5258. }
  5259. append(byte);
  5260. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5261. if (byte == '\n') { break; }
  5262. #else
  5263. if (prev_byte == '\r' && byte == '\n') { break; }
  5264. prev_byte = byte;
  5265. #endif
  5266. }
  5267. return true;
  5268. }
  5269. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5270. inline void stream_line_reader::append(const char *data, size_t size) {
  5271. // Once the line has outgrown the fixed buffer everything must keep going to
  5272. // the growable one, even if a later chunk would have fit. Without the
  5273. // emptiness check a short append after a long one would land in the fixed
  5274. // buffer, which ptr() and size() no longer look at, and be lost.
  5275. if (growable_buffer_.empty() &&
  5276. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5277. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5278. fixed_buffer_used_size_ += size;
  5279. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5280. } else {
  5281. // Unlike the per-character overload, this can be the very first append of
  5282. // the line, so the fixed buffer may hold nothing and carry no terminator
  5283. // yet. assign() takes an explicit length and does not need one.
  5284. if (growable_buffer_.empty()) {
  5285. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5286. }
  5287. growable_buffer_.append(data, size);
  5288. }
  5289. }
  5290. inline mmap::mmap(const char *path) { open(path); }
  5291. inline mmap::~mmap() { close(); }
  5292. inline bool mmap::open(const char *path) {
  5293. close();
  5294. #if defined(_WIN32)
  5295. auto wpath = u8string_to_wstring(path);
  5296. if (wpath.empty()) { return false; }
  5297. hFile_ =
  5298. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5299. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5300. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5301. LARGE_INTEGER size{};
  5302. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5303. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5304. // See:
  5305. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5306. if (static_cast<ULONGLONG>(size.QuadPart) >
  5307. (std::numeric_limits<decltype(size_)>::max)()) {
  5308. // `size_t` might be 32-bits, on 32-bits Windows.
  5309. return false;
  5310. }
  5311. size_ = static_cast<size_t>(size.QuadPart);
  5312. hMapping_ =
  5313. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5314. // Special treatment for an empty file...
  5315. if (hMapping_ == NULL && size_ == 0) {
  5316. close();
  5317. is_open_empty_file = true;
  5318. return true;
  5319. }
  5320. if (hMapping_ == NULL) {
  5321. close();
  5322. return false;
  5323. }
  5324. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5325. if (addr_ == nullptr) {
  5326. close();
  5327. return false;
  5328. }
  5329. #else
  5330. fd_ = ::open(path, O_RDONLY);
  5331. if (fd_ == -1) { return false; }
  5332. struct stat sb;
  5333. if (fstat(fd_, &sb) == -1) {
  5334. close();
  5335. return false;
  5336. }
  5337. size_ = static_cast<size_t>(sb.st_size);
  5338. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5339. // Special treatment for an empty file...
  5340. if (addr_ == MAP_FAILED && size_ == 0) {
  5341. close();
  5342. is_open_empty_file = true;
  5343. return false;
  5344. }
  5345. if (addr_ == MAP_FAILED) {
  5346. // Clear the sentinel before `close()`, since `is_open()` only checks
  5347. // `addr_` against nullptr and `munmap()` must not be called with it.
  5348. addr_ = nullptr;
  5349. close();
  5350. return false;
  5351. }
  5352. #endif
  5353. return true;
  5354. }
  5355. inline bool mmap::is_open() const {
  5356. return is_open_empty_file ? true : addr_ != nullptr;
  5357. }
  5358. inline size_t mmap::size() const { return size_; }
  5359. inline const char *mmap::data() const {
  5360. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5361. }
  5362. inline void mmap::close() {
  5363. #if defined(_WIN32)
  5364. if (addr_) {
  5365. ::UnmapViewOfFile(addr_);
  5366. addr_ = nullptr;
  5367. }
  5368. if (hMapping_) {
  5369. ::CloseHandle(hMapping_);
  5370. hMapping_ = NULL;
  5371. }
  5372. if (hFile_ != INVALID_HANDLE_VALUE) {
  5373. ::CloseHandle(hFile_);
  5374. hFile_ = INVALID_HANDLE_VALUE;
  5375. }
  5376. is_open_empty_file = false;
  5377. #else
  5378. if (addr_ != nullptr) {
  5379. munmap(addr_, size_);
  5380. addr_ = nullptr;
  5381. }
  5382. if (fd_ != -1) {
  5383. ::close(fd_);
  5384. fd_ = -1;
  5385. }
  5386. #endif
  5387. size_ = 0;
  5388. }
  5389. inline int close_socket(socket_t sock) noexcept {
  5390. #ifdef _WIN32
  5391. return closesocket(sock);
  5392. #else
  5393. return close(sock);
  5394. #endif
  5395. }
  5396. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5397. ssize_t res = 0;
  5398. while (true) {
  5399. res = fn();
  5400. if (res < 0 && errno == EINTR) {
  5401. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5402. continue;
  5403. }
  5404. break;
  5405. }
  5406. return res;
  5407. }
  5408. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5409. return handle_EINTR([&]() {
  5410. return recv(sock,
  5411. #ifdef _WIN32
  5412. static_cast<char *>(ptr), static_cast<int>(size),
  5413. #else
  5414. ptr, size,
  5415. #endif
  5416. flags);
  5417. });
  5418. }
  5419. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5420. int flags) {
  5421. return handle_EINTR([&]() {
  5422. return send(sock,
  5423. #ifdef _WIN32
  5424. static_cast<const char *>(ptr), static_cast<int>(size),
  5425. #else
  5426. ptr, size,
  5427. #endif
  5428. flags);
  5429. });
  5430. }
  5431. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5432. #ifdef _WIN32
  5433. return ::WSAPoll(fds, nfds, timeout);
  5434. #else
  5435. return ::poll(fds, nfds, timeout);
  5436. #endif
  5437. }
  5438. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5439. time_t usec) {
  5440. struct pollfd pfd;
  5441. pfd.fd = sock;
  5442. pfd.events = events;
  5443. pfd.revents = 0;
  5444. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5445. // "return immediately", which callers here rely on to probe a socket.
  5446. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5447. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5448. }
  5449. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5450. return select_impl(sock, POLLIN, sec, usec);
  5451. }
  5452. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5453. return select_impl(sock, POLLOUT, sec, usec);
  5454. }
  5455. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5456. time_t usec) {
  5457. struct pollfd pfd_read;
  5458. pfd_read.fd = sock;
  5459. pfd_read.events = POLLIN | POLLOUT;
  5460. pfd_read.revents = 0;
  5461. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5462. auto poll_res =
  5463. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5464. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5465. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5466. auto error = 0;
  5467. socklen_t len = sizeof(error);
  5468. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5469. reinterpret_cast<char *>(&error), &len);
  5470. auto successful = res >= 0 && !error;
  5471. return successful ? Error::Success : Error::Connection;
  5472. }
  5473. return Error::Connection;
  5474. }
  5475. inline bool is_socket_alive(socket_t sock) {
  5476. const auto val = detail::select_read(sock, 0, 0);
  5477. if (val == 0) {
  5478. return true;
  5479. } else if (val < 0 && errno == EBADF) {
  5480. return false;
  5481. }
  5482. char buf[1];
  5483. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5484. }
  5485. class SocketStream final : public Stream {
  5486. public:
  5487. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5488. time_t write_timeout_sec, time_t write_timeout_usec,
  5489. time_t max_timeout_msec = 0,
  5490. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5491. (std::chrono::steady_clock::time_point::min)());
  5492. ~SocketStream() override;
  5493. bool is_readable() const override;
  5494. bool wait_readable() const override;
  5495. bool wait_writable() const override;
  5496. bool is_peer_alive() const override;
  5497. ssize_t read(char *ptr, size_t size) override;
  5498. ssize_t write(const char *ptr, size_t size) override;
  5499. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5500. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5501. socket_t socket() const override;
  5502. time_t duration() const override;
  5503. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5504. const char *buffered_data(size_t &size) const override;
  5505. void consume_buffered(size_t size) override;
  5506. // The caller has just seen this socket become readable. Lets the next read
  5507. // skip its own readiness wait, which would otherwise ask the kernel a
  5508. // question that was answered a moment ago. Consumed by that read.
  5509. void set_readable_hint() { readable_hint_ = true; }
  5510. private:
  5511. bool ensure_readable();
  5512. socket_t sock_;
  5513. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5514. // thread while a read is in flight -- that is the point of it, for a caller
  5515. // holding one connection and wanting control back to send on it.
  5516. std::atomic<time_t> read_timeout_sec_;
  5517. std::atomic<time_t> read_timeout_usec_;
  5518. time_t write_timeout_sec_;
  5519. time_t write_timeout_usec_;
  5520. time_t max_timeout_msec_;
  5521. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5522. std::vector<char> read_buff_;
  5523. size_t read_buff_off_ = 0;
  5524. size_t read_buff_content_size_ = 0;
  5525. bool readable_hint_ = false;
  5526. static const size_t read_buff_size_ = 1024l * 4;
  5527. };
  5528. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5529. time_t keep_alive_timeout_sec) {
  5530. using namespace std::chrono;
  5531. const auto interval_usec =
  5532. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5533. // Avoid expensive `steady_clock::now()` call for the first time
  5534. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5535. const auto start = steady_clock::now() - microseconds{interval_usec};
  5536. const auto timeout = seconds{keep_alive_timeout_sec};
  5537. while (true) {
  5538. if (svr_sock == INVALID_SOCKET) {
  5539. break; // Server socket is closed
  5540. }
  5541. auto val = select_read(sock, 0, interval_usec);
  5542. if (val < 0) {
  5543. break; // Ssocket error
  5544. } else if (val == 0) {
  5545. if (steady_clock::now() - start > timeout) {
  5546. break; // Timeout
  5547. }
  5548. } else {
  5549. return true; // Ready for read
  5550. }
  5551. }
  5552. return false;
  5553. }
  5554. // `has_buffered_request` reports whether the connection's stream already holds
  5555. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5556. // 9.3.2), so reading one request can pull the start of the next one into the
  5557. // stream's buffer; that request must be served without waiting for the socket
  5558. // to become readable again, since its bytes are no longer on the socket.
  5559. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5560. template <typename P, typename T>
  5561. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5562. socket_t sock,
  5563. size_t keep_alive_max_count,
  5564. time_t keep_alive_timeout_sec,
  5565. P has_buffered_request, T callback) {
  5566. assert(keep_alive_max_count > 0);
  5567. auto ret = false;
  5568. auto count = keep_alive_max_count;
  5569. while (count > 0) {
  5570. auto socket_readable = false;
  5571. if (!has_buffered_request()) {
  5572. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5573. socket_readable = true;
  5574. }
  5575. auto close_connection = count == 1;
  5576. auto connection_closed = false;
  5577. ret = callback(socket_readable, close_connection, connection_closed);
  5578. if (!ret || connection_closed) { break; }
  5579. count--;
  5580. }
  5581. return ret;
  5582. }
  5583. template <typename T>
  5584. inline bool
  5585. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5586. size_t keep_alive_max_count,
  5587. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5588. time_t read_timeout_usec, time_t write_timeout_sec,
  5589. time_t write_timeout_usec, T callback) {
  5590. // One stream per connection: its read buffer can already hold the start of
  5591. // the next, pipelined request.
  5592. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5593. write_timeout_sec, write_timeout_usec);
  5594. return process_server_socket_core(
  5595. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5596. [&]() { return strm.is_readable(); },
  5597. [&](bool socket_readable, bool close_connection,
  5598. bool &connection_closed) {
  5599. if (socket_readable) { strm.set_readable_hint(); }
  5600. return callback(strm, close_connection, connection_closed);
  5601. });
  5602. }
  5603. inline bool process_client_socket(
  5604. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5605. time_t write_timeout_sec, time_t write_timeout_usec,
  5606. time_t max_timeout_msec,
  5607. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5608. std::function<bool(Stream &)> callback) {
  5609. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5610. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5611. start_time);
  5612. return callback(strm);
  5613. }
  5614. inline int shutdown_socket(socket_t sock) noexcept {
  5615. #ifdef _WIN32
  5616. return shutdown(sock, SD_BOTH);
  5617. #else
  5618. return shutdown(sock, SHUT_RDWR);
  5619. #endif
  5620. }
  5621. // Half-closes the write side and drains any in-flight/queued bytes before
  5622. // the final shutdown+close. Closing with unread data in the receive queue
  5623. // (or bytes arriving after the receive side is closed) makes the stack send
  5624. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5625. // response as a failed read even though it was fully written.
  5626. inline void drain_and_close_socket(socket_t sock) noexcept {
  5627. #ifdef _WIN32
  5628. shutdown(sock, SD_SEND);
  5629. #else
  5630. shutdown(sock, SHUT_WR);
  5631. #endif
  5632. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5633. size_t total = 0;
  5634. const auto deadline = std::chrono::steady_clock::now() +
  5635. std::chrono::milliseconds(100); // bound #1
  5636. while (total < size_t(1024u * 1024u)) { // bound #2
  5637. const auto remaining =
  5638. std::chrono::duration_cast<std::chrono::microseconds>(
  5639. deadline - std::chrono::steady_clock::now())
  5640. .count();
  5641. if (remaining <= 0) { break; }
  5642. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5643. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5644. if (n <= 0) { break; }
  5645. total += static_cast<size_t>(n);
  5646. }
  5647. shutdown_socket(sock);
  5648. close_socket(sock);
  5649. }
  5650. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5651. if (s.size() > 1 && s[0] == '\0') {
  5652. auto ret = s;
  5653. ret[0] = '@';
  5654. return ret;
  5655. }
  5656. return s;
  5657. }
  5658. inline std::string
  5659. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5660. if (s.size() > 1 && s[0] == '@') {
  5661. auto ret = s;
  5662. ret[0] = '\0';
  5663. return ret;
  5664. }
  5665. return s;
  5666. }
  5667. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5668. const struct addrinfo *hints,
  5669. struct addrinfo **res, time_t timeout_sec) {
  5670. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5671. if (timeout_sec <= 0) {
  5672. // No timeout specified, use standard getaddrinfo
  5673. return getaddrinfo(node, service, hints, res);
  5674. }
  5675. #ifdef _WIN32
  5676. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5677. OVERLAPPED overlapped = {};
  5678. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5679. if (!event) { return EAI_FAIL; }
  5680. overlapped.hEvent = event;
  5681. PADDRINFOEXW result_addrinfo = nullptr;
  5682. HANDLE cancel_handle = nullptr;
  5683. ADDRINFOEXW hints_ex = {};
  5684. if (hints) {
  5685. hints_ex.ai_flags = hints->ai_flags;
  5686. hints_ex.ai_family = hints->ai_family;
  5687. hints_ex.ai_socktype = hints->ai_socktype;
  5688. hints_ex.ai_protocol = hints->ai_protocol;
  5689. }
  5690. auto wnode = u8string_to_wstring(node);
  5691. auto wservice = u8string_to_wstring(service);
  5692. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5693. hints ? &hints_ex : nullptr, &result_addrinfo,
  5694. nullptr, &overlapped, nullptr, &cancel_handle);
  5695. if (ret == WSA_IO_PENDING) {
  5696. auto wait_result =
  5697. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5698. if (wait_result == WAIT_TIMEOUT) {
  5699. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5700. ::CloseHandle(event);
  5701. return EAI_AGAIN;
  5702. }
  5703. DWORD bytes_returned;
  5704. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5705. &bytes_returned, FALSE)) {
  5706. ::CloseHandle(event);
  5707. return ::WSAGetLastError();
  5708. }
  5709. }
  5710. ::CloseHandle(event);
  5711. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5712. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5713. return 0;
  5714. }
  5715. return ret;
  5716. #elif TARGET_OS_MAC && defined(__clang__)
  5717. if (!node) { return EAI_NONAME; }
  5718. // macOS implementation using CFHost API for asynchronous DNS resolution
  5719. CFStringRef hostname_ref = CFStringCreateWithCString(
  5720. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5721. if (!hostname_ref) { return EAI_MEMORY; }
  5722. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5723. CFRelease(hostname_ref);
  5724. if (!host_ref) { return EAI_MEMORY; }
  5725. // Set up context for callback
  5726. struct CFHostContext {
  5727. bool completed = false;
  5728. bool success = false;
  5729. CFArrayRef addresses = nullptr;
  5730. std::mutex mutex;
  5731. std::condition_variable cv;
  5732. } context;
  5733. CFHostClientContext client_context;
  5734. memset(&client_context, 0, sizeof(client_context));
  5735. client_context.info = &context;
  5736. // Set callback
  5737. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5738. const CFStreamError *error, void *info) {
  5739. auto ctx = static_cast<CFHostContext *>(info);
  5740. std::lock_guard<std::mutex> lock(ctx->mutex);
  5741. if (error && error->error != 0) {
  5742. ctx->success = false;
  5743. } else {
  5744. Boolean hasBeenResolved;
  5745. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5746. if (ctx->addresses && hasBeenResolved) {
  5747. CFRetain(ctx->addresses);
  5748. ctx->success = true;
  5749. } else {
  5750. ctx->success = false;
  5751. }
  5752. }
  5753. ctx->completed = true;
  5754. ctx->cv.notify_one();
  5755. };
  5756. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5757. CFRelease(host_ref);
  5758. return EAI_SYSTEM;
  5759. }
  5760. // Schedule on run loop
  5761. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5762. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5763. // Start resolution
  5764. CFStreamError stream_error;
  5765. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5766. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5767. CFRelease(host_ref);
  5768. return EAI_FAIL;
  5769. }
  5770. // Wait for completion with timeout
  5771. auto timeout_time =
  5772. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5773. bool timed_out = false;
  5774. {
  5775. std::unique_lock<std::mutex> lock(context.mutex);
  5776. while (!context.completed) {
  5777. auto now = std::chrono::steady_clock::now();
  5778. if (now >= timeout_time) {
  5779. timed_out = true;
  5780. break;
  5781. }
  5782. // Run the runloop for a short time
  5783. lock.unlock();
  5784. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5785. lock.lock();
  5786. }
  5787. }
  5788. // Clean up
  5789. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5790. CFHostSetClient(host_ref, nullptr, nullptr);
  5791. if (timed_out || !context.completed) {
  5792. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5793. CFRelease(host_ref);
  5794. return EAI_AGAIN;
  5795. }
  5796. if (!context.success || !context.addresses) {
  5797. CFRelease(host_ref);
  5798. return EAI_NODATA;
  5799. }
  5800. // Convert CFArray to addrinfo
  5801. CFIndex count = CFArrayGetCount(context.addresses);
  5802. if (count == 0) {
  5803. CFRelease(context.addresses);
  5804. CFRelease(host_ref);
  5805. return EAI_NODATA;
  5806. }
  5807. struct addrinfo *result_addrinfo = nullptr;
  5808. struct addrinfo **current = &result_addrinfo;
  5809. for (CFIndex i = 0; i < count; i++) {
  5810. CFDataRef addr_data =
  5811. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5812. if (!addr_data) continue;
  5813. const struct sockaddr *sockaddr_ptr =
  5814. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5815. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5816. // Allocate addrinfo structure
  5817. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5818. if (!*current) {
  5819. freeaddrinfo(result_addrinfo);
  5820. CFRelease(context.addresses);
  5821. CFRelease(host_ref);
  5822. return EAI_MEMORY;
  5823. }
  5824. memset(*current, 0, sizeof(struct addrinfo));
  5825. // Set up addrinfo fields
  5826. (*current)->ai_family = sockaddr_ptr->sa_family;
  5827. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5828. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5829. (*current)->ai_addrlen = sockaddr_len;
  5830. // Copy sockaddr
  5831. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5832. if (!(*current)->ai_addr) {
  5833. freeaddrinfo(result_addrinfo);
  5834. CFRelease(context.addresses);
  5835. CFRelease(host_ref);
  5836. return EAI_MEMORY;
  5837. }
  5838. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5839. // Set port if service is specified
  5840. if (service && *service) {
  5841. int port = 0;
  5842. if (parse_port(service, strlen(service), port)) {
  5843. if (sockaddr_ptr->sa_family == AF_INET) {
  5844. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5845. ->sin_port = htons(static_cast<uint16_t>(port));
  5846. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5847. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5848. ->sin6_port = htons(static_cast<uint16_t>(port));
  5849. }
  5850. }
  5851. }
  5852. current = &((*current)->ai_next);
  5853. }
  5854. CFRelease(context.addresses);
  5855. CFRelease(host_ref);
  5856. *res = result_addrinfo;
  5857. return 0;
  5858. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5859. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5860. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5861. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5862. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5863. // the resolver worker still references the stack-local gaicb. The cancel
  5864. // path therefore waits (gai_suspend with no timeout) for the worker to
  5865. // actually finish before letting the stack frame go. The trade-off is that
  5866. // a wedged DNS server can hold this thread for the system resolver timeout
  5867. // (~30s by default) past the caller's connection timeout.
  5868. struct gaicb request{};
  5869. struct gaicb *requests[1] = {&request};
  5870. struct sigevent sevp{};
  5871. struct timespec timeout{timeout_sec, 0};
  5872. request.ar_name = node;
  5873. request.ar_service = service;
  5874. request.ar_request = hints;
  5875. sevp.sigev_notify = SIGEV_NONE;
  5876. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5877. if (rc != 0) { return rc; }
  5878. auto cleanup = scope_exit([&] {
  5879. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5880. });
  5881. int wait_result = gai_suspend(requests, 1, &timeout);
  5882. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5883. int gai_result = gai_error(&request);
  5884. if (gai_result == 0) {
  5885. *res = request.ar_result;
  5886. request.ar_result = nullptr;
  5887. return 0;
  5888. }
  5889. return gai_result;
  5890. }
  5891. gai_cancel(&request);
  5892. while (gai_error(&request) == EAI_INPROGRESS) {
  5893. gai_suspend(requests, 1, nullptr);
  5894. }
  5895. return wait_result;
  5896. #else
  5897. // Fallback implementation using thread-based timeout for other Unix systems.
  5898. struct GetAddrInfoState {
  5899. ~GetAddrInfoState() {
  5900. if (info) { freeaddrinfo(info); }
  5901. }
  5902. std::mutex mutex;
  5903. std::condition_variable result_cv;
  5904. bool completed = false;
  5905. int result = EAI_SYSTEM;
  5906. std::string node;
  5907. std::string service;
  5908. struct addrinfo hints;
  5909. struct addrinfo *info = nullptr;
  5910. };
  5911. // Allocate on the heap, so the resolver thread can keep using the data.
  5912. auto state = std::make_shared<GetAddrInfoState>();
  5913. if (node) { state->node = node; }
  5914. state->service = service;
  5915. state->hints = *hints;
  5916. std::thread resolve_thread([state]() {
  5917. auto thread_result =
  5918. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5919. &state->info);
  5920. std::lock_guard<std::mutex> lock(state->mutex);
  5921. state->result = thread_result;
  5922. state->completed = true;
  5923. state->result_cv.notify_one();
  5924. });
  5925. // Wait for completion or timeout
  5926. std::unique_lock<std::mutex> lock(state->mutex);
  5927. auto finished =
  5928. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5929. [&] { return state->completed; });
  5930. if (finished) {
  5931. // Operation completed within timeout
  5932. resolve_thread.join();
  5933. *res = state->info;
  5934. state->info = nullptr; // Pass ownership to caller
  5935. return state->result;
  5936. } else {
  5937. // Timeout occurred
  5938. resolve_thread.detach(); // Let the thread finish in background
  5939. return EAI_AGAIN; // Return timeout error
  5940. }
  5941. #endif
  5942. #else
  5943. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5944. return getaddrinfo(node, service, hints, res);
  5945. #endif
  5946. }
  5947. template <typename BindOrConnect>
  5948. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5949. int address_family, int socket_flags, bool tcp_nodelay,
  5950. bool ipv6_v6only, SocketOptions socket_options,
  5951. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5952. // Get address info
  5953. const char *node = nullptr;
  5954. struct addrinfo hints;
  5955. struct addrinfo *result;
  5956. memset(&hints, 0, sizeof(struct addrinfo));
  5957. hints.ai_socktype = SOCK_STREAM;
  5958. hints.ai_protocol = IPPROTO_IP;
  5959. if (!ip.empty()) {
  5960. node = ip.c_str();
  5961. // Ask getaddrinfo to convert IP in c-string to address
  5962. hints.ai_family = AF_UNSPEC;
  5963. hints.ai_flags = AI_NUMERICHOST;
  5964. } else {
  5965. if (!host.empty()) { node = host.c_str(); }
  5966. hints.ai_family = address_family;
  5967. hints.ai_flags = socket_flags;
  5968. }
  5969. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5970. if (hints.ai_family == AF_UNIX) {
  5971. const auto addrlen = host.length();
  5972. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5973. #ifdef SOCK_CLOEXEC
  5974. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5975. hints.ai_protocol);
  5976. #else
  5977. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5978. #endif
  5979. if (sock != INVALID_SOCKET) {
  5980. sockaddr_un addr{};
  5981. addr.sun_family = AF_UNIX;
  5982. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5983. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5984. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5985. hints.ai_addrlen = static_cast<socklen_t>(
  5986. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5987. #ifndef SOCK_CLOEXEC
  5988. #ifndef _WIN32
  5989. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5990. #endif
  5991. #endif
  5992. if (socket_options) { socket_options(sock); }
  5993. #ifdef _WIN32
  5994. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5995. // remove the option.
  5996. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5997. #endif
  5998. bool dummy;
  5999. if (!bind_or_connect(sock, hints, dummy)) {
  6000. close_socket(sock);
  6001. sock = INVALID_SOCKET;
  6002. }
  6003. }
  6004. return sock;
  6005. }
  6006. #endif
  6007. auto service = std::to_string(port);
  6008. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6009. timeout_sec)) {
  6010. #if defined __linux__ && !defined __ANDROID__
  6011. res_init();
  6012. #endif
  6013. return INVALID_SOCKET;
  6014. }
  6015. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6016. for (auto rp = result; rp; rp = rp->ai_next) {
  6017. // Create a socket
  6018. #ifdef _WIN32
  6019. auto sock =
  6020. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6021. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6022. /**
  6023. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6024. * and above the socket creation fails on older Windows Systems.
  6025. *
  6026. * Let's try to create a socket the old way in this case.
  6027. *
  6028. * Reference:
  6029. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6030. *
  6031. * WSA_FLAG_NO_HANDLE_INHERIT:
  6032. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6033. * SP1, and later
  6034. *
  6035. */
  6036. if (sock == INVALID_SOCKET) {
  6037. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6038. }
  6039. #else
  6040. #ifdef SOCK_CLOEXEC
  6041. auto sock =
  6042. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6043. #else
  6044. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6045. #endif
  6046. #endif
  6047. if (sock == INVALID_SOCKET) { continue; }
  6048. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6049. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6050. close_socket(sock);
  6051. continue;
  6052. }
  6053. #endif
  6054. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6055. if (rp->ai_family == AF_INET6) {
  6056. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6057. }
  6058. if (socket_options) { socket_options(sock); }
  6059. // bind or connect
  6060. auto quit = false;
  6061. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6062. close_socket(sock);
  6063. if (quit) { break; }
  6064. }
  6065. return INVALID_SOCKET;
  6066. }
  6067. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6068. #ifdef _WIN32
  6069. auto flags = nonblocking ? 1UL : 0UL;
  6070. ioctlsocket(sock, FIONBIO, &flags);
  6071. #else
  6072. auto flags = fcntl(sock, F_GETFL, 0);
  6073. fcntl(sock, F_SETFL,
  6074. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6075. #endif
  6076. }
  6077. inline bool is_connection_error() {
  6078. #ifdef _WIN32
  6079. return WSAGetLastError() != WSAEWOULDBLOCK;
  6080. #else
  6081. return errno != EINPROGRESS;
  6082. #endif
  6083. }
  6084. // accept() failed because the process or the network stack is temporarily out
  6085. // of resources. The listening socket is still usable, so back off briefly and
  6086. // try again.
  6087. inline bool is_accept_resource_error() {
  6088. #ifdef _WIN32
  6089. auto err = WSAGetLastError();
  6090. return err == WSAEMFILE || err == WSAENOBUFS;
  6091. #else
  6092. auto err = errno;
  6093. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6094. #endif
  6095. }
  6096. // accept() failed for a reason that says nothing about the listening socket:
  6097. // the pending connection went away before it could be accepted, or the call
  6098. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6099. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6100. // connection that way.
  6101. inline bool is_accept_transient_error() {
  6102. #ifdef _WIN32
  6103. auto err = WSAGetLastError();
  6104. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6105. err == WSAECONNABORTED;
  6106. #else
  6107. auto err = errno;
  6108. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6109. err == ECONNABORTED;
  6110. #endif
  6111. }
  6112. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6113. struct addrinfo hints;
  6114. struct addrinfo *result;
  6115. memset(&hints, 0, sizeof(struct addrinfo));
  6116. hints.ai_family = AF_UNSPEC;
  6117. hints.ai_socktype = SOCK_STREAM;
  6118. hints.ai_protocol = 0;
  6119. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6120. return false;
  6121. }
  6122. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6123. auto ret = false;
  6124. for (auto rp = result; rp; rp = rp->ai_next) {
  6125. const auto &ai = *rp;
  6126. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6127. ret = true;
  6128. break;
  6129. }
  6130. }
  6131. return ret;
  6132. }
  6133. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6134. #define USE_IF2IP
  6135. #endif
  6136. #ifdef USE_IF2IP
  6137. inline std::string if2ip(int address_family, const std::string &ifn) {
  6138. struct ifaddrs *ifap;
  6139. getifaddrs(&ifap);
  6140. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6141. std::string addr_candidate;
  6142. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6143. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6144. (AF_UNSPEC == address_family ||
  6145. ifa->ifa_addr->sa_family == address_family)) {
  6146. if (ifa->ifa_addr->sa_family == AF_INET) {
  6147. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6148. char buf[INET_ADDRSTRLEN];
  6149. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6150. return std::string(buf, INET_ADDRSTRLEN);
  6151. }
  6152. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6153. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6154. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6155. char buf[INET6_ADDRSTRLEN] = {};
  6156. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6157. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6158. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6159. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6160. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6161. } else {
  6162. return std::string(buf, INET6_ADDRSTRLEN);
  6163. }
  6164. }
  6165. }
  6166. }
  6167. }
  6168. }
  6169. return addr_candidate;
  6170. }
  6171. #endif
  6172. inline socket_t create_client_socket(
  6173. const std::string &host, const std::string &ip, int port,
  6174. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6175. SocketOptions socket_options, time_t connection_timeout_sec,
  6176. time_t connection_timeout_usec, time_t read_timeout_sec,
  6177. time_t read_timeout_usec, time_t write_timeout_sec,
  6178. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6179. auto sock = create_socket(
  6180. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6181. std::move(socket_options),
  6182. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6183. if (!intf.empty()) {
  6184. #ifdef USE_IF2IP
  6185. auto ip_from_if = if2ip(address_family, intf);
  6186. if (ip_from_if.empty()) { ip_from_if = intf; }
  6187. if (!bind_ip_address(sock2, ip_from_if)) {
  6188. error = Error::BindIPAddress;
  6189. return false;
  6190. }
  6191. #endif
  6192. }
  6193. set_nonblocking(sock2, true);
  6194. auto ret =
  6195. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6196. if (ret < 0) {
  6197. if (is_connection_error()) {
  6198. error = Error::Connection;
  6199. return false;
  6200. }
  6201. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6202. connection_timeout_usec);
  6203. if (error != Error::Success) {
  6204. if (error == Error::ConnectionTimeout) { quit = true; }
  6205. return false;
  6206. }
  6207. }
  6208. set_nonblocking(sock2, false);
  6209. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6210. read_timeout_usec);
  6211. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6212. write_timeout_usec);
  6213. error = Error::Success;
  6214. return true;
  6215. },
  6216. connection_timeout_sec); // Pass DNS timeout
  6217. if (sock != INVALID_SOCKET) {
  6218. error = Error::Success;
  6219. } else {
  6220. if (error == Error::Success) { error = Error::Connection; }
  6221. }
  6222. return sock;
  6223. }
  6224. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6225. socklen_t addr_len, std::string &ip, int &port) {
  6226. if (addr.ss_family == AF_INET) {
  6227. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6228. } else if (addr.ss_family == AF_INET6) {
  6229. port =
  6230. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6231. } else {
  6232. return false;
  6233. }
  6234. std::array<char, NI_MAXHOST> ipstr{};
  6235. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6236. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6237. 0, NI_NUMERICHOST)) {
  6238. return false;
  6239. }
  6240. ip = ipstr.data();
  6241. return true;
  6242. }
  6243. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6244. struct sockaddr_storage addr;
  6245. socklen_t addr_len = sizeof(addr);
  6246. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6247. &addr_len)) {
  6248. get_ip_and_port(addr, addr_len, ip, port);
  6249. }
  6250. }
  6251. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6252. struct sockaddr_storage addr;
  6253. socklen_t addr_len = sizeof(addr);
  6254. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6255. &addr_len)) {
  6256. #ifndef _WIN32
  6257. if (addr.ss_family == AF_UNIX) {
  6258. #if defined(__linux__)
  6259. struct ucred ucred;
  6260. socklen_t len = sizeof(ucred);
  6261. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6262. port = ucred.pid;
  6263. }
  6264. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6265. pid_t pid;
  6266. socklen_t len = sizeof(pid);
  6267. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6268. port = pid;
  6269. }
  6270. #endif
  6271. return;
  6272. }
  6273. #endif
  6274. get_ip_and_port(addr, addr_len, ip, port);
  6275. }
  6276. }
  6277. // Recursive form retained so operator""_t below can compute hashes for
  6278. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6279. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6280. // instead, which is iterative and stack-safe.
  6281. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6282. unsigned int h) {
  6283. return (l == 0)
  6284. ? h
  6285. : str2tag_core(
  6286. s + 1, l - 1,
  6287. // Unsets the 6 high bits of h, therefore no overflow happens
  6288. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6289. h * 33) ^
  6290. static_cast<unsigned char>(*s));
  6291. }
  6292. inline unsigned int str2tag(const std::string &s) {
  6293. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6294. // for compile-time UDL evaluation of short string literals, but at runtime
  6295. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6296. // would blow the stack with one frame per character.
  6297. unsigned int h = 0;
  6298. for (auto c : s) {
  6299. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6300. static_cast<unsigned char>(c);
  6301. }
  6302. return h;
  6303. }
  6304. namespace udl {
  6305. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6306. return str2tag_core(s, l, 0);
  6307. }
  6308. } // namespace udl
  6309. inline std::string
  6310. find_content_type(const std::string &path,
  6311. const std::map<std::string, std::string> &user_data,
  6312. const std::string &default_content_type) {
  6313. auto ext = file_extension(path);
  6314. auto it = user_data.find(ext);
  6315. if (it != user_data.end()) { return it->second; }
  6316. using udl::operator""_t;
  6317. switch (str2tag(ext)) {
  6318. default: return default_content_type;
  6319. case "css"_t: return "text/css";
  6320. case "csv"_t: return "text/csv";
  6321. case "htm"_t:
  6322. case "html"_t: return "text/html";
  6323. case "js"_t:
  6324. case "mjs"_t: return "text/javascript";
  6325. case "txt"_t: return "text/plain";
  6326. case "vtt"_t: return "text/vtt";
  6327. case "apng"_t: return "image/apng";
  6328. case "avif"_t: return "image/avif";
  6329. case "bmp"_t: return "image/bmp";
  6330. case "gif"_t: return "image/gif";
  6331. case "png"_t: return "image/png";
  6332. case "svg"_t: return "image/svg+xml";
  6333. case "webp"_t: return "image/webp";
  6334. case "ico"_t: return "image/x-icon";
  6335. case "tif"_t: return "image/tiff";
  6336. case "tiff"_t: return "image/tiff";
  6337. case "jpg"_t:
  6338. case "jpeg"_t: return "image/jpeg";
  6339. case "mp4"_t: return "video/mp4";
  6340. case "mpeg"_t: return "video/mpeg";
  6341. case "webm"_t: return "video/webm";
  6342. case "mp3"_t: return "audio/mp3";
  6343. case "mpga"_t: return "audio/mpeg";
  6344. case "weba"_t: return "audio/webm";
  6345. case "wav"_t: return "audio/wave";
  6346. case "otf"_t: return "font/otf";
  6347. case "ttf"_t: return "font/ttf";
  6348. case "woff"_t: return "font/woff";
  6349. case "woff2"_t: return "font/woff2";
  6350. case "7z"_t: return "application/x-7z-compressed";
  6351. case "atom"_t: return "application/atom+xml";
  6352. case "pdf"_t: return "application/pdf";
  6353. case "json"_t: return "application/json";
  6354. case "rss"_t: return "application/rss+xml";
  6355. case "tar"_t: return "application/x-tar";
  6356. case "xht"_t:
  6357. case "xhtml"_t: return "application/xhtml+xml";
  6358. case "xslt"_t: return "application/xslt+xml";
  6359. case "xml"_t: return "application/xml";
  6360. case "gz"_t: return "application/gzip";
  6361. case "zip"_t: return "application/zip";
  6362. case "wasm"_t: return "application/wasm";
  6363. }
  6364. }
  6365. inline std::string
  6366. extract_media_type(const std::string &content_type,
  6367. std::map<std::string, std::string> *params = nullptr) {
  6368. // Extract type/subtype from Content-Type value (RFC 2045)
  6369. // e.g. "application/json; charset=utf-8" -> "application/json"
  6370. auto media_type = content_type;
  6371. auto semicolon_pos = media_type.find(';');
  6372. if (semicolon_pos != std::string::npos) {
  6373. auto param_str = media_type.substr(semicolon_pos + 1);
  6374. media_type = media_type.substr(0, semicolon_pos);
  6375. if (params) {
  6376. // Parse parameters: key=value pairs separated by ';'
  6377. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6378. [&](const char *b, const char *e) {
  6379. std::string key;
  6380. std::string val;
  6381. divide_param_pair(b, e, key, val);
  6382. if (!key.empty()) {
  6383. params->emplace(trim_copy(key),
  6384. trim_double_quotes_copy(val));
  6385. }
  6386. });
  6387. }
  6388. }
  6389. // Trim whitespace from media type
  6390. return trim_copy(media_type);
  6391. }
  6392. inline bool can_compress_content_type(const std::string &content_type) {
  6393. using udl::operator""_t;
  6394. auto mime_type = extract_media_type(content_type);
  6395. auto tag = str2tag(mime_type);
  6396. switch (tag) {
  6397. case "image/svg+xml"_t:
  6398. case "application/javascript"_t:
  6399. case "application/x-javascript"_t:
  6400. case "application/json"_t:
  6401. case "application/ld+json"_t:
  6402. case "application/xml"_t:
  6403. case "application/xhtml+xml"_t:
  6404. case "application/rss+xml"_t:
  6405. case "application/atom+xml"_t:
  6406. case "application/xslt+xml"_t:
  6407. case "application/protobuf"_t: return true;
  6408. case "text/event-stream"_t: return false;
  6409. default: return !mime_type.rfind("text/", 0);
  6410. }
  6411. }
  6412. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6413. double &quality) {
  6414. quality = 1.0;
  6415. token.clear();
  6416. // Split on first ';': left = token name, right = parameters
  6417. const char *params_b = nullptr;
  6418. std::size_t params_len = 0;
  6419. divide(
  6420. b, static_cast<std::size_t>(e - b), ';',
  6421. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6422. auto r = trim(lb, lb + llen, 0, llen);
  6423. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6424. params_b = rb;
  6425. params_len = rlen;
  6426. });
  6427. if (token.empty()) { return false; }
  6428. if (params_len == 0) { return true; }
  6429. // Scan parameters for q= (stops on first match)
  6430. bool invalid = false;
  6431. split_find(params_b, params_b + params_len, ';',
  6432. (std::numeric_limits<size_t>::max)(),
  6433. [&](const char *pb, const char *pe) -> bool {
  6434. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6435. auto len = static_cast<size_t>(pe - pb);
  6436. if (len < 2) { return false; }
  6437. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6438. return false;
  6439. }
  6440. // Trim the value portion
  6441. auto r = trim(pb, pe, 2, len);
  6442. if (r.first >= r.second) {
  6443. invalid = true;
  6444. return true;
  6445. }
  6446. double v = 0.0;
  6447. auto res = from_chars(pb + r.first, pb + r.second, v);
  6448. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6449. v < 0.0 || v > 1.0) {
  6450. invalid = true;
  6451. return true;
  6452. }
  6453. quality = v;
  6454. return true;
  6455. });
  6456. return !invalid;
  6457. }
  6458. inline EncodingType encoding_type(const Request &req,
  6459. const std::string &content_type) {
  6460. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6461. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6462. if (s.empty()) { return EncodingType::None; }
  6463. // Single-pass: iterate tokens and track the best supported encoding.
  6464. // Server preference breaks ties (br > gzip > zstd).
  6465. EncodingType best = EncodingType::None;
  6466. double best_q = 0.0; // q=0 means "not acceptable"
  6467. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6468. auto priority = [](EncodingType t) -> int {
  6469. switch (t) {
  6470. case EncodingType::Brotli: return 0;
  6471. case EncodingType::Gzip: return 1;
  6472. case EncodingType::Zstd: return 2;
  6473. default: return 3;
  6474. }
  6475. };
  6476. std::string name;
  6477. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6478. double quality = 1.0;
  6479. if (!parse_quality(b, e, name, quality)) { return; }
  6480. if (quality <= 0.0) { return; }
  6481. EncodingType type = EncodingType::None;
  6482. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6483. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6484. #endif
  6485. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6486. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6487. type = EncodingType::Gzip;
  6488. }
  6489. #endif
  6490. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6491. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6492. type = EncodingType::Zstd;
  6493. }
  6494. #endif
  6495. if (type == EncodingType::None) { return; }
  6496. // Higher q-value wins; for equal q, server preference breaks ties
  6497. if (quality > best_q ||
  6498. (quality == best_q && priority(type) < priority(best))) {
  6499. best_q = quality;
  6500. best = type;
  6501. }
  6502. });
  6503. return best;
  6504. }
  6505. // `content_type` is taken separately because a file-backed response has not
  6506. // been given one yet when its coding has to be decided.
  6507. inline EncodingType encoding_type(const Request &req, const Response &res,
  6508. const std::string &content_type) {
  6509. // The response already names a content coding of its own: a handler serving
  6510. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6511. // point whose headers name the coding its files are stored in. Applying one
  6512. // on top of that would double-encode the body and append a second
  6513. // `Content-Encoding` field line.
  6514. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6515. return encoding_type(req, content_type);
  6516. }
  6517. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6518. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6519. }
  6520. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6521. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6522. if (type == EncodingType::Gzip) {
  6523. return detail::make_unique<gzip_compressor>();
  6524. }
  6525. #endif
  6526. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6527. if (type == EncodingType::Brotli) {
  6528. return detail::make_unique<brotli_compressor>();
  6529. }
  6530. #endif
  6531. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6532. if (type == EncodingType::Zstd) {
  6533. return detail::make_unique<zstd_compressor>();
  6534. }
  6535. #endif
  6536. (void)type;
  6537. return nullptr;
  6538. }
  6539. inline const char *encoding_name(EncodingType type) {
  6540. switch (type) {
  6541. case EncodingType::Gzip: return "gzip";
  6542. case EncodingType::Brotli: return "br";
  6543. case EncodingType::Zstd: return "zstd";
  6544. default: return "";
  6545. }
  6546. }
  6547. inline bool nocompressor::compress(const char *data, size_t data_length,
  6548. bool /*last*/, Callback callback) {
  6549. if (!data_length) { return true; }
  6550. return callback(data, data_length);
  6551. }
  6552. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6553. inline gzip_compressor::gzip_compressor() {
  6554. std::memset(&strm_, 0, sizeof(strm_));
  6555. strm_.zalloc = Z_NULL;
  6556. strm_.zfree = Z_NULL;
  6557. strm_.opaque = Z_NULL;
  6558. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6559. Z_DEFAULT_STRATEGY) == Z_OK;
  6560. }
  6561. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6562. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6563. bool last, Callback callback) {
  6564. assert(is_valid_);
  6565. do {
  6566. constexpr size_t max_avail_in =
  6567. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6568. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6569. (std::min)(data_length, max_avail_in));
  6570. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6571. data_length -= strm_.avail_in;
  6572. data += strm_.avail_in;
  6573. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6574. auto ret = Z_OK;
  6575. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6576. do {
  6577. strm_.avail_out = static_cast<uInt>(buff.size());
  6578. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6579. ret = deflate(&strm_, flush);
  6580. if (ret == Z_STREAM_ERROR) { return false; }
  6581. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6582. return false;
  6583. }
  6584. } while (strm_.avail_out == 0);
  6585. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6586. (flush == Z_NO_FLUSH && ret == Z_OK));
  6587. assert(strm_.avail_in == 0);
  6588. } while (data_length > 0);
  6589. return true;
  6590. }
  6591. inline gzip_decompressor::gzip_decompressor() {
  6592. std::memset(&strm_, 0, sizeof(strm_));
  6593. strm_.zalloc = Z_NULL;
  6594. strm_.zfree = Z_NULL;
  6595. strm_.opaque = Z_NULL;
  6596. // 15 is the value of wbits, which should be at the maximum possible value
  6597. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6598. // that the stream type should be automatically detected either gzip or
  6599. // deflate.
  6600. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6601. }
  6602. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6603. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6604. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6605. Callback callback) {
  6606. assert(is_valid_);
  6607. auto ret = Z_OK;
  6608. do {
  6609. constexpr size_t max_avail_in =
  6610. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6611. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6612. (std::min)(data_length, max_avail_in));
  6613. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6614. data_length -= strm_.avail_in;
  6615. data += strm_.avail_in;
  6616. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6617. while (strm_.avail_in > 0 && ret == Z_OK) {
  6618. strm_.avail_out = static_cast<uInt>(buff.size());
  6619. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6620. ret = inflate(&strm_, Z_NO_FLUSH);
  6621. assert(ret != Z_STREAM_ERROR);
  6622. switch (ret) {
  6623. case Z_NEED_DICT:
  6624. case Z_DATA_ERROR:
  6625. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6626. }
  6627. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6628. return false;
  6629. }
  6630. }
  6631. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6632. } while (data_length > 0);
  6633. return true;
  6634. }
  6635. #endif
  6636. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6637. inline brotli_compressor::brotli_compressor() {
  6638. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6639. }
  6640. inline brotli_compressor::~brotli_compressor() {
  6641. BrotliEncoderDestroyInstance(state_);
  6642. }
  6643. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6644. bool last, Callback callback) {
  6645. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6646. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6647. auto available_in = data_length;
  6648. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6649. for (;;) {
  6650. if (last) {
  6651. if (BrotliEncoderIsFinished(state_)) { break; }
  6652. } else {
  6653. if (!available_in) { break; }
  6654. }
  6655. auto available_out = buff.size();
  6656. auto next_out = buff.data();
  6657. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6658. &available_out, &next_out, nullptr)) {
  6659. return false;
  6660. }
  6661. auto output_bytes = buff.size() - available_out;
  6662. if (output_bytes) {
  6663. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6664. }
  6665. }
  6666. return true;
  6667. }
  6668. inline brotli_decompressor::brotli_decompressor() {
  6669. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6670. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6671. : BROTLI_DECODER_RESULT_ERROR;
  6672. }
  6673. inline brotli_decompressor::~brotli_decompressor() {
  6674. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6675. }
  6676. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6677. inline bool brotli_decompressor::decompress(const char *data,
  6678. size_t data_length,
  6679. Callback callback) {
  6680. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6681. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6682. return 0;
  6683. }
  6684. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6685. size_t avail_in = data_length;
  6686. size_t total_out;
  6687. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6688. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6689. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6690. char *next_out = buff.data();
  6691. size_t avail_out = buff.size();
  6692. decoder_r = BrotliDecoderDecompressStream(
  6693. decoder_s, &avail_in, &next_in, &avail_out,
  6694. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6695. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6696. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6697. }
  6698. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6699. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6700. }
  6701. #endif
  6702. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6703. inline zstd_compressor::zstd_compressor() {
  6704. ctx_ = ZSTD_createCCtx();
  6705. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6706. }
  6707. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6708. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6709. bool last, Callback callback) {
  6710. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6711. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6712. ZSTD_inBuffer input = {data, data_length, 0};
  6713. bool finished;
  6714. do {
  6715. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6716. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6717. if (ZSTD_isError(remaining)) { return false; }
  6718. if (!callback(buff.data(), output.pos)) { return false; }
  6719. finished = last ? (remaining == 0) : (input.pos == input.size);
  6720. } while (!finished);
  6721. return true;
  6722. }
  6723. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6724. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6725. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6726. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6727. Callback callback) {
  6728. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6729. ZSTD_inBuffer input = {data, data_length, 0};
  6730. while (input.pos < input.size) {
  6731. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6732. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6733. if (ZSTD_isError(remaining)) { return false; }
  6734. if (!callback(buff.data(), output.pos)) { return false; }
  6735. }
  6736. return true;
  6737. }
  6738. #endif
  6739. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6740. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6741. // unknown coding, and its payload would be handed back still compressed.
  6742. inline bool is_zlib_encoding(const std::string &encoding) {
  6743. return case_ignore::equal(encoding, "gzip") ||
  6744. case_ignore::equal(encoding, "deflate");
  6745. }
  6746. inline bool is_brotli_encoding(const std::string &encoding) {
  6747. return case_ignore::equal(encoding, "br");
  6748. }
  6749. inline bool is_zstd_encoding(const std::string &encoding) {
  6750. return case_ignore::equal(encoding, "zstd");
  6751. }
  6752. // Returns true if the content coding is one cpp-httplib is able to decompress
  6753. // when the corresponding support is compiled in.
  6754. inline bool is_known_content_encoding(const std::string &encoding) {
  6755. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6756. is_zstd_encoding(encoding);
  6757. }
  6758. inline std::unique_ptr<decompressor>
  6759. create_decompressor(const std::string &encoding) {
  6760. std::unique_ptr<decompressor> decompressor;
  6761. if (is_zlib_encoding(encoding)) {
  6762. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6763. decompressor = detail::make_unique<gzip_decompressor>();
  6764. #endif
  6765. } else if (is_brotli_encoding(encoding)) {
  6766. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6767. decompressor = detail::make_unique<brotli_decompressor>();
  6768. #endif
  6769. } else if (is_zstd_encoding(encoding)) {
  6770. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6771. decompressor = detail::make_unique<zstd_decompressor>();
  6772. #endif
  6773. }
  6774. return decompressor;
  6775. }
  6776. // Returns the best available compressor and its Content-Encoding name.
  6777. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6778. inline std::pair<std::unique_ptr<compressor>, const char *>
  6779. create_compressor() {
  6780. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6781. return {detail::make_unique<brotli_compressor>(), "br"};
  6782. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6783. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6784. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6785. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6786. #else
  6787. return {nullptr, nullptr};
  6788. #endif
  6789. }
  6790. inline bool is_prohibited_header_name(const std::string &name) {
  6791. using udl::operator""_t;
  6792. switch (str2tag(name)) {
  6793. case "REMOTE_ADDR"_t:
  6794. case "REMOTE_PORT"_t:
  6795. case "LOCAL_ADDR"_t:
  6796. case "LOCAL_PORT"_t: return true;
  6797. default: return false;
  6798. }
  6799. }
  6800. inline bool has_header(const Headers &headers, const std::string &key) {
  6801. if (is_prohibited_header_name(key)) { return false; }
  6802. return headers.find(key) != headers.end();
  6803. }
  6804. inline const char *get_header_value(const Headers &headers,
  6805. const std::string &key, const char *def,
  6806. size_t id) {
  6807. if (is_prohibited_header_name(key)) {
  6808. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6809. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6810. throw std::invalid_argument(msg);
  6811. #else
  6812. return "";
  6813. #endif
  6814. }
  6815. auto rng = headers.equal_range(key);
  6816. auto it = bounded_next(rng.first, id, rng.second);
  6817. if (it != rng.second) { return it->second.c_str(); }
  6818. return def;
  6819. }
  6820. inline size_t get_header_value_count(const Headers &headers,
  6821. const std::string &key) {
  6822. return headers.count(key);
  6823. }
  6824. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6825. // list may be sent as several field lines, and the combined field value is
  6826. // those values joined by commas in the order they were received. Callers that
  6827. // parse such a list must work on the combined value; reading only the first
  6828. // occurrence silently drops whatever the later field lines carry.
  6829. inline std::string get_combined_header_value(const Headers &headers,
  6830. const std::string &key) {
  6831. std::string combined;
  6832. auto rng = headers.equal_range(key);
  6833. for (auto it = rng.first; it != rng.second; ++it) {
  6834. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6835. // elements, so an empty field line must not contribute a bare comma to the
  6836. // combined value.
  6837. if (it->second.empty()) { continue; }
  6838. if (!combined.empty()) { combined += ", "; }
  6839. combined += it->second;
  6840. }
  6841. return combined;
  6842. }
  6843. inline bool has_header_token(const Headers &headers, const std::string &key,
  6844. const std::string &token) {
  6845. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6846. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6847. // several lines. Match complete tokens rather than searching the raw value,
  6848. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6849. auto rng = headers.equal_range(key);
  6850. for (auto it = rng.first; it != rng.second; ++it) {
  6851. const auto &value = it->second;
  6852. if (split_find(value.data(), value.data() + value.size(), ',',
  6853. [&](const char *b, const char *e) {
  6854. return case_ignore::equal(std::string(b, e), token);
  6855. })) {
  6856. return true;
  6857. }
  6858. }
  6859. return false;
  6860. }
  6861. template <typename Map>
  6862. inline typename Map::mapped_type
  6863. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6864. auto rng = m.equal_range(key);
  6865. auto it = bounded_next(rng.first, id, rng.second);
  6866. if (it != rng.second) { return it->second; }
  6867. return typename Map::mapped_type();
  6868. }
  6869. inline void set_header(Headers &headers, const std::string &key,
  6870. const std::string &val) {
  6871. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6872. }
  6873. inline bool read_headers(Stream &strm, Headers &headers) {
  6874. const auto bufsiz = 2048;
  6875. char buf[bufsiz];
  6876. stream_line_reader line_reader(strm, buf, bufsiz);
  6877. size_t header_count = 0;
  6878. for (;;) {
  6879. if (!line_reader.getline()) { return false; }
  6880. // Check if the line ends with CRLF.
  6881. auto line_terminator_len = 2;
  6882. if (line_reader.end_with_crlf()) {
  6883. // Blank line indicates end of headers.
  6884. if (line_reader.size() == 2) { break; }
  6885. } else {
  6886. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6887. // Blank line indicates end of headers.
  6888. if (line_reader.size() == 1) { break; }
  6889. line_terminator_len = 1;
  6890. #else
  6891. continue; // Skip invalid line.
  6892. #endif
  6893. }
  6894. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6895. // Check header count limit
  6896. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6897. // Exclude line terminator
  6898. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6899. if (!parse_header(line_reader.ptr(), end,
  6900. [&](const std::string &key, const std::string &val) {
  6901. headers.emplace(key, val);
  6902. })) {
  6903. return false;
  6904. }
  6905. header_count++;
  6906. }
  6907. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6908. // headers that have different values to prevent request smuggling.
  6909. auto cl_range = headers.equal_range("Content-Length");
  6910. if (cl_range.first != cl_range.second) {
  6911. const auto &first_val = cl_range.first->second;
  6912. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6913. if (it->second != first_val) { return false; }
  6914. }
  6915. }
  6916. return true;
  6917. }
  6918. // Parsed by hand: std::regex_match recurses once per character of the reason
  6919. // phrase, which a server can make as long as a whole line.
  6920. inline bool parse_status_line(const char *line, std::string &version,
  6921. int &status, std::string &reason) {
  6922. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  6923. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  6924. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  6925. !is_ascii_digit(line[11])) {
  6926. return false;
  6927. }
  6928. auto p = line + 12;
  6929. auto reason_begin = p;
  6930. if (*p == ' ') {
  6931. reason_begin = ++p;
  6932. p += std::strcspn(p, "\r\n");
  6933. }
  6934. auto reason_end = p;
  6935. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6936. if (*p == '\r') { p++; }
  6937. #else
  6938. if (*p++ != '\r') { return false; }
  6939. #endif
  6940. if (*p++ != '\n' || *p != '\0') { return false; }
  6941. version.assign(line, 8);
  6942. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  6943. reason.assign(reason_begin, reason_end);
  6944. return true;
  6945. }
  6946. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6947. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6948. struct WebSocketUpgradeResponse {
  6949. Error error = Error::Success;
  6950. int status = -1;
  6951. Headers headers;
  6952. std::string selected_subprotocol;
  6953. };
  6954. inline bool
  6955. read_websocket_upgrade_response(Stream &strm,
  6956. const std::string &expected_accept,
  6957. const std::string &offered_subprotocols,
  6958. WebSocketUpgradeResponse &upgrade) {
  6959. // Read status line
  6960. const auto bufsiz = 2048;
  6961. char buf[bufsiz];
  6962. stream_line_reader line_reader(strm, buf, bufsiz);
  6963. if (!line_reader.getline()) {
  6964. upgrade.error = Error::Read;
  6965. return false;
  6966. }
  6967. std::string version;
  6968. std::string reason;
  6969. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6970. upgrade.error = Error::WebSocketHandshake;
  6971. return false;
  6972. }
  6973. // Read the headers even for a rejection so the caller can see why the
  6974. // server refused the upgrade. A non-101 response may carry a body; it is
  6975. // deliberately left unread since the caller closes the socket right away.
  6976. if (!read_headers(strm, upgrade.headers)) {
  6977. upgrade.error = Error::Read;
  6978. return false;
  6979. }
  6980. const auto &headers = upgrade.headers;
  6981. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6982. upgrade.error = Error::WebSocketHandshake;
  6983. return false;
  6984. }
  6985. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6986. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6987. upgrade.error = Error::WebSocketHandshake;
  6988. return false;
  6989. }
  6990. // Verify Connection: Upgrade
  6991. if (!has_header_token(headers, "Connection", "upgrade")) {
  6992. upgrade.error = Error::WebSocketHandshake;
  6993. return false;
  6994. }
  6995. // Verify Sec-WebSocket-Accept header value
  6996. auto it = headers.find("Sec-WebSocket-Accept");
  6997. if (it == headers.end() || it->second != expected_accept) {
  6998. upgrade.error = Error::WebSocketHandshake;
  6999. return false;
  7000. }
  7001. // Extract negotiated subprotocol
  7002. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7003. if (proto_it != headers.end()) {
  7004. upgrade.selected_subprotocol = proto_it->second;
  7005. }
  7006. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7007. if (!upgrade.selected_subprotocol.empty()) {
  7008. auto was_offered = false;
  7009. split(offered_subprotocols.data(),
  7010. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7011. [&](const char *b, const char *e) {
  7012. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7013. was_offered = true;
  7014. }
  7015. });
  7016. if (!was_offered) {
  7017. upgrade.error = Error::WebSocketHandshake;
  7018. return false;
  7019. }
  7020. }
  7021. return true;
  7022. }
  7023. enum class ReadContentResult {
  7024. Success, // Successfully read the content
  7025. PayloadTooLarge, // The content exceeds the specified payload limit
  7026. Error // An error occurred while reading the content
  7027. };
  7028. inline ReadContentResult read_content_with_length(
  7029. Stream &strm, size_t len, DownloadProgress progress,
  7030. ContentReceiverWithProgress out,
  7031. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7032. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7033. detail::BodyReader br;
  7034. br.stream = &strm;
  7035. br.has_content_length = true;
  7036. br.content_length = len;
  7037. br.payload_max_length = payload_max_length;
  7038. br.chunked = false;
  7039. br.bytes_read = 0;
  7040. br.last_error = Error::Success;
  7041. size_t r = 0;
  7042. while (r < len) {
  7043. auto read_len = static_cast<size_t>(len - r);
  7044. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7045. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7046. if (n <= 0) {
  7047. // Check if it was a payload size error
  7048. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7049. return ReadContentResult::PayloadTooLarge;
  7050. }
  7051. return ReadContentResult::Error;
  7052. }
  7053. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7054. return ReadContentResult::Error;
  7055. }
  7056. r += static_cast<size_t>(n);
  7057. if (progress) {
  7058. if (!progress(r, len)) { return ReadContentResult::Error; }
  7059. }
  7060. }
  7061. return ReadContentResult::Success;
  7062. }
  7063. inline ReadContentResult
  7064. read_content_without_length(Stream &strm, size_t payload_max_length,
  7065. ContentReceiverWithProgress out) {
  7066. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7067. size_t r = 0;
  7068. for (;;) {
  7069. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7070. if (n == 0) { return ReadContentResult::Success; }
  7071. if (n < 0) { return ReadContentResult::Error; }
  7072. // Check if adding this data would exceed the payload limit
  7073. if (payload_max_length > 0 &&
  7074. (r > payload_max_length ||
  7075. payload_max_length - r < static_cast<size_t>(n))) {
  7076. return ReadContentResult::PayloadTooLarge;
  7077. }
  7078. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7079. return ReadContentResult::Error;
  7080. }
  7081. r += static_cast<size_t>(n);
  7082. }
  7083. return ReadContentResult::Success;
  7084. }
  7085. template <typename T>
  7086. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7087. size_t payload_max_length,
  7088. ContentReceiverWithProgress out) {
  7089. detail::ChunkedDecoder dec(strm);
  7090. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7091. size_t total_len = 0;
  7092. for (;;) {
  7093. size_t chunk_offset = 0;
  7094. size_t chunk_total = 0;
  7095. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7096. if (n < 0) { return ReadContentResult::Error; }
  7097. if (n == 0) {
  7098. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7099. return ReadContentResult::Error;
  7100. }
  7101. return ReadContentResult::Success;
  7102. }
  7103. if (payload_max_length > 0 &&
  7104. (total_len > payload_max_length ||
  7105. payload_max_length - total_len < static_cast<size_t>(n))) {
  7106. return ReadContentResult::PayloadTooLarge;
  7107. }
  7108. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7109. return ReadContentResult::Error;
  7110. }
  7111. total_len += static_cast<size_t>(n);
  7112. }
  7113. }
  7114. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7115. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7116. // is the final transfer coding. A single field value may list several
  7117. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7118. // several Transfer-Encoding lines, which combine into one comma-separated
  7119. // list in the order the lines were received. Headers preserves that order,
  7120. // so the final coding is the last token of the last line. Match it
  7121. // case-insensitively rather than comparing the whole value against
  7122. // "chunked".
  7123. //
  7124. // Security: reading a chunked message as unframed leaves its body in the
  7125. // socket, where a keep-alive connection parses it as a smuggled request.
  7126. // Server::process_request() answers 400 and closes when the final coding is
  7127. // not chunked, so a request whose framing cannot be determined never
  7128. // reaches the "no body" path.
  7129. auto rng = headers.equal_range("Transfer-Encoding");
  7130. if (rng.first == rng.second) { return false; }
  7131. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7132. // combined list ending in nothing rather than inheriting the line before it.
  7133. std::string last_coding;
  7134. for (auto it = rng.first; it != rng.second; ++it) {
  7135. const auto &value = it->second;
  7136. last_coding.clear();
  7137. split(value.data(), value.data() + value.size(), ',',
  7138. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7139. }
  7140. return case_ignore::equal(last_coding, "chunked");
  7141. }
  7142. inline bool has_conflicting_content_length(const Headers &headers) {
  7143. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7144. // Content-Length is framed ambiguously. The body readers here delimit it by
  7145. // the transfer coding and drop Content-Length, while an intermediary may do
  7146. // the reverse, so the two disagree on where the body ends and a reused
  7147. // connection is desynchronised (request/response smuggling). Content-Length:
  7148. // 0 is tolerated for compatibility with existing peers.
  7149. return has_header(headers, "Transfer-Encoding") &&
  7150. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7151. }
  7152. template <typename T, typename U>
  7153. bool prepare_content_receiver(T &x, int &status,
  7154. ContentReceiverWithProgress receiver,
  7155. bool decompress, size_t payload_max_length,
  7156. bool &exceed_payload_max_length, U callback) {
  7157. if (decompress) {
  7158. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7159. std::unique_ptr<decompressor> decompressor;
  7160. if (!encoding.empty()) {
  7161. // A coding we know about but were not built with is an error. An
  7162. // unrecognized coding (including "identity") is left alone and the
  7163. // payload is passed through as-is, since some servers misuse the header,
  7164. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7165. decompressor = detail::create_decompressor(encoding);
  7166. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7167. status = StatusCode::UnsupportedMediaType_415;
  7168. return false;
  7169. }
  7170. }
  7171. if (decompressor) {
  7172. if (decompressor->is_valid()) {
  7173. size_t decompressed_size = 0;
  7174. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7175. size_t off, size_t len) {
  7176. return decompressor->decompress(
  7177. buf, n, [&](const char *buf2, size_t n2) {
  7178. // Guard against zip-bomb: check
  7179. // decompressed size against limit.
  7180. if (payload_max_length > 0 &&
  7181. (decompressed_size >= payload_max_length ||
  7182. n2 > payload_max_length - decompressed_size)) {
  7183. exceed_payload_max_length = true;
  7184. return false;
  7185. }
  7186. decompressed_size += n2;
  7187. return receiver(buf2, n2, off, len);
  7188. });
  7189. };
  7190. return callback(std::move(out));
  7191. } else {
  7192. status = StatusCode::InternalServerError_500;
  7193. return false;
  7194. }
  7195. }
  7196. }
  7197. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7198. size_t len) {
  7199. return receiver(buf, n, off, len);
  7200. };
  7201. return callback(std::move(out));
  7202. }
  7203. template <typename T>
  7204. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7205. DownloadProgress progress,
  7206. ContentReceiverWithProgress receiver, bool decompress) {
  7207. bool exceed_payload_max_length = false;
  7208. return prepare_content_receiver(
  7209. x, status, std::move(receiver), decompress, payload_max_length,
  7210. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7211. auto ret = true;
  7212. // Note: exceed_payload_max_length may also be set by the decompressor
  7213. // wrapper in prepare_content_receiver when the decompressed payload
  7214. // size exceeds the limit.
  7215. if (is_chunked_transfer_encoding(x.headers)) {
  7216. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7217. if (result == ReadContentResult::Success) {
  7218. ret = true;
  7219. } else if (result == ReadContentResult::PayloadTooLarge) {
  7220. exceed_payload_max_length = true;
  7221. ret = false;
  7222. } else {
  7223. ret = false;
  7224. }
  7225. } else if (!has_header(x.headers, "Content-Length")) {
  7226. auto result =
  7227. read_content_without_length(strm, payload_max_length, out);
  7228. if (result == ReadContentResult::Success) {
  7229. ret = true;
  7230. } else if (result == ReadContentResult::PayloadTooLarge) {
  7231. exceed_payload_max_length = true;
  7232. ret = false;
  7233. } else {
  7234. ret = false;
  7235. }
  7236. } else {
  7237. auto is_invalid_value = false;
  7238. auto len = get_header_value_u64(x.headers, "Content-Length",
  7239. (std::numeric_limits<size_t>::max)(),
  7240. 0, is_invalid_value);
  7241. if (is_invalid_value) {
  7242. ret = false;
  7243. } else if (len > 0) {
  7244. auto result = read_content_with_length(
  7245. strm, len, std::move(progress), out, payload_max_length);
  7246. ret = (result == ReadContentResult::Success);
  7247. if (result == ReadContentResult::PayloadTooLarge) {
  7248. exceed_payload_max_length = true;
  7249. }
  7250. }
  7251. }
  7252. if (!ret) {
  7253. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7254. : StatusCode::BadRequest_400;
  7255. }
  7256. return ret;
  7257. });
  7258. }
  7259. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7260. const std::string &path) {
  7261. // Neither the method nor the request target may carry CR/LF, SP or other
  7262. // control octets; otherwise a value smuggled into either splits the request
  7263. // line and injects headers or a whole request.
  7264. if (!fields::is_token(method)) { return -1; }
  7265. if (!fields::is_request_target(path)) { return -1; }
  7266. std::string s = method;
  7267. s += ' ';
  7268. s += path;
  7269. s += " HTTP/1.1\r\n";
  7270. return strm.write(s.data(), s.size());
  7271. }
  7272. inline ssize_t write_response_line(Stream &strm, int status) {
  7273. std::string s = "HTTP/1.1 ";
  7274. s += std::to_string(status);
  7275. s += ' ';
  7276. s += httplib::status_message(status);
  7277. s += "\r\n";
  7278. return strm.write(s.data(), s.size());
  7279. }
  7280. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7281. ssize_t write_len = 0;
  7282. for (const auto &x : headers) {
  7283. // Skip fields with invalid names or values to prevent response splitting
  7284. // via CR/LF injection, matching set_header(). The client validates request
  7285. // headers up front in check_and_write_headers, but the server passes
  7286. // res.headers straight to this writer, and res.headers is a public field
  7287. // an application can populate directly with request-derived values.
  7288. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7289. std::string s;
  7290. s = x.first;
  7291. s += ": ";
  7292. s += x.second;
  7293. s += "\r\n";
  7294. auto len = strm.write(s.data(), s.size());
  7295. if (len < 0) { return len; }
  7296. write_len += len;
  7297. }
  7298. auto len = strm.write("\r\n");
  7299. if (len < 0) { return len; }
  7300. write_len += len;
  7301. return write_len;
  7302. }
  7303. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7304. size_t offset = 0;
  7305. while (offset < l) {
  7306. auto length = strm.write(d + offset, l - offset);
  7307. if (length < 0) { return false; }
  7308. offset += static_cast<size_t>(length);
  7309. }
  7310. return true;
  7311. }
  7312. template <typename T>
  7313. inline bool write_content_with_progress(Stream &strm,
  7314. const ContentProvider &content_provider,
  7315. size_t offset, size_t length,
  7316. T is_shutting_down,
  7317. const UploadProgress &upload_progress,
  7318. Error &error) {
  7319. size_t end_offset = offset + length;
  7320. size_t start_offset = offset;
  7321. auto ok = true;
  7322. auto finished = false;
  7323. DataSink data_sink;
  7324. data_sink.write = [&](const char *d, size_t l) -> bool {
  7325. if (ok) {
  7326. if (write_data(strm, d, l)) {
  7327. offset += l;
  7328. if (upload_progress && length > 0) {
  7329. size_t current_written = offset - start_offset;
  7330. if (!upload_progress(current_written, length)) {
  7331. ok = false;
  7332. return false;
  7333. }
  7334. }
  7335. } else {
  7336. ok = false;
  7337. }
  7338. }
  7339. return ok;
  7340. };
  7341. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7342. // The body is framed by `length`, so a provider that reports itself done
  7343. // early has truncated it. Record that and let the short-body check below
  7344. // fail the write, rather than calling the provider again forever.
  7345. data_sink.done = [&]() { finished = true; };
  7346. while (offset < end_offset && !finished && !is_shutting_down()) {
  7347. auto last_offset = offset;
  7348. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7349. error = Error::Write;
  7350. return false;
  7351. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7352. error = Error::Canceled;
  7353. return false;
  7354. } else if (!ok) {
  7355. error = Error::Write;
  7356. return false;
  7357. }
  7358. // A provider that reports success without writing anything and without
  7359. // reporting itself done gets handed the same offset and length again on
  7360. // the next pass, so it would spin here for as long as the peer stays
  7361. // connected. Treat making no progress as a short body, like done() early.
  7362. if (!finished && offset == last_offset) {
  7363. error = Error::Write;
  7364. return false;
  7365. }
  7366. }
  7367. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7368. error = Error::Write;
  7369. return false;
  7370. }
  7371. error = Error::Success;
  7372. return true;
  7373. }
  7374. template <typename T>
  7375. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7376. size_t offset, size_t length, T is_shutting_down,
  7377. Error &error) {
  7378. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7379. is_shutting_down, nullptr, error);
  7380. }
  7381. template <typename T>
  7382. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7383. size_t offset, size_t length,
  7384. const T &is_shutting_down) {
  7385. auto error = Error::Success;
  7386. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7387. error);
  7388. }
  7389. template <typename T>
  7390. inline bool
  7391. write_content_without_length(Stream &strm,
  7392. const ContentProvider &content_provider,
  7393. const T &is_shutting_down) {
  7394. size_t offset = 0;
  7395. auto data_available = true;
  7396. auto ok = true;
  7397. DataSink data_sink;
  7398. data_sink.write = [&](const char *d, size_t l) -> bool {
  7399. if (ok) {
  7400. offset += l;
  7401. if (!write_data(strm, d, l)) { ok = false; }
  7402. }
  7403. return ok;
  7404. };
  7405. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7406. data_sink.done = [&](void) { data_available = false; };
  7407. while (data_available && !is_shutting_down()) {
  7408. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7409. return false;
  7410. } else if (!content_provider(offset, 0, data_sink)) {
  7411. return false;
  7412. } else if (!ok) {
  7413. return false;
  7414. }
  7415. }
  7416. return !data_available; // true only if done() was called, false if shutting
  7417. // down
  7418. }
  7419. // Runs a known-length content provider to completion and compresses what it
  7420. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7421. // by an mmap hands the compressor a pointer straight into the mapping.
  7422. inline bool compress_content_provider(const ContentProvider &content_provider,
  7423. size_t length, compressor &cmp,
  7424. std::string &out) {
  7425. size_t offset = 0;
  7426. auto ok = true;
  7427. auto finished = false;
  7428. DataSink data_sink;
  7429. auto append = [&](const char *data, size_t data_len) {
  7430. out.append(data, data_len);
  7431. return true;
  7432. };
  7433. data_sink.write = [&](const char *d, size_t l) -> bool {
  7434. if (!ok) { return false; }
  7435. offset += l;
  7436. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7437. return ok;
  7438. };
  7439. // The body is framed by `length`, so a provider that reports itself done
  7440. // early has truncated it; the short-body check below turns that into a
  7441. // failure rather than calling the provider again forever.
  7442. data_sink.done = [&]() { finished = true; };
  7443. while (offset < length && !finished) {
  7444. auto prev_offset = offset;
  7445. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7446. return false;
  7447. }
  7448. // No Stream to block on here, so a provider that keeps returning true
  7449. // without writing would spin. Treat a pass that made no progress as a
  7450. // failure.
  7451. if (offset == prev_offset) { return false; }
  7452. }
  7453. if (offset != length) { return false; }
  7454. return cmp.compress(nullptr, 0, true, append);
  7455. }
  7456. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7457. // and the file flag, so recording them has to come after; keeping all of it
  7458. // here means a third file-serving path cannot get that order wrong.
  7459. inline void set_file_content_provider(Response &res,
  7460. const std::shared_ptr<mmap> &m,
  7461. const std::string &content_type,
  7462. EncodingType encoding) {
  7463. res.set_content_provider(
  7464. m->size(), content_type,
  7465. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7466. // Never read past the mapping.
  7467. if (offset >= m->size()) { return false; }
  7468. sink.write(m->data() + offset, (std::min)(length, m->size() - offset));
  7469. return true;
  7470. });
  7471. res.is_file_content_provider_ = true;
  7472. res.content_coding_ = encoding;
  7473. }
  7474. template <typename T, typename U>
  7475. inline bool
  7476. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7477. const T &is_shutting_down, U &compressor, Error &error) {
  7478. size_t offset = 0;
  7479. auto data_available = true;
  7480. auto ok = true;
  7481. DataSink data_sink;
  7482. data_sink.write = [&](const char *d, size_t l) -> bool {
  7483. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7484. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7485. // zero-length chunk is the terminator, so it must not be emitted here.
  7486. if (ok && l > 0) {
  7487. offset += l;
  7488. std::string payload;
  7489. if (compressor.compress(d, l, false,
  7490. [&](const char *data, size_t data_len) {
  7491. payload.append(data, data_len);
  7492. return true;
  7493. })) {
  7494. if (!payload.empty()) {
  7495. // Emit chunked response header and footer for each chunk
  7496. auto chunk =
  7497. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7498. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7499. }
  7500. } else {
  7501. ok = false;
  7502. }
  7503. }
  7504. return ok;
  7505. };
  7506. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7507. auto done_with_trailer = [&](const Headers *trailer) {
  7508. if (!ok) { return; }
  7509. data_available = false;
  7510. std::string payload;
  7511. if (!compressor.compress(nullptr, 0, true,
  7512. [&](const char *data, size_t data_len) {
  7513. payload.append(data, data_len);
  7514. return true;
  7515. })) {
  7516. ok = false;
  7517. return;
  7518. }
  7519. if (!payload.empty()) {
  7520. // Emit chunked response header and footer for each chunk
  7521. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7522. if (!write_data(strm, chunk.data(), chunk.size())) {
  7523. ok = false;
  7524. return;
  7525. }
  7526. }
  7527. constexpr const char done_marker[] = "0\r\n";
  7528. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7529. // Trailer
  7530. if (trailer) {
  7531. for (const auto &kv : *trailer) {
  7532. // Skip fields with invalid names or values to prevent response
  7533. // splitting via CR/LF injection, matching set_header().
  7534. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7535. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7536. if (!write_data(strm, field_line.data(), field_line.size())) {
  7537. ok = false;
  7538. }
  7539. }
  7540. }
  7541. constexpr const char crlf[] = "\r\n";
  7542. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7543. };
  7544. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7545. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7546. done_with_trailer(&trailer);
  7547. };
  7548. while (data_available && !is_shutting_down()) {
  7549. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7550. error = Error::Write;
  7551. return false;
  7552. } else if (!content_provider(offset, 0, data_sink)) {
  7553. error = Error::Canceled;
  7554. return false;
  7555. } else if (!ok) {
  7556. error = Error::Write;
  7557. return false;
  7558. }
  7559. }
  7560. if (data_available) { // exited due to is_shutting_down(), not done()
  7561. error = Error::Write;
  7562. return false;
  7563. }
  7564. error = Error::Success;
  7565. return true;
  7566. }
  7567. template <typename T, typename U>
  7568. inline bool write_content_chunked(Stream &strm,
  7569. const ContentProvider &content_provider,
  7570. const T &is_shutting_down, U &compressor) {
  7571. auto error = Error::Success;
  7572. return write_content_chunked(strm, content_provider, is_shutting_down,
  7573. compressor, error);
  7574. }
  7575. template <typename T>
  7576. inline bool redirect(T &cli, Request &req, Response &res,
  7577. const std::string &path, const std::string &location,
  7578. Error &error) {
  7579. Request new_req = req;
  7580. new_req.path = path;
  7581. new_req.redirect_count_ -= 1;
  7582. if (res.status == StatusCode::SeeOther_303 &&
  7583. (req.method != "GET" && req.method != "HEAD")) {
  7584. new_req.method = "GET";
  7585. new_req.body.clear();
  7586. new_req.headers.clear();
  7587. new_req.content_length_ = 0;
  7588. new_req.content_provider_ = nullptr;
  7589. new_req.is_chunked_content_provider_ = false;
  7590. }
  7591. Response new_res;
  7592. auto ret = cli.send(new_req, new_res, error);
  7593. if (ret) {
  7594. req = std::move(new_req);
  7595. res = std::move(new_res);
  7596. if (res.location.empty()) { res.location = location; }
  7597. }
  7598. return ret;
  7599. }
  7600. inline std::string params_to_query_str(const Params &params) {
  7601. std::string query;
  7602. for (auto it = params.begin(); it != params.end(); ++it) {
  7603. if (it != params.begin()) { query += '&'; }
  7604. query += encode_query_component(it->first);
  7605. query += '=';
  7606. query += encode_query_component(it->second);
  7607. }
  7608. return query;
  7609. }
  7610. // Splits one "key=value" span of a query string at its first '='. A span with
  7611. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7612. // "?flag" keeps its name.
  7613. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7614. std::string &val) {
  7615. divide(b, static_cast<std::size_t>(e - b), '=',
  7616. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7617. std::size_t rhs_size) {
  7618. key.assign(lhs_data, lhs_size);
  7619. val.assign(rhs_data, rhs_size);
  7620. });
  7621. }
  7622. inline void parse_query_text(const char *data, std::size_t size,
  7623. Params &params) {
  7624. std::set<std::string> cache;
  7625. split(data, data + size, '&', [&](const char *b, const char *e) {
  7626. std::string kv(b, e);
  7627. if (cache.find(kv) != cache.end()) { return; }
  7628. cache.insert(std::move(kv));
  7629. std::string key;
  7630. std::string val;
  7631. divide_query_pair(b, e, key, val);
  7632. if (!key.empty()) {
  7633. params.emplace(decode_query_component(key), decode_query_component(val));
  7634. }
  7635. });
  7636. }
  7637. inline void parse_query_text(const std::string &s, Params &params) {
  7638. parse_query_text(s.data(), s.size(), params);
  7639. }
  7640. // Normalize a query string by decoding and re-encoding each key/value pair
  7641. // while preserving the original parameter order. This avoids double-encoding
  7642. // and ensures consistent encoding. It works on the raw string rather than
  7643. // parsing into Params and re-serializing, because that round trip cannot
  7644. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7645. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7646. // duplicated pairs.
  7647. inline std::string normalize_query_string(const std::string &query) {
  7648. std::string result;
  7649. split(query.data(), query.data() + query.size(), '&',
  7650. [&](const char *b, const char *e) {
  7651. std::string key;
  7652. std::string val;
  7653. divide_query_pair(b, e, key, val);
  7654. if (!key.empty()) {
  7655. auto dec_key = decode_query_component(key);
  7656. auto dec_val = decode_query_component(val);
  7657. if (!result.empty()) { result += '&'; }
  7658. result += encode_query_component(dec_key);
  7659. if (!val.empty() || std::find(b, e, '=') != e) {
  7660. result += '=';
  7661. result += encode_query_component(dec_val);
  7662. }
  7663. }
  7664. });
  7665. return result;
  7666. }
  7667. // Build the request target that goes on the wire from a caller-supplied path.
  7668. // Shared by the buffered send path and the streaming API so that both put the
  7669. // same bytes in the request line for the same input.
  7670. inline std::string encode_request_target(const std::string &target,
  7671. bool path_encode) {
  7672. // `substr(0, npos)` yields the whole string, which is what the no-query
  7673. // case needs.
  7674. auto query_pos = target.find('?');
  7675. auto path_part = target.substr(0, query_pos);
  7676. std::string query_part;
  7677. if (query_pos != std::string::npos) {
  7678. query_part = target.substr(query_pos + 1);
  7679. }
  7680. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7681. if (!query_part.empty()) {
  7682. // When path encoding is disabled the caller has supplied an already-encoded
  7683. // target and expects the exact bytes to be sent on the wire, so skip
  7684. // normalization for the query too. Normalizing would decode-then-re-encode
  7685. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7686. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7687. if (path_encode) {
  7688. auto normalized = normalize_query_string(query_part);
  7689. if (!normalized.empty()) {
  7690. result += '?';
  7691. result += normalized;
  7692. }
  7693. } else {
  7694. result += '?';
  7695. result += query_part;
  7696. }
  7697. }
  7698. return result;
  7699. }
  7700. inline bool parse_multipart_boundary(const std::string &content_type,
  7701. std::string &boundary) {
  7702. std::map<std::string, std::string> params;
  7703. extract_media_type(content_type, &params);
  7704. auto it = params.find("boundary");
  7705. if (it == params.end()) { return false; }
  7706. boundary = it->second;
  7707. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7708. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7709. // bytes costs a nearly full comparison at nearly every position: the
  7710. // boundary's length multiplies the worst-case cost of scanning a body.
  7711. return !boundary.empty() && boundary.size() <= 70;
  7712. }
  7713. inline void parse_disposition_params(const std::string &s, Params &params) {
  7714. std::set<std::string> cache;
  7715. split_unquoted(s.data(), s.data() + s.size(), ';',
  7716. [&](const char *b, const char *e) {
  7717. std::string kv(b, e);
  7718. if (cache.find(kv) != cache.end()) { return; }
  7719. cache.insert(kv);
  7720. std::string key;
  7721. std::string val;
  7722. divide_param_pair(b, e, key, val);
  7723. if (!key.empty()) {
  7724. params.emplace(trim_double_quotes_copy(key),
  7725. trim_double_quotes_copy(val));
  7726. }
  7727. });
  7728. }
  7729. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7730. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7731. #else
  7732. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7733. #endif
  7734. auto is_valid = [](const std::string &str) {
  7735. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7736. };
  7737. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7738. const auto pos = static_cast<size_t>(6);
  7739. const auto len = static_cast<size_t>(s.size() - 6);
  7740. auto all_valid_ranges = true;
  7741. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7742. if (!all_valid_ranges) { return; }
  7743. const auto it = std::find(b, e, '-');
  7744. if (it == e) {
  7745. all_valid_ranges = false;
  7746. return;
  7747. }
  7748. const auto lhs = std::string(b, it);
  7749. const auto rhs = std::string(it + 1, e);
  7750. if (!is_valid(lhs) || !is_valid(rhs)) {
  7751. all_valid_ranges = false;
  7752. return;
  7753. }
  7754. ssize_t first = -1;
  7755. if (!lhs.empty()) {
  7756. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7757. // would turn the range into a suffix range.
  7758. auto res =
  7759. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7760. if (res.ec != std::errc{}) {
  7761. all_valid_ranges = false;
  7762. return;
  7763. }
  7764. }
  7765. ssize_t last = -1;
  7766. if (!rhs.empty()) {
  7767. // An overflowing last-byte-pos is past any content length, so keeping
  7768. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7769. ssize_t v;
  7770. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7771. if (res.ec == std::errc{}) { last = v; }
  7772. }
  7773. if ((first == -1 && last == -1) ||
  7774. (first != -1 && last != -1 && first > last)) {
  7775. all_valid_ranges = false;
  7776. return;
  7777. }
  7778. ranges.emplace_back(first, last);
  7779. });
  7780. return all_valid_ranges && !ranges.empty();
  7781. }
  7782. return false;
  7783. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7784. }
  7785. #else
  7786. } catch (...) { return false; }
  7787. #endif
  7788. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7789. inline std::string remove_quoted_strings(const std::string &s) {
  7790. std::string out;
  7791. auto in_quotes = false;
  7792. for (size_t i = 0; i < s.size(); i++) {
  7793. if (s[i] == '"') {
  7794. in_quotes = !in_quotes;
  7795. } else if (!in_quotes) {
  7796. out += s[i];
  7797. } else if (s[i] == '\\') {
  7798. i++;
  7799. }
  7800. }
  7801. return out;
  7802. }
  7803. inline bool parse_accept_header(const std::string &s,
  7804. std::vector<std::string> &content_types) {
  7805. // Parameter values are not used here, so a quoted-string is dropped rather
  7806. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7807. if (s.find('"') != std::string::npos) {
  7808. return parse_accept_header(remove_quoted_strings(s), content_types);
  7809. }
  7810. content_types.clear();
  7811. // Empty string is considered valid (no preference)
  7812. if (s.empty()) { return true; }
  7813. struct AcceptEntry {
  7814. std::string media_type;
  7815. double quality;
  7816. int order;
  7817. };
  7818. std::vector<AcceptEntry> entries;
  7819. int order = 0;
  7820. bool has_invalid_entry = false;
  7821. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7822. // has to parse and ignore empty list elements, so a leading, trailing or
  7823. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7824. // split() skips them, and the header length limit bounds how many a sender
  7825. // can send, so ignoring all of them cannot be used as a denial-of-service
  7826. // vector.
  7827. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7828. std::string entry(b, e);
  7829. entry = trim_copy(entry);
  7830. AcceptEntry accept_entry;
  7831. accept_entry.order = order++;
  7832. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7833. accept_entry.media_type, accept_entry.quality)) {
  7834. has_invalid_entry = true;
  7835. return;
  7836. }
  7837. // Remove additional parameters from media type
  7838. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7839. // Basic validation of media type format
  7840. if (accept_entry.media_type.empty()) {
  7841. has_invalid_entry = true;
  7842. return;
  7843. }
  7844. // Check for basic media type format (should contain '/' or be '*')
  7845. if (accept_entry.media_type != "*" &&
  7846. accept_entry.media_type.find('/') == std::string::npos) {
  7847. has_invalid_entry = true;
  7848. return;
  7849. }
  7850. entries.push_back(std::move(accept_entry));
  7851. });
  7852. // Return false if any invalid entry was found
  7853. if (has_invalid_entry) { return false; }
  7854. // Sort by quality (descending), then by original order (ascending)
  7855. std::sort(entries.begin(), entries.end(),
  7856. [](const AcceptEntry &a, const AcceptEntry &b) {
  7857. if (a.quality != b.quality) {
  7858. return a.quality > b.quality; // Higher quality first
  7859. }
  7860. return a.order < b.order; // Earlier order first for same quality
  7861. });
  7862. // Extract sorted media types
  7863. content_types.reserve(entries.size());
  7864. for (auto &entry : entries) {
  7865. content_types.push_back(std::move(entry.media_type));
  7866. }
  7867. return true;
  7868. }
  7869. class FormDataParser {
  7870. public:
  7871. FormDataParser() = default;
  7872. void set_boundary(std::string &&boundary) {
  7873. boundary_ = std::move(boundary);
  7874. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7875. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7876. }
  7877. bool is_valid() const { return is_valid_; }
  7878. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7879. const ContentReceiver &content_callback) {
  7880. // Once the close delimiter has been seen the rest of the body is epilogue
  7881. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7882. // spread across reads is not copied in only to be erased right away.
  7883. if (state_ == 5) { return true; }
  7884. buf_append(buf, n);
  7885. while (buf_size() > 0) {
  7886. switch (state_) {
  7887. case 0: { // Initial boundary
  7888. auto pos = buf_find(dash_boundary_crlf_);
  7889. if (pos == buf_size()) {
  7890. // Not found yet: keep only a possible partial boundary at the tail so
  7891. // that a body which never contains the boundary cannot grow the
  7892. // buffer (and get rescanned from the start) without bound.
  7893. auto keep = dash_boundary_crlf_.size() - 1;
  7894. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7895. return true;
  7896. }
  7897. buf_erase(pos + dash_boundary_crlf_.size());
  7898. state_ = 1;
  7899. break;
  7900. }
  7901. case 1: { // New entry
  7902. clear_file_info();
  7903. state_ = 2;
  7904. break;
  7905. }
  7906. case 2: { // Headers
  7907. auto pos = buf_find(crlf_);
  7908. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7909. while (pos < buf_size()) {
  7910. // Empty line
  7911. if (pos == 0) {
  7912. if (!header_callback(file_)) {
  7913. is_valid_ = false;
  7914. return false;
  7915. }
  7916. buf_erase(crlf_.size());
  7917. state_ = 3;
  7918. break;
  7919. }
  7920. // Check header count limit
  7921. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7922. is_valid_ = false;
  7923. return false;
  7924. }
  7925. header_count_++;
  7926. const auto header = buf_head(pos);
  7927. if (!parse_header(header.data(), header.data() + header.size(),
  7928. [&](const std::string &, const std::string &) {})) {
  7929. is_valid_ = false;
  7930. return false;
  7931. }
  7932. // Parse and emplace space trimmed headers into a map
  7933. if (!parse_header(
  7934. header.data(), header.data() + header.size(),
  7935. [&](const std::string &key, const std::string &val) {
  7936. file_.headers.emplace(key, val);
  7937. })) {
  7938. is_valid_ = false;
  7939. return false;
  7940. }
  7941. constexpr const char header_content_type[] = "Content-Type:";
  7942. if (start_with_case_ignore(header, header_content_type)) {
  7943. file_.content_type =
  7944. trim_copy(header.substr(str_len(header_content_type)));
  7945. } else {
  7946. std::string disposition_params;
  7947. if (parse_content_disposition(header, disposition_params)) {
  7948. Params params;
  7949. parse_disposition_params(disposition_params, params);
  7950. auto it = params.find("name");
  7951. if (it != params.end()) {
  7952. file_.name = it->second;
  7953. } else {
  7954. is_valid_ = false;
  7955. return false;
  7956. }
  7957. it = params.find("filename");
  7958. if (it != params.end()) { file_.filename = it->second; }
  7959. it = params.find("filename*");
  7960. if (it != params.end()) {
  7961. // RFC 5987: only UTF-8 encoding is allowed
  7962. const auto &val = it->second;
  7963. constexpr const char utf8_prefix[] = "UTF-8''";
  7964. constexpr size_t prefix_len = str_len(utf8_prefix);
  7965. if (val.size() > prefix_len &&
  7966. start_with_case_ignore(val, utf8_prefix)) {
  7967. file_.filename = decode_path_component(
  7968. val.substr(prefix_len)); // override...
  7969. } else {
  7970. is_valid_ = false;
  7971. return false;
  7972. }
  7973. }
  7974. }
  7975. }
  7976. buf_erase(pos + crlf_.size());
  7977. pos = buf_find(crlf_);
  7978. }
  7979. if (state_ != 3) { return true; }
  7980. break;
  7981. }
  7982. case 3: { // Body
  7983. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7984. auto pos = buf_find(crlf_dash_boundary_);
  7985. if (pos < buf_size()) {
  7986. if (!content_callback(buf_data(), pos)) {
  7987. is_valid_ = false;
  7988. return false;
  7989. }
  7990. buf_erase(pos + crlf_dash_boundary_.size());
  7991. state_ = 4;
  7992. } else {
  7993. auto len = buf_size() - crlf_dash_boundary_.size();
  7994. if (len > 0) {
  7995. if (!content_callback(buf_data(), len)) {
  7996. is_valid_ = false;
  7997. return false;
  7998. }
  7999. buf_erase(len);
  8000. }
  8001. return true;
  8002. }
  8003. break;
  8004. }
  8005. case 4: { // Boundary
  8006. if (crlf_.size() > buf_size()) { return true; }
  8007. if (buf_start_with(crlf_)) {
  8008. buf_erase(crlf_.size());
  8009. state_ = 1;
  8010. } else if (buf_start_with(dash_)) {
  8011. buf_erase(dash_.size());
  8012. is_valid_ = true;
  8013. state_ = 5;
  8014. } else {
  8015. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8016. // accepted after a boundary; RFC 2046 allows transport-padding in
  8017. // between, but this parser has never supported it. Either way the
  8018. // body is already destined to be rejected, so fail now instead of
  8019. // buffering the rest of it. Both are two bytes, so the check above
  8020. // already guarantees enough buffered data to decide.
  8021. is_valid_ = false;
  8022. return false;
  8023. }
  8024. break;
  8025. }
  8026. case 5: { // Epilogue
  8027. buf_erase(buf_size());
  8028. break;
  8029. }
  8030. }
  8031. }
  8032. return true;
  8033. }
  8034. private:
  8035. void clear_file_info() {
  8036. file_.name.clear();
  8037. file_.filename.clear();
  8038. file_.content_type.clear();
  8039. file_.headers.clear();
  8040. header_count_ = 0;
  8041. }
  8042. bool start_with_case_ignore(const std::string &a, const char *b,
  8043. size_t offset = 0) const {
  8044. const auto b_len = strlen(b);
  8045. if (a.size() < offset + b_len) { return false; }
  8046. for (size_t i = 0; i < b_len; i++) {
  8047. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8048. return false;
  8049. }
  8050. }
  8051. return true;
  8052. }
  8053. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8054. // Returns true if header matches, with the params portion in `params_out`.
  8055. bool parse_content_disposition(const std::string &header,
  8056. std::string &params_out) const {
  8057. constexpr const char prefix[] = "Content-Disposition:";
  8058. constexpr size_t prefix_len = str_len(prefix);
  8059. if (!start_with_case_ignore(header, prefix)) { return false; }
  8060. // Skip whitespace after "Content-Disposition:"
  8061. auto pos = prefix_len;
  8062. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8063. pos++;
  8064. }
  8065. // Match "form-data;" (case-insensitive)
  8066. constexpr const char form_data[] = "form-data;";
  8067. constexpr size_t form_data_len = str_len(form_data);
  8068. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8069. pos += form_data_len;
  8070. // Skip whitespace after "form-data;"
  8071. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8072. pos++;
  8073. }
  8074. params_out = header.substr(pos);
  8075. return true;
  8076. }
  8077. const std::string dash_ = "--";
  8078. const std::string crlf_ = "\r\n";
  8079. std::string boundary_;
  8080. std::string dash_boundary_crlf_;
  8081. std::string crlf_dash_boundary_;
  8082. size_t state_ = 0;
  8083. bool is_valid_ = false;
  8084. FormData file_;
  8085. size_t header_count_ = 0;
  8086. // Buffer
  8087. bool start_with(const std::string &a, size_t spos, size_t epos,
  8088. const std::string &b) const {
  8089. if (epos - spos < b.size()) { return false; }
  8090. for (size_t i = 0; i < b.size(); i++) {
  8091. if (a[i + spos] != b[i]) { return false; }
  8092. }
  8093. return true;
  8094. }
  8095. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8096. const char *buf_data() const { return &buf_[buf_spos_]; }
  8097. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8098. bool buf_start_with(const std::string &s) const {
  8099. return start_with(buf_, buf_spos_, buf_epos_, s);
  8100. }
  8101. size_t buf_find(const std::string &s) const {
  8102. auto c = s.front();
  8103. size_t off = buf_spos_;
  8104. while (off < buf_epos_) {
  8105. auto pos = off;
  8106. while (true) {
  8107. if (pos == buf_epos_) { return buf_size(); }
  8108. if (buf_[pos] == c) { break; }
  8109. pos++;
  8110. }
  8111. auto remaining_size = buf_epos_ - pos;
  8112. if (s.size() > remaining_size) { return buf_size(); }
  8113. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8114. off = pos + 1;
  8115. }
  8116. return buf_size();
  8117. }
  8118. void buf_append(const char *data, size_t n) {
  8119. auto remaining_size = buf_size();
  8120. if (remaining_size > 0 && buf_spos_ > 0) {
  8121. for (size_t i = 0; i < remaining_size; i++) {
  8122. buf_[i] = buf_[buf_spos_ + i];
  8123. }
  8124. }
  8125. buf_spos_ = 0;
  8126. buf_epos_ = remaining_size;
  8127. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8128. for (size_t i = 0; i < n; i++) {
  8129. buf_[buf_epos_ + i] = data[i];
  8130. }
  8131. buf_epos_ += n;
  8132. }
  8133. void buf_erase(size_t size) { buf_spos_ += size; }
  8134. std::string buf_;
  8135. size_t buf_spos_ = 0;
  8136. size_t buf_epos_ = 0;
  8137. };
  8138. inline std::string random_string(size_t length) {
  8139. constexpr const char data[] =
  8140. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8141. std::string result(length, '\0');
  8142. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8143. for (auto &c : result) {
  8144. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8145. }
  8146. return result;
  8147. }
  8148. inline std::string make_multipart_data_boundary() {
  8149. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8150. }
  8151. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8152. auto valid = true;
  8153. for (size_t i = 0; i < boundary.size(); i++) {
  8154. auto c = boundary[i];
  8155. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8156. valid = false;
  8157. break;
  8158. }
  8159. }
  8160. return valid;
  8161. }
  8162. // Escape a multipart field name/filename following the WHATWG HTML standard
  8163. // ("escape a multipart form-data name"), which is what browsers send:
  8164. // '"' -> %22, CR -> %0D, LF -> %0A
  8165. // With escape_quote = false, only CR and LF are escaped; this is for header
  8166. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8167. inline std::string escape_multipart_field(const std::string &s,
  8168. bool escape_quote = true) {
  8169. std::string result;
  8170. result.reserve(s.size());
  8171. for (auto c : s) {
  8172. switch (c) {
  8173. case '"':
  8174. if (escape_quote) {
  8175. result += "%22";
  8176. } else {
  8177. result += c;
  8178. }
  8179. break;
  8180. case '\r': result += "%0D"; break;
  8181. case '\n': result += "%0A"; break;
  8182. default: result += c; break;
  8183. }
  8184. }
  8185. return result;
  8186. }
  8187. template <typename T>
  8188. inline std::string
  8189. serialize_multipart_formdata_item_begin(const T &item,
  8190. const std::string &boundary) {
  8191. std::string body = "--" + boundary + "\r\n";
  8192. body += "Content-Disposition: form-data; name=\"" +
  8193. escape_multipart_field(item.name) + "\"";
  8194. if (!item.filename.empty()) {
  8195. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8196. }
  8197. body += "\r\n";
  8198. if (!item.content_type.empty()) {
  8199. body +=
  8200. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8201. "\r\n";
  8202. }
  8203. body += "\r\n";
  8204. return body;
  8205. }
  8206. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8207. inline std::string
  8208. serialize_multipart_formdata_finish(const std::string &boundary) {
  8209. return "--" + boundary + "--\r\n";
  8210. }
  8211. inline std::string
  8212. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8213. return "multipart/form-data; boundary=" + boundary;
  8214. }
  8215. inline std::string
  8216. serialize_multipart_formdata(const UploadFormDataItems &items,
  8217. const std::string &boundary, bool finish = true) {
  8218. std::string body;
  8219. for (const auto &item : items) {
  8220. body += serialize_multipart_formdata_item_begin(item, boundary);
  8221. body += item.content + serialize_multipart_formdata_item_end();
  8222. }
  8223. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8224. return body;
  8225. }
  8226. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8227. const std::string &boundary) {
  8228. size_t total = 0;
  8229. for (const auto &item : items) {
  8230. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8231. total += item.content.size();
  8232. total += serialize_multipart_formdata_item_end().size();
  8233. }
  8234. total += serialize_multipart_formdata_finish(boundary).size();
  8235. return total;
  8236. }
  8237. struct MultipartSegment {
  8238. const char *data;
  8239. size_t size;
  8240. };
  8241. // NOTE: items must outlive the returned ContentProvider
  8242. // (safe for synchronous use inside Post/Put/Patch)
  8243. inline ContentProvider
  8244. make_multipart_content_provider(const UploadFormDataItems &items,
  8245. const std::string &boundary) {
  8246. // Own the per-item header strings and the finish string
  8247. std::vector<std::string> owned;
  8248. owned.reserve(items.size() + 1);
  8249. for (const auto &item : items)
  8250. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8251. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8252. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8253. std::vector<MultipartSegment> segs;
  8254. segs.reserve(items.size() * 3 + 1);
  8255. static const char crlf[] = "\r\n";
  8256. for (size_t i = 0; i < items.size(); i++) {
  8257. segs.push_back({owned[i].data(), owned[i].size()});
  8258. segs.push_back({items[i].content.data(), items[i].content.size()});
  8259. segs.push_back({crlf, 2});
  8260. }
  8261. segs.push_back({owned.back().data(), owned.back().size()});
  8262. struct MultipartState {
  8263. std::vector<std::string> owned;
  8264. std::vector<MultipartSegment> segs;
  8265. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8266. };
  8267. auto state = std::make_shared<MultipartState>();
  8268. state->owned = std::move(owned);
  8269. // `segs` holds raw pointers into owned strings; std::string move preserves
  8270. // the data pointer, so these pointers remain valid after the move above.
  8271. state->segs = std::move(segs);
  8272. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8273. // Buffer multiple small segments into fewer, larger writes to avoid
  8274. // excessive TCP packets when there are many form data items (#2410)
  8275. auto &buf = state->buf;
  8276. auto buf_size = buf.size();
  8277. size_t buf_len = 0;
  8278. size_t remaining = length;
  8279. // Find the first segment containing 'offset'
  8280. size_t pos = 0;
  8281. size_t seg_idx = 0;
  8282. for (; seg_idx < state->segs.size(); seg_idx++) {
  8283. const auto &seg = state->segs[seg_idx];
  8284. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8285. pos += seg.size;
  8286. }
  8287. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8288. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8289. const auto &seg = state->segs[seg_idx];
  8290. size_t available = seg.size - seg_offset;
  8291. size_t to_copy = (std::min)(available, remaining);
  8292. const char *src = seg.data + seg_offset;
  8293. seg_offset = 0; // only the first segment has a non-zero offset
  8294. while (to_copy > 0) {
  8295. size_t space = buf_size - buf_len;
  8296. size_t chunk = (std::min)(to_copy, space);
  8297. std::memcpy(buf.data() + buf_len, src, chunk);
  8298. buf_len += chunk;
  8299. src += chunk;
  8300. to_copy -= chunk;
  8301. remaining -= chunk;
  8302. if (buf_len == buf_size) {
  8303. if (!sink.write(buf.data(), buf_len)) { return false; }
  8304. buf_len = 0;
  8305. }
  8306. }
  8307. }
  8308. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8309. return true;
  8310. };
  8311. }
  8312. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8313. if (ranges.size() <= 1) return;
  8314. // Sort ranges by start position
  8315. std::sort(ranges.begin(), ranges.end(),
  8316. [](const Range &a, const Range &b) { return a.first < b.first; });
  8317. Ranges coalesced;
  8318. coalesced.reserve(ranges.size());
  8319. for (auto &r : ranges) {
  8320. auto first_pos = r.first;
  8321. auto last_pos = r.second;
  8322. // Handle special cases like in range_error
  8323. if (first_pos == -1 && last_pos == -1) {
  8324. first_pos = 0;
  8325. last_pos = static_cast<ssize_t>(content_length);
  8326. }
  8327. if (first_pos == -1) {
  8328. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8329. last_pos = static_cast<ssize_t>(content_length) - 1;
  8330. }
  8331. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8332. last_pos = static_cast<ssize_t>(content_length) - 1;
  8333. }
  8334. // Skip invalid ranges
  8335. if (!(0 <= first_pos && first_pos <= last_pos &&
  8336. last_pos < static_cast<ssize_t>(content_length))) {
  8337. continue;
  8338. }
  8339. // Coalesce with previous range if overlapping or adjacent (but not
  8340. // identical)
  8341. if (!coalesced.empty()) {
  8342. auto &prev = coalesced.back();
  8343. // Check if current range overlaps or is adjacent to previous range
  8344. // but don't coalesce identical ranges (allow duplicates)
  8345. if (first_pos <= prev.second + 1 &&
  8346. !(first_pos == prev.first && last_pos == prev.second)) {
  8347. // Extend the previous range
  8348. prev.second = (std::max)(prev.second, last_pos);
  8349. continue;
  8350. }
  8351. }
  8352. // Add new range
  8353. coalesced.emplace_back(first_pos, last_pos);
  8354. }
  8355. ranges = std::move(coalesced);
  8356. }
  8357. inline bool range_error(Request &req, Response &res) {
  8358. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8359. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8360. req.ranges.clear();
  8361. if (res.status == StatusCode::PartialContent_206) {
  8362. res.status = StatusCode::OK_200;
  8363. }
  8364. return false;
  8365. }
  8366. ssize_t content_len = static_cast<ssize_t>(
  8367. res.content_length_ ? res.content_length_ : res.body.size());
  8368. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8369. size_t overwrapping_count = 0;
  8370. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8371. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8372. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8373. // Too many ranges
  8374. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8375. for (auto &r : req.ranges) {
  8376. auto &first_pos = r.first;
  8377. auto &last_pos = r.second;
  8378. if (first_pos == -1 && last_pos == -1) {
  8379. first_pos = 0;
  8380. last_pos = content_len;
  8381. }
  8382. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8383. // selects the entire representation.
  8384. if (first_pos == -1) {
  8385. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8386. last_pos = content_len - 1;
  8387. }
  8388. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8389. // A client can limit the number of bytes requested without knowing the
  8390. // size of the selected representation. If the last-pos value is absent,
  8391. // or if the value is greater than or equal to the current length of the
  8392. // representation data, the byte range is interpreted as the remainder of
  8393. // the representation (i.e., the server replaces the value of last-pos
  8394. // with a value that is one less than the current length of the selected
  8395. // representation).
  8396. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8397. if (last_pos == -1 || last_pos >= content_len) {
  8398. last_pos = content_len - 1;
  8399. }
  8400. // Range must be within content length
  8401. if (!(0 <= first_pos && first_pos <= last_pos &&
  8402. last_pos <= content_len - 1)) {
  8403. return true;
  8404. }
  8405. // Request must not have more than two overlapping ranges
  8406. for (const auto &processed_range : processed_ranges) {
  8407. if (!(last_pos < processed_range.first ||
  8408. first_pos > processed_range.second)) {
  8409. overwrapping_count++;
  8410. if (overwrapping_count > 2) { return true; }
  8411. break; // Only count once per range
  8412. }
  8413. }
  8414. processed_ranges.emplace_back(first_pos, last_pos);
  8415. }
  8416. // After validation, coalesce overlapping ranges as per RFC 9110
  8417. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8418. }
  8419. return false;
  8420. }
  8421. inline std::pair<size_t, size_t>
  8422. get_range_offset_and_length(Range r, size_t content_length) {
  8423. assert(r.first != -1 && r.second != -1);
  8424. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8425. assert(r.first <= r.second &&
  8426. r.second < static_cast<ssize_t>(content_length));
  8427. (void)(content_length);
  8428. return std::make_pair(static_cast<size_t>(r.first),
  8429. static_cast<size_t>(r.second - r.first) + 1);
  8430. }
  8431. inline std::string make_content_range_header_field(
  8432. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8433. auto st = offset_and_length.first;
  8434. auto ed = st + offset_and_length.second - 1;
  8435. std::string field = "bytes ";
  8436. field += std::to_string(st);
  8437. field += '-';
  8438. field += std::to_string(ed);
  8439. field += '/';
  8440. field += std::to_string(content_length);
  8441. return field;
  8442. }
  8443. template <typename SToken, typename CToken, typename Content>
  8444. bool process_multipart_ranges_data(const Request &req,
  8445. const std::string &boundary,
  8446. const std::string &content_type,
  8447. size_t content_length, SToken stoken,
  8448. CToken ctoken, Content content) {
  8449. for (size_t i = 0; i < req.ranges.size(); i++) {
  8450. ctoken("--");
  8451. stoken(boundary);
  8452. ctoken("\r\n");
  8453. if (!content_type.empty()) {
  8454. ctoken("Content-Type: ");
  8455. stoken(content_type);
  8456. ctoken("\r\n");
  8457. }
  8458. auto offset_and_length =
  8459. get_range_offset_and_length(req.ranges[i], content_length);
  8460. ctoken("Content-Range: ");
  8461. stoken(make_content_range_header_field(offset_and_length, content_length));
  8462. ctoken("\r\n");
  8463. ctoken("\r\n");
  8464. if (!content(offset_and_length.first, offset_and_length.second)) {
  8465. return false;
  8466. }
  8467. ctoken("\r\n");
  8468. }
  8469. ctoken("--");
  8470. stoken(boundary);
  8471. ctoken("--");
  8472. return true;
  8473. }
  8474. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8475. const std::string &boundary,
  8476. const std::string &content_type,
  8477. size_t content_length,
  8478. std::string &data) {
  8479. process_multipart_ranges_data(
  8480. req, boundary, content_type, content_length,
  8481. [&](const std::string &token) { data += token; },
  8482. [&](const std::string &token) { data += token; },
  8483. [&](size_t offset, size_t length) {
  8484. assert(offset + length <= content_length);
  8485. data += res.body.substr(offset, length);
  8486. return true;
  8487. });
  8488. }
  8489. inline size_t get_multipart_ranges_data_length(const Request &req,
  8490. const std::string &boundary,
  8491. const std::string &content_type,
  8492. size_t content_length) {
  8493. size_t data_length = 0;
  8494. process_multipart_ranges_data(
  8495. req, boundary, content_type, content_length,
  8496. [&](const std::string &token) { data_length += token.size(); },
  8497. [&](const std::string &token) { data_length += token.size(); },
  8498. [&](size_t /*offset*/, size_t length) {
  8499. data_length += length;
  8500. return true;
  8501. });
  8502. return data_length;
  8503. }
  8504. template <typename T>
  8505. inline bool
  8506. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8507. const std::string &boundary,
  8508. const std::string &content_type,
  8509. size_t content_length, const T &is_shutting_down) {
  8510. return process_multipart_ranges_data(
  8511. req, boundary, content_type, content_length,
  8512. [&](const std::string &token) { strm.write(token); },
  8513. [&](const std::string &token) { strm.write(token); },
  8514. [&](size_t offset, size_t length) {
  8515. return write_content(strm, res.content_provider_, offset, length,
  8516. is_shutting_down);
  8517. });
  8518. }
  8519. inline bool has_framed_body(const Request &req) {
  8520. return is_chunked_transfer_encoding(req.headers) ||
  8521. req.get_header_value_u64("Content-Length") > 0;
  8522. }
  8523. inline bool is_connection_persistent(const Request &req) {
  8524. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8525. if (req.version == "HTTP/1.0" &&
  8526. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8527. return false;
  8528. }
  8529. return true;
  8530. }
  8531. inline bool expect_content(const Request &req) {
  8532. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8533. req.method == "DELETE") {
  8534. return true;
  8535. }
  8536. return has_framed_body(req);
  8537. }
  8538. #ifdef _WIN32
  8539. class WSInit {
  8540. public:
  8541. WSInit() {
  8542. WSADATA wsaData;
  8543. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8544. }
  8545. ~WSInit() {
  8546. if (is_valid_) WSACleanup();
  8547. }
  8548. bool is_valid_ = false;
  8549. };
  8550. static WSInit wsinit_;
  8551. #endif
  8552. // RFC 9110 Section 11.6.1 defines a challenge list as
  8553. // WWW-Authenticate = #challenge
  8554. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8555. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8556. // so a server may offer several schemes, each with its own comma-separated
  8557. // auth-param list, in either order and either as separate field lines or
  8558. // packed into one. Splitting on every comma would break apart a challenge's
  8559. // own param list; splitting only on the first space would miss a Digest
  8560. // challenge that isn't first. Split on commas that aren't inside a
  8561. // quoted-string instead, then track which scheme each resulting segment
  8562. // belongs to: a segment whose text before "=" contains whitespace (or that
  8563. // has no "=" at all) starts a new challenge named by its leading token.
  8564. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8565. std::vector<std::string> segments;
  8566. size_t start = 0;
  8567. auto in_quotes = false;
  8568. for (size_t i = 0; i < s.size(); i++) {
  8569. auto c = s[i];
  8570. if (in_quotes) {
  8571. if (c == '\\' && i + 1 < s.size()) {
  8572. i++;
  8573. } else if (c == '"') {
  8574. in_quotes = false;
  8575. }
  8576. } else if (c == '"') {
  8577. in_quotes = true;
  8578. } else if (c == ',') {
  8579. segments.push_back(s.substr(start, i - start));
  8580. start = i + 1;
  8581. }
  8582. }
  8583. segments.push_back(s.substr(start));
  8584. return segments;
  8585. }
  8586. inline std::string unescape_quoted_pairs(const std::string &s) {
  8587. std::string out;
  8588. out.reserve(s.size());
  8589. for (size_t i = 0; i < s.size(); i++) {
  8590. if (s[i] == '\\' && i + 1 < s.size()) {
  8591. out += s[++i];
  8592. } else {
  8593. out += s[i];
  8594. }
  8595. }
  8596. return out;
  8597. }
  8598. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8599. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8600. // quoted-pair, so the recipient recovers the original value.
  8601. inline std::string escape_quoted_pairs(const std::string &s) {
  8602. std::string out;
  8603. out.reserve(s.size());
  8604. for (auto c : s) {
  8605. if (c == '\\' || c == '"') { out += '\\'; }
  8606. out += c;
  8607. }
  8608. return out;
  8609. }
  8610. inline bool parse_www_authenticate(const Response &res,
  8611. std::map<std::string, std::string> &auth,
  8612. bool is_proxy) {
  8613. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8614. auto combined = get_combined_header_value(res.headers, auth_key);
  8615. if (combined.empty()) { return false; }
  8616. auto found_digest = false;
  8617. auto in_digest_challenge = false;
  8618. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8619. auto segment = trim_copy(raw_segment);
  8620. if (segment.empty()) { continue; }
  8621. auto eq_pos = segment.find('=');
  8622. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8623. // for the first segment of a challenge, "<scheme> <key>") must be
  8624. // trimmed before its boundaries are inspected.
  8625. auto key_part = trim_copy(
  8626. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8627. auto space_pos = key_part.find_last_of(" \t");
  8628. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8629. // "<scheme>[ <key>]" starts a new challenge.
  8630. auto scheme_end =
  8631. space_pos == std::string::npos ? key_part.size() : space_pos;
  8632. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8633. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8634. // from one challenge is never paired with another's algorithm.
  8635. in_digest_challenge =
  8636. !found_digest &&
  8637. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8638. if (in_digest_challenge) { found_digest = true; }
  8639. if (space_pos == std::string::npos) {
  8640. // Bare scheme (or a token68), no auth-param on this segment.
  8641. continue;
  8642. }
  8643. key_part = key_part.substr(space_pos + 1);
  8644. }
  8645. if (!in_digest_challenge) { continue; }
  8646. auto val = trim_copy(segment.substr(eq_pos + 1));
  8647. auto unquoted = trim_double_quotes_copy(val);
  8648. if (unquoted.size() != val.size()) {
  8649. unquoted = unescape_quoted_pairs(unquoted);
  8650. }
  8651. auth[std::move(key_part)] = std::move(unquoted);
  8652. }
  8653. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8654. // make_digest_authentication_header() dereferences both unconditionally, so
  8655. // a challenge missing either can't produce a usable Authorization header.
  8656. // Treat it the same as no Digest challenge at all.
  8657. return found_digest && auth.find("realm") != auth.end() &&
  8658. auth.find("nonce") != auth.end();
  8659. }
  8660. class ContentProviderAdapter {
  8661. public:
  8662. explicit ContentProviderAdapter(
  8663. ContentProviderWithoutLength &&content_provider)
  8664. : content_provider_(std::move(content_provider)) {}
  8665. bool operator()(size_t offset, size_t, DataSink &sink) {
  8666. return content_provider_(offset, sink);
  8667. }
  8668. private:
  8669. ContentProviderWithoutLength content_provider_;
  8670. };
  8671. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8672. namespace fields {
  8673. inline bool is_token_char(char c) {
  8674. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8675. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8676. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8677. }
  8678. inline bool is_token(const std::string &s) {
  8679. if (s.empty()) { return false; }
  8680. for (auto c : s) {
  8681. if (!is_token_char(c)) { return false; }
  8682. }
  8683. return true;
  8684. }
  8685. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8686. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8687. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8688. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8689. inline bool is_field_content(const std::string &s) {
  8690. if (s.empty()) { return true; }
  8691. if (s.size() == 1) {
  8692. return is_field_vchar(s[0]);
  8693. } else if (s.size() == 2) {
  8694. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8695. } else {
  8696. size_t i = 0;
  8697. if (!is_field_vchar(s[i])) { return false; }
  8698. i++;
  8699. while (i < s.size() - 1) {
  8700. auto c = s[i++];
  8701. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8702. } else {
  8703. return false;
  8704. }
  8705. }
  8706. return is_field_vchar(s[i]);
  8707. }
  8708. }
  8709. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8710. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8711. return is_field_name(name) && is_field_value(value);
  8712. }
  8713. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8714. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8715. inline bool is_request_target(const std::string &s) {
  8716. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8717. }
  8718. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8719. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8720. inline bool is_host(const std::string &s) {
  8721. return std::all_of(s.begin(), s.end(), [](char c) {
  8722. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8723. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8724. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8725. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8726. });
  8727. }
  8728. } // namespace fields
  8729. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8730. WebSocketUpgradeResponse &upgrade) {
  8731. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8732. std::string key_bytes(16, '\0');
  8733. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8734. key_bytes.size());
  8735. auto client_key = base64_encode(key_bytes);
  8736. req.headers.erase("Upgrade");
  8737. req.headers.erase("Connection");
  8738. req.headers.erase("Sec-WebSocket-Key");
  8739. req.headers.erase("Sec-WebSocket-Version");
  8740. req.headers.emplace("Upgrade", "websocket");
  8741. req.headers.emplace("Connection", "Upgrade");
  8742. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8743. req.headers.emplace("Sec-WebSocket-Version", "13");
  8744. // Build the request in memory first, like ClientImpl::write_request does.
  8745. // Writing straight to the socket would leak a request line onto the wire
  8746. // before check_and_write_headers gets a chance to reject an invalid header,
  8747. // and would emit one small write per header.
  8748. BufferStream bstrm;
  8749. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8750. upgrade.error = Error::Write;
  8751. return false;
  8752. }
  8753. auto error = Error::Success;
  8754. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8755. upgrade.error = error;
  8756. return false;
  8757. }
  8758. const auto &data = bstrm.get_buffer();
  8759. if (!write_data(strm, data.data(), data.size())) {
  8760. upgrade.error = Error::Write;
  8761. return false;
  8762. }
  8763. // Verify 101 response and Sec-WebSocket-Accept header
  8764. auto expected_accept = websocket_accept_key(client_key);
  8765. auto offered_subprotocols =
  8766. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8767. return read_websocket_upgrade_response(strm, expected_accept,
  8768. offered_subprotocols, upgrade);
  8769. }
  8770. inline bool is_ip_address(const std::string &host) {
  8771. struct in_addr addr4;
  8772. struct in6_addr addr6;
  8773. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8774. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8775. }
  8776. // Resolve where a client should connect for `host`, honoring a user-supplied
  8777. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8778. // supplying the Host header and SNI; only the connection target changes.
  8779. //
  8780. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8781. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8782. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8783. // absent or empty mapping leaves `host` as the connection target; without the
  8784. // empty check the value would reach getaddrinfo as a null node and silently
  8785. // resolve to loopback.
  8786. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8787. const std::string &host, std::string &connect_host,
  8788. std::string &ip) {
  8789. connect_host = host;
  8790. ip.clear();
  8791. auto it = addr_map.find(host);
  8792. if (it == addr_map.end() || it->second.empty()) { return; }
  8793. if (is_ip_address(it->second)) {
  8794. ip = it->second;
  8795. } else {
  8796. connect_host = it->second;
  8797. }
  8798. }
  8799. } // namespace detail
  8800. /*
  8801. * Group 2: detail namespace - SSL common utilities
  8802. */
  8803. #ifdef CPPHTTPLIB_SSL_ENABLED
  8804. namespace detail {
  8805. class SSLSocketStream final : public Stream {
  8806. public:
  8807. SSLSocketStream(
  8808. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8809. time_t read_timeout_usec, time_t write_timeout_sec,
  8810. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8811. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8812. (std::chrono::steady_clock::time_point::min)());
  8813. ~SSLSocketStream() override;
  8814. bool is_readable() const override;
  8815. bool wait_readable() const override;
  8816. bool wait_writable() const override;
  8817. bool is_peer_alive() const override;
  8818. ssize_t read(char *ptr, size_t size) override;
  8819. ssize_t write(const char *ptr, size_t size) override;
  8820. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8821. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8822. socket_t socket() const override;
  8823. time_t duration() const override;
  8824. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8825. // See SocketStream::set_readable_hint().
  8826. void set_readable_hint() { readable_hint_ = true; }
  8827. private:
  8828. bool ensure_readable();
  8829. socket_t sock_;
  8830. tls::session_t session_;
  8831. time_t read_timeout_sec_;
  8832. time_t read_timeout_usec_;
  8833. time_t write_timeout_sec_;
  8834. time_t write_timeout_usec_;
  8835. time_t max_timeout_msec_;
  8836. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8837. bool readable_hint_ = false;
  8838. };
  8839. // A TLS stream for WebSocket connections, where the receive path and the
  8840. // send path (application send() plus the heartbeat ping thread) run on
  8841. // different threads. A single TLS session must never be entered
  8842. // concurrently, so every call into the session is serialized by one mutex.
  8843. //
  8844. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8845. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8846. // call under the lock, then waits for readiness with select() outside the
  8847. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8848. // blocked waiting for data never stalls a concurrent sender.
  8849. //
  8850. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8851. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8852. class WebSocketSSLStream final : public Stream {
  8853. public:
  8854. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8855. time_t read_timeout_sec, time_t read_timeout_usec,
  8856. time_t write_timeout_sec, time_t write_timeout_usec);
  8857. ~WebSocketSSLStream() override;
  8858. bool is_readable() const override;
  8859. bool wait_readable() const override;
  8860. bool wait_writable() const override;
  8861. ssize_t read(char *ptr, size_t size) override;
  8862. ssize_t write(const char *ptr, size_t size) override;
  8863. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8864. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8865. socket_t socket() const override;
  8866. time_t duration() const override;
  8867. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8868. private:
  8869. mutable std::mutex session_mutex_;
  8870. socket_t sock_;
  8871. tls::session_t session_;
  8872. // WebSocket::close() shortens the read timeout from the closing thread
  8873. // while the receive thread is inside wait_readable(), so these two are read
  8874. // and written concurrently. The write timeouts are never mutated.
  8875. std::atomic<time_t> read_timeout_sec_;
  8876. std::atomic<time_t> read_timeout_usec_;
  8877. time_t write_timeout_sec_;
  8878. time_t write_timeout_usec_;
  8879. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8880. };
  8881. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8882. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8883. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8884. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8885. unsigned int hash_length = 0;
  8886. unsigned char hash[EVP_MAX_MD_SIZE];
  8887. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8888. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8889. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8890. std::stringstream ss;
  8891. for (auto i = 0u; i < hash_length; ++i) {
  8892. ss << std::hex << std::setw(2) << std::setfill('0')
  8893. << static_cast<unsigned int>(hash[i]);
  8894. }
  8895. return ss.str();
  8896. }
  8897. inline std::string MD5(const std::string &s) {
  8898. return message_digest(s, EVP_md5());
  8899. }
  8900. inline std::string SHA_256(const std::string &s) {
  8901. return message_digest(s, EVP_sha256());
  8902. }
  8903. inline std::string SHA_512(const std::string &s) {
  8904. return message_digest(s, EVP_sha512());
  8905. }
  8906. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8907. namespace {
  8908. template <size_t N>
  8909. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8910. std::stringstream ss;
  8911. for (size_t i = 0; i < N; ++i) {
  8912. ss << std::hex << std::setw(2) << std::setfill('0')
  8913. << static_cast<unsigned int>(hash[i]);
  8914. }
  8915. return ss.str();
  8916. }
  8917. } // namespace
  8918. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8919. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8920. // initialized once. PSA state is process-global; do not free it.
  8921. inline bool ensure_mbedtls_psa_crypto() {
  8922. static std::once_flag once;
  8923. static bool ok = false;
  8924. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8925. return ok;
  8926. }
  8927. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8928. unsigned char *out, size_t out_size) {
  8929. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8930. size_t olen = 0;
  8931. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8932. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8933. olen == out_size;
  8934. }
  8935. #endif
  8936. inline std::string MD5(const std::string &s) {
  8937. unsigned char hash[16];
  8938. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8939. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8940. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8941. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8942. hash);
  8943. #else
  8944. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8945. hash);
  8946. #endif
  8947. return hash_to_hex(hash);
  8948. }
  8949. inline std::string SHA_256(const std::string &s) {
  8950. unsigned char hash[32];
  8951. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8952. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8953. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8954. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8955. hash, 0);
  8956. #else
  8957. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8958. s.size(), hash, 0);
  8959. #endif
  8960. return hash_to_hex(hash);
  8961. }
  8962. inline std::string SHA_512(const std::string &s) {
  8963. unsigned char hash[64];
  8964. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8965. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8966. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8967. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8968. hash, 0);
  8969. #else
  8970. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8971. s.size(), hash, 0);
  8972. #endif
  8973. return hash_to_hex(hash);
  8974. }
  8975. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8976. namespace {
  8977. template <size_t N>
  8978. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8979. std::stringstream ss;
  8980. for (size_t i = 0; i < N; ++i) {
  8981. ss << std::hex << std::setw(2) << std::setfill('0')
  8982. << static_cast<unsigned int>(hash[i]);
  8983. }
  8984. return ss.str();
  8985. }
  8986. } // namespace
  8987. inline std::string MD5(const std::string &s) {
  8988. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8989. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8990. static_cast<word32>(s.size()), hash);
  8991. return hash_to_hex(hash);
  8992. }
  8993. inline std::string SHA_256(const std::string &s) {
  8994. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8995. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8996. static_cast<word32>(s.size()), hash);
  8997. return hash_to_hex(hash);
  8998. }
  8999. inline std::string SHA_512(const std::string &s) {
  9000. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9001. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9002. static_cast<word32>(s.size()), hash);
  9003. return hash_to_hex(hash);
  9004. }
  9005. #endif
  9006. template <typename T>
  9007. inline bool process_server_socket_ssl(
  9008. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9009. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9010. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9011. time_t write_timeout_usec, T callback) {
  9012. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9013. // of a pipelined request, which keep_alive() cannot see on the socket.
  9014. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9015. write_timeout_sec, write_timeout_usec);
  9016. return process_server_socket_core(
  9017. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9018. [&]() { return strm.is_readable(); },
  9019. [&](bool socket_readable, bool close_connection,
  9020. bool &connection_closed) {
  9021. if (socket_readable) { strm.set_readable_hint(); }
  9022. return callback(strm, close_connection, connection_closed);
  9023. });
  9024. }
  9025. template <typename T>
  9026. inline bool process_client_socket_ssl(
  9027. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9028. time_t read_timeout_usec, time_t write_timeout_sec,
  9029. time_t write_timeout_usec, time_t max_timeout_msec,
  9030. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9031. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9032. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9033. start_time);
  9034. return callback(strm);
  9035. }
  9036. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9037. const Request &req, const std::map<std::string, std::string> &auth,
  9038. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9039. const std::string &password, bool is_proxy = false) {
  9040. std::string nc;
  9041. {
  9042. std::stringstream ss;
  9043. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9044. nc = ss.str();
  9045. }
  9046. std::string qop;
  9047. if (auth.find("qop") != auth.end()) {
  9048. qop = auth.at("qop");
  9049. if (qop.find("auth-int") != std::string::npos) {
  9050. qop = "auth-int";
  9051. } else if (qop.find("auth") != std::string::npos) {
  9052. qop = "auth";
  9053. } else {
  9054. qop.clear();
  9055. }
  9056. }
  9057. std::string algo = "MD5";
  9058. if (auth.find("algorithm") != auth.end()) {
  9059. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9060. // not a token would otherwise be emitted verbatim and could carry commas
  9061. // or quotes that inject further auth-params into the header below.
  9062. const auto &a = auth.at("algorithm");
  9063. if (fields::is_token(a)) { algo = a; }
  9064. }
  9065. std::string response;
  9066. {
  9067. auto H = algo == "SHA-256" ? detail::SHA_256
  9068. : algo == "SHA-512" ? detail::SHA_512
  9069. : detail::MD5;
  9070. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9071. auto A2 = req.method + ":" + req.path;
  9072. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9073. if (qop.empty()) {
  9074. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9075. } else {
  9076. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9077. ":" + qop + ":" + H(A2));
  9078. }
  9079. }
  9080. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9081. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9082. // close the string early. realm, nonce and opaque come straight from the
  9083. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9084. // without this a crafted challenge injects extra auth-params into the header.
  9085. auto field =
  9086. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9087. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9088. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9089. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9090. "\", algorithm=" + algo +
  9091. (qop.empty() ? ", response=\""
  9092. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9093. "\", response=\"") +
  9094. response + "\"" +
  9095. (opaque.empty()
  9096. ? ""
  9097. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9098. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9099. return std::make_pair(key, field);
  9100. }
  9101. inline bool match_hostname(const std::string &pattern,
  9102. const std::string &hostname) {
  9103. // Exact match (case-insensitive)
  9104. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  9105. // Split both pattern and hostname into components by '.'
  9106. std::vector<std::string> pattern_components;
  9107. if (!pattern.empty()) {
  9108. split(pattern.data(), pattern.data() + pattern.size(), '.',
  9109. [&](const char *b, const char *e) {
  9110. pattern_components.emplace_back(b, e);
  9111. });
  9112. }
  9113. std::vector<std::string> host_components;
  9114. if (!hostname.empty()) {
  9115. split(hostname.data(), hostname.data() + hostname.size(), '.',
  9116. [&](const char *b, const char *e) {
  9117. host_components.emplace_back(b, e);
  9118. });
  9119. }
  9120. // Component count must match
  9121. if (host_components.size() != pattern_components.size()) { return false; }
  9122. // Compare each component with wildcard support
  9123. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9124. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9125. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9126. auto itr = pattern_components.begin();
  9127. for (const auto &h : host_components) {
  9128. auto &p = *itr;
  9129. auto is_leftmost = itr == pattern_components.begin();
  9130. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9131. bool partial_match = false;
  9132. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9133. const auto prefix_length = p.size() - 1;
  9134. if (prefix_length == 0) {
  9135. partial_match = true;
  9136. } else if (h.size() >= prefix_length) {
  9137. partial_match =
  9138. std::equal(p.begin(),
  9139. p.begin() + static_cast<std::string::difference_type>(
  9140. prefix_length),
  9141. h.begin(), [](const char ca, const char cb) {
  9142. return detail::case_ignore::to_lower(ca) ==
  9143. detail::case_ignore::to_lower(cb);
  9144. });
  9145. }
  9146. }
  9147. if (!partial_match) { return false; }
  9148. }
  9149. ++itr;
  9150. }
  9151. return true;
  9152. }
  9153. #ifdef _WIN32
  9154. // Verify certificate using Windows CertGetCertificateChain API.
  9155. // This provides real-time certificate validation with Windows Update
  9156. // integration, independent of the TLS backend.
  9157. inline bool verify_cert_with_windows_schannel(
  9158. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9159. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9160. if (der_cert.empty()) { return false; }
  9161. out_error = 0;
  9162. // Create Windows certificate context from DER data
  9163. auto cert_context = CertCreateCertificateContext(
  9164. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9165. static_cast<DWORD>(der_cert.size()));
  9166. if (!cert_context) {
  9167. out_error = GetLastError();
  9168. return false;
  9169. }
  9170. auto cert_guard =
  9171. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9172. // Give CryptoAPI the certificates the server sent. Without them it follows
  9173. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9174. std::vector<tls::cert_t> peer_certs;
  9175. tls::get_peer_certs(session, peer_certs);
  9176. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9177. auto store_guard = scope_exit([&] {
  9178. for (auto cert : peer_certs) {
  9179. tls::free_cert(cert);
  9180. }
  9181. if (store) { CertCloseStore(store, 0); }
  9182. });
  9183. for (auto cert : peer_certs) {
  9184. std::vector<unsigned char> der;
  9185. if (store && tls::get_cert_der(cert, der)) {
  9186. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9187. static_cast<DWORD>(der.size()),
  9188. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9189. }
  9190. }
  9191. // Setup chain parameters
  9192. CERT_CHAIN_PARA chain_para = {};
  9193. chain_para.cbSize = sizeof(chain_para);
  9194. // Require the server authentication usage along the chain, which also
  9195. // rejects roots that Windows trusts only for other purposes.
  9196. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9197. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9198. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9199. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9200. // Build certificate chain with revocation checking
  9201. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9202. auto chain_result = CertGetCertificateChain(
  9203. nullptr, cert_context, nullptr, store, &chain_para,
  9204. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9205. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9206. nullptr, &chain_context);
  9207. if (!chain_result || !chain_context) {
  9208. out_error = GetLastError();
  9209. return false;
  9210. }
  9211. auto chain_guard =
  9212. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9213. // Verify SSL policy
  9214. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9215. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9216. #ifdef AUTHTYPE_SERVER
  9217. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9218. #endif
  9219. std::wstring whost;
  9220. if (verify_hostname) {
  9221. whost = u8string_to_wstring(hostname.c_str());
  9222. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9223. }
  9224. CERT_CHAIN_POLICY_PARA policy_para = {};
  9225. policy_para.cbSize = sizeof(policy_para);
  9226. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9227. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9228. #else
  9229. policy_para.dwFlags = 0;
  9230. #endif
  9231. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9232. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9233. policy_status.cbSize = sizeof(policy_status);
  9234. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9235. &policy_para, &policy_status)) {
  9236. out_error = GetLastError();
  9237. return false;
  9238. }
  9239. if (policy_status.dwError != 0) {
  9240. out_error = policy_status.dwError;
  9241. return false;
  9242. }
  9243. return true;
  9244. }
  9245. #endif // _WIN32
  9246. // Loads CA file/dir configuration and applies the system CA policy to a
  9247. // client TLS context. PEM data and native stores are applied to the context
  9248. // directly at set time; has_custom_store reflects them for the Auto policy
  9249. // decision.
  9250. inline bool load_client_ca_config(tls::ctx_t ctx,
  9251. const std::string &ca_cert_file_path,
  9252. const std::string &ca_cert_dir_path,
  9253. bool has_custom_store, SystemCAMode mode,
  9254. uint64_t &backend_error) {
  9255. auto ret = true;
  9256. if (!ca_cert_file_path.empty()) {
  9257. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9258. backend_error = tls::get_error();
  9259. ret = false;
  9260. }
  9261. } else if (!ca_cert_dir_path.empty()) {
  9262. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9263. backend_error = tls::get_error();
  9264. ret = false;
  9265. }
  9266. }
  9267. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9268. !ca_cert_dir_path.empty() || has_custom_store;
  9269. if (mode == SystemCAMode::Enabled ||
  9270. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9271. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9272. }
  9273. return ret;
  9274. }
  9275. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9276. std::vector<tls::cert_t> certs;
  9277. tls::get_ca_certs(ctx, certs);
  9278. std::string pem;
  9279. for (auto cert : certs) {
  9280. std::vector<unsigned char> der;
  9281. if (tls::get_cert_der(cert, der)) {
  9282. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9283. pem += "-----BEGIN CERTIFICATE-----\n";
  9284. for (size_t i = 0; i < b64.size(); i += 64) {
  9285. pem += b64.substr(i, 64) + "\n";
  9286. }
  9287. pem += "-----END CERTIFICATE-----\n";
  9288. }
  9289. tls::free_cert(cert);
  9290. }
  9291. return pem;
  9292. }
  9293. // The parts of session setup that only SSLClient needs, plus the handful
  9294. // WebSocketClient also exposes; everything else takes the defaults, which is
  9295. // what keeps the two clients on one implementation.
  9296. struct ClientTlsSessionOptions {
  9297. // Both SSLClient and WebSocketClient expose this independently of
  9298. // certificate verification.
  9299. bool server_hostname_verification = true;
  9300. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9301. // When non-null, guards session creation against concurrent use of the
  9302. // context. A WebSocketClient is not safe to use from several threads to
  9303. // begin with, so it passes nothing.
  9304. std::mutex *ctx_mutex = nullptr;
  9305. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9306. // The caller decides whether Schannel has anything to say about this
  9307. // connection; see SSLClient::initialize_ssl().
  9308. bool windows_cert_verification = false;
  9309. // A server certificate verifier works on the backend's chain verification,
  9310. // so the backend keeps deciding and Schannel only adds its own check.
  9311. bool server_certificate_verifier_set = false;
  9312. #endif
  9313. };
  9314. // Filled in on failure for callers that report error details.
  9315. struct ClientTlsSessionError {
  9316. Error error = Error::Success;
  9317. int ssl_error = 0;
  9318. uint64_t backend_error = 0;
  9319. };
  9320. // Establishes a client TLS session on an already connected socket. On failure
  9321. // the session is left for the caller to free: SSLClient frees it right away,
  9322. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9323. inline bool setup_client_tls_session(
  9324. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9325. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9326. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9327. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9328. using namespace tls;
  9329. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9330. if (out_error) {
  9331. out_error->error = error;
  9332. out_error->ssl_error = ssl_error;
  9333. out_error->backend_error = backend_error;
  9334. }
  9335. return false;
  9336. };
  9337. if (!ctx) {
  9338. session = nullptr;
  9339. return fail(Error::SSLConnection, 0, 0);
  9340. }
  9341. // With Windows verification on and no server certificate verifier set,
  9342. // Schannel is the only chain verifier. The backend's trust store is a
  9343. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9344. // demand, so the backend's verdict is not used.
  9345. auto windows_verifies_chain = false;
  9346. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9347. windows_verifies_chain = options.windows_cert_verification &&
  9348. !options.server_certificate_verifier_set;
  9349. #endif
  9350. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9351. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9352. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9353. // Schannel verifies the chain instead, chain verification happens during
  9354. // the handshake even for IP hosts; the certificate identity is verified
  9355. // post-handshake via verify_hostname().
  9356. set_verify_client(ctx,
  9357. server_certificate_verification && !windows_verifies_chain);
  9358. #endif
  9359. {
  9360. std::unique_lock<std::mutex> guard;
  9361. if (options.ctx_mutex) {
  9362. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9363. }
  9364. session = create_session(ctx, sock);
  9365. }
  9366. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9367. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9368. // their identity is checked post-handshake below instead. On Mbed TLS and
  9369. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9370. // options.server_hostname_verification is threaded through here.
  9371. if (!is_ip_address(host)) {
  9372. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9373. return fail(Error::SSLConnection, 0, get_error());
  9374. }
  9375. }
  9376. TlsError tls_err;
  9377. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9378. &tls_err)) {
  9379. auto error = Error::SSLConnection;
  9380. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9381. error = Error::SSLServerVerification;
  9382. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9383. error = Error::SSLServerHostnameVerification;
  9384. }
  9385. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9386. }
  9387. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9388. if (options.session_verifier) {
  9389. verification_status = options.session_verifier(session);
  9390. }
  9391. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9392. return fail(Error::SSLServerVerification, 0, get_error());
  9393. }
  9394. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9395. server_certificate_verification) {
  9396. if (!windows_verifies_chain) {
  9397. auto verify_result = get_verify_result(session);
  9398. if (verify_result != 0) {
  9399. return fail(Error::SSLServerVerification, 0,
  9400. static_cast<uint64_t>(verify_result));
  9401. }
  9402. }
  9403. auto server_cert = get_peer_cert(session);
  9404. if (!server_cert) {
  9405. return fail(Error::SSLServerVerification, 0, get_error());
  9406. }
  9407. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9408. // Identity check against the peer certificate, post-handshake for all
  9409. // backends. For IP hosts this is the only identity verification, since no
  9410. // hostname is bound during the handshake.
  9411. if (options.server_hostname_verification) {
  9412. if (!verify_hostname(server_cert, host.c_str())) {
  9413. return fail(Error::SSLServerHostnameVerification, 0,
  9414. hostname_mismatch_code());
  9415. }
  9416. }
  9417. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9418. // Windows Schannel verification, which lets Windows fetch missing roots
  9419. // and intermediates on demand. It must not be skipped: unless a server
  9420. // certificate verifier is set, it is the only chain check.
  9421. if (options.windows_cert_verification) {
  9422. std::vector<unsigned char> der;
  9423. uint64_t wincrypt_error = 0;
  9424. if (!get_cert_der(server_cert, der) ||
  9425. !verify_cert_with_windows_schannel(
  9426. der, host, options.server_hostname_verification, wincrypt_error,
  9427. session)) {
  9428. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9429. }
  9430. }
  9431. #endif
  9432. }
  9433. return true;
  9434. }
  9435. } // namespace detail
  9436. #endif // CPPHTTPLIB_SSL_ENABLED
  9437. /*
  9438. * Group 3: httplib namespace - Non-SSL public API implementations
  9439. */
  9440. inline void default_socket_options(socket_t sock) {
  9441. set_socket_opt(sock, SOL_SOCKET,
  9442. #ifdef SO_REUSEPORT
  9443. SO_REUSEPORT,
  9444. #else
  9445. SO_REUSEADDR,
  9446. #endif
  9447. 1);
  9448. }
  9449. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9450. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9451. sizeof(optval));
  9452. }
  9453. inline std::string get_bearer_token_auth(const Request &req) {
  9454. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9455. // than the prefix carries no token.
  9456. constexpr const char bearer_prefix[] = "Bearer ";
  9457. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9458. auto value = req.get_header_value("Authorization");
  9459. if (value.size() >= bearer_prefix_len &&
  9460. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9461. bearer_prefix)) {
  9462. return value.substr(bearer_prefix_len);
  9463. }
  9464. return "";
  9465. }
  9466. inline const char *status_message(int status) {
  9467. switch (status) {
  9468. case StatusCode::Continue_100: return "Continue";
  9469. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9470. case StatusCode::Processing_102: return "Processing";
  9471. case StatusCode::EarlyHints_103: return "Early Hints";
  9472. case StatusCode::OK_200: return "OK";
  9473. case StatusCode::Created_201: return "Created";
  9474. case StatusCode::Accepted_202: return "Accepted";
  9475. case StatusCode::NonAuthoritativeInformation_203:
  9476. return "Non-Authoritative Information";
  9477. case StatusCode::NoContent_204: return "No Content";
  9478. case StatusCode::ResetContent_205: return "Reset Content";
  9479. case StatusCode::PartialContent_206: return "Partial Content";
  9480. case StatusCode::MultiStatus_207: return "Multi-Status";
  9481. case StatusCode::AlreadyReported_208: return "Already Reported";
  9482. case StatusCode::IMUsed_226: return "IM Used";
  9483. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9484. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9485. case StatusCode::Found_302: return "Found";
  9486. case StatusCode::SeeOther_303: return "See Other";
  9487. case StatusCode::NotModified_304: return "Not Modified";
  9488. case StatusCode::UseProxy_305: return "Use Proxy";
  9489. case StatusCode::unused_306: return "unused";
  9490. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9491. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9492. case StatusCode::BadRequest_400: return "Bad Request";
  9493. case StatusCode::Unauthorized_401: return "Unauthorized";
  9494. case StatusCode::PaymentRequired_402: return "Payment Required";
  9495. case StatusCode::Forbidden_403: return "Forbidden";
  9496. case StatusCode::NotFound_404: return "Not Found";
  9497. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9498. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9499. case StatusCode::ProxyAuthenticationRequired_407:
  9500. return "Proxy Authentication Required";
  9501. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9502. case StatusCode::Conflict_409: return "Conflict";
  9503. case StatusCode::Gone_410: return "Gone";
  9504. case StatusCode::LengthRequired_411: return "Length Required";
  9505. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9506. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9507. case StatusCode::UriTooLong_414: return "URI Too Long";
  9508. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9509. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9510. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9511. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9512. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9513. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9514. case StatusCode::Locked_423: return "Locked";
  9515. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9516. case StatusCode::TooEarly_425: return "Too Early";
  9517. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9518. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9519. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9520. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9521. return "Request Header Fields Too Large";
  9522. case StatusCode::UnavailableForLegalReasons_451:
  9523. return "Unavailable For Legal Reasons";
  9524. case StatusCode::NotImplemented_501: return "Not Implemented";
  9525. case StatusCode::BadGateway_502: return "Bad Gateway";
  9526. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9527. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9528. case StatusCode::HttpVersionNotSupported_505:
  9529. return "HTTP Version Not Supported";
  9530. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9531. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9532. case StatusCode::LoopDetected_508: return "Loop Detected";
  9533. case StatusCode::NotExtended_510: return "Not Extended";
  9534. case StatusCode::NetworkAuthenticationRequired_511:
  9535. return "Network Authentication Required";
  9536. default:
  9537. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9538. }
  9539. }
  9540. inline std::string to_string(const Error error) {
  9541. switch (error) {
  9542. case Error::Success: return "Success (no error)";
  9543. case Error::Unknown: return "Unknown";
  9544. case Error::Connection: return "Could not establish connection";
  9545. case Error::BindIPAddress: return "Failed to bind IP address";
  9546. case Error::Read: return "Failed to read connection";
  9547. case Error::Write: return "Failed to write connection";
  9548. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9549. case Error::Canceled: return "Connection handling canceled";
  9550. case Error::SSLConnection: return "SSL connection failed";
  9551. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9552. case Error::SSLServerVerification: return "SSL server verification failed";
  9553. case Error::SSLServerHostnameVerification:
  9554. return "SSL server hostname verification failed";
  9555. case Error::UnsupportedMultipartBoundaryChars:
  9556. return "Unsupported HTTP multipart boundary characters";
  9557. case Error::Compression: return "Compression failed";
  9558. case Error::ConnectionTimeout: return "Connection timed out";
  9559. case Error::ProxyConnection: return "Proxy connection failed";
  9560. case Error::ConnectionClosed: return "Connection closed by server";
  9561. case Error::Timeout: return "Read timeout";
  9562. case Error::ResourceExhaustion: return "Resource exhaustion";
  9563. case Error::TooManyFormDataFiles: return "Too many form data files";
  9564. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9565. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9566. case Error::ExceedMaxSocketDescriptorCount:
  9567. return "Exceeded maximum socket descriptor count";
  9568. case Error::InvalidRequestLine: return "Invalid request line";
  9569. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9570. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9571. case Error::InvalidHeaders: return "Invalid headers";
  9572. case Error::MultipartParsing: return "Multipart parsing failed";
  9573. case Error::OpenFile: return "Failed to open file";
  9574. case Error::Listen: return "Failed to listen on socket";
  9575. case Error::GetSockName: return "Failed to get socket name";
  9576. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9577. case Error::HTTPParsing: return "HTTP parsing failed";
  9578. case Error::InvalidRangeHeader: return "Invalid Range header";
  9579. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9580. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9581. case Error::UserCallbackException: return "User callback threw an exception";
  9582. default: break;
  9583. }
  9584. return "Invalid";
  9585. }
  9586. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9587. os << to_string(obj);
  9588. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9589. return os;
  9590. }
  9591. inline std::string hosted_at(const std::string &hostname) {
  9592. std::vector<std::string> addrs;
  9593. hosted_at(hostname, addrs);
  9594. if (addrs.empty()) { return std::string(); }
  9595. return addrs[0];
  9596. }
  9597. inline void hosted_at(const std::string &hostname,
  9598. std::vector<std::string> &addrs) {
  9599. struct addrinfo hints;
  9600. struct addrinfo *result;
  9601. memset(&hints, 0, sizeof(struct addrinfo));
  9602. hints.ai_family = AF_UNSPEC;
  9603. hints.ai_socktype = SOCK_STREAM;
  9604. hints.ai_protocol = 0;
  9605. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9606. &result, 0)) {
  9607. #if defined __linux__ && !defined __ANDROID__
  9608. res_init();
  9609. #endif
  9610. return;
  9611. }
  9612. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9613. for (auto rp = result; rp; rp = rp->ai_next) {
  9614. const auto &addr =
  9615. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9616. std::string ip;
  9617. auto dummy = -1;
  9618. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9619. dummy)) {
  9620. addrs.emplace_back(std::move(ip));
  9621. }
  9622. }
  9623. }
  9624. inline std::string encode_uri_component(const std::string &value) {
  9625. std::ostringstream escaped;
  9626. escaped.fill('0');
  9627. escaped << std::hex;
  9628. for (auto c : value) {
  9629. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9630. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9631. escaped << c;
  9632. } else {
  9633. escaped << std::uppercase;
  9634. escaped << '%' << std::setw(2)
  9635. << static_cast<int>(static_cast<unsigned char>(c));
  9636. escaped << std::nouppercase;
  9637. }
  9638. }
  9639. return escaped.str();
  9640. }
  9641. inline std::string encode_uri(const std::string &value) {
  9642. std::ostringstream escaped;
  9643. escaped.fill('0');
  9644. escaped << std::hex;
  9645. for (auto c : value) {
  9646. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9647. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9648. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9649. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9650. escaped << c;
  9651. } else {
  9652. escaped << std::uppercase;
  9653. escaped << '%' << std::setw(2)
  9654. << static_cast<int>(static_cast<unsigned char>(c));
  9655. escaped << std::nouppercase;
  9656. }
  9657. }
  9658. return escaped.str();
  9659. }
  9660. inline std::string decode_uri_component(const std::string &value) {
  9661. std::string result;
  9662. for (size_t i = 0; i < value.size(); i++) {
  9663. if (value[i] == '%' && i + 2 < value.size()) {
  9664. auto val = 0;
  9665. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9666. result += static_cast<char>(val);
  9667. i += 2;
  9668. } else {
  9669. result += value[i];
  9670. }
  9671. } else {
  9672. result += value[i];
  9673. }
  9674. }
  9675. return result;
  9676. }
  9677. inline std::string decode_uri(const std::string &value) {
  9678. std::string result;
  9679. for (size_t i = 0; i < value.size(); i++) {
  9680. if (value[i] == '%' && i + 2 < value.size()) {
  9681. auto val = 0;
  9682. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9683. auto c = static_cast<char>(val);
  9684. // Keep escapes of the reserved characters that encode_uri leaves
  9685. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9686. // delimiter is not promoted into a real one (as with JS decodeURI).
  9687. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9688. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9689. c == '#') {
  9690. result += value[i];
  9691. result += value[i + 1];
  9692. result += value[i + 2];
  9693. } else {
  9694. result += c;
  9695. }
  9696. i += 2;
  9697. } else {
  9698. result += value[i];
  9699. }
  9700. } else {
  9701. result += value[i];
  9702. }
  9703. }
  9704. return result;
  9705. }
  9706. inline std::string encode_path_component(const std::string &component) {
  9707. std::string result;
  9708. result.reserve(component.size() * 3);
  9709. for (size_t i = 0; i < component.size(); i++) {
  9710. auto c = static_cast<unsigned char>(component[i]);
  9711. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9712. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9713. c == '_' || c == '~') {
  9714. result += static_cast<char>(c);
  9715. }
  9716. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9717. // "," / ";" / "="
  9718. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9719. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9720. c == '=') {
  9721. result += static_cast<char>(c);
  9722. }
  9723. // Colon is allowed in path segments except first segment
  9724. else if (c == ':') {
  9725. result += static_cast<char>(c);
  9726. }
  9727. // @ is allowed in path
  9728. else if (c == '@') {
  9729. result += static_cast<char>(c);
  9730. } else {
  9731. result += '%';
  9732. char hex[3];
  9733. snprintf(hex, sizeof(hex), "%02X", c);
  9734. result.append(hex, 2);
  9735. }
  9736. }
  9737. return result;
  9738. }
  9739. inline std::string decode_path_component(const std::string &component) {
  9740. std::string result;
  9741. result.reserve(component.size());
  9742. for (size_t i = 0; i < component.size(); i++) {
  9743. if (component[i] == '%' && i + 1 < component.size()) {
  9744. if (component[i + 1] == 'u') {
  9745. // Unicode %uXXXX encoding
  9746. auto val = 0;
  9747. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9748. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9749. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9750. char buff[4];
  9751. size_t len = detail::to_utf8(val, buff);
  9752. if (len > 0) { result.append(buff, len); }
  9753. i += 5; // 'u0000'
  9754. } else {
  9755. result += component[i];
  9756. }
  9757. } else {
  9758. // Standard %XX encoding
  9759. auto val = 0;
  9760. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9761. // 2 digits hex codes
  9762. result += static_cast<char>(val);
  9763. i += 2; // 'XX'
  9764. } else {
  9765. result += component[i];
  9766. }
  9767. }
  9768. } else {
  9769. result += component[i];
  9770. }
  9771. }
  9772. return result;
  9773. }
  9774. inline std::string encode_query_component(const std::string &component,
  9775. bool space_as_plus) {
  9776. std::string result;
  9777. result.reserve(component.size() * 3);
  9778. for (size_t i = 0; i < component.size(); i++) {
  9779. auto c = static_cast<unsigned char>(component[i]);
  9780. // Unreserved characters per RFC 3986
  9781. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9782. c == '_' || c == '~') {
  9783. result += static_cast<char>(c);
  9784. }
  9785. // Space handling
  9786. else if (c == ' ') {
  9787. if (space_as_plus) {
  9788. result += '+';
  9789. } else {
  9790. result += "%20";
  9791. }
  9792. }
  9793. // Plus sign handling
  9794. else if (c == '+') {
  9795. if (space_as_plus) {
  9796. result += "%2B";
  9797. } else {
  9798. result += static_cast<char>(c);
  9799. }
  9800. }
  9801. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9802. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9803. c == '*' || c == ',' || c == ';') {
  9804. result += static_cast<char>(c);
  9805. }
  9806. // Colon and @ are allowed in query
  9807. else if (c == ':' || c == '@') {
  9808. result += static_cast<char>(c);
  9809. }
  9810. // Forward slash is allowed in query values
  9811. else if (c == '/') {
  9812. result += static_cast<char>(c);
  9813. }
  9814. // Question mark is allowed in query values (after first ?)
  9815. else if (c == '?') {
  9816. result += static_cast<char>(c);
  9817. } else {
  9818. result += '%';
  9819. char hex[3];
  9820. snprintf(hex, sizeof(hex), "%02X", c);
  9821. result.append(hex, 2);
  9822. }
  9823. }
  9824. return result;
  9825. }
  9826. inline std::string decode_query_component(const std::string &component,
  9827. bool plus_as_space) {
  9828. std::string result;
  9829. result.reserve(component.size());
  9830. for (size_t i = 0; i < component.size(); i++) {
  9831. if (component[i] == '%' && i + 2 < component.size()) {
  9832. auto val = 0;
  9833. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9834. result += static_cast<char>(val);
  9835. i += 2;
  9836. } else {
  9837. result += component[i];
  9838. }
  9839. } else if (component[i] == '+' && plus_as_space) {
  9840. result += ' '; // + becomes space in form-urlencoded
  9841. } else {
  9842. result += component[i];
  9843. }
  9844. }
  9845. return result;
  9846. }
  9847. inline std::string sanitize_filename(const std::string &filename) {
  9848. // Extract basename: find the last path separator (/ or \)
  9849. auto pos = filename.find_last_of("/\\");
  9850. auto result =
  9851. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9852. // Strip null bytes
  9853. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9854. // Trim whitespace
  9855. {
  9856. auto start = result.find_first_not_of(" \t");
  9857. auto end = result.find_last_not_of(" \t");
  9858. result = (start == std::string::npos)
  9859. ? ""
  9860. : result.substr(start, end - start + 1);
  9861. }
  9862. // Reject . and ..
  9863. if (result == "." || result == "..") { return ""; }
  9864. return result;
  9865. }
  9866. inline std::string append_query_params(const std::string &path,
  9867. const Params &params) {
  9868. std::string path_with_query = path;
  9869. path_with_query += path.find('?') == std::string::npos ? '?' : '&';
  9870. path_with_query += detail::params_to_query_str(params);
  9871. return path_with_query;
  9872. }
  9873. // Header utilities
  9874. inline std::pair<std::string, std::string>
  9875. make_range_header(const Ranges &ranges) {
  9876. std::string field = "bytes=";
  9877. auto i = 0;
  9878. for (const auto &r : ranges) {
  9879. if (i != 0) { field += ", "; }
  9880. if (r.first != -1) { field += std::to_string(r.first); }
  9881. field += '-';
  9882. if (r.second != -1) { field += std::to_string(r.second); }
  9883. i++;
  9884. }
  9885. return std::make_pair("Range", std::move(field));
  9886. }
  9887. inline std::pair<std::string, std::string>
  9888. make_basic_authentication_header(const std::string &username,
  9889. const std::string &password, bool is_proxy) {
  9890. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9891. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9892. return std::make_pair(key, std::move(field));
  9893. }
  9894. inline std::pair<std::string, std::string>
  9895. make_bearer_token_authentication_header(const std::string &token,
  9896. bool is_proxy = false) {
  9897. auto field = "Bearer " + token;
  9898. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9899. return std::make_pair(key, std::move(field));
  9900. }
  9901. // Request implementation
  9902. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9903. size_t id) const {
  9904. return detail::get_header_value_u64(headers, key, def, id);
  9905. }
  9906. inline bool Request::has_header(const std::string &key) const {
  9907. return detail::has_header(headers, key);
  9908. }
  9909. inline std::string Request::get_header_value(const std::string &key,
  9910. const char *def, size_t id) const {
  9911. return detail::get_header_value(headers, key, def, id);
  9912. }
  9913. inline size_t Request::get_header_value_count(const std::string &key) const {
  9914. return detail::get_header_value_count(headers, key);
  9915. }
  9916. inline void Request::set_header(const std::string &key,
  9917. const std::string &val) {
  9918. detail::set_header(headers, key, val);
  9919. }
  9920. inline bool Request::has_trailer(const std::string &key) const {
  9921. return trailers.find(key) != trailers.end();
  9922. }
  9923. inline std::string Request::get_trailer_value(const std::string &key,
  9924. size_t id) const {
  9925. return detail::get_multimap_value(trailers, key, id);
  9926. }
  9927. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9928. return trailers.count(key);
  9929. }
  9930. inline bool Request::has_param(const std::string &key) const {
  9931. return params.find(key) != params.end();
  9932. }
  9933. inline std::string Request::get_param_value(const std::string &key,
  9934. size_t id) const {
  9935. return detail::get_multimap_value(params, key, id);
  9936. }
  9937. inline std::vector<std::string>
  9938. Request::get_param_values(const std::string &key) const {
  9939. auto rng = params.equal_range(key);
  9940. std::vector<std::string> values;
  9941. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9942. for (auto it = rng.first; it != rng.second; ++it) {
  9943. values.push_back(it->second);
  9944. }
  9945. return values;
  9946. }
  9947. inline size_t Request::get_param_value_count(const std::string &key) const {
  9948. return params.count(key);
  9949. }
  9950. inline bool Request::is_multipart_form_data() const {
  9951. const auto &content_type = get_header_value("Content-Type");
  9952. return detail::extract_media_type(content_type) == "multipart/form-data";
  9953. }
  9954. // Multipart FormData implementation
  9955. inline std::string MultipartFormData::get_field(const std::string &key,
  9956. size_t id) const {
  9957. auto rng = fields.equal_range(key);
  9958. auto it = detail::bounded_next(rng.first, id, rng.second);
  9959. if (it != rng.second) { return it->second.content; }
  9960. return std::string();
  9961. }
  9962. inline std::vector<std::string>
  9963. MultipartFormData::get_fields(const std::string &key) const {
  9964. std::vector<std::string> values;
  9965. auto rng = fields.equal_range(key);
  9966. for (auto it = rng.first; it != rng.second; it++) {
  9967. values.push_back(it->second.content);
  9968. }
  9969. return values;
  9970. }
  9971. inline bool MultipartFormData::has_field(const std::string &key) const {
  9972. return fields.find(key) != fields.end();
  9973. }
  9974. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9975. return fields.count(key);
  9976. }
  9977. inline FormData MultipartFormData::get_file(const std::string &key,
  9978. size_t id) const {
  9979. return detail::get_multimap_value(files, key, id);
  9980. }
  9981. inline std::vector<FormData>
  9982. MultipartFormData::get_files(const std::string &key) const {
  9983. std::vector<FormData> values;
  9984. auto rng = files.equal_range(key);
  9985. for (auto it = rng.first; it != rng.second; it++) {
  9986. values.push_back(it->second);
  9987. }
  9988. return values;
  9989. }
  9990. inline bool MultipartFormData::has_file(const std::string &key) const {
  9991. return files.find(key) != files.end();
  9992. }
  9993. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9994. return files.count(key);
  9995. }
  9996. // Multipart FormData writer implementation
  9997. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9998. return detail::is_multipart_boundary_chars_valid(boundary);
  9999. }
  10000. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10001. : boundary_(detail::make_multipart_data_boundary()) {}
  10002. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10003. : boundary_(std::move(boundary)) {}
  10004. inline const std::string &MultipartFormDataWriter::boundary() const {
  10005. return boundary_;
  10006. }
  10007. inline std::string MultipartFormDataWriter::content_type() const {
  10008. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10009. }
  10010. inline std::string
  10011. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10012. return detail::serialize_multipart_formdata(items, boundary_);
  10013. }
  10014. inline size_t MultipartFormDataWriter::content_length(
  10015. const UploadFormDataItems &items) const {
  10016. return detail::get_multipart_content_length(items, boundary_);
  10017. }
  10018. inline std::string
  10019. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10020. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10021. }
  10022. inline std::string MultipartFormDataWriter::item_end() {
  10023. return detail::serialize_multipart_formdata_item_end();
  10024. }
  10025. inline std::string MultipartFormDataWriter::finish() const {
  10026. return detail::serialize_multipart_formdata_finish(boundary_);
  10027. }
  10028. // Response implementation
  10029. namespace detail {
  10030. // A response has one content source: `body`, a content provider, or a file.
  10031. // Each content setter calls this so that the one called last wins.
  10032. inline void clear_content_provider(Response &res) {
  10033. auto releaser = std::move(res.content_provider_resource_releaser_);
  10034. auto success = res.content_provider_success_;
  10035. res.content_length_ = 0;
  10036. res.content_provider_ = nullptr;
  10037. res.content_provider_resource_releaser_ = nullptr;
  10038. res.is_chunked_content_provider_ = false;
  10039. res.is_file_content_provider_ = false;
  10040. res.content_provider_success_ = false;
  10041. res.content_coding_ = EncodingType::None;
  10042. res.file_content_path_.clear();
  10043. res.file_content_content_type_.clear();
  10044. if (releaser) { releaser(success); }
  10045. }
  10046. inline void clear_content(Response &res) {
  10047. res.body.clear();
  10048. clear_content_provider(res);
  10049. }
  10050. // `body` is public, so it can be assigned directly after a provider or a file
  10051. // was set. It came last, so it wins.
  10052. inline void prefer_assigned_body(Response &res) {
  10053. if (!res.body.empty() &&
  10054. (res.content_provider_ || !res.file_content_path_.empty())) {
  10055. clear_content_provider(res);
  10056. }
  10057. }
  10058. } // namespace detail
  10059. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10060. size_t id) const {
  10061. return detail::get_header_value_u64(headers, key, def, id);
  10062. }
  10063. inline bool Response::has_header(const std::string &key) const {
  10064. return headers.find(key) != headers.end();
  10065. }
  10066. inline std::string Response::get_header_value(const std::string &key,
  10067. const char *def,
  10068. size_t id) const {
  10069. return detail::get_header_value(headers, key, def, id);
  10070. }
  10071. inline size_t Response::get_header_value_count(const std::string &key) const {
  10072. return detail::get_header_value_count(headers, key);
  10073. }
  10074. inline void Response::set_header(const std::string &key,
  10075. const std::string &val) {
  10076. detail::set_header(headers, key, val);
  10077. }
  10078. inline bool Response::has_trailer(const std::string &key) const {
  10079. return trailers.find(key) != trailers.end();
  10080. }
  10081. inline std::string Response::get_trailer_value(const std::string &key,
  10082. size_t id) const {
  10083. return detail::get_multimap_value(trailers, key, id);
  10084. }
  10085. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10086. return trailers.count(key);
  10087. }
  10088. inline void Response::set_redirect(const std::string &url, int stat) {
  10089. if (detail::fields::is_field_value(url)) {
  10090. set_header("Location", url);
  10091. if (300 <= stat && stat < 400) {
  10092. this->status = stat;
  10093. } else {
  10094. this->status = StatusCode::Found_302;
  10095. }
  10096. }
  10097. }
  10098. inline void Response::set_content(const char *s, size_t n,
  10099. const std::string &content_type) {
  10100. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10101. detail::clear_content_provider(*this);
  10102. auto rng = headers.equal_range("Content-Type");
  10103. headers.erase(rng.first, rng.second);
  10104. set_header("Content-Type", content_type);
  10105. }
  10106. inline void Response::set_content(const std::string &s,
  10107. const std::string &content_type) {
  10108. set_content(s.data(), s.size(), content_type);
  10109. }
  10110. inline void Response::set_content(std::string &&s,
  10111. const std::string &content_type) {
  10112. body = std::move(s);
  10113. detail::clear_content_provider(*this);
  10114. auto rng = headers.equal_range("Content-Type");
  10115. headers.erase(rng.first, rng.second);
  10116. set_header("Content-Type", content_type);
  10117. }
  10118. inline void Response::set_content_provider(
  10119. size_t in_length, const std::string &content_type, ContentProvider provider,
  10120. ContentProviderResourceReleaser resource_releaser) {
  10121. detail::clear_content(*this);
  10122. set_header("Content-Type", content_type);
  10123. content_length_ = in_length;
  10124. if (in_length > 0) { content_provider_ = std::move(provider); }
  10125. content_provider_resource_releaser_ = std::move(resource_releaser);
  10126. }
  10127. inline void Response::set_content_provider(
  10128. const std::string &content_type, ContentProviderWithoutLength provider,
  10129. ContentProviderResourceReleaser resource_releaser) {
  10130. detail::clear_content(*this);
  10131. set_header("Content-Type", content_type);
  10132. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10133. content_provider_resource_releaser_ = std::move(resource_releaser);
  10134. }
  10135. inline void Response::set_chunked_content_provider(
  10136. const std::string &content_type, ContentProviderWithoutLength provider,
  10137. ContentProviderResourceReleaser resource_releaser) {
  10138. set_content_provider(content_type, std::move(provider),
  10139. std::move(resource_releaser));
  10140. is_chunked_content_provider_ = true;
  10141. }
  10142. inline void Response::set_file_content(const std::string &path,
  10143. const std::string &content_type) {
  10144. detail::clear_content(*this);
  10145. file_content_path_ = path;
  10146. file_content_content_type_ = content_type;
  10147. }
  10148. inline void Response::set_file_content(const std::string &path) {
  10149. set_file_content(path, std::string());
  10150. }
  10151. // Result implementation
  10152. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10153. size_t def,
  10154. size_t id) const {
  10155. return detail::get_header_value_u64(request_headers_, key, def, id);
  10156. }
  10157. inline bool Result::has_request_header(const std::string &key) const {
  10158. return request_headers_.find(key) != request_headers_.end();
  10159. }
  10160. inline std::string Result::get_request_header_value(const std::string &key,
  10161. const char *def,
  10162. size_t id) const {
  10163. return detail::get_header_value(request_headers_, key, def, id);
  10164. }
  10165. inline size_t
  10166. Result::get_request_header_value_count(const std::string &key) const {
  10167. return request_headers_.count(key);
  10168. }
  10169. // Stream implementation
  10170. inline ssize_t Stream::write(const char *ptr) {
  10171. return write(ptr, strlen(ptr));
  10172. }
  10173. inline ssize_t Stream::write(const std::string &s) {
  10174. return write(s.data(), s.size());
  10175. }
  10176. // BodyReader implementation
  10177. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10178. if (!stream) {
  10179. last_error = Error::Connection;
  10180. return -1;
  10181. }
  10182. if (eof) { return 0; }
  10183. if (!chunked) {
  10184. // Content-Length based reading
  10185. if (has_content_length && bytes_read >= content_length) {
  10186. eof = true;
  10187. return 0;
  10188. }
  10189. auto to_read = len;
  10190. if (has_content_length) {
  10191. auto remaining = content_length - bytes_read;
  10192. to_read = (std::min)(len, remaining);
  10193. }
  10194. auto n = stream->read(buf, to_read);
  10195. if (n < 0) {
  10196. last_error = stream->get_error();
  10197. if (last_error == Error::Success) { last_error = Error::Read; }
  10198. eof = true;
  10199. return n;
  10200. }
  10201. if (n == 0) {
  10202. // Unexpected EOF before content_length
  10203. last_error = stream->get_error();
  10204. if (last_error == Error::Success) { last_error = Error::Read; }
  10205. eof = true;
  10206. return 0;
  10207. }
  10208. bytes_read += static_cast<size_t>(n);
  10209. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10210. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10211. last_error = Error::ExceedMaxPayloadSize;
  10212. eof = true;
  10213. return -1;
  10214. }
  10215. return n;
  10216. }
  10217. // Chunked transfer encoding: delegate to shared decoder instance.
  10218. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10219. size_t chunk_offset = 0;
  10220. size_t chunk_total = 0;
  10221. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10222. if (n < 0) {
  10223. last_error = stream->get_error();
  10224. if (last_error == Error::Success) { last_error = Error::Read; }
  10225. eof = true;
  10226. return n;
  10227. }
  10228. if (n == 0) {
  10229. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10230. eof = true;
  10231. return 0;
  10232. }
  10233. bytes_read += static_cast<size_t>(n);
  10234. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10235. last_error = Error::ExceedMaxPayloadSize;
  10236. eof = true;
  10237. return -1;
  10238. }
  10239. return n;
  10240. }
  10241. // ThreadPool implementation
  10242. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10243. time_t idle_timeout_sec)
  10244. : base_thread_count_(n), max_queued_requests_(mqr),
  10245. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10246. shutdown_(false) {
  10247. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10248. if (max_n != 0 && max_n < n) {
  10249. std::string msg = "max_threads must be >= base_threads";
  10250. throw std::invalid_argument(msg);
  10251. }
  10252. #endif
  10253. max_thread_count_ = max_n == 0 ? n : max_n;
  10254. threads_.reserve(base_thread_count_);
  10255. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10256. try {
  10257. #endif
  10258. for (size_t i = 0; i < base_thread_count_; i++) {
  10259. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10260. }
  10261. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10262. } catch (...) {
  10263. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10264. // signal the workers we already spawned to exit and join them so the
  10265. // vector destructor does not see joinable threads (which would call
  10266. // std::terminate). Then rethrow so the caller learns of the failure.
  10267. {
  10268. std::unique_lock<std::mutex> lock(mutex_);
  10269. shutdown_ = true;
  10270. }
  10271. cond_.notify_all();
  10272. for (auto &t : threads_) {
  10273. if (t.joinable()) { t.join(); }
  10274. }
  10275. throw;
  10276. }
  10277. #endif
  10278. }
  10279. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10280. {
  10281. std::unique_lock<std::mutex> lock(mutex_);
  10282. if (shutdown_) { return false; }
  10283. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10284. return false;
  10285. }
  10286. jobs_.push_back(std::move(fn));
  10287. // Spawn a dynamic thread if no idle threads and under max
  10288. if (idle_thread_count_ == 0 &&
  10289. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10290. cleanup_finished_threads();
  10291. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10292. }
  10293. }
  10294. cond_.notify_one();
  10295. return true;
  10296. }
  10297. inline void ThreadPool::shutdown() {
  10298. {
  10299. std::unique_lock<std::mutex> lock(mutex_);
  10300. shutdown_ = true;
  10301. }
  10302. cond_.notify_all();
  10303. for (auto &t : threads_) {
  10304. if (t.joinable()) { t.join(); }
  10305. }
  10306. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10307. // with worker threads that call move_to_finished() concurrently.
  10308. std::list<std::thread> remaining_dynamic;
  10309. {
  10310. std::unique_lock<std::mutex> lock(mutex_);
  10311. remaining_dynamic = std::move(dynamic_threads_);
  10312. }
  10313. for (auto &t : remaining_dynamic) {
  10314. if (t.joinable()) { t.join(); }
  10315. }
  10316. std::unique_lock<std::mutex> lock(mutex_);
  10317. cleanup_finished_threads();
  10318. }
  10319. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10320. // Must be called with mutex_ held
  10321. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10322. if (it->get_id() == id) {
  10323. finished_threads_.push_back(std::move(*it));
  10324. dynamic_threads_.erase(it);
  10325. return;
  10326. }
  10327. }
  10328. }
  10329. inline void ThreadPool::cleanup_finished_threads() {
  10330. // Must be called with mutex_ held
  10331. for (auto &t : finished_threads_) {
  10332. if (t.joinable()) { t.join(); }
  10333. }
  10334. finished_threads_.clear();
  10335. }
  10336. inline void ThreadPool::worker(bool is_dynamic) {
  10337. for (;;) {
  10338. std::function<void()> fn;
  10339. {
  10340. std::unique_lock<std::mutex> lock(mutex_);
  10341. idle_thread_count_++;
  10342. if (is_dynamic) {
  10343. auto has_work =
  10344. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10345. [&] { return !jobs_.empty() || shutdown_; });
  10346. if (!has_work) {
  10347. // Timed out with no work - exit this dynamic thread
  10348. idle_thread_count_--;
  10349. move_to_finished(std::this_thread::get_id());
  10350. break;
  10351. }
  10352. } else {
  10353. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10354. }
  10355. idle_thread_count_--;
  10356. if (shutdown_ && jobs_.empty()) { break; }
  10357. fn = std::move(jobs_.front());
  10358. jobs_.pop_front();
  10359. }
  10360. assert(true == static_cast<bool>(fn));
  10361. fn();
  10362. }
  10363. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10364. !defined(LIBRESSL_VERSION_NUMBER)
  10365. OPENSSL_thread_stop();
  10366. #endif
  10367. }
  10368. /*
  10369. * Group 1 (continued): detail namespace - Stream implementations
  10370. */
  10371. namespace detail {
  10372. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10373. time_t timeout_sec, time_t timeout_usec,
  10374. time_t &actual_timeout_sec,
  10375. time_t &actual_timeout_usec) {
  10376. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10377. auto actual_timeout_msec =
  10378. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10379. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10380. actual_timeout_sec = actual_timeout_msec / 1000;
  10381. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10382. }
  10383. // Socket stream implementation
  10384. inline SocketStream::SocketStream(
  10385. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10386. time_t write_timeout_sec, time_t write_timeout_usec,
  10387. time_t max_timeout_msec,
  10388. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10389. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10390. read_timeout_usec_(read_timeout_usec),
  10391. write_timeout_sec_(write_timeout_sec),
  10392. write_timeout_usec_(write_timeout_usec),
  10393. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10394. read_buff_(read_buff_size_, 0) {}
  10395. inline SocketStream::~SocketStream() = default;
  10396. inline bool SocketStream::is_readable() const {
  10397. return read_buff_off_ < read_buff_content_size_;
  10398. }
  10399. inline bool SocketStream::wait_readable() const {
  10400. if (max_timeout_msec_ <= 0) {
  10401. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10402. }
  10403. time_t read_timeout_sec;
  10404. time_t read_timeout_usec;
  10405. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10406. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10407. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10408. }
  10409. inline bool SocketStream::wait_writable() const {
  10410. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10411. }
  10412. inline bool SocketStream::ensure_readable() {
  10413. if (readable_hint_) {
  10414. readable_hint_ = false;
  10415. return true;
  10416. }
  10417. return wait_readable();
  10418. }
  10419. inline const char *SocketStream::buffered_data(size_t &size) const {
  10420. size = read_buff_content_size_ - read_buff_off_;
  10421. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10422. }
  10423. inline void SocketStream::consume_buffered(size_t size) {
  10424. assert(size <= read_buff_content_size_ - read_buff_off_);
  10425. read_buff_off_ += size;
  10426. }
  10427. inline bool SocketStream::is_peer_alive() const {
  10428. return detail::is_socket_alive(sock_);
  10429. }
  10430. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10431. #ifdef _WIN32
  10432. size =
  10433. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10434. #else
  10435. size = (std::min)(size,
  10436. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10437. #endif
  10438. if (read_buff_off_ < read_buff_content_size_) {
  10439. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10440. if (size <= remaining_size) {
  10441. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10442. read_buff_off_ += size;
  10443. return static_cast<ssize_t>(size);
  10444. } else {
  10445. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10446. read_buff_off_ += remaining_size;
  10447. return static_cast<ssize_t>(remaining_size);
  10448. }
  10449. }
  10450. if (!ensure_readable()) {
  10451. error_ = Error::Timeout;
  10452. return -1;
  10453. }
  10454. read_buff_off_ = 0;
  10455. read_buff_content_size_ = 0;
  10456. if (size < read_buff_size_) {
  10457. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10458. CPPHTTPLIB_RECV_FLAGS);
  10459. if (n <= 0) {
  10460. if (n == 0) {
  10461. error_ = Error::ConnectionClosed;
  10462. } else {
  10463. error_ = Error::Read;
  10464. }
  10465. return n;
  10466. } else if (n <= static_cast<ssize_t>(size)) {
  10467. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10468. return n;
  10469. } else {
  10470. memcpy(ptr, read_buff_.data(), size);
  10471. read_buff_off_ = size;
  10472. read_buff_content_size_ = static_cast<size_t>(n);
  10473. return static_cast<ssize_t>(size);
  10474. }
  10475. } else {
  10476. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10477. if (n <= 0) {
  10478. if (n == 0) {
  10479. error_ = Error::ConnectionClosed;
  10480. } else {
  10481. error_ = Error::Read;
  10482. }
  10483. }
  10484. return n;
  10485. }
  10486. }
  10487. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10488. if (!wait_writable()) { return -1; }
  10489. #if defined(_WIN32) && !defined(_WIN64)
  10490. size =
  10491. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10492. #endif
  10493. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10494. }
  10495. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10496. int &port) const {
  10497. return detail::get_remote_ip_and_port(sock_, ip, port);
  10498. }
  10499. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10500. int &port) const {
  10501. return detail::get_local_ip_and_port(sock_, ip, port);
  10502. }
  10503. inline socket_t SocketStream::socket() const { return sock_; }
  10504. inline time_t SocketStream::duration() const {
  10505. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10506. std::chrono::steady_clock::now() - start_time_)
  10507. .count();
  10508. }
  10509. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10510. read_timeout_sec_ = sec;
  10511. read_timeout_usec_ = usec;
  10512. }
  10513. // Buffer stream implementation
  10514. inline bool BufferStream::is_readable() const { return true; }
  10515. inline bool BufferStream::wait_readable() const { return true; }
  10516. inline bool BufferStream::wait_writable() const { return true; }
  10517. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10518. #if defined(_MSC_VER) && _MSC_VER < 1910
  10519. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10520. #else
  10521. auto len_read = buffer.copy(ptr, size, position);
  10522. #endif
  10523. position += static_cast<size_t>(len_read);
  10524. return static_cast<ssize_t>(len_read);
  10525. }
  10526. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10527. buffer.append(ptr, size);
  10528. return static_cast<ssize_t>(size);
  10529. }
  10530. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10531. int & /*port*/) const {}
  10532. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10533. int & /*port*/) const {}
  10534. inline socket_t BufferStream::socket() const { return 0; }
  10535. inline time_t BufferStream::duration() const { return 0; }
  10536. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10537. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10538. : MatcherBase(pattern) {
  10539. constexpr const char marker[] = "/:";
  10540. // One past the last ending position of a path param substring
  10541. std::size_t last_param_end = 0;
  10542. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10543. // Needed to ensure that parameter names are unique during matcher
  10544. // construction
  10545. // If exceptions are disabled, only last duplicate path
  10546. // parameter will be set
  10547. std::unordered_set<std::string> param_name_set;
  10548. #endif
  10549. while (true) {
  10550. const auto marker_pos = pattern.find(
  10551. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10552. if (marker_pos == std::string::npos) { break; }
  10553. static_fragments_.push_back(
  10554. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10555. const auto param_name_start = marker_pos + str_len(marker);
  10556. auto sep_pos = pattern.find(separator, param_name_start);
  10557. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10558. auto param_name =
  10559. pattern.substr(param_name_start, sep_pos - param_name_start);
  10560. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10561. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10562. std::string msg = "Encountered path parameter '" + param_name +
  10563. "' multiple times in route pattern '" + pattern + "'.";
  10564. throw std::invalid_argument(msg);
  10565. }
  10566. #endif
  10567. param_names_.push_back(std::move(param_name));
  10568. last_param_end = sep_pos + 1;
  10569. }
  10570. if (last_param_end < pattern.length()) {
  10571. static_fragments_.push_back(pattern.substr(last_param_end));
  10572. }
  10573. }
  10574. inline bool PathParamsMatcher::match(Request &request) const {
  10575. request.matches = std::smatch();
  10576. request.path_params.clear();
  10577. // A pattern without parameters is just a literal path to compare against
  10578. if (param_names_.empty()) { return request.path == pattern(); }
  10579. request.path_params.reserve(param_names_.size());
  10580. // One past the position at which the path matched the pattern last time
  10581. std::size_t starting_pos = 0;
  10582. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10583. const auto &fragment = static_fragments_[i];
  10584. if (starting_pos + fragment.length() > request.path.length()) {
  10585. return false;
  10586. }
  10587. // Avoid unnecessary allocation by using strncmp instead of substr +
  10588. // comparison
  10589. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10590. fragment.length()) != 0) {
  10591. return false;
  10592. }
  10593. starting_pos += fragment.length();
  10594. // Should only happen when we have a static fragment after a param
  10595. // Example: '/users/:id/subscriptions'
  10596. // The 'subscriptions' fragment here does not have a corresponding param
  10597. if (i >= param_names_.size()) { continue; }
  10598. auto sep_pos = request.path.find(separator, starting_pos);
  10599. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10600. const auto &param_name = param_names_[i];
  10601. request.path_params.emplace(
  10602. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10603. // Mark everything up to '/' as matched
  10604. starting_pos = sep_pos + 1;
  10605. }
  10606. // Returns false if the path is longer than the pattern
  10607. return starting_pos >= request.path.length();
  10608. }
  10609. inline bool RegexMatcher::match(Request &request) const {
  10610. request.path_params.clear();
  10611. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10612. // a non-match rather than risking a stack overflow in std::regex_match.
  10613. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10614. return false;
  10615. }
  10616. return std::regex_match(request.path, request.matches, regex_);
  10617. }
  10618. // Enclose IPv6 address in brackets if needed
  10619. inline std::string prepare_host_string(const std::string &host) {
  10620. // Enclose IPv6 address in brackets (but not if already enclosed)
  10621. if (host.find(':') == std::string::npos ||
  10622. (!host.empty() && host[0] == '[')) {
  10623. // IPv4, hostname, or already bracketed IPv6
  10624. return host;
  10625. } else {
  10626. // IPv6 address without brackets
  10627. return "[" + host + "]";
  10628. }
  10629. }
  10630. inline std::string make_host_and_port_string(const std::string &host, int port,
  10631. bool is_ssl) {
  10632. auto result = prepare_host_string(host);
  10633. // Append port if not default
  10634. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10635. ; // do nothing
  10636. } else {
  10637. result += ":" + std::to_string(port);
  10638. }
  10639. return result;
  10640. }
  10641. // Create "host:port" string always including port number (for CONNECT method)
  10642. inline std::string
  10643. make_host_and_port_string_always_port(const std::string &host, int port) {
  10644. return prepare_host_string(host) + ":" + std::to_string(port);
  10645. }
  10646. // Value for the Host header a client sends when the caller supplied none.
  10647. // Only the value: callers decide where in their header list it goes.
  10648. inline std::string make_default_host_header_value(const std::string &host,
  10649. int port, bool is_ssl,
  10650. int address_family) {
  10651. if (address_family == AF_UNIX) { return "localhost"; }
  10652. return make_host_and_port_string(host, port, is_ssl);
  10653. }
  10654. inline void add_default_user_agent_header(Request &req) {
  10655. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10656. if (!req.has_header("User-Agent")) {
  10657. req.set_header("User-Agent",
  10658. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10659. }
  10660. #else
  10661. (void)req;
  10662. #endif
  10663. }
  10664. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10665. NormalizedTarget normalize_target(const std::string &host);
  10666. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10667. bool host_matches_no_proxy(const NormalizedTarget &target,
  10668. const std::vector<NoProxyEntry> &entries);
  10669. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10670. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10671. if (prefix_bits == 0) { return true; }
  10672. int full_bytes = prefix_bits / 8;
  10673. int rem_bits = prefix_bits % 8;
  10674. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10675. static_cast<size_t>(full_bytes)) != 0) {
  10676. return false;
  10677. }
  10678. if (rem_bits == 0) { return true; }
  10679. auto i = static_cast<size_t>(full_bytes);
  10680. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10681. return (ip[i] & mask) == (net[i] & mask);
  10682. }
  10683. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10684. if (token.empty()) { return false; }
  10685. if (token == "*") {
  10686. out.kind = NoProxyKind::Wildcard;
  10687. return true;
  10688. }
  10689. auto slash = token.find('/');
  10690. std::string addr_part =
  10691. (slash == std::string::npos) ? token : token.substr(0, slash);
  10692. std::string prefix_part =
  10693. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10694. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10695. // don't silently treat it as a /32 (or /128).
  10696. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10697. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10698. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10699. // when brackets are present.
  10700. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10701. addr_part.back() == ']';
  10702. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10703. if (!bracketed) {
  10704. struct in_addr v4;
  10705. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10706. int prefix = 32;
  10707. if (!prefix_part.empty() &&
  10708. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10709. prefix)) {
  10710. return false;
  10711. }
  10712. out.kind = NoProxyKind::IPv4Cidr;
  10713. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10714. out.prefix_bits = prefix;
  10715. return true;
  10716. }
  10717. }
  10718. struct in6_addr v6;
  10719. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10720. int prefix = 128;
  10721. if (!prefix_part.empty() &&
  10722. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10723. prefix)) {
  10724. return false;
  10725. }
  10726. out.kind = NoProxyKind::IPv6Cidr;
  10727. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10728. out.prefix_bits = prefix;
  10729. return true;
  10730. }
  10731. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10732. // the entry is malformed — don't fall through to the hostname branch.
  10733. if (bracketed) { return false; }
  10734. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10735. if (slash != std::string::npos) { return false; }
  10736. // Port-specific entries (host:port) are not supported.
  10737. if (token.find(':') != std::string::npos) { return false; }
  10738. std::string hostname = case_ignore::to_lower(token);
  10739. while (!hostname.empty() && hostname.front() == '.') {
  10740. hostname.erase(hostname.begin());
  10741. }
  10742. while (!hostname.empty() && hostname.back() == '.') {
  10743. hostname.pop_back();
  10744. }
  10745. if (hostname.empty()) { return false; }
  10746. out.kind = NoProxyKind::HostnameSuffix;
  10747. out.hostname_pattern = std::move(hostname);
  10748. return true;
  10749. }
  10750. inline NormalizedTarget normalize_target(const std::string &host) {
  10751. NormalizedTarget t;
  10752. std::string h = host;
  10753. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10754. h = h.substr(1, h.size() - 2);
  10755. }
  10756. // Strip a single trailing dot so "example.com." canonicalizes to
  10757. // "example.com".
  10758. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10759. t.hostname = case_ignore::to_lower(h);
  10760. if (!t.hostname.empty()) {
  10761. struct in_addr v4;
  10762. struct in6_addr v6;
  10763. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10764. t.is_ipv4 = true;
  10765. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10766. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10767. t.is_ipv6 = true;
  10768. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10769. }
  10770. }
  10771. return t;
  10772. }
  10773. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10774. const std::vector<NoProxyEntry> &entries) {
  10775. if (target.hostname.empty()) { return false; }
  10776. for (const auto &e : entries) {
  10777. switch (e.kind) {
  10778. case NoProxyKind::Wildcard: return true;
  10779. case NoProxyKind::IPv4Cidr:
  10780. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10781. return true;
  10782. }
  10783. break;
  10784. case NoProxyKind::IPv6Cidr:
  10785. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10786. return true;
  10787. }
  10788. break;
  10789. case NoProxyKind::HostnameSuffix:
  10790. if (target.is_ipv4 || target.is_ipv6) { break; }
  10791. if (target.hostname == e.hostname_pattern) { return true; }
  10792. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10793. // an entry of "example.com".
  10794. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10795. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10796. if (target.hostname[offset - 1] == '.' &&
  10797. target.hostname.compare(offset, e.hostname_pattern.size(),
  10798. e.hostname_pattern) == 0) {
  10799. return true;
  10800. }
  10801. }
  10802. break;
  10803. }
  10804. }
  10805. return false;
  10806. }
  10807. template <typename T>
  10808. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10809. T header_writer, Error &error) {
  10810. for (const auto &h : headers) {
  10811. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10812. error = Error::InvalidHeaders;
  10813. return false;
  10814. }
  10815. }
  10816. if (header_writer(strm, headers) <= 0) {
  10817. error = Error::Write;
  10818. return false;
  10819. }
  10820. return true;
  10821. }
  10822. } // namespace detail
  10823. /*
  10824. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10825. */
  10826. #ifdef CPPHTTPLIB_SSL_ENABLED
  10827. namespace detail {
  10828. // SSL socket stream implementation
  10829. inline SSLSocketStream::SSLSocketStream(
  10830. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10831. time_t read_timeout_usec, time_t write_timeout_sec,
  10832. time_t write_timeout_usec, time_t max_timeout_msec,
  10833. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10834. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10835. read_timeout_usec_(read_timeout_usec),
  10836. write_timeout_sec_(write_timeout_sec),
  10837. write_timeout_usec_(write_timeout_usec),
  10838. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10839. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10840. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10841. // Note: create_session() also clears this, but SSLClient currently
  10842. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10843. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10844. // SSL session was created.
  10845. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10846. #endif
  10847. }
  10848. inline SSLSocketStream::~SSLSocketStream() = default;
  10849. inline bool SSLSocketStream::is_readable() const {
  10850. return tls::pending(session_) > 0;
  10851. }
  10852. inline bool SSLSocketStream::wait_readable() const {
  10853. if (max_timeout_msec_ <= 0) {
  10854. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10855. }
  10856. time_t read_timeout_sec;
  10857. time_t read_timeout_usec;
  10858. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10859. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10860. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10861. }
  10862. inline bool SSLSocketStream::wait_writable() const {
  10863. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10864. !tls::is_peer_closed(session_, sock_);
  10865. }
  10866. inline bool SSLSocketStream::ensure_readable() {
  10867. if (readable_hint_) {
  10868. readable_hint_ = false;
  10869. return true;
  10870. }
  10871. return wait_readable();
  10872. }
  10873. inline bool SSLSocketStream::is_peer_alive() const {
  10874. return !tls::is_peer_closed(session_, sock_);
  10875. }
  10876. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10877. if (tls::pending(session_) > 0) {
  10878. tls::TlsError err;
  10879. auto ret = tls::read(session_, ptr, size, err);
  10880. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10881. error_ = Error::ConnectionClosed;
  10882. }
  10883. return ret;
  10884. } else if (ensure_readable()) {
  10885. tls::TlsError err;
  10886. auto ret = tls::read(session_, ptr, size, err);
  10887. if (ret < 0) {
  10888. auto n = 1000;
  10889. #ifdef _WIN32
  10890. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10891. (err.code == tls::ErrorCode::SyscallError &&
  10892. WSAGetLastError() == WSAETIMEDOUT))) {
  10893. #else
  10894. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10895. #endif
  10896. if (tls::pending(session_) > 0) {
  10897. return tls::read(session_, ptr, size, err);
  10898. } else if (wait_readable()) {
  10899. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10900. ret = tls::read(session_, ptr, size, err);
  10901. if (ret >= 0) { return ret; }
  10902. } else {
  10903. break;
  10904. }
  10905. }
  10906. assert(ret < 0);
  10907. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10908. error_ = Error::ConnectionClosed;
  10909. }
  10910. return ret;
  10911. } else {
  10912. error_ = Error::Timeout;
  10913. return -1;
  10914. }
  10915. }
  10916. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10917. if (wait_writable()) {
  10918. auto handle_size =
  10919. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10920. tls::TlsError err;
  10921. auto ret = tls::write(session_, ptr, handle_size, err);
  10922. if (ret < 0) {
  10923. auto n = 1000;
  10924. #ifdef _WIN32
  10925. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10926. (err.code == tls::ErrorCode::SyscallError &&
  10927. WSAGetLastError() == WSAETIMEDOUT))) {
  10928. #else
  10929. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10930. #endif
  10931. if (wait_writable()) {
  10932. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10933. ret = tls::write(session_, ptr, handle_size, err);
  10934. if (ret >= 0) { return ret; }
  10935. } else {
  10936. break;
  10937. }
  10938. }
  10939. assert(ret < 0);
  10940. }
  10941. return ret;
  10942. }
  10943. return -1;
  10944. }
  10945. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10946. int &port) const {
  10947. detail::get_remote_ip_and_port(sock_, ip, port);
  10948. }
  10949. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10950. int &port) const {
  10951. detail::get_local_ip_and_port(sock_, ip, port);
  10952. }
  10953. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10954. inline time_t SSLSocketStream::duration() const {
  10955. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10956. std::chrono::steady_clock::now() - start_time_)
  10957. .count();
  10958. }
  10959. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10960. read_timeout_sec_ = sec;
  10961. read_timeout_usec_ = usec;
  10962. }
  10963. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10964. tls::session_t session,
  10965. time_t read_timeout_sec,
  10966. time_t read_timeout_usec,
  10967. time_t write_timeout_sec,
  10968. time_t write_timeout_usec)
  10969. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10970. read_timeout_usec_(read_timeout_usec),
  10971. write_timeout_sec_(write_timeout_sec),
  10972. write_timeout_usec_(write_timeout_usec),
  10973. start_time_(std::chrono::steady_clock::now()) {
  10974. // The receive and send paths run on different threads, so each TLS call is
  10975. // driven in non-blocking mode and readiness is awaited with select()
  10976. // outside the session lock. Set the socket non-blocking once here; it is
  10977. // never flipped back, so no thread races on the flag.
  10978. detail::set_nonblocking(sock_, true);
  10979. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10980. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10981. #endif
  10982. }
  10983. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10984. inline bool WebSocketSSLStream::is_readable() const {
  10985. std::lock_guard<std::mutex> guard(session_mutex_);
  10986. return tls::pending(session_) > 0;
  10987. }
  10988. inline bool WebSocketSSLStream::wait_readable() const {
  10989. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10990. }
  10991. inline bool WebSocketSSLStream::wait_writable() const {
  10992. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10993. // that probe toggles the socket's blocking flag, which would race with the
  10994. // concurrent reader on a permanently non-blocking socket.
  10995. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10996. }
  10997. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10998. tls::TlsError err;
  10999. auto n = 1000;
  11000. while (--n >= 0) {
  11001. {
  11002. std::lock_guard<std::mutex> guard(session_mutex_);
  11003. auto ret = tls::read(session_, ptr, size, err);
  11004. if (ret > 0) { return ret; }
  11005. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11006. error_ = Error::ConnectionClosed;
  11007. return ret;
  11008. }
  11009. }
  11010. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11011. // direction: the send path shares this session, so output it left pending
  11012. // has to be flushed before more input can be decrypted. Anything else is
  11013. // a hard error.
  11014. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11015. #ifdef _WIN32
  11016. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11017. needs_readable =
  11018. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11019. WSAGetLastError() == WSAETIMEDOUT);
  11020. #endif
  11021. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11022. error_ = Error::Read;
  11023. return -1;
  11024. }
  11025. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11026. error_ = Error::Timeout;
  11027. return -1;
  11028. }
  11029. }
  11030. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11031. // to tell a timeout from a close would otherwise see whatever the previous
  11032. // failure left behind (error_ is never cleared on success).
  11033. error_ = Error::Read;
  11034. return -1;
  11035. }
  11036. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11037. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11038. tls::TlsError err;
  11039. auto n = 1000;
  11040. while (--n >= 0) {
  11041. {
  11042. std::lock_guard<std::mutex> guard(session_mutex_);
  11043. auto ret = tls::write(session_, ptr, handle_size, err);
  11044. if (ret >= 0) { return ret; }
  11045. }
  11046. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11047. // or a post-handshake message must be consumed before the record goes
  11048. // out. Anything else is a hard error.
  11049. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11050. #ifdef _WIN32
  11051. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11052. needs_writable =
  11053. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11054. WSAGetLastError() == WSAETIMEDOUT);
  11055. #endif
  11056. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11057. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11058. }
  11059. return -1;
  11060. }
  11061. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11062. int &port) const {
  11063. detail::get_remote_ip_and_port(sock_, ip, port);
  11064. }
  11065. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11066. int &port) const {
  11067. detail::get_local_ip_and_port(sock_, ip, port);
  11068. }
  11069. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11070. inline time_t WebSocketSSLStream::duration() const {
  11071. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11072. std::chrono::steady_clock::now() - start_time_)
  11073. .count();
  11074. }
  11075. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11076. read_timeout_sec_ = sec;
  11077. read_timeout_usec_ = usec;
  11078. }
  11079. } // namespace detail
  11080. #endif // CPPHTTPLIB_SSL_ENABLED
  11081. /*
  11082. * Group 4: Server implementation
  11083. */
  11084. // HTTP server implementation
  11085. inline Server::Server()
  11086. : new_task_queue([] {
  11087. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11088. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11089. }) {
  11090. #ifndef _WIN32
  11091. signal(SIGPIPE, SIG_IGN);
  11092. #endif
  11093. }
  11094. inline Server::~Server() = default;
  11095. inline std::unique_ptr<detail::MatcherBase>
  11096. Server::make_matcher(const std::string &pattern) {
  11097. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11098. // a path params pattern
  11099. if (pattern.find("/:") != std::string::npos) {
  11100. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11101. }
  11102. // A pattern with no regex metacharacter only has to be compared literally,
  11103. // which is what PathParamsMatcher already does when it captures no
  11104. // parameter, so std::regex is only worth building for the patterns that
  11105. // actually need it
  11106. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11107. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11108. }
  11109. return detail::make_unique<detail::RegexMatcher>(pattern);
  11110. }
  11111. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11112. return add_handler(get_handlers_, pattern, std::move(handler));
  11113. }
  11114. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11115. return add_handler(post_handlers_, pattern, std::move(handler));
  11116. }
  11117. inline Server &Server::Post(const std::string &pattern,
  11118. HandlerWithContentReader handler) {
  11119. return add_handler(post_handlers_for_content_reader_, pattern,
  11120. std::move(handler));
  11121. }
  11122. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11123. return add_handler(put_handlers_, pattern, std::move(handler));
  11124. }
  11125. inline Server &Server::Put(const std::string &pattern,
  11126. HandlerWithContentReader handler) {
  11127. return add_handler(put_handlers_for_content_reader_, pattern,
  11128. std::move(handler));
  11129. }
  11130. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11131. return add_handler(patch_handlers_, pattern, std::move(handler));
  11132. }
  11133. inline Server &Server::Patch(const std::string &pattern,
  11134. HandlerWithContentReader handler) {
  11135. return add_handler(patch_handlers_for_content_reader_, pattern,
  11136. std::move(handler));
  11137. }
  11138. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11139. return add_handler(delete_handlers_, pattern, std::move(handler));
  11140. }
  11141. inline Server &Server::Delete(const std::string &pattern,
  11142. HandlerWithContentReader handler) {
  11143. return add_handler(delete_handlers_for_content_reader_, pattern,
  11144. std::move(handler));
  11145. }
  11146. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11147. return add_handler(options_handlers_, pattern, std::move(handler));
  11148. }
  11149. inline const std::set<std::string> &Server::builtin_methods() {
  11150. thread_local const std::set<std::string> methods{
  11151. "GET", "HEAD", "POST", "PUT", "DELETE",
  11152. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11153. return methods;
  11154. }
  11155. inline Server::CustomHandlerEntry *
  11156. Server::custom_entry_for_registration(const std::string &method) {
  11157. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11158. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11159. // routing() before the custom tables are consulted, so a route registered
  11160. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11161. // there and would be reachable, but they carry protocol-level meaning
  11162. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11163. // library does not route.
  11164. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11165. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11166. has_invalid_registration_ = true;
  11167. return nullptr;
  11168. }
  11169. return &custom_handlers_[method];
  11170. }
  11171. inline Server &Server::CustomRoute(const std::string &method,
  11172. const std::string &pattern,
  11173. Handler handler) {
  11174. auto *entry = custom_entry_for_registration(method);
  11175. if (!entry) { return *this; }
  11176. return add_handler(entry->handlers, pattern, std::move(handler));
  11177. }
  11178. inline Server &Server::CustomRoute(const std::string &method,
  11179. const std::string &pattern,
  11180. HandlerWithContentReader handler) {
  11181. auto *entry = custom_entry_for_registration(method);
  11182. if (!entry) { return *this; }
  11183. return add_handler(entry->handlers_for_content_reader, pattern,
  11184. std::move(handler));
  11185. }
  11186. inline const Server::CustomHandlerEntry *
  11187. Server::find_custom_entry(const std::string &method) const {
  11188. // find() alone would be correct here. The empty() check is what keeps the
  11189. // per-request cost off servers that never call CustomRoute(), which is the
  11190. // overwhelmingly common case; keep it rather than walking into the tree.
  11191. if (custom_handlers_.empty()) { return nullptr; }
  11192. auto it = custom_handlers_.find(method);
  11193. return it == custom_handlers_.end() ? nullptr : &it->second;
  11194. }
  11195. inline Server &Server::WebSocket(const std::string &pattern,
  11196. WebSocketHandler handler) {
  11197. websocket_handlers_.push_back(
  11198. {make_matcher(pattern), std::move(handler), nullptr});
  11199. return *this;
  11200. }
  11201. inline Server &Server::WebSocket(const std::string &pattern,
  11202. WebSocketHandler handler,
  11203. SubProtocolSelector sub_protocol_selector) {
  11204. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11205. std::move(sub_protocol_selector)});
  11206. return *this;
  11207. }
  11208. inline bool Server::set_base_dir(const std::string &dir,
  11209. const std::string &mount_point) {
  11210. return set_mount_point(mount_point, dir);
  11211. }
  11212. inline bool Server::set_mount_point(const std::string &mount_point,
  11213. const std::string &dir, Headers headers) {
  11214. detail::FileStat stat(dir);
  11215. if (stat.is_dir()) {
  11216. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11217. if (!mnt.empty() && mnt[0] == '/') {
  11218. std::string resolved_base;
  11219. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11220. #if defined(_WIN32)
  11221. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11222. resolved_base += '\\';
  11223. }
  11224. #else
  11225. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11226. #endif
  11227. }
  11228. base_dirs_.push_back(
  11229. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11230. return true;
  11231. }
  11232. }
  11233. return false;
  11234. }
  11235. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11236. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11237. if (it->mount_point == mount_point) {
  11238. base_dirs_.erase(it);
  11239. return true;
  11240. }
  11241. }
  11242. return false;
  11243. }
  11244. inline Server &
  11245. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11246. const std::string &mime) {
  11247. file_extension_and_mimetype_map_[ext] = mime;
  11248. return *this;
  11249. }
  11250. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11251. default_file_mimetype_ = mime;
  11252. return *this;
  11253. }
  11254. inline Server &Server::set_file_request_handler(Handler handler) {
  11255. file_request_handler_ = std::move(handler);
  11256. return *this;
  11257. }
  11258. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11259. std::true_type) {
  11260. error_handler_ = std::move(handler);
  11261. return *this;
  11262. }
  11263. inline Server &Server::set_error_handler_core(Handler handler,
  11264. std::false_type) {
  11265. error_handler_ = [handler](const Request &req, Response &res) {
  11266. handler(req, res);
  11267. return HandlerResponse::Handled;
  11268. };
  11269. return *this;
  11270. }
  11271. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11272. exception_handler_ = std::move(handler);
  11273. return *this;
  11274. }
  11275. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11276. pre_routing_handler_ = std::move(handler);
  11277. return *this;
  11278. }
  11279. inline Server &Server::set_post_routing_handler(Handler handler) {
  11280. post_routing_handler_ = std::move(handler);
  11281. return *this;
  11282. }
  11283. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11284. pre_request_handler_ = std::move(handler);
  11285. return *this;
  11286. }
  11287. inline Server &Server::set_logger(Logger logger) {
  11288. logger_ = std::move(logger);
  11289. return *this;
  11290. }
  11291. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11292. error_logger_ = std::move(error_logger);
  11293. return *this;
  11294. }
  11295. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11296. pre_compression_logger_ = std::move(logger);
  11297. return *this;
  11298. }
  11299. inline Server &
  11300. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11301. expect_100_continue_handler_ = std::move(handler);
  11302. return *this;
  11303. }
  11304. inline Server &Server::set_start_handler(StartHandler handler) {
  11305. start_handler_ = std::move(handler);
  11306. return *this;
  11307. }
  11308. inline Server &Server::set_address_family(int family) {
  11309. address_family_ = family;
  11310. return *this;
  11311. }
  11312. inline Server &Server::set_tcp_nodelay(bool on) {
  11313. tcp_nodelay_ = on;
  11314. return *this;
  11315. }
  11316. inline Server &Server::set_ipv6_v6only(bool on) {
  11317. ipv6_v6only_ = on;
  11318. return *this;
  11319. }
  11320. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11321. socket_options_ = std::move(socket_options);
  11322. return *this;
  11323. }
  11324. inline Server &Server::set_default_headers(Headers headers) {
  11325. default_headers_ = std::move(headers);
  11326. return *this;
  11327. }
  11328. inline Server &Server::set_header_writer(
  11329. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11330. header_writer_ = writer;
  11331. return *this;
  11332. }
  11333. inline Server &
  11334. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11335. trusted_proxies_ = proxies;
  11336. return *this;
  11337. }
  11338. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11339. keep_alive_max_count_ = count;
  11340. return *this;
  11341. }
  11342. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11343. keep_alive_timeout_sec_ = sec;
  11344. return *this;
  11345. }
  11346. template <class Rep, class Period>
  11347. inline Server &Server::set_keep_alive_timeout(
  11348. const std::chrono::duration<Rep, Period> &duration) {
  11349. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11350. set_keep_alive_timeout(sec);
  11351. });
  11352. return *this;
  11353. }
  11354. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11355. read_timeout_sec_ = sec;
  11356. read_timeout_usec_ = usec;
  11357. return *this;
  11358. }
  11359. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11360. write_timeout_sec_ = sec;
  11361. write_timeout_usec_ = usec;
  11362. return *this;
  11363. }
  11364. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11365. idle_interval_sec_ = sec;
  11366. idle_interval_usec_ = usec;
  11367. return *this;
  11368. }
  11369. inline Server &Server::set_payload_max_length(size_t length) {
  11370. payload_max_length_ = length;
  11371. return *this;
  11372. }
  11373. inline Server &Server::set_static_file_compression(bool on) {
  11374. static_file_compression_ = on;
  11375. return *this;
  11376. }
  11377. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11378. static_file_compression_min_length_ = length;
  11379. return *this;
  11380. }
  11381. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11382. static_file_compression_max_length_ = length;
  11383. return *this;
  11384. }
  11385. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11386. websocket_max_missed_pongs_ = count;
  11387. return *this;
  11388. }
  11389. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11390. websocket_ping_interval_sec_ = sec;
  11391. return *this;
  11392. }
  11393. template <class Rep, class Period>
  11394. inline Server &Server::set_websocket_ping_interval(
  11395. const std::chrono::duration<Rep, Period> &duration) {
  11396. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11397. set_websocket_ping_interval(sec);
  11398. });
  11399. return *this;
  11400. }
  11401. inline bool Server::bind_to_port(const std::string &host, int port,
  11402. int socket_flags) {
  11403. auto ret = bind_internal(host, port, socket_flags);
  11404. if (ret == -1) { is_decommissioned = true; }
  11405. return ret >= 0;
  11406. }
  11407. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11408. auto ret = bind_internal(host, 0, socket_flags);
  11409. if (ret == -1) { is_decommissioned = true; }
  11410. return ret;
  11411. }
  11412. inline bool Server::listen_after_bind() { return listen_internal(); }
  11413. inline bool Server::listen(const std::string &host, int port,
  11414. int socket_flags) {
  11415. return bind_to_port(host, port, socket_flags) && listen_internal();
  11416. }
  11417. inline bool Server::is_running() const { return is_running_; }
  11418. inline void Server::wait_until_ready() const {
  11419. while (!is_running_ && !is_decommissioned) {
  11420. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11421. }
  11422. }
  11423. inline void Server::stop() noexcept {
  11424. // Release the listening socket whether or not the accept loop is running:
  11425. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11426. // exchange is what makes this safe to call concurrently with the accept loop.
  11427. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11428. if (sock != INVALID_SOCKET) {
  11429. detail::shutdown_socket(sock);
  11430. detail::close_socket(sock);
  11431. }
  11432. is_decommissioned = false;
  11433. }
  11434. inline void Server::decommission() { is_decommissioned = true; }
  11435. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11436. auto len = strlen(s);
  11437. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11438. len -= 2;
  11439. {
  11440. size_t count = 0;
  11441. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11442. switch (count) {
  11443. case 0: req.method = std::string(b, e); break;
  11444. case 1: req.target = std::string(b, e); break;
  11445. case 2: req.version = std::string(b, e); break;
  11446. default: break;
  11447. }
  11448. count++;
  11449. });
  11450. if (count != 3) { return false; }
  11451. }
  11452. // A method outside the built-in set is accepted only when a handler has been
  11453. // registered for it with CustomRoute().
  11454. const auto &methods = builtin_methods();
  11455. if (methods.find(req.method) == methods.end() &&
  11456. !find_custom_entry(req.method)) {
  11457. output_error_log(Error::InvalidHTTPMethod, &req);
  11458. return false;
  11459. }
  11460. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11461. output_error_log(Error::InvalidHTTPVersion, &req);
  11462. return false;
  11463. }
  11464. if (!detail::fields::is_request_target(req.target)) { return false; }
  11465. {
  11466. // Skip URL fragment
  11467. for (size_t i = 0; i < req.target.size(); i++) {
  11468. if (req.target[i] == '#') {
  11469. req.target.erase(i);
  11470. break;
  11471. }
  11472. }
  11473. detail::divide(req.target, '?',
  11474. [&](const char *lhs_data, std::size_t lhs_size,
  11475. const char *rhs_data, std::size_t rhs_size) {
  11476. req.path =
  11477. decode_path_component(std::string(lhs_data, lhs_size));
  11478. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11479. });
  11480. }
  11481. return true;
  11482. }
  11483. inline bool Server::write_response(Stream &strm, bool close_connection,
  11484. Request &req, Response &res) {
  11485. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11486. // incorrectly to the error content.
  11487. req.ranges.clear();
  11488. return write_response_core(strm, close_connection, req, res, false);
  11489. }
  11490. inline bool Server::write_response_with_content(Stream &strm,
  11491. bool close_connection,
  11492. const Request &req,
  11493. Response &res) {
  11494. return write_response_core(strm, close_connection, req, res, true);
  11495. }
  11496. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11497. const Request &req, Response &res,
  11498. bool need_apply_ranges) {
  11499. assert(res.status != -1);
  11500. if (400 <= res.status && error_handler_ &&
  11501. error_handler_(req, res) == HandlerResponse::Handled) {
  11502. need_apply_ranges = true;
  11503. }
  11504. detail::prefer_assigned_body(res);
  11505. std::string content_type;
  11506. std::string boundary;
  11507. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11508. // Prepare additional headers
  11509. if (close_connection ||
  11510. detail::has_header_token(req.headers, "Connection", "close") ||
  11511. 400 <= res.status || // Don't leave connections open after errors
  11512. // The client withholds the body until `100 Continue`, which was never
  11513. // sent, so whether and when the body follows is unknown.
  11514. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11515. // The body was left partway, e.g. by a content receiver that returned
  11516. // false, so the rest of it cannot be told from the next request.
  11517. (req.body_read_started_ && !req.body_consumed_)) {
  11518. res.set_header("Connection", "close");
  11519. } else {
  11520. std::string s = "timeout=";
  11521. s += std::to_string(keep_alive_timeout_sec_);
  11522. s += ", max=";
  11523. s += std::to_string(keep_alive_max_count_);
  11524. res.set_header("Keep-Alive", s);
  11525. }
  11526. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11527. !res.has_header("Content-Type")) {
  11528. res.set_header("Content-Type", "text/plain");
  11529. }
  11530. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11531. !res.has_header("Content-Length")) {
  11532. res.set_header("Content-Length", "0");
  11533. }
  11534. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11535. res.set_header("Accept-Ranges", "bytes");
  11536. }
  11537. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11538. // Response line and headers
  11539. detail::BufferStream bstrm;
  11540. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11541. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11542. // Combine a small body with the headers so the whole response leaves in a
  11543. // single write. A large body is written on its own instead: a copy of it
  11544. // costs more than the extra write saves.
  11545. auto send_body = req.method != "HEAD";
  11546. auto body_is_separate = false;
  11547. auto provider_done = false;
  11548. if (send_body && !res.body.empty() && !res.content_provider_) {
  11549. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11550. bstrm.write(res.body.data(), res.body.size());
  11551. } else {
  11552. body_is_separate = true;
  11553. }
  11554. } else if (send_body && res.content_provider_ &&
  11555. res.is_file_content_provider_ &&
  11556. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11557. // A small file is read into the same buffer. Other providers may produce
  11558. // their data over time, so they are never held back.
  11559. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11560. return false;
  11561. }
  11562. provider_done = true;
  11563. }
  11564. // Log before writing to avoid race condition with client-side code that
  11565. // accesses logger-captured data immediately after receiving the response.
  11566. output_log(req, res);
  11567. // Flush buffer
  11568. auto &data = bstrm.get_buffer();
  11569. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11570. if (body_is_separate) {
  11571. return detail::write_data(strm, res.body.data(), res.body.size());
  11572. }
  11573. // Streaming body
  11574. if (send_body && res.content_provider_) {
  11575. if (!provider_done &&
  11576. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11577. return false;
  11578. }
  11579. res.content_provider_success_ = true;
  11580. }
  11581. return true;
  11582. }
  11583. inline bool
  11584. Server::write_content_with_provider(Stream &strm, const Request &req,
  11585. Response &res, const std::string &boundary,
  11586. const std::string &content_type) {
  11587. auto is_shutting_down = [this]() {
  11588. return this->svr_sock_ == INVALID_SOCKET;
  11589. };
  11590. if (res.content_length_ > 0) {
  11591. // Only a 206 response is served as a partial representation, matching the
  11592. // condition `apply_ranges()` used to decide the Content-Length and the
  11593. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11594. // only for a 2xx status, slicing under any other status would write a body
  11595. // that disagrees with the header already sent, from an unchecked offset.
  11596. auto is_partial =
  11597. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11598. if (!is_partial) {
  11599. return detail::write_content(strm, res.content_provider_, 0,
  11600. res.content_length_, is_shutting_down);
  11601. } else if (req.ranges.size() == 1) {
  11602. auto offset_and_length = detail::get_range_offset_and_length(
  11603. req.ranges[0], res.content_length_);
  11604. return detail::write_content(strm, res.content_provider_,
  11605. offset_and_length.first,
  11606. offset_and_length.second, is_shutting_down);
  11607. } else {
  11608. return detail::write_multipart_ranges_data(
  11609. strm, req, res, boundary, content_type, res.content_length_,
  11610. is_shutting_down);
  11611. }
  11612. } else {
  11613. if (res.is_chunked_content_provider_) {
  11614. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11615. // re-negotiating here would disagree with them, e.g. once a handler's
  11616. // own Content-Encoding header suppresses the negotiation.
  11617. auto compressor = detail::make_compressor(res.content_coding_);
  11618. if (!compressor) {
  11619. compressor = detail::make_unique<detail::nocompressor>();
  11620. }
  11621. return detail::write_content_chunked(strm, res.content_provider_,
  11622. is_shutting_down, *compressor);
  11623. } else {
  11624. return detail::write_content_without_length(strm, res.content_provider_,
  11625. is_shutting_down);
  11626. }
  11627. }
  11628. }
  11629. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11630. FormFields::iterator cur_field;
  11631. FormFiles::iterator cur_file;
  11632. auto is_text_field = false;
  11633. size_t count = 0;
  11634. if (read_content_core(
  11635. strm, req, res,
  11636. // Regular
  11637. [&](const char *buf, size_t n) {
  11638. // Prevent arithmetic overflow when checking sizes.
  11639. // Avoid computing (req.body.size() + n) directly because
  11640. // adding two unsigned `size_t` values can wrap around and
  11641. // produce a small result instead of indicating overflow.
  11642. // Instead, check using subtraction: ensure `n` does not
  11643. // exceed the remaining capacity `max_size() - size()`.
  11644. if (req.body.size() >= req.body.max_size() ||
  11645. n > req.body.max_size() - req.body.size()) {
  11646. return false;
  11647. }
  11648. // Limit decompressed body size to payload_max_length_ to protect
  11649. // against "zip bomb" attacks where a small compressed payload
  11650. // decompresses to a massive size.
  11651. if (payload_max_length_ > 0 &&
  11652. (req.body.size() >= payload_max_length_ ||
  11653. n > payload_max_length_ - req.body.size())) {
  11654. return false;
  11655. }
  11656. req.body.append(buf, n);
  11657. return true;
  11658. },
  11659. // Multipart FormData
  11660. [&](const FormData &file) {
  11661. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11662. output_error_log(Error::TooManyFormDataFiles, &req);
  11663. return false;
  11664. }
  11665. if (file.filename.empty()) {
  11666. cur_field = req.form.fields.emplace(
  11667. file.name, FormField{file.name, file.content, file.headers});
  11668. is_text_field = true;
  11669. } else {
  11670. cur_file = req.form.files.emplace(file.name, file);
  11671. is_text_field = false;
  11672. }
  11673. return true;
  11674. },
  11675. [&](const char *buf, size_t n) {
  11676. if (is_text_field) {
  11677. auto &content = cur_field->second.content;
  11678. if (content.size() + n > content.max_size()) { return false; }
  11679. content.append(buf, n);
  11680. } else {
  11681. auto &content = cur_file->second.content;
  11682. if (content.size() + n > content.max_size()) { return false; }
  11683. content.append(buf, n);
  11684. }
  11685. return true;
  11686. })) {
  11687. const auto &content_type = req.get_header_value("Content-Type");
  11688. if (detail::extract_media_type(content_type) ==
  11689. "application/x-www-form-urlencoded") {
  11690. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11691. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11692. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11693. return false;
  11694. }
  11695. detail::parse_query_text(req.body, req.params);
  11696. }
  11697. return true;
  11698. }
  11699. return false;
  11700. }
  11701. inline bool Server::read_content_with_content_receiver(
  11702. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11703. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11704. return read_content_core(strm, req, res, std::move(receiver),
  11705. std::move(multipart_header),
  11706. std::move(multipart_receiver));
  11707. }
  11708. inline bool Server::read_content_core(
  11709. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11710. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11711. detail::FormDataParser multipart_form_data_parser;
  11712. ContentReceiverWithProgress out;
  11713. if (req.is_multipart_form_data()) {
  11714. const auto &content_type = req.get_header_value("Content-Type");
  11715. std::string boundary;
  11716. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11717. res.status = StatusCode::BadRequest_400;
  11718. output_error_log(Error::MultipartParsing, &req);
  11719. return false;
  11720. }
  11721. multipart_form_data_parser.set_boundary(std::move(boundary));
  11722. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11723. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11724. multipart_receiver);
  11725. };
  11726. } else {
  11727. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11728. size_t /*len*/) { return receiver(buf, n); };
  11729. }
  11730. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11731. // For non-SSL builds we still scan non-persistent connections for stray
  11732. // body bytes so the payload limit is enforced (413). On keep-alive,
  11733. // pending bytes may be the next request (issue #2450), so skip.
  11734. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11735. if (!req.has_header("Content-Length") &&
  11736. !detail::is_chunked_transfer_encoding(req.headers)) {
  11737. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11738. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11739. auto has_data = strm.is_readable();
  11740. if (!has_data) {
  11741. auto s = strm.socket();
  11742. if (s != INVALID_SOCKET) {
  11743. has_data = detail::select_read(s, 0, 0) > 0;
  11744. }
  11745. }
  11746. if (has_data) {
  11747. // Route through the same decompressing reader used by the
  11748. // length-framed and chunked paths below, so payload_max_length_ is
  11749. // enforced on the decompressed size here too instead of only on the
  11750. // compressed wire bytes.
  11751. return detail::read_content(strm, req, payload_max_length_, res.status,
  11752. nullptr, out, true);
  11753. }
  11754. }
  11755. return true;
  11756. }
  11757. #else
  11758. if (!req.has_header("Content-Length") &&
  11759. !detail::is_chunked_transfer_encoding(req.headers)) {
  11760. return true;
  11761. }
  11762. #endif
  11763. // A second read would start where the first one stopped, or in the next
  11764. // request.
  11765. if (req.body_read_started_) { return false; }
  11766. // The client is waiting for this before it sends the body.
  11767. if (req.expect_100_continue_pending_) {
  11768. req.expect_100_continue_pending_ = false;
  11769. detail::write_response_line(strm, StatusCode::Continue_100);
  11770. strm.write("\r\n");
  11771. }
  11772. // Set before reading, since a receiver may also stop by throwing.
  11773. req.body_read_started_ = true;
  11774. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11775. out, true)) {
  11776. return false;
  11777. }
  11778. req.body_consumed_ = true;
  11779. if (req.is_multipart_form_data()) {
  11780. if (!multipart_form_data_parser.is_valid()) {
  11781. res.status = StatusCode::BadRequest_400;
  11782. output_error_log(Error::MultipartParsing, &req);
  11783. return false;
  11784. }
  11785. }
  11786. return true;
  11787. }
  11788. inline bool Server::handle_file_request(Request &req, Response &res) {
  11789. for (const auto &entry : base_dirs_) {
  11790. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11791. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11792. // One that already ends in '/' (the root mount among them) carries its own
  11793. // boundary; set_mount_point() guarantees the mount point is not empty.
  11794. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11795. (entry.mount_point.back() == '/' ||
  11796. req.path.size() == entry.mount_point.size() ||
  11797. req.path[entry.mount_point.size()] == '/')) {
  11798. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11799. if (detail::is_valid_path(sub_path)) {
  11800. auto path = entry.base_dir + sub_path;
  11801. if (path.back() == '/') { path += "index.html"; }
  11802. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11803. // but symlinks/junctions can still escape the base directory.
  11804. if (!entry.resolved_base_dir.empty()) {
  11805. std::string resolved_path;
  11806. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11807. !detail::is_path_within_base(resolved_path,
  11808. entry.resolved_base_dir)) {
  11809. res.status = StatusCode::Forbidden_403;
  11810. return true;
  11811. }
  11812. }
  11813. detail::FileStat stat(path);
  11814. if (stat.is_dir()) {
  11815. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  11816. // in the name from reading as a scheme.
  11817. auto name = req.path.substr(req.path.rfind('/') + 1);
  11818. res.set_redirect("./" + encode_path_component(name) + "/",
  11819. StatusCode::MovedPermanently_301);
  11820. return true;
  11821. }
  11822. if (stat.is_file()) {
  11823. for (const auto &kv : entry.headers) {
  11824. res.set_header(kv.first, kv.second);
  11825. }
  11826. auto content_type = detail::find_content_type(
  11827. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11828. auto encoding = detail::EncodingType::None;
  11829. if (static_file_compression_) {
  11830. encoding =
  11831. static_file_encoding(req, res, content_type, stat.size());
  11832. }
  11833. // The ETag names the representation actually sent, so a client that
  11834. // cached the compressed form revalidates against the compressed ETag
  11835. // and still gets a 304, while one that took identity keeps the plain
  11836. // ETag.
  11837. auto etag = detail::compute_etag(
  11838. stat, encoding == detail::EncodingType::None
  11839. ? std::string()
  11840. : std::string("-") + detail::encoding_name(encoding));
  11841. if (!etag.empty()) { res.set_header("ETag", etag); }
  11842. auto mtime = stat.mtime();
  11843. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11844. if (!last_modified.empty()) {
  11845. res.set_header("Last-Modified", last_modified);
  11846. }
  11847. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11848. check_if_range(req, etag, mtime);
  11849. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11850. if (!mm->is_open()) {
  11851. output_error_log(Error::OpenFile, &req);
  11852. return false;
  11853. }
  11854. detail::set_file_content_provider(res, mm, content_type, encoding);
  11855. if (req.method != "HEAD" && file_request_handler_) {
  11856. file_request_handler_(req, res);
  11857. }
  11858. return true;
  11859. } else {
  11860. output_error_log(Error::OpenFile, &req);
  11861. }
  11862. }
  11863. }
  11864. }
  11865. return false;
  11866. }
  11867. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11868. const std::string &etag,
  11869. time_t mtime) const {
  11870. // Handle conditional GET:
  11871. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11872. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11873. if (req.has_header("If-None-Match")) {
  11874. if (!etag.empty()) {
  11875. auto val =
  11876. detail::get_combined_header_value(req.headers, "If-None-Match");
  11877. // NOTE: We use exact string matching here. This works correctly
  11878. // because our server always generates weak ETags (W/"..."), and
  11879. // clients typically send back the same ETag they received.
  11880. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11881. // If-None-Match, where W/"x" and "x" would match, but this
  11882. // simplified implementation requires exact matches.
  11883. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11884. [&](const char *b, const char *e) {
  11885. auto seg_len = static_cast<size_t>(e - b);
  11886. return (seg_len == 1 && *b == '*') ||
  11887. (seg_len == etag.size() &&
  11888. std::equal(b, e, etag.begin()));
  11889. });
  11890. if (ret) {
  11891. res.status = StatusCode::NotModified_304;
  11892. return true;
  11893. }
  11894. }
  11895. } else if (req.has_header("If-Modified-Since")) {
  11896. auto val = req.get_header_value("If-Modified-Since");
  11897. auto t = detail::parse_http_date(val);
  11898. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11899. res.status = StatusCode::NotModified_304;
  11900. return true;
  11901. }
  11902. }
  11903. return false;
  11904. }
  11905. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11906. time_t mtime) const {
  11907. // Handle If-Range for partial content requests (RFC 9110
  11908. // Section 13.1.5). If-Range is only evaluated when Range header is
  11909. // present. If the validator matches, serve partial content; otherwise
  11910. // serve full content.
  11911. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11912. auto val = req.get_header_value("If-Range");
  11913. auto is_valid_range = [&]() {
  11914. if (detail::is_strong_etag(val)) {
  11915. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11916. // comparison.
  11917. return (!etag.empty() && val == etag);
  11918. } else if (detail::is_weak_etag(val)) {
  11919. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11920. return false;
  11921. } else {
  11922. // HTTP-date comparison
  11923. auto t = detail::parse_http_date(val);
  11924. return (t != static_cast<time_t>(-1) && mtime <= t);
  11925. }
  11926. };
  11927. if (!is_valid_range()) {
  11928. // Validator doesn't match: ignore Range and serve full content
  11929. req.ranges.clear();
  11930. return false;
  11931. }
  11932. }
  11933. return true;
  11934. }
  11935. inline socket_t
  11936. Server::create_server_socket(const std::string &host, int port,
  11937. int socket_flags,
  11938. SocketOptions socket_options) const {
  11939. return detail::create_socket(
  11940. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11941. ipv6_v6only_, std::move(socket_options),
  11942. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11943. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11944. output_error_log(Error::BindIPAddress, nullptr);
  11945. return false;
  11946. }
  11947. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11948. output_error_log(Error::Listen, nullptr);
  11949. return false;
  11950. }
  11951. return true;
  11952. });
  11953. }
  11954. inline int Server::bind_internal(const std::string &host, int port,
  11955. int socket_flags) {
  11956. if (is_decommissioned) { return -1; }
  11957. if (!is_valid()) { return -1; }
  11958. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11959. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11960. if (port == 0) {
  11961. struct sockaddr_storage addr;
  11962. socklen_t addr_len = sizeof(addr);
  11963. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11964. &addr_len) == -1) {
  11965. output_error_log(Error::GetSockName, nullptr);
  11966. return -1;
  11967. }
  11968. if (addr.ss_family == AF_INET) {
  11969. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11970. } else if (addr.ss_family == AF_INET6) {
  11971. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11972. } else {
  11973. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11974. return -1;
  11975. }
  11976. } else {
  11977. return port;
  11978. }
  11979. }
  11980. inline bool Server::listen_internal() {
  11981. // A stop() between bind and listen leaves nothing to accept on. Report
  11982. // failure instead of returning success without ever serving, and mark the
  11983. // server decommissioned the way any failed listen does so that a concurrent
  11984. // wait_until_ready() wakes up instead of spinning forever.
  11985. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11986. is_decommissioned = true;
  11987. return false;
  11988. }
  11989. auto ret = true;
  11990. is_running_ = true;
  11991. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11992. if (start_handler_) { start_handler_(); }
  11993. {
  11994. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11995. while (svr_sock_ != INVALID_SOCKET) {
  11996. #ifndef _WIN32
  11997. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11998. #endif
  11999. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12000. idle_interval_usec_);
  12001. if (val == 0) { // Timeout
  12002. task_queue->on_idle();
  12003. continue;
  12004. }
  12005. #ifndef _WIN32
  12006. }
  12007. #endif
  12008. #if defined _WIN32
  12009. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12010. // OVERLAPPED
  12011. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12012. #elif defined SOCK_CLOEXEC
  12013. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12014. #else
  12015. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12016. #endif
  12017. if (sock == INVALID_SOCKET) {
  12018. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12019. // touches the CRT errno, so the two have to be asked platform by
  12020. // platform rather than by testing errno here.
  12021. if (detail::is_accept_resource_error()) {
  12022. // The per-process descriptor limit or the network stack's buffer
  12023. // space has been reached. Try to accept new connections after a
  12024. // short sleep.
  12025. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12026. continue;
  12027. } else if (detail::is_accept_transient_error()) {
  12028. continue;
  12029. }
  12030. // Take the descriptor out of svr_sock_ before closing it: a later
  12031. // stop() would otherwise shutdown()/close() a value the OS may have
  12032. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12033. // gone. The exchange also settles the race with a concurrent stop(),
  12034. // since whichever side takes the descriptor closes it exactly once.
  12035. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12036. if (listen_sock != INVALID_SOCKET) {
  12037. detail::close_socket(listen_sock);
  12038. ret = false;
  12039. output_error_log(Error::Connection, nullptr);
  12040. } else {
  12041. ; // The server socket was closed by user.
  12042. }
  12043. break;
  12044. }
  12045. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12046. read_timeout_sec_, read_timeout_usec_);
  12047. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12048. write_timeout_sec_, write_timeout_usec_);
  12049. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12050. if (!task_queue->enqueue(
  12051. [this, sock]() { process_and_close_socket(sock); })) {
  12052. output_error_log(Error::ResourceExhaustion, nullptr);
  12053. detail::shutdown_socket(sock);
  12054. detail::close_socket(sock);
  12055. }
  12056. }
  12057. task_queue->shutdown();
  12058. }
  12059. is_decommissioned = !ret;
  12060. return ret;
  12061. }
  12062. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12063. if (pre_routing_handler_ &&
  12064. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12065. return true;
  12066. }
  12067. // File handler
  12068. if ((req.method == "GET" || req.method == "HEAD") &&
  12069. handle_file_request(req, res)) {
  12070. return true;
  12071. }
  12072. const auto *custom = find_custom_entry(req.method);
  12073. // The second clause mirrors what expect_content() does unconditionally for
  12074. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12075. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12076. // `allprop`) would skip its handler and fall through to 404.
  12077. if (detail::expect_content(req) ||
  12078. (custom && !custom->handlers_for_content_reader.empty())) {
  12079. // Content reader handler
  12080. {
  12081. // Track whether the ContentReader was aborted due to the decompressed
  12082. // payload exceeding `payload_max_length_`.
  12083. // The user handler runs after the lambda returns, so we must restore the
  12084. // 413 status if the handler overwrites it.
  12085. bool content_reader_payload_too_large = false;
  12086. ContentReader reader(
  12087. [&](ContentReceiver receiver) {
  12088. auto result = read_content_with_content_receiver(
  12089. strm, req, res, std::move(receiver), nullptr, nullptr);
  12090. if (!result) {
  12091. output_error_log(Error::Read, &req);
  12092. if (res.status == StatusCode::PayloadTooLarge_413) {
  12093. content_reader_payload_too_large = true;
  12094. }
  12095. }
  12096. return result;
  12097. },
  12098. [&](FormDataHeader header, ContentReceiver receiver) {
  12099. auto result = read_content_with_content_receiver(
  12100. strm, req, res, nullptr, std::move(header),
  12101. std::move(receiver));
  12102. if (!result) {
  12103. output_error_log(Error::Read, &req);
  12104. if (res.status == StatusCode::PayloadTooLarge_413) {
  12105. content_reader_payload_too_large = true;
  12106. }
  12107. }
  12108. return result;
  12109. });
  12110. bool dispatched = false;
  12111. if (req.method == "POST") {
  12112. dispatched = dispatch_request_for_content_reader(
  12113. req, res, std::move(reader), post_handlers_for_content_reader_);
  12114. } else if (req.method == "PUT") {
  12115. dispatched = dispatch_request_for_content_reader(
  12116. req, res, std::move(reader), put_handlers_for_content_reader_);
  12117. } else if (req.method == "PATCH") {
  12118. dispatched = dispatch_request_for_content_reader(
  12119. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12120. } else if (req.method == "DELETE") {
  12121. dispatched = dispatch_request_for_content_reader(
  12122. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12123. } else if (custom) {
  12124. dispatched = dispatch_request_for_content_reader(
  12125. req, res, std::move(reader), custom->handlers_for_content_reader);
  12126. }
  12127. if (dispatched) {
  12128. if (content_reader_payload_too_large) {
  12129. // Enforce the limit: override any status the handler may have set
  12130. // and return false so the error path sends a plain 413 response.
  12131. res.status = StatusCode::PayloadTooLarge_413;
  12132. detail::clear_content(res);
  12133. return false;
  12134. }
  12135. return true;
  12136. }
  12137. }
  12138. // NOTE: `req.body` is not read here. For a regular handler the body is
  12139. // read inside dispatch_request(), after the route has matched and the
  12140. // pre-request handler has approved the request, so that a rejected
  12141. // request (e.g. failed authentication) never forces us to buffer a
  12142. // potentially large body.
  12143. }
  12144. // Regular handler
  12145. if (req.method == "GET" || req.method == "HEAD") {
  12146. return dispatch_request(req, res, get_handlers_, strm);
  12147. } else if (req.method == "POST") {
  12148. return dispatch_request(req, res, post_handlers_, strm);
  12149. } else if (req.method == "PUT") {
  12150. return dispatch_request(req, res, put_handlers_, strm);
  12151. } else if (req.method == "DELETE") {
  12152. return dispatch_request(req, res, delete_handlers_, strm);
  12153. } else if (req.method == "OPTIONS") {
  12154. return dispatch_request(req, res, options_handlers_, strm);
  12155. } else if (req.method == "PATCH") {
  12156. return dispatch_request(req, res, patch_handlers_, strm);
  12157. } else if (custom) {
  12158. return dispatch_request(req, res, custom->handlers, strm);
  12159. }
  12160. res.status = StatusCode::BadRequest_400;
  12161. return false;
  12162. }
  12163. inline bool Server::dispatch_request(Request &req, Response &res,
  12164. const Handlers &handlers, Stream &strm) {
  12165. for (const auto &x : handlers) {
  12166. const auto &matcher = x.first;
  12167. const auto &handler = x.second;
  12168. if (matcher->match(req)) {
  12169. req.matched_route = matcher->pattern();
  12170. // Run the pre-request handler before reading the body so a rejected
  12171. // request (e.g. failed authentication) never forces us to buffer a
  12172. // potentially large body. `req.matched_route` is available here.
  12173. if (pre_request_handler_ &&
  12174. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12175. return true;
  12176. }
  12177. // The route matched and the request was approved; read the body now.
  12178. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12179. output_error_log(Error::Read, &req);
  12180. return false;
  12181. }
  12182. handler(req, res);
  12183. return true;
  12184. }
  12185. }
  12186. return false;
  12187. }
  12188. // Decides the content coding for a response served straight from a file. Both
  12189. // the ETag, which has to name the representation actually sent, and
  12190. // `apply_static_file_compression()` go through this, so the two cannot drift
  12191. // apart.
  12192. inline detail::EncodingType
  12193. Server::static_file_encoding(const Request &req, const Response &res,
  12194. const std::string &content_type,
  12195. size_t length) const {
  12196. if (!static_file_compression_) { return detail::EncodingType::None; }
  12197. // Nothing to compress, and an empty file already answers with
  12198. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12199. // turn an empty body into a 20-byte gzip stream.
  12200. if (length == 0) { return detail::EncodingType::None; }
  12201. // A file that already fits in a single packet gains nothing from being made
  12202. // smaller, since it still travels in that one segment, and a file of a few
  12203. // bytes comes out larger than it went in.
  12204. if (length < static_file_compression_min_length_) {
  12205. return detail::EncodingType::None;
  12206. }
  12207. // RFC 9110 applies Range to the representation after content coding, so a
  12208. // compressed 206 would mean compressing the whole file and then slicing it.
  12209. // Serve ranges from the identity representation instead.
  12210. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12211. if (static_file_compression_max_length_ > 0 &&
  12212. length > static_file_compression_max_length_) {
  12213. return detail::EncodingType::None;
  12214. }
  12215. return detail::encoding_type(req, res, content_type);
  12216. }
  12217. // Compresses a file-backed content provider into `res.body` and takes over the
  12218. // framing headers. Returns false when the response is left untouched.
  12219. inline bool Server::apply_static_file_compression(const Request &req,
  12220. Response &res) const {
  12221. auto type = res.content_coding_;
  12222. if (type == detail::EncodingType::None || !res.content_provider_) {
  12223. return false;
  12224. }
  12225. auto compressor = detail::make_compressor(type);
  12226. if (!compressor) { return false; }
  12227. output_pre_compression_log(req, res);
  12228. std::string compressed;
  12229. if (!detail::compress_content_provider(res.content_provider_,
  12230. res.content_length_, *compressor,
  12231. compressed)) {
  12232. return false;
  12233. }
  12234. res.body.swap(compressed);
  12235. // The provider was consumed in full, so its releaser hears about a success.
  12236. res.content_provider_success_ = true;
  12237. detail::clear_content_provider(res);
  12238. res.set_header("Content-Encoding", detail::encoding_name(type));
  12239. res.set_header("Vary", "Accept-Encoding");
  12240. res.set_header("Content-Length", std::to_string(res.body.size()));
  12241. return true;
  12242. }
  12243. inline void Server::apply_ranges(const Request &req, Response &res,
  12244. std::string &content_type,
  12245. std::string &boundary) const {
  12246. // A known-length content provider leaves `res.body` empty, so the compressor
  12247. // at the end of this function never runs for one (issue #2545). A file-backed
  12248. // provider is fully readable right here, so compress it and answer with an
  12249. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12250. // takes the same path as `set_content()` from here on. Range requests never
  12251. // get a content coding, so `Content-Range` still names identity bytes and
  12252. // none of the framing below applies.
  12253. if (apply_static_file_compression(req, res)) { return; }
  12254. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12255. auto it = res.headers.find("Content-Type");
  12256. if (it != res.headers.end()) {
  12257. content_type = it->second;
  12258. res.headers.erase(it);
  12259. }
  12260. boundary = detail::make_multipart_data_boundary();
  12261. res.set_header("Content-Type",
  12262. "multipart/byteranges; boundary=" + boundary);
  12263. }
  12264. auto type = detail::encoding_type(req, res);
  12265. if (res.body.empty()) {
  12266. if (res.content_length_ > 0) {
  12267. size_t length = 0;
  12268. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12269. length = res.content_length_;
  12270. } else if (req.ranges.size() == 1) {
  12271. auto offset_and_length = detail::get_range_offset_and_length(
  12272. req.ranges[0], res.content_length_);
  12273. length = offset_and_length.second;
  12274. auto content_range = detail::make_content_range_header_field(
  12275. offset_and_length, res.content_length_);
  12276. res.set_header("Content-Range", content_range);
  12277. } else {
  12278. length = detail::get_multipart_ranges_data_length(
  12279. req, boundary, content_type, res.content_length_);
  12280. }
  12281. res.set_header("Content-Length", std::to_string(length));
  12282. } else {
  12283. if (res.content_provider_) {
  12284. if (res.is_chunked_content_provider_) {
  12285. res.set_header("Transfer-Encoding", "chunked");
  12286. res.content_coding_ = type;
  12287. if (type != detail::EncodingType::None) {
  12288. res.set_header("Content-Encoding", detail::encoding_name(type));
  12289. res.set_header("Vary", "Accept-Encoding");
  12290. }
  12291. }
  12292. }
  12293. }
  12294. } else {
  12295. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12296. ;
  12297. } else if (req.ranges.size() == 1) {
  12298. auto offset_and_length =
  12299. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12300. auto offset = offset_and_length.first;
  12301. auto length = offset_and_length.second;
  12302. auto content_range = detail::make_content_range_header_field(
  12303. offset_and_length, res.body.size());
  12304. res.set_header("Content-Range", content_range);
  12305. assert(offset + length <= res.body.size());
  12306. res.body = res.body.substr(offset, length);
  12307. } else {
  12308. std::string data;
  12309. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12310. res.body.size(), data);
  12311. res.body.swap(data);
  12312. }
  12313. if (type != detail::EncodingType::None) {
  12314. output_pre_compression_log(req, res);
  12315. if (auto compressor = detail::make_compressor(type)) {
  12316. std::string compressed;
  12317. if (compressor->compress(res.body.data(), res.body.size(), true,
  12318. [&](const char *data, size_t data_len) {
  12319. compressed.append(data, data_len);
  12320. return true;
  12321. })) {
  12322. res.body.swap(compressed);
  12323. res.set_header("Content-Encoding", detail::encoding_name(type));
  12324. res.set_header("Vary", "Accept-Encoding");
  12325. }
  12326. }
  12327. }
  12328. res.content_length_ = res.body.size();
  12329. res.set_header("Content-Length", std::to_string(res.content_length_));
  12330. }
  12331. }
  12332. inline bool Server::dispatch_request_for_content_reader(
  12333. Request &req, Response &res, ContentReader content_reader,
  12334. const HandlersForContentReader &handlers) const {
  12335. for (const auto &x : handlers) {
  12336. const auto &matcher = x.first;
  12337. const auto &handler = x.second;
  12338. if (matcher->match(req)) {
  12339. req.matched_route = matcher->pattern();
  12340. if (!pre_request_handler_ ||
  12341. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12342. handler(req, res, content_reader);
  12343. }
  12344. return true;
  12345. }
  12346. }
  12347. return false;
  12348. }
  12349. inline std::string
  12350. get_client_ip(const std::string &x_forwarded_for,
  12351. const std::vector<std::string> &trusted_proxies) {
  12352. // X-Forwarded-For is a comma-separated list per RFC 7239
  12353. std::vector<std::string> ip_list;
  12354. detail::split(x_forwarded_for.data(),
  12355. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12356. [&](const char *b, const char *e) {
  12357. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12358. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12359. });
  12360. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12361. // no segments. Signal "no client IP derived" with an empty string so the
  12362. // caller can fall back to the connection-level remote address.
  12363. if (ip_list.empty()) { return std::string(); }
  12364. // Each hop appends the address it received the request from, so the rightmost
  12365. // entries are the ones written by our own infrastructure while the leftmost
  12366. // are whatever the original client chose to send. Walk from the right and
  12367. // skip trusted proxies; the first address that is not a trusted proxy is the
  12368. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12369. // from the left instead lets a client forge an arbitrary address by following
  12370. // it with a trusted proxy's address, which the left-to-right scan then
  12371. // returned as the client.
  12372. for (size_t i = ip_list.size(); i-- > 0;) {
  12373. const auto &ip = ip_list[i];
  12374. auto is_trusted_proxy =
  12375. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12376. [&](const std::string &proxy) { return ip == proxy; });
  12377. if (!is_trusted_proxy) { return ip; }
  12378. }
  12379. // Every hop was a trusted proxy; fall back to the first entry.
  12380. return ip_list.front();
  12381. }
  12382. inline bool
  12383. Server::process_request(Stream &strm, const std::string &remote_addr,
  12384. int remote_port, const std::string &local_addr,
  12385. int local_port, bool close_connection,
  12386. bool &connection_closed,
  12387. const std::function<void(Request &)> &setup_request,
  12388. bool *websocket_upgraded) {
  12389. std::array<char, 2048> buf{};
  12390. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12391. // Connection has been closed on client
  12392. if (!line_reader.getline()) { return false; }
  12393. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12394. // clients send an extra CRLF after a request body, which would otherwise be
  12395. // parsed as the next request on a persistent connection.
  12396. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12397. return false;
  12398. }
  12399. Request req;
  12400. req.start_time_ = std::chrono::steady_clock::now();
  12401. req.remote_addr = remote_addr;
  12402. req.remote_port = remote_port;
  12403. req.local_addr = local_addr;
  12404. req.local_port = local_port;
  12405. Response res;
  12406. res.version = "HTTP/1.1";
  12407. res.headers = default_headers_;
  12408. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12409. // close the connection after that response, whichever path wrote it (an
  12410. // error status, a handler, or a rejected request). Reading on would also
  12411. // parse whatever the client sent next on a connection it considers done.
  12412. auto honor_connection_close = detail::scope_exit([&] {
  12413. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12414. connection_closed = true;
  12415. }
  12416. });
  12417. // Request line and headers. A rejected message leaves the rest of it (and
  12418. // any body) unread, so the connection cannot be reused: the leftover bytes
  12419. // would be parsed as the next request.
  12420. if (!parse_request_line(line_reader.ptr(), req)) {
  12421. connection_closed = true;
  12422. res.status = StatusCode::BadRequest_400;
  12423. output_error_log(Error::InvalidRequestLine, &req);
  12424. return write_response(strm, close_connection, req, res);
  12425. }
  12426. // Request headers
  12427. if (!detail::read_headers(strm, req.headers)) {
  12428. connection_closed = true;
  12429. res.status = StatusCode::BadRequest_400;
  12430. output_error_log(Error::InvalidHeaders, &req);
  12431. return write_response(strm, close_connection, req, res);
  12432. }
  12433. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12434. // which would otherwise let an intermediary and this parser disagree on
  12435. // where the body ends and enable request smuggling. Three cases: a
  12436. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12437. // or empty), which would otherwise be read as "no body"; a non-zero
  12438. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12439. // tolerated for compatibility with existing clients); and a
  12440. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12441. // length undeterminable. None of them may fall through to the "no body"
  12442. // path, or the body bytes are parsed as the next request on a persistent
  12443. // connection.
  12444. auto is_invalid_content_length = false;
  12445. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12446. is_invalid_content_length);
  12447. if (is_invalid_content_length ||
  12448. detail::has_conflicting_content_length(req.headers) ||
  12449. (req.has_header("Transfer-Encoding") &&
  12450. !detail::is_chunked_transfer_encoding(req.headers))) {
  12451. connection_closed = true;
  12452. res.status = StatusCode::BadRequest_400;
  12453. return write_response(strm, close_connection, req, res);
  12454. }
  12455. // RFC 9112 §3.2: Reject more than one Host field line or an invalid Host
  12456. // value, so that every recipient of the request sees the same authority.
  12457. if (req.get_header_value_count("Host") > 1 ||
  12458. !detail::fields::is_host(req.get_header_value("Host"))) {
  12459. connection_closed = true;
  12460. res.status = StatusCode::BadRequest_400;
  12461. output_error_log(Error::InvalidHeaders, &req);
  12462. return write_response(strm, close_connection, req, res);
  12463. }
  12464. // Check if the request URI doesn't exceed the limit
  12465. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12466. connection_closed = true;
  12467. res.status = StatusCode::UriTooLong_414;
  12468. output_error_log(Error::ExceedUriMaxLength, &req);
  12469. return write_response(strm, close_connection, req, res);
  12470. }
  12471. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12472. connection_closed = true;
  12473. }
  12474. if (req.version == "HTTP/1.0" &&
  12475. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12476. connection_closed = true;
  12477. }
  12478. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12479. // itself a trusted proxy. Otherwise any direct client could spoof
  12480. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12481. auto is_trusted_peer = std::any_of(
  12482. trusted_proxies_.begin(), trusted_proxies_.end(),
  12483. [&](const std::string &proxy) { return proxy == remote_addr; });
  12484. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12485. // Some proxies append the address they observed as a separate
  12486. // X-Forwarded-For field line instead of extending the one the client sent
  12487. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12488. // be scanned. Reading only the first occurrence would hand back the
  12489. // client-supplied, and therefore forgeable, value.
  12490. auto x_forwarded_for =
  12491. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12492. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12493. req.remote_addr = derived.empty() ? remote_addr : derived;
  12494. } else {
  12495. req.remote_addr = remote_addr;
  12496. }
  12497. req.remote_port = remote_port;
  12498. req.local_addr = local_addr;
  12499. req.local_port = local_port;
  12500. if (req.has_header("Accept")) {
  12501. auto accept_header =
  12502. detail::get_combined_header_value(req.headers, "Accept");
  12503. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12504. connection_closed = true;
  12505. res.status = StatusCode::BadRequest_400;
  12506. output_error_log(Error::HTTPParsing, &req);
  12507. return write_response(strm, close_connection, req, res);
  12508. }
  12509. }
  12510. if (req.has_header("Range")) {
  12511. const auto &range_header_value = req.get_header_value("Range");
  12512. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12513. connection_closed = true;
  12514. res.status = StatusCode::RangeNotSatisfiable_416;
  12515. output_error_log(Error::InvalidRangeHeader, &req);
  12516. return write_response(strm, close_connection, req, res);
  12517. }
  12518. }
  12519. if (setup_request) { setup_request(req); }
  12520. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12521. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12522. // must be ignored. An expectation we do not recognize is left alone; the
  12523. // 417 the section allows for one is a MAY, not a requirement.
  12524. //
  12525. // `100 Continue` itself is deferred until the body is actually read (see
  12526. // read_content_core), so a request rejected by a later handler never
  12527. // invites the client to send a body nobody will read.
  12528. if (req.version != "HTTP/1.0" &&
  12529. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12530. int status = StatusCode::Continue_100;
  12531. if (expect_100_continue_handler_) {
  12532. status = expect_100_continue_handler_(req, res);
  12533. }
  12534. if (status == StatusCode::Continue_100) {
  12535. req.expect_100_continue_pending_ = true;
  12536. } else {
  12537. if (res.status == -1) { res.status = status; }
  12538. connection_closed = true;
  12539. return write_response(strm, true, req, res);
  12540. }
  12541. }
  12542. // Setup `is_connection_closed` method
  12543. auto sock = strm.socket();
  12544. req.is_connection_closed = [sock]() {
  12545. return !detail::is_socket_alive(sock);
  12546. };
  12547. // WebSocket upgrade
  12548. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12549. // that authentication and other middleware can reject the request with an
  12550. // HTTP response (e.g., 401) before the protocol switches.
  12551. if (detail::is_websocket_upgrade(req)) {
  12552. if (pre_routing_handler_ &&
  12553. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12554. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12555. return write_response_with_content(strm, close_connection, req, res);
  12556. }
  12557. // Find matching WebSocket handler
  12558. for (const auto &entry : websocket_handlers_) {
  12559. if (entry.matcher->match(req)) {
  12560. req.matched_route = entry.matcher->pattern();
  12561. if (pre_request_handler_ &&
  12562. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12563. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12564. return write_response_with_content(strm, close_connection, req, res);
  12565. }
  12566. // Compute accept key
  12567. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12568. auto accept_key = detail::websocket_accept_key(client_key);
  12569. // Negotiate subprotocol
  12570. std::string selected_subprotocol;
  12571. if (entry.sub_protocol_selector) {
  12572. auto protocol_header = detail::get_combined_header_value(
  12573. req.headers, "Sec-WebSocket-Protocol");
  12574. if (!protocol_header.empty()) {
  12575. std::vector<std::string> protocols;
  12576. detail::split(protocol_header.data(),
  12577. protocol_header.data() + protocol_header.size(), ',',
  12578. [&](const char *b, const char *e) {
  12579. protocols.emplace_back(b, e);
  12580. });
  12581. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12582. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12583. if (std::find(protocols.begin(), protocols.end(),
  12584. selected_subprotocol) == protocols.end()) {
  12585. selected_subprotocol.clear();
  12586. }
  12587. }
  12588. }
  12589. // Send 101 Switching Protocols
  12590. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12591. "Upgrade: websocket\r\n"
  12592. "Connection: Upgrade\r\n"
  12593. "Sec-WebSocket-Accept: " +
  12594. accept_key + "\r\n";
  12595. if (!selected_subprotocol.empty()) {
  12596. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12597. return false;
  12598. }
  12599. handshake_response +=
  12600. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12601. }
  12602. handshake_response += "\r\n";
  12603. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12604. 0) {
  12605. return false;
  12606. }
  12607. connection_closed = true;
  12608. if (websocket_upgraded) { *websocket_upgraded = true; }
  12609. {
  12610. #ifdef CPPHTTPLIB_SSL_ENABLED
  12611. if (req.ssl) {
  12612. // wss: the heartbeat ping thread and the read path enter the same
  12613. // TLS session from different threads. Hand the WebSocket a stream
  12614. // that serializes every TLS call, so the shared SSLSocketStream on
  12615. // the plain HTTP/HTTPS paths stays untouched.
  12616. auto ws_strm =
  12617. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12618. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12619. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12620. write_timeout_sec_, write_timeout_usec_));
  12621. ws::WebSocket ws(std::move(ws_strm), req, true,
  12622. websocket_ping_interval_sec_,
  12623. websocket_max_missed_pongs_);
  12624. entry.handler(req, ws);
  12625. return true;
  12626. }
  12627. #endif
  12628. // Use WebSocket-specific read timeout instead of HTTP timeout
  12629. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12630. 0);
  12631. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12632. websocket_max_missed_pongs_);
  12633. entry.handler(req, ws);
  12634. }
  12635. return true;
  12636. }
  12637. }
  12638. // No matching handler - fall through to 404
  12639. }
  12640. // Routing
  12641. auto routed = false;
  12642. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12643. routed = routing(req, res, strm);
  12644. #else
  12645. try {
  12646. routed = routing(req, res, strm);
  12647. } catch (std::exception &) {
  12648. if (exception_handler_) {
  12649. auto ep = std::current_exception();
  12650. exception_handler_(req, res, ep);
  12651. routed = true;
  12652. } else {
  12653. res.status = StatusCode::InternalServerError_500;
  12654. }
  12655. } catch (...) {
  12656. if (exception_handler_) {
  12657. auto ep = std::current_exception();
  12658. exception_handler_(req, res, ep);
  12659. routed = true;
  12660. } else {
  12661. res.status = StatusCode::InternalServerError_500;
  12662. }
  12663. }
  12664. #endif
  12665. auto ret = false;
  12666. if (routed) {
  12667. if (res.status == -1) {
  12668. res.status = req.ranges.empty() ? StatusCode::OK_200
  12669. : StatusCode::PartialContent_206;
  12670. }
  12671. // Before the Range checks below, so they see the body's own length.
  12672. detail::prefer_assigned_body(res);
  12673. // Serve file content by using a content provider
  12674. auto file_open_error = false;
  12675. if (!res.file_content_path_.empty()) {
  12676. const auto &path = res.file_content_path_;
  12677. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12678. if (!mm->is_open()) {
  12679. res.status = StatusCode::NotFound_404;
  12680. output_error_log(Error::OpenFile, &req);
  12681. file_open_error = true;
  12682. } else {
  12683. auto content_type = res.file_content_content_type_;
  12684. if (content_type.empty()) {
  12685. content_type = detail::find_content_type(
  12686. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12687. }
  12688. detail::set_file_content_provider(
  12689. res, mm, content_type,
  12690. static_file_encoding(req, res, content_type, mm->size()));
  12691. }
  12692. }
  12693. if (file_open_error) {
  12694. ret = write_response(strm, close_connection, req, res);
  12695. } else if (detail::range_error(req, res)) {
  12696. detail::clear_content(res);
  12697. res.status = StatusCode::RangeNotSatisfiable_416;
  12698. ret = write_response(strm, close_connection, req, res);
  12699. } else {
  12700. ret = write_response_with_content(strm, close_connection, req, res);
  12701. }
  12702. } else {
  12703. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12704. ret = write_response(strm, close_connection, req, res);
  12705. }
  12706. // Drain any unconsumed framed body to prevent request smuggling on
  12707. // keep-alive. Without framing there is no body to drain — reading would
  12708. // consume the next request (issue #2450). If the response has committed the
  12709. // connection to close, there is no next request to protect. A body read in
  12710. // part cannot be drained from where it stopped, so the connection closes.
  12711. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12712. !detail::has_header_token(res.headers, "Connection", "close")) {
  12713. int dummy_status;
  12714. if (req.body_read_started_ ||
  12715. !detail::read_content(
  12716. strm, req, payload_max_length_, dummy_status, nullptr,
  12717. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12718. connection_closed = true;
  12719. }
  12720. }
  12721. return ret;
  12722. }
  12723. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12724. inline bool Server::process_and_close_socket(socket_t sock) {
  12725. std::string remote_addr;
  12726. int remote_port = 0;
  12727. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12728. std::string local_addr;
  12729. int local_port = 0;
  12730. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12731. bool websocket_upgraded = false;
  12732. auto ret = serve_guarded([&]() {
  12733. return detail::process_server_socket(
  12734. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12735. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12736. write_timeout_usec_,
  12737. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12738. return process_request(strm, remote_addr, remote_port, local_addr,
  12739. local_port, close_connection,
  12740. connection_closed, nullptr,
  12741. &websocket_upgraded);
  12742. });
  12743. });
  12744. detail::drain_and_close_socket(sock);
  12745. return ret;
  12746. }
  12747. inline void Server::output_log(const Request &req, const Response &res) const {
  12748. if (logger_) {
  12749. std::lock_guard<std::mutex> guard(logger_mutex_);
  12750. logger_(req, res);
  12751. }
  12752. }
  12753. inline void Server::output_pre_compression_log(const Request &req,
  12754. const Response &res) const {
  12755. if (pre_compression_logger_) {
  12756. std::lock_guard<std::mutex> guard(logger_mutex_);
  12757. pre_compression_logger_(req, res);
  12758. }
  12759. }
  12760. inline void Server::output_error_log(const Error &err,
  12761. const Request *req) const {
  12762. if (error_logger_) {
  12763. std::lock_guard<std::mutex> guard(logger_mutex_);
  12764. error_logger_(err, req);
  12765. }
  12766. }
  12767. /*
  12768. * Group 5: ClientImpl and Client (Universal) implementation
  12769. */
  12770. // HTTP client implementation
  12771. inline ClientImpl::ClientImpl(const std::string &host)
  12772. : ClientImpl(host, 80, std::string(), std::string()) {}
  12773. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12774. : ClientImpl(host, port, std::string(), std::string()) {}
  12775. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12776. const std::string &client_cert_path,
  12777. const std::string &client_key_path)
  12778. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12779. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12780. inline ClientImpl::~ClientImpl() {
  12781. // Wait until all the requests in flight are handled.
  12782. size_t retry_count = 10;
  12783. while (retry_count-- > 0) {
  12784. {
  12785. std::lock_guard<std::mutex> guard(socket_mutex_);
  12786. if (socket_requests_in_flight_ == 0) { break; }
  12787. }
  12788. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12789. }
  12790. std::lock_guard<std::mutex> guard(socket_mutex_);
  12791. shutdown_socket(socket_);
  12792. close_socket(socket_);
  12793. }
  12794. inline bool ClientImpl::is_valid() const { return true; }
  12795. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12796. client_cert_path_ = rhs.client_cert_path_;
  12797. client_key_path_ = rhs.client_key_path_;
  12798. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12799. read_timeout_sec_ = rhs.read_timeout_sec_;
  12800. read_timeout_usec_ = rhs.read_timeout_usec_;
  12801. write_timeout_sec_ = rhs.write_timeout_sec_;
  12802. write_timeout_usec_ = rhs.write_timeout_usec_;
  12803. max_timeout_msec_ = rhs.max_timeout_msec_;
  12804. basic_auth_username_ = rhs.basic_auth_username_;
  12805. basic_auth_password_ = rhs.basic_auth_password_;
  12806. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12807. keep_alive_ = rhs.keep_alive_;
  12808. follow_location_ = rhs.follow_location_;
  12809. path_encode_ = rhs.path_encode_;
  12810. address_family_ = rhs.address_family_;
  12811. tcp_nodelay_ = rhs.tcp_nodelay_;
  12812. ipv6_v6only_ = rhs.ipv6_v6only_;
  12813. socket_options_ = rhs.socket_options_;
  12814. compress_ = rhs.compress_;
  12815. decompress_ = rhs.decompress_;
  12816. payload_max_length_ = rhs.payload_max_length_;
  12817. has_payload_max_length_ = rhs.has_payload_max_length_;
  12818. interface_ = rhs.interface_;
  12819. proxy_host_ = rhs.proxy_host_;
  12820. proxy_port_ = rhs.proxy_port_;
  12821. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12822. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12823. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12824. no_proxy_entries_ = rhs.no_proxy_entries_;
  12825. logger_ = rhs.logger_;
  12826. error_logger_ = rhs.error_logger_;
  12827. #ifdef CPPHTTPLIB_SSL_ENABLED
  12828. digest_auth_username_ = rhs.digest_auth_username_;
  12829. digest_auth_password_ = rhs.digest_auth_password_;
  12830. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12831. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12832. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12833. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12834. server_certificate_verification_ = rhs.server_certificate_verification_;
  12835. server_hostname_verification_ = rhs.server_hostname_verification_;
  12836. system_ca_mode_ = rhs.system_ca_mode_;
  12837. #endif
  12838. }
  12839. inline bool
  12840. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12841. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12842. if (no_proxy_entries_.empty()) { return true; }
  12843. // host_ is const so its normalized form is invariant; cache it. The
  12844. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12845. if (host == host_) {
  12846. if (!host_normalized_valid_) {
  12847. host_normalized_ = detail::normalize_target(host_);
  12848. host_normalized_valid_ = true;
  12849. }
  12850. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12851. }
  12852. auto target = detail::normalize_target(host);
  12853. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12854. }
  12855. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12856. if (is_proxy_enabled_for_host(host_)) {
  12857. return detail::create_client_socket(
  12858. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12859. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12860. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12861. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12862. }
  12863. // Check is custom IP or hostname specified for host_
  12864. std::string connect_host;
  12865. std::string ip;
  12866. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12867. return detail::create_client_socket(
  12868. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12869. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12870. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12871. write_timeout_usec_, interface_, error);
  12872. }
  12873. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12874. Error &error) {
  12875. auto sock = create_client_socket(error);
  12876. if (sock == INVALID_SOCKET) { return false; }
  12877. socket.sock = sock;
  12878. return true;
  12879. }
  12880. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12881. return create_and_connect_socket(socket, error);
  12882. }
  12883. inline bool ClientImpl::setup_proxy_connection(
  12884. Socket & /*socket*/,
  12885. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12886. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12887. return true;
  12888. }
  12889. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12890. bool /*shutdown_gracefully*/) {
  12891. // If there are any requests in flight from threads other than us, then it's
  12892. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12893. assert(socket_requests_in_flight_ == 0 ||
  12894. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12895. }
  12896. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12897. if (socket.sock == INVALID_SOCKET) { return; }
  12898. detail::shutdown_socket(socket.sock);
  12899. }
  12900. inline void ClientImpl::close_socket(Socket &socket) {
  12901. // If there are requests in flight in another thread, usually closing
  12902. // the socket will be fine and they will simply receive an error when
  12903. // using the closed socket, but it is still a bug since rarely the OS
  12904. // may reassign the socket id to be used for a new socket, and then
  12905. // suddenly they will be operating on a live socket that is different
  12906. // than the one they intended!
  12907. assert(socket_requests_in_flight_ == 0 ||
  12908. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12909. // It is also a bug if this happens while SSL is still active
  12910. #ifdef CPPHTTPLIB_SSL_ENABLED
  12911. assert(socket.ssl == nullptr);
  12912. #endif
  12913. if (socket.sock == INVALID_SOCKET) { return; }
  12914. detail::close_socket(socket.sock);
  12915. socket.sock = INVALID_SOCKET;
  12916. }
  12917. inline void ClientImpl::disconnect(bool gracefully) {
  12918. shutdown_ssl(socket_, gracefully);
  12919. shutdown_socket(socket_);
  12920. close_socket(socket_);
  12921. }
  12922. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12923. Response &res,
  12924. bool skip_100_continue) const {
  12925. std::array<char, 2048> buf{};
  12926. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12927. if (!line_reader.getline()) { return false; }
  12928. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12929. res.reason)) {
  12930. return req.method == "CONNECT";
  12931. }
  12932. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12933. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12934. if (!line_reader.getline()) { return false; } // CRLF
  12935. if (!line_reader.getline()) { return false; } // next response line
  12936. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12937. res.reason)) {
  12938. return false;
  12939. }
  12940. }
  12941. return true;
  12942. }
  12943. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12944. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12945. auto ret = send_(req, res, error);
  12946. if (error == Error::SSLPeerCouldBeClosed_) {
  12947. assert(!ret);
  12948. ret = send_(req, res, error);
  12949. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12950. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12951. }
  12952. return ret;
  12953. }
  12954. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12955. {
  12956. std::lock_guard<std::mutex> guard(socket_mutex_);
  12957. // Set this to false immediately - if it ever gets set to true by the end
  12958. // of the request, we know another thread instructed us to close the
  12959. // socket.
  12960. socket_should_be_closed_when_request_is_done_ = false;
  12961. auto is_alive = false;
  12962. if (socket_.is_open()) {
  12963. is_alive = detail::is_socket_alive(socket_.sock);
  12964. #ifdef CPPHTTPLIB_SSL_ENABLED
  12965. if (is_alive && is_ssl()) {
  12966. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12967. is_alive = false;
  12968. }
  12969. }
  12970. #endif
  12971. if (!is_alive) {
  12972. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12973. disconnect(/*gracefully=*/false);
  12974. }
  12975. }
  12976. if (!is_alive) {
  12977. if (!ensure_socket_connection(socket_, error)) {
  12978. output_error_log(error, &req);
  12979. return false;
  12980. }
  12981. {
  12982. auto success = true;
  12983. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12984. error)) {
  12985. if (!success) { output_error_log(error, &req); }
  12986. return success;
  12987. }
  12988. }
  12989. }
  12990. // Mark the current socket as being in use so that it cannot be closed by
  12991. // anyone else while this request is ongoing, even though we will be
  12992. // releasing the mutex.
  12993. if (socket_requests_in_flight_ > 1) {
  12994. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12995. }
  12996. socket_requests_in_flight_ += 1;
  12997. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12998. }
  12999. for (const auto &header : default_headers_) {
  13000. if (req.headers.find(header.first) == req.headers.end()) {
  13001. req.headers.insert(header);
  13002. }
  13003. }
  13004. auto ret = false;
  13005. auto close_connection = !keep_alive_;
  13006. auto se = detail::scope_exit([&]() {
  13007. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13008. std::lock_guard<std::mutex> guard(socket_mutex_);
  13009. socket_requests_in_flight_ -= 1;
  13010. if (socket_requests_in_flight_ <= 0) {
  13011. assert(socket_requests_in_flight_ == 0);
  13012. socket_requests_are_from_thread_ = std::thread::id();
  13013. }
  13014. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13015. !ret) {
  13016. disconnect(/*gracefully=*/true);
  13017. }
  13018. });
  13019. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13020. return handle_request(strm, req, res, close_connection, error);
  13021. });
  13022. if (!ret) {
  13023. if (error == Error::Success) {
  13024. error = Error::Unknown;
  13025. output_error_log(error, &req);
  13026. }
  13027. }
  13028. return ret;
  13029. }
  13030. inline Result ClientImpl::send(const Request &req) {
  13031. auto req2 = req;
  13032. return send_(std::move(req2));
  13033. }
  13034. inline Result ClientImpl::send_(Request &&req) {
  13035. auto res = detail::make_unique<Response>();
  13036. auto error = Error::Success;
  13037. auto ret = send(req, *res, error);
  13038. #ifdef CPPHTTPLIB_SSL_ENABLED
  13039. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13040. last_ssl_error_, last_backend_error_};
  13041. #else
  13042. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13043. #endif
  13044. }
  13045. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13046. const std::string &ct) {
  13047. (void)for_stream;
  13048. // Default headers are meant for the origin and may carry its credentials, so
  13049. // keep them off the CONNECT request the proxy reads.
  13050. if (r.method != "CONNECT") {
  13051. for (const auto &header : default_headers_) {
  13052. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13053. }
  13054. }
  13055. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13056. // prepend it rather than appending it after the caller's own fields.
  13057. if (!r.has_header("Host")) {
  13058. r.headers.emplace_front(
  13059. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13060. address_family_));
  13061. }
  13062. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13063. if (!r.content_receiver) {
  13064. if (!r.has_header("Accept-Encoding")) {
  13065. std::string accept_encoding;
  13066. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13067. accept_encoding = "br";
  13068. #endif
  13069. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13070. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13071. accept_encoding += "gzip, deflate";
  13072. #endif
  13073. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13074. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13075. accept_encoding += "zstd";
  13076. #endif
  13077. r.set_header("Accept-Encoding", accept_encoding);
  13078. }
  13079. detail::add_default_user_agent_header(r);
  13080. }
  13081. if (!r.body.empty()) {
  13082. if (!ct.empty() && !r.has_header("Content-Type")) {
  13083. r.headers.emplace("Content-Type", ct);
  13084. }
  13085. if (!r.has_header("Content-Length")) {
  13086. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13087. }
  13088. }
  13089. }
  13090. inline ClientImpl::StreamHandle
  13091. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13092. const Params &params, const Headers &headers,
  13093. const std::string &body,
  13094. const std::string &content_type) {
  13095. StreamHandle handle;
  13096. handle.response = detail::make_unique<Response>();
  13097. handle.error = Error::Success;
  13098. // Encode the target exactly like the buffered send path does, so that the
  13099. // same `path` produces the same request line through either API.
  13100. auto raw_query_path =
  13101. params.empty() ? path : append_query_params(path, params);
  13102. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13103. handle.connection_ = detail::make_unique<ClientConnection>();
  13104. {
  13105. std::lock_guard<std::mutex> guard(socket_mutex_);
  13106. auto is_alive = false;
  13107. if (socket_.is_open()) {
  13108. is_alive = detail::is_socket_alive(socket_.sock);
  13109. #ifdef CPPHTTPLIB_SSL_ENABLED
  13110. if (is_alive && is_ssl()) {
  13111. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13112. is_alive = false;
  13113. }
  13114. }
  13115. #endif
  13116. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13117. }
  13118. if (!is_alive) {
  13119. if (!ensure_socket_connection(socket_, handle.error)) {
  13120. handle.response.reset();
  13121. return handle;
  13122. }
  13123. {
  13124. auto success = true;
  13125. auto start_time = std::chrono::steady_clock::now();
  13126. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13127. success, handle.error)) {
  13128. if (!success) { handle.response.reset(); }
  13129. return handle;
  13130. }
  13131. }
  13132. }
  13133. transfer_socket_ownership_to_handle(handle);
  13134. }
  13135. #ifdef CPPHTTPLIB_SSL_ENABLED
  13136. if (is_ssl() && handle.connection_->session) {
  13137. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13138. handle.connection_->sock, handle.connection_->session,
  13139. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13140. write_timeout_usec_);
  13141. } else {
  13142. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13143. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13144. write_timeout_sec_, write_timeout_usec_);
  13145. }
  13146. #else
  13147. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13148. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13149. write_timeout_sec_, write_timeout_usec_);
  13150. #endif
  13151. handle.stream_ = handle.socket_stream_.get();
  13152. Request req;
  13153. req.method = method;
  13154. req.path = query_path;
  13155. req.headers = headers;
  13156. req.body = body;
  13157. prepare_default_headers(req, true, content_type);
  13158. auto &strm = *handle.stream_;
  13159. // Build the request line and headers in memory first, like write_request()
  13160. // does, so that a rejected header leaves nothing on the wire.
  13161. {
  13162. detail::BufferStream bstrm;
  13163. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13164. handle.error = Error::Write;
  13165. handle.response.reset();
  13166. return handle;
  13167. }
  13168. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13169. handle.error)) {
  13170. handle.response.reset();
  13171. return handle;
  13172. }
  13173. const auto &data = bstrm.get_buffer();
  13174. if (!detail::write_data(strm, data.data(), data.size())) {
  13175. handle.error = Error::Write;
  13176. handle.response.reset();
  13177. return handle;
  13178. }
  13179. }
  13180. if (!body.empty()) {
  13181. if (strm.write(body.data(), body.size()) < 0) {
  13182. handle.error = Error::Write;
  13183. handle.response.reset();
  13184. return handle;
  13185. }
  13186. }
  13187. if (!read_response_line(strm, req, *handle.response) ||
  13188. !detail::read_headers(strm, handle.response->headers)) {
  13189. handle.error = Error::Read;
  13190. handle.response.reset();
  13191. return handle;
  13192. }
  13193. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13194. // (204/304) response legitimately carries framing headers with no body.
  13195. if (method != "HEAD" &&
  13196. handle.response->status != StatusCode::NoContent_204 &&
  13197. handle.response->status != StatusCode::NotModified_304 &&
  13198. detail::has_conflicting_content_length(handle.response->headers)) {
  13199. handle.error = Error::Read;
  13200. handle.response.reset();
  13201. return handle;
  13202. }
  13203. handle.body_reader_.stream = handle.stream_;
  13204. handle.body_reader_.payload_max_length = payload_max_length_;
  13205. if (handle.response->has_header("Content-Length")) {
  13206. bool is_invalid = false;
  13207. auto content_length = detail::get_header_value_u64(
  13208. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13209. if (is_invalid) {
  13210. handle.error = Error::Read;
  13211. handle.response.reset();
  13212. return handle;
  13213. }
  13214. handle.body_reader_.has_content_length = true;
  13215. handle.body_reader_.content_length = content_length;
  13216. }
  13217. handle.body_reader_.chunked =
  13218. detail::is_chunked_transfer_encoding(handle.response->headers);
  13219. auto content_encoding = detail::get_combined_header_value(
  13220. handle.response->headers, "Content-Encoding");
  13221. if (!content_encoding.empty()) {
  13222. // Same policy as prepare_content_receiver(): reject a coding we know about
  13223. // but were not built with, pass an unrecognized one through as-is.
  13224. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13225. if (!handle.decompressor_) {
  13226. if (detail::is_known_content_encoding(content_encoding)) {
  13227. handle.error = Error::UnsupportedContentEncoding;
  13228. handle.response.reset();
  13229. return handle;
  13230. }
  13231. } else if (!handle.decompressor_->is_valid()) {
  13232. handle.error = Error::Compression;
  13233. handle.response.reset();
  13234. return handle;
  13235. }
  13236. }
  13237. return handle;
  13238. }
  13239. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13240. if (!is_valid() || !response) { return -1; }
  13241. if (decompressor_) { return read_with_decompression(buf, len); }
  13242. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13243. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13244. trailers_parsed_ = true;
  13245. if (body_reader_.chunked_decoder) {
  13246. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13247. response->trailers, response->headers)) {
  13248. return n;
  13249. }
  13250. } else {
  13251. detail::ChunkedDecoder dec(*stream_);
  13252. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13253. return n;
  13254. }
  13255. }
  13256. }
  13257. return n;
  13258. }
  13259. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13260. size_t len) {
  13261. if (decompress_offset_ < decompress_buffer_.size()) {
  13262. auto available = decompress_buffer_.size() - decompress_offset_;
  13263. auto to_copy = (std::min)(len, available);
  13264. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13265. decompress_offset_ += to_copy;
  13266. decompressed_bytes_read_ += to_copy;
  13267. return static_cast<ssize_t>(to_copy);
  13268. }
  13269. decompress_buffer_.clear();
  13270. decompress_offset_ = 0;
  13271. constexpr size_t kDecompressionBufferSize = 8192;
  13272. char compressed_buf[kDecompressionBufferSize];
  13273. while (true) {
  13274. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13275. sizeof(compressed_buf));
  13276. if (n <= 0) { return n; }
  13277. bool decompress_ok = decompressor_->decompress(
  13278. compressed_buf, static_cast<size_t>(n),
  13279. [this](const char *data, size_t data_len) {
  13280. decompress_buffer_.append(data, data_len);
  13281. auto limit = body_reader_.payload_max_length;
  13282. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13283. return false;
  13284. }
  13285. return true;
  13286. });
  13287. if (!decompress_ok) {
  13288. body_reader_.last_error = Error::Read;
  13289. return -1;
  13290. }
  13291. if (!decompress_buffer_.empty()) { break; }
  13292. }
  13293. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13294. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13295. decompress_offset_ = to_copy;
  13296. decompressed_bytes_read_ += to_copy;
  13297. return static_cast<ssize_t>(to_copy);
  13298. }
  13299. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13300. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13301. return;
  13302. }
  13303. trailers_parsed_ = true;
  13304. const auto bufsiz = 128;
  13305. char line_buf[bufsiz];
  13306. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13307. if (!line_reader.getline()) { return; }
  13308. if (!detail::parse_trailers(line_reader, response->trailers,
  13309. response->headers)) {
  13310. return;
  13311. }
  13312. }
  13313. namespace detail {
  13314. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13315. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13316. size_t &out_chunk_offset,
  13317. size_t &out_chunk_total) {
  13318. if (finished) { return 0; }
  13319. if (chunk_remaining == 0) {
  13320. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13321. if (!lr.getline()) { return -1; }
  13322. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13323. // the line terminator is never mistaken for line content.
  13324. const char *eol = lr.ptr() + lr.size();
  13325. if (lr.end_with_crlf()) {
  13326. eol -= 2;
  13327. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13328. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13329. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13330. // has to come off here or the check below would reject the line.
  13331. eol -= 1;
  13332. }
  13333. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13334. const char *p = lr.ptr();
  13335. int v = 0;
  13336. if (p == eol || !is_hex(*p, v)) { return -1; }
  13337. size_t chunk_len = 0;
  13338. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13339. for (; p < eol && is_hex(*p, v); ++p) {
  13340. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13341. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13342. }
  13343. while (p < eol && is_space_or_tab(*p)) {
  13344. ++p;
  13345. }
  13346. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13347. // terminator, and it is built from tokens and quoted-strings, so it never
  13348. // holds a CR, LF or any other control character. getline() reads up to the
  13349. // CRLF, so a bare LF left in here would be swallowed as extension text
  13350. // while an intermediary that ends the line on it delimits the chunks
  13351. // differently, and the two disagree on where the body ends (request
  13352. // smuggling).
  13353. if (p < eol && *p != ';') { return -1; }
  13354. for (; p < eol; ++p) {
  13355. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13356. }
  13357. if (chunk_len == 0) {
  13358. chunk_remaining = 0;
  13359. finished = true;
  13360. out_chunk_offset = 0;
  13361. out_chunk_total = 0;
  13362. return 0;
  13363. }
  13364. chunk_remaining = chunk_len;
  13365. last_chunk_total = chunk_remaining;
  13366. last_chunk_offset = 0;
  13367. }
  13368. auto to_read = (std::min)(chunk_remaining, len);
  13369. auto n = strm.read(buf, to_read);
  13370. if (n <= 0) { return -1; }
  13371. auto offset_before = last_chunk_offset;
  13372. last_chunk_offset += static_cast<size_t>(n);
  13373. chunk_remaining -= static_cast<size_t>(n);
  13374. out_chunk_offset = offset_before;
  13375. out_chunk_total = last_chunk_total;
  13376. if (chunk_remaining == 0) {
  13377. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13378. if (!lr.getline()) { return -1; }
  13379. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13380. }
  13381. return n;
  13382. }
  13383. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13384. const Headers &src_headers) {
  13385. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13386. if (!lr.getline()) { return false; }
  13387. return parse_trailers(lr, dest, src_headers);
  13388. }
  13389. } // namespace detail
  13390. inline void
  13391. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13392. handle.connection_->sock = socket_.sock;
  13393. #ifdef CPPHTTPLIB_SSL_ENABLED
  13394. handle.connection_->session = socket_.ssl;
  13395. socket_.ssl = nullptr;
  13396. #endif
  13397. socket_.sock = INVALID_SOCKET;
  13398. }
  13399. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13400. Response &res, bool close_connection,
  13401. Error &error) {
  13402. if (req.path.empty()) {
  13403. error = Error::Connection;
  13404. output_error_log(error, &req);
  13405. return false;
  13406. }
  13407. auto req_save = req;
  13408. bool ret;
  13409. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13410. auto req2 = req;
  13411. req2.path = "http://" +
  13412. detail::make_host_and_port_string(host_, port_, false) +
  13413. req.path;
  13414. ret = process_request(strm, req2, res, close_connection, error);
  13415. req = std::move(req2);
  13416. req.path = req_save.path;
  13417. } else {
  13418. ret = process_request(strm, req, res, close_connection, error);
  13419. }
  13420. if (!ret) { return false; }
  13421. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13422. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13423. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13424. // for this to be safe.
  13425. // This is safe to call because handle_request is only called by send_
  13426. // which locks the request mutex during the process. It would be a bug
  13427. // to call it from a different thread since it's a thread-safety issue
  13428. // to do these things to the socket if another thread is using the socket.
  13429. std::lock_guard<std::mutex> guard(socket_mutex_);
  13430. disconnect(/*gracefully=*/true);
  13431. }
  13432. if (300 < res.status && res.status < 400 && follow_location_) {
  13433. req = std::move(req_save);
  13434. // The client that followed the redirect has answered any challenge it
  13435. // could. Retrying below would sign another host's challenge and send it
  13436. // here.
  13437. return redirect(req, res, error);
  13438. }
  13439. #ifdef CPPHTTPLIB_SSL_ENABLED
  13440. if ((res.status == StatusCode::Unauthorized_401 ||
  13441. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13442. req.authorization_count_ < 5) {
  13443. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13444. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13445. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13446. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13447. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13448. return ret;
  13449. }
  13450. const auto &username =
  13451. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13452. const auto &password =
  13453. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13454. if (!username.empty() && !password.empty()) {
  13455. std::map<std::string, std::string> auth;
  13456. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13457. Request new_req = req;
  13458. new_req.authorization_count_ += 1;
  13459. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13460. : "Authorization");
  13461. new_req.headers.insert(detail::make_digest_authentication_header(
  13462. req, auth, new_req.authorization_count_, detail::random_string(10),
  13463. username, password, is_proxy));
  13464. Response new_res;
  13465. ret = send(new_req, new_res, error);
  13466. if (ret) { res = std::move(new_res); }
  13467. }
  13468. }
  13469. }
  13470. #endif
  13471. return ret;
  13472. }
  13473. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13474. if (req.redirect_count_ == 0) {
  13475. error = Error::ExceedRedirectCount;
  13476. output_error_log(error, &req);
  13477. return false;
  13478. }
  13479. auto location = res.get_header_value("location");
  13480. if (location.empty()) { return false; }
  13481. detail::UrlComponents uc;
  13482. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13483. uc)) {
  13484. return false;
  13485. }
  13486. // Only follow http/https redirects
  13487. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13488. return false;
  13489. }
  13490. auto scheme = is_ssl() ? "https" : "http";
  13491. auto next_scheme = std::move(uc.scheme);
  13492. auto next_host = std::move(uc.host);
  13493. auto port_str = std::move(uc.port);
  13494. auto next_path = std::move(uc.path);
  13495. auto next_query = std::move(uc.query);
  13496. auto next_port = port_;
  13497. if (!port_str.empty()) {
  13498. if (!detail::parse_port(port_str, next_port)) { return false; }
  13499. } else if (!next_scheme.empty()) {
  13500. next_port = next_scheme == "https" ? 443 : 80;
  13501. }
  13502. if (next_scheme.empty()) { next_scheme = scheme; }
  13503. if (next_host.empty()) { next_host = host_; }
  13504. if (next_path.empty()) { next_path = "/"; }
  13505. auto path = std::move(next_path) + next_query;
  13506. // Same host redirect - use current client
  13507. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13508. return detail::redirect(*this, req, res, path, location, error);
  13509. }
  13510. // Cross-host/scheme redirect - create new client with robust setup
  13511. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13512. path, location, error);
  13513. }
  13514. // New method for robust redirect client creation
  13515. inline bool ClientImpl::create_redirect_client(
  13516. const std::string &scheme, const std::string &host, int port, Request &req,
  13517. Response &res, const std::string &path, const std::string &location,
  13518. Error &error) {
  13519. // Determine if we need SSL
  13520. auto need_ssl = (scheme == "https");
  13521. // Clean up request headers that are host/client specific
  13522. // Remove headers that should not be carried over to new host
  13523. auto headers_to_remove = std::vector<std::string>{
  13524. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13525. for (const auto &header_name : headers_to_remove) {
  13526. auto it = req.headers.find(header_name);
  13527. while (it != req.headers.end()) {
  13528. it = req.headers.erase(it);
  13529. it = req.headers.find(header_name);
  13530. }
  13531. }
  13532. // Create appropriate client type and handle redirect
  13533. if (need_ssl) {
  13534. #ifdef CPPHTTPLIB_SSL_ENABLED
  13535. // Create SSL client for HTTPS redirect
  13536. SSLClient redirect_client(host, port);
  13537. // Setup basic client configuration first
  13538. setup_redirect_client(redirect_client);
  13539. redirect_client.enable_server_certificate_verification(
  13540. server_certificate_verification_);
  13541. redirect_client.enable_server_hostname_verification(
  13542. server_hostname_verification_);
  13543. redirect_client.system_ca_mode_ = system_ca_mode_;
  13544. // Transfer CA certificate to redirect client
  13545. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13546. ca_cert_pem_.size());
  13547. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13548. if (is_ssl()) {
  13549. auto &self = static_cast<SSLClient &>(*this);
  13550. // A store given to set_ca_cert_store() lives only in this client's
  13551. // context, so pass on the CA certificates the context holds.
  13552. if (self.ca_cert_store_set_) {
  13553. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13554. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13555. }
  13556. redirect_client.set_session_verifier(self.session_verifier_);
  13557. if (self.server_certificate_verifier_) {
  13558. redirect_client.set_server_certificate_verifier(
  13559. self.server_certificate_verifier_);
  13560. }
  13561. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13562. redirect_client.enable_windows_cert_verification_ =
  13563. self.enable_windows_cert_verification_;
  13564. #endif
  13565. }
  13566. // Client certificates are set through constructor for SSLClient
  13567. // NOTE: SSLClient constructor already takes client_cert_path and
  13568. // client_key_path so we need to create it properly if client certs are
  13569. // needed
  13570. // Execute the redirect
  13571. return detail::redirect(redirect_client, req, res, path, location, error);
  13572. #else
  13573. // SSL not supported - set appropriate error
  13574. error = Error::SSLConnection;
  13575. output_error_log(error, &req);
  13576. return false;
  13577. #endif
  13578. } else {
  13579. // HTTP redirect
  13580. ClientImpl redirect_client(host, port);
  13581. // Setup client with robust configuration
  13582. setup_redirect_client(redirect_client);
  13583. // Execute the redirect
  13584. return detail::redirect(redirect_client, req, res, path, location, error);
  13585. }
  13586. }
  13587. // New method for robust client setup (based on basic_manual_redirect.cpp
  13588. // logic)
  13589. template <typename ClientType>
  13590. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13591. // Copy basic settings first
  13592. client.set_connection_timeout(connection_timeout_sec_,
  13593. connection_timeout_usec_);
  13594. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13595. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13596. client.set_max_timeout(max_timeout_msec_);
  13597. if (has_payload_max_length_) {
  13598. client.set_payload_max_length(payload_max_length_);
  13599. }
  13600. client.set_keep_alive(keep_alive_);
  13601. client.set_follow_location(
  13602. true); // Enable redirects to handle multi-step redirects
  13603. client.set_path_encode(path_encode_);
  13604. client.set_compress(compress_);
  13605. client.set_decompress(decompress_);
  13606. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13607. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13608. // 15.4, credentials must not be forwarded when redirecting to a different
  13609. // host. This function is only called for cross-host redirects; same-host
  13610. // redirects are handled directly in ClientImpl::redirect().
  13611. // Copy the proxy configuration unconditionally; the per-target bypass is
  13612. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13613. // still use the proxy.
  13614. client.no_proxy_entries_ = no_proxy_entries_;
  13615. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13616. client.set_proxy(proxy_host_, proxy_port_);
  13617. if (!proxy_basic_auth_username_.empty() ||
  13618. !proxy_basic_auth_password_.empty()) {
  13619. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13620. proxy_basic_auth_password_);
  13621. }
  13622. if (!proxy_bearer_token_auth_token_.empty()) {
  13623. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13624. }
  13625. #ifdef CPPHTTPLIB_SSL_ENABLED
  13626. if (!proxy_digest_auth_username_.empty()) {
  13627. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13628. proxy_digest_auth_password_);
  13629. }
  13630. #endif
  13631. }
  13632. // Copy network and socket settings
  13633. client.addr_map_ = addr_map_;
  13634. client.set_address_family(address_family_);
  13635. client.set_tcp_nodelay(tcp_nodelay_);
  13636. client.set_ipv6_v6only(ipv6_v6only_);
  13637. if (socket_options_) { client.set_socket_options(socket_options_); }
  13638. if (!interface_.empty()) { client.set_interface(interface_); }
  13639. // Copy logging and headers
  13640. if (logger_) { client.set_logger(logger_); }
  13641. if (error_logger_) { client.set_error_logger(error_logger_); }
  13642. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13643. // Each new client should generate its own headers based on its target host
  13644. }
  13645. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13646. const Request &req,
  13647. Error &error) const {
  13648. auto is_shutting_down = []() { return false; };
  13649. if (req.is_chunked_content_provider_) {
  13650. auto compressor = compress_ ? detail::create_compressor().first
  13651. : std::unique_ptr<detail::compressor>();
  13652. if (!compressor) {
  13653. compressor = detail::make_unique<detail::nocompressor>();
  13654. }
  13655. return detail::write_content_chunked(strm, req.content_provider_,
  13656. is_shutting_down, *compressor, error);
  13657. } else {
  13658. return detail::write_content_with_progress(
  13659. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13660. req.upload_progress, error);
  13661. }
  13662. }
  13663. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13664. bool close_connection, Error &error,
  13665. bool skip_body, bool &rejected_locally) {
  13666. rejected_locally = false;
  13667. // Prepare additional headers
  13668. if (close_connection) {
  13669. if (!req.has_header("Connection")) {
  13670. req.set_header("Connection", "close");
  13671. }
  13672. }
  13673. std::string ct_for_defaults;
  13674. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13675. ct_for_defaults = "text/plain";
  13676. }
  13677. prepare_default_headers(req, false, ct_for_defaults);
  13678. if (req.body.empty()) {
  13679. if (req.content_provider_) {
  13680. if (!req.is_chunked_content_provider_) {
  13681. if (!req.has_header("Content-Length")) {
  13682. auto length = std::to_string(req.content_length_);
  13683. req.set_header("Content-Length", length);
  13684. }
  13685. }
  13686. } else {
  13687. if (req.method == "POST" || req.method == "PUT" ||
  13688. req.method == "PATCH") {
  13689. req.set_header("Content-Length", "0");
  13690. }
  13691. }
  13692. }
  13693. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13694. // it opens is read by the origin. Each credential goes only to its own hop.
  13695. auto is_connect = req.method == "CONNECT";
  13696. if (!is_connect && !req.has_header("Authorization")) {
  13697. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13698. req.headers.insert(make_basic_authentication_header(
  13699. basic_auth_username_, basic_auth_password_, false));
  13700. } else if (!bearer_token_auth_token_.empty()) {
  13701. req.headers.insert(make_bearer_token_authentication_header(
  13702. bearer_token_auth_token_, false));
  13703. }
  13704. }
  13705. // Proxy-Authorization is only sent when the proxy reads this message —
  13706. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13707. // would leak proxy credentials to the destination server.
  13708. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13709. if ((!proxy_basic_auth_username_.empty() ||
  13710. !proxy_basic_auth_password_.empty()) &&
  13711. !req.has_header("Proxy-Authorization")) {
  13712. req.headers.insert(make_basic_authentication_header(
  13713. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13714. }
  13715. if (!proxy_bearer_token_auth_token_.empty() &&
  13716. !req.has_header("Proxy-Authorization")) {
  13717. req.headers.insert(make_bearer_token_authentication_header(
  13718. proxy_bearer_token_auth_token_, true));
  13719. }
  13720. }
  13721. // Request line and headers
  13722. {
  13723. detail::BufferStream bstrm;
  13724. // Extract the query from req.path. The encoding itself is delegated to
  13725. // `encode_request_target`; the raw query is still needed here to decide
  13726. // between populating `req.params` from it and falling back to building a
  13727. // query out of caller-supplied `req.params`.
  13728. auto query_pos = req.path.find('?');
  13729. auto query_part = query_pos == std::string::npos
  13730. ? std::string()
  13731. : req.path.substr(query_pos + 1);
  13732. auto path_with_query =
  13733. detail::encode_request_target(req.path, path_encode_);
  13734. if (!query_part.empty()) {
  13735. // The query already came in through `req.path`; still populate
  13736. // `req.params` for handlers/users who read them.
  13737. detail::parse_query_text(query_part, req.params);
  13738. } else if (!req.params.empty()) {
  13739. // No query in `req.path`; build one from `req.params` so existing
  13740. // callers that pass `Params` separately continue to work.
  13741. path_with_query = append_query_params(path_with_query, req.params);
  13742. }
  13743. // Write request line and headers
  13744. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13745. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13746. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13747. // fail the request cleanly instead of emitting a request-line-less,
  13748. // header-injecting request.
  13749. error = Error::Write;
  13750. rejected_locally = true;
  13751. output_error_log(error, &req);
  13752. return false;
  13753. }
  13754. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13755. error)) {
  13756. rejected_locally = true;
  13757. output_error_log(error, &req);
  13758. return false;
  13759. }
  13760. // Flush buffer
  13761. auto &data = bstrm.get_buffer();
  13762. if (!detail::write_data(strm, data.data(), data.size())) {
  13763. error = Error::Write;
  13764. output_error_log(error, &req);
  13765. return false;
  13766. }
  13767. }
  13768. // After sending request line and headers, wait briefly for an early server
  13769. // response (e.g. 4xx) and avoid sending a potentially large request body
  13770. // unnecessarily. This workaround is only enabled on Windows because Unix
  13771. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13772. // buffering can accept large writes even when the peer already responded.
  13773. // Check the stream first (which covers SSL via `is_readable()`), then
  13774. // fall back to select on the socket. Only perform the wait for very large
  13775. // request bodies to avoid interfering with normal small requests and
  13776. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13777. // response. Skip this check when using Expect: 100-continue, as the protocol
  13778. // handles early responses properly.
  13779. #if defined(_WIN32)
  13780. if (!skip_body &&
  13781. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13782. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13783. auto start = std::chrono::high_resolution_clock::now();
  13784. for (;;) {
  13785. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13786. // from SSL internals. If the underlying socket is readable, assume an
  13787. // early response may be present.
  13788. auto sock = strm.socket();
  13789. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13790. return false;
  13791. }
  13792. // Fallback to stream-level check for non-socket streams or when the
  13793. // socket isn't reporting readable. Avoid using `is_readable()` for
  13794. // SSL, since `SSL_pending()` may report buffered records that do not
  13795. // indicate a complete application-level response yet.
  13796. if (!is_ssl() && strm.is_readable()) { return false; }
  13797. auto now = std::chrono::high_resolution_clock::now();
  13798. auto elapsed =
  13799. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13800. .count();
  13801. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13802. break;
  13803. }
  13804. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13805. }
  13806. }
  13807. #endif
  13808. // Body
  13809. if (skip_body) { return true; }
  13810. return write_request_body(strm, req, error);
  13811. }
  13812. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13813. Error &error) {
  13814. if (req.body.empty()) {
  13815. return write_content_with_provider(strm, req, error);
  13816. }
  13817. if (req.upload_progress) {
  13818. auto body_size = req.body.size();
  13819. size_t written = 0;
  13820. auto data = req.body.data();
  13821. while (written < body_size) {
  13822. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13823. if (!detail::write_data(strm, data + written, to_write)) {
  13824. error = Error::Write;
  13825. output_error_log(error, &req);
  13826. return false;
  13827. }
  13828. written += to_write;
  13829. if (!req.upload_progress(written, body_size)) {
  13830. error = Error::Canceled;
  13831. output_error_log(error, &req);
  13832. return false;
  13833. }
  13834. }
  13835. } else {
  13836. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13837. error = Error::Write;
  13838. output_error_log(error, &req);
  13839. return false;
  13840. }
  13841. }
  13842. return true;
  13843. }
  13844. inline std::unique_ptr<Response>
  13845. ClientImpl::send_with_content_provider_and_receiver(
  13846. Request &req, const char *body, size_t content_length,
  13847. ContentProvider content_provider,
  13848. ContentProviderWithoutLength content_provider_without_length,
  13849. const std::string &content_type, ContentReceiver content_receiver,
  13850. Error &error) {
  13851. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13852. auto enc = compress_
  13853. ? detail::create_compressor()
  13854. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13855. nullptr, nullptr);
  13856. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13857. if (enc.first && !content_provider_without_length) {
  13858. auto &compressor = enc.first;
  13859. if (content_provider) {
  13860. auto ok = true;
  13861. auto finished = false;
  13862. size_t offset = 0;
  13863. DataSink data_sink;
  13864. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13865. if (ok) {
  13866. auto last = offset + data_len == content_length;
  13867. auto ret = compressor->compress(
  13868. data, data_len, last,
  13869. [&](const char *compressed_data, size_t compressed_data_len) {
  13870. req.body.append(compressed_data, compressed_data_len);
  13871. return true;
  13872. });
  13873. if (ret) {
  13874. offset += data_len;
  13875. } else {
  13876. ok = false;
  13877. }
  13878. }
  13879. return ok;
  13880. };
  13881. // As in detail::write_content_with_progress(): the body is framed by
  13882. // content_length, so a provider that finishes early has truncated it.
  13883. // Stop and report that instead of calling the provider forever.
  13884. data_sink.done = [&]() { finished = true; };
  13885. while (ok && !finished && offset < content_length) {
  13886. if (!content_provider(offset, content_length - offset, data_sink)) {
  13887. error = Error::Canceled;
  13888. output_error_log(error, &req);
  13889. return nullptr;
  13890. }
  13891. }
  13892. // A short body here means either the provider stopped early or the
  13893. // compressor gave up. The branch below reports a failing compressor as
  13894. // Error::Compression, so keep the two distinguishable.
  13895. if (offset < content_length) {
  13896. error = ok ? Error::Write : Error::Compression;
  13897. output_error_log(error, &req);
  13898. return nullptr;
  13899. }
  13900. } else {
  13901. if (!compressor->compress(body, content_length, true,
  13902. [&](const char *data, size_t data_len) {
  13903. req.body.append(data, data_len);
  13904. return true;
  13905. })) {
  13906. error = Error::Compression;
  13907. output_error_log(error, &req);
  13908. return nullptr;
  13909. }
  13910. }
  13911. } else {
  13912. if (content_provider) {
  13913. req.content_length_ = content_length;
  13914. req.content_provider_ = std::move(content_provider);
  13915. req.is_chunked_content_provider_ = false;
  13916. } else if (content_provider_without_length) {
  13917. req.content_length_ = 0;
  13918. req.content_provider_ = detail::ContentProviderAdapter(
  13919. std::move(content_provider_without_length));
  13920. req.is_chunked_content_provider_ = true;
  13921. req.set_header("Transfer-Encoding", "chunked");
  13922. } else {
  13923. req.body.assign(body, content_length);
  13924. }
  13925. }
  13926. if (content_receiver) {
  13927. req.content_receiver =
  13928. [content_receiver](const char *data, size_t data_length,
  13929. size_t /*offset*/, size_t /*total_length*/) {
  13930. return content_receiver(data, data_length);
  13931. };
  13932. }
  13933. auto res = detail::make_unique<Response>();
  13934. return send(req, *res, error) ? std::move(res) : nullptr;
  13935. }
  13936. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13937. const std::string &method, const std::string &path, const Headers &headers,
  13938. const char *body, size_t content_length, ContentProvider content_provider,
  13939. ContentProviderWithoutLength content_provider_without_length,
  13940. const std::string &content_type, ContentReceiver content_receiver,
  13941. UploadProgress progress) {
  13942. Request req;
  13943. req.method = method;
  13944. req.headers = headers;
  13945. req.path = path;
  13946. req.upload_progress = std::move(progress);
  13947. if (max_timeout_msec_ > 0) {
  13948. req.start_time_ = std::chrono::steady_clock::now();
  13949. }
  13950. auto error = Error::Success;
  13951. auto res = send_with_content_provider_and_receiver(
  13952. req, body, content_length, std::move(content_provider),
  13953. std::move(content_provider_without_length), content_type,
  13954. std::move(content_receiver), error);
  13955. #ifdef CPPHTTPLIB_SSL_ENABLED
  13956. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13957. last_backend_error_};
  13958. #else
  13959. return Result{std::move(res), error, std::move(req.headers)};
  13960. #endif
  13961. }
  13962. inline void ClientImpl::output_log(const Request &req,
  13963. const Response &res) const {
  13964. if (logger_) {
  13965. std::lock_guard<std::mutex> guard(logger_mutex_);
  13966. logger_(req, res);
  13967. }
  13968. }
  13969. inline void ClientImpl::output_error_log(const Error &err,
  13970. const Request *req) const {
  13971. if (error_logger_) {
  13972. std::lock_guard<std::mutex> guard(logger_mutex_);
  13973. error_logger_(err, req);
  13974. }
  13975. }
  13976. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13977. Response &res, bool close_connection,
  13978. Error &error) {
  13979. // Auto-add Expect: 100-continue for large bodies
  13980. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13981. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13982. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13983. req.set_header("Expect", "100-continue");
  13984. }
  13985. }
  13986. // Check for Expect: 100-continue
  13987. auto expect_100_continue =
  13988. detail::has_header_token(req.headers, "Expect", "100-continue");
  13989. // Send request (skip body if using Expect: 100-continue)
  13990. auto rejected_locally = false;
  13991. auto write_request_success =
  13992. write_request(strm, req, close_connection, error, expect_100_continue,
  13993. rejected_locally);
  13994. // A failed write normally still reads the response below, since the server
  13995. // may have answered early (e.g. 413/414) and closed while the body was being
  13996. // sent. A request rejected before any byte reached the socket gets no such
  13997. // response, and waiting for one would block until the read timeout.
  13998. if (rejected_locally) { return false; }
  13999. #ifdef CPPHTTPLIB_SSL_ENABLED
  14000. if (is_ssl() && !expect_100_continue) {
  14001. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14002. if (!is_proxy_enabled) {
  14003. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14004. error = Error::SSLPeerCouldBeClosed_;
  14005. output_error_log(error, &req);
  14006. return false;
  14007. }
  14008. }
  14009. }
  14010. #endif
  14011. // Handle Expect: 100-continue.
  14012. //
  14013. // Wait for an interim/early response by attempting to read the status line
  14014. // under a short timeout, instead of trusting raw socket readability. Over
  14015. // TLS, post-handshake records (e.g. session tickets) make the socket
  14016. // readable without any HTTP response being available; relying on
  14017. // `select_read` there caused the body to be withheld forever and the
  14018. // request to fail with `Read` (#2458). If no status line arrives within the
  14019. // timeout, send the body anyway (matching curl's behavior).
  14020. auto status_line_read = false;
  14021. if (expect_100_continue && write_request_success) {
  14022. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14023. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14024. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14025. strm.set_read_timeout(sec, usec);
  14026. status_line_read = read_response_line(strm, req, res, false);
  14027. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14028. }
  14029. if (!status_line_read) {
  14030. // No interim response within the timeout: send the body and handle the
  14031. // response as usual.
  14032. if (!write_request_body(strm, req, error)) { return false; }
  14033. expect_100_continue = false; // Switch to normal response handling
  14034. }
  14035. }
  14036. // Receive response and headers
  14037. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14038. if ((!status_line_read &&
  14039. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14040. !detail::read_headers(strm, res.headers)) {
  14041. if (write_request_success) { error = Error::Read; }
  14042. output_error_log(error, &req);
  14043. return false;
  14044. }
  14045. if (!write_request_success) { return false; }
  14046. // Handle Expect: 100-continue response
  14047. if (expect_100_continue) {
  14048. if (res.status == StatusCode::Continue_100) {
  14049. // Server accepted, send the body
  14050. if (!write_request_body(strm, req, error)) { return false; }
  14051. // Read the actual response
  14052. res.headers.clear();
  14053. res.body.clear();
  14054. if (!read_response_line(strm, req, res) ||
  14055. !detail::read_headers(strm, res.headers)) {
  14056. error = Error::Read;
  14057. output_error_log(error, &req);
  14058. return false;
  14059. }
  14060. }
  14061. // If not 100 Continue, server returned an error; proceed with that response
  14062. }
  14063. // Body
  14064. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14065. req.method != "CONNECT") {
  14066. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14067. // whose final transfer coding is not chunked is not ambiguous: its body
  14068. // runs until the server closes the connection, so it is not rejected.
  14069. // HEAD/204 are excluded above and a 304 carries no body.
  14070. if (res.status != StatusCode::NotModified_304 &&
  14071. detail::has_conflicting_content_length(res.headers)) {
  14072. error = Error::Read;
  14073. output_error_log(error, &req);
  14074. return false;
  14075. }
  14076. auto redirect = 300 < res.status && res.status < 400 &&
  14077. res.status != StatusCode::NotModified_304 &&
  14078. follow_location_;
  14079. if (req.response_handler && !redirect) {
  14080. if (!req.response_handler(res)) {
  14081. error = Error::Canceled;
  14082. output_error_log(error, &req);
  14083. return false;
  14084. }
  14085. }
  14086. auto out =
  14087. req.content_receiver
  14088. ? static_cast<ContentReceiverWithProgress>(
  14089. [&](const char *buf, size_t n, size_t off, size_t len) {
  14090. if (redirect) { return true; }
  14091. auto ret = req.content_receiver(buf, n, off, len);
  14092. if (!ret) {
  14093. error = Error::Canceled;
  14094. output_error_log(error, &req);
  14095. }
  14096. return ret;
  14097. })
  14098. : static_cast<ContentReceiverWithProgress>(
  14099. [&](const char *buf, size_t n, size_t /*off*/,
  14100. size_t /*len*/) {
  14101. assert(res.body.size() + n <= res.body.max_size());
  14102. if (payload_max_length_ > 0 &&
  14103. (res.body.size() >= payload_max_length_ ||
  14104. n > payload_max_length_ - res.body.size())) {
  14105. return false;
  14106. }
  14107. res.body.append(buf, n);
  14108. return true;
  14109. });
  14110. auto progress = [&](size_t current, size_t total) {
  14111. if (!req.download_progress || redirect) { return true; }
  14112. auto ret = req.download_progress(current, total);
  14113. if (!ret) {
  14114. error = Error::Canceled;
  14115. output_error_log(error, &req);
  14116. }
  14117. return ret;
  14118. };
  14119. if (res.has_header("Content-Length")) {
  14120. if (!req.content_receiver) {
  14121. auto len = res.get_header_value_u64("Content-Length");
  14122. if (len > res.body.max_size()) {
  14123. error = Error::Read;
  14124. output_error_log(error, &req);
  14125. return false;
  14126. }
  14127. // Cap the reservation by payload_max_length_ to avoid OOM when a
  14128. // hostile or malformed server sends an enormous Content-Length.
  14129. // The actual body read below is bounded by payload_max_length_,
  14130. // so reserving more than that is never useful.
  14131. auto reserve_len = static_cast<size_t>(len);
  14132. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  14133. reserve_len = payload_max_length_;
  14134. }
  14135. res.body.reserve(reserve_len);
  14136. }
  14137. }
  14138. if (res.status != StatusCode::NotModified_304) {
  14139. auto content_status = 0;
  14140. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14141. ? (std::numeric_limits<size_t>::max)()
  14142. : payload_max_length_;
  14143. if (!detail::read_content(strm, res, max_length, content_status,
  14144. std::move(progress), std::move(out),
  14145. decompress_)) {
  14146. if (error != Error::Canceled) {
  14147. // Tell the caller apart from a plain read failure when the body could
  14148. // not be decoded because of its Content-Encoding.
  14149. switch (content_status) {
  14150. case StatusCode::UnsupportedMediaType_415:
  14151. error = Error::UnsupportedContentEncoding;
  14152. break;
  14153. case StatusCode::InternalServerError_500:
  14154. error = Error::Compression;
  14155. break;
  14156. default: error = Error::Read; break;
  14157. }
  14158. }
  14159. output_error_log(error, &req);
  14160. return false;
  14161. }
  14162. }
  14163. }
  14164. // Log
  14165. output_log(req, res);
  14166. return true;
  14167. }
  14168. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14169. const std::string &boundary, const UploadFormDataItems &items,
  14170. const FormDataProviderItems &provider_items) const {
  14171. size_t cur_item = 0;
  14172. size_t cur_start = 0;
  14173. // cur_item and cur_start are copied to within the std::function and
  14174. // maintain state between successive calls
  14175. return [&, cur_item, cur_start](size_t offset,
  14176. DataSink &sink) mutable -> bool {
  14177. if (!offset && !items.empty()) {
  14178. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14179. return true;
  14180. } else if (cur_item < provider_items.size()) {
  14181. if (!cur_start) {
  14182. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14183. provider_items[cur_item], boundary);
  14184. offset += begin.size();
  14185. cur_start = offset;
  14186. sink.os << begin;
  14187. }
  14188. DataSink cur_sink;
  14189. auto has_data = true;
  14190. cur_sink.write = sink.write;
  14191. // Forward is_writable so a provider item asking whether it may keep
  14192. // going gets the outer sink's answer rather than the default `true`.
  14193. cur_sink.is_writable = sink.is_writable;
  14194. cur_sink.done = [&]() { has_data = false; };
  14195. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14196. return false;
  14197. }
  14198. if (!has_data) {
  14199. sink.os << detail::serialize_multipart_formdata_item_end();
  14200. cur_item++;
  14201. cur_start = 0;
  14202. }
  14203. return true;
  14204. } else {
  14205. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14206. sink.done();
  14207. return true;
  14208. }
  14209. };
  14210. }
  14211. inline bool ClientImpl::process_socket(
  14212. const Socket &socket,
  14213. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14214. std::function<bool(Stream &strm)> callback) {
  14215. return detail::process_client_socket(
  14216. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14217. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14218. }
  14219. inline bool ClientImpl::is_ssl() const { return false; }
  14220. inline Result ClientImpl::Get(const std::string &path,
  14221. DownloadProgress progress) {
  14222. return Get(path, Headers(), std::move(progress));
  14223. }
  14224. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14225. DownloadProgress progress) {
  14226. return Get(path, params, Headers(), std::move(progress));
  14227. }
  14228. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14229. const Headers &headers,
  14230. DownloadProgress progress) {
  14231. if (params.empty()) { return Get(path, headers); }
  14232. std::string path_with_query = append_query_params(path, params);
  14233. return Get(path_with_query, headers, std::move(progress));
  14234. }
  14235. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14236. DownloadProgress progress) {
  14237. Request req;
  14238. req.method = "GET";
  14239. req.path = path;
  14240. req.headers = headers;
  14241. req.download_progress = std::move(progress);
  14242. if (max_timeout_msec_ > 0) {
  14243. req.start_time_ = std::chrono::steady_clock::now();
  14244. }
  14245. return send_(std::move(req));
  14246. }
  14247. inline Result ClientImpl::Get(const std::string &path,
  14248. ContentReceiver content_receiver,
  14249. DownloadProgress progress) {
  14250. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14251. std::move(progress));
  14252. }
  14253. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14254. ContentReceiver content_receiver,
  14255. DownloadProgress progress) {
  14256. return Get(path, headers, nullptr, std::move(content_receiver),
  14257. std::move(progress));
  14258. }
  14259. inline Result ClientImpl::Get(const std::string &path,
  14260. ResponseHandler response_handler,
  14261. ContentReceiver content_receiver,
  14262. DownloadProgress progress) {
  14263. return Get(path, Headers(), std::move(response_handler),
  14264. std::move(content_receiver), std::move(progress));
  14265. }
  14266. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14267. ResponseHandler response_handler,
  14268. ContentReceiver content_receiver,
  14269. DownloadProgress progress) {
  14270. Request req;
  14271. req.method = "GET";
  14272. req.path = path;
  14273. req.headers = headers;
  14274. req.response_handler = std::move(response_handler);
  14275. req.content_receiver =
  14276. [content_receiver](const char *data, size_t data_length,
  14277. size_t /*offset*/, size_t /*total_length*/) {
  14278. return content_receiver(data, data_length);
  14279. };
  14280. req.download_progress = std::move(progress);
  14281. if (max_timeout_msec_ > 0) {
  14282. req.start_time_ = std::chrono::steady_clock::now();
  14283. }
  14284. return send_(std::move(req));
  14285. }
  14286. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14287. const Headers &headers,
  14288. ContentReceiver content_receiver,
  14289. DownloadProgress progress) {
  14290. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14291. std::move(progress));
  14292. }
  14293. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14294. const Headers &headers,
  14295. ResponseHandler response_handler,
  14296. ContentReceiver content_receiver,
  14297. DownloadProgress progress) {
  14298. if (params.empty()) {
  14299. return Get(path, headers, std::move(response_handler),
  14300. std::move(content_receiver), std::move(progress));
  14301. }
  14302. std::string path_with_query = append_query_params(path, params);
  14303. return Get(path_with_query, headers, std::move(response_handler),
  14304. std::move(content_receiver), std::move(progress));
  14305. }
  14306. inline Result ClientImpl::Head(const std::string &path) {
  14307. return Head(path, Headers());
  14308. }
  14309. inline Result ClientImpl::Head(const std::string &path,
  14310. const Headers &headers) {
  14311. Request req;
  14312. req.method = "HEAD";
  14313. req.headers = headers;
  14314. req.path = path;
  14315. if (max_timeout_msec_ > 0) {
  14316. req.start_time_ = std::chrono::steady_clock::now();
  14317. }
  14318. return send_(std::move(req));
  14319. }
  14320. inline Result ClientImpl::Post(const std::string &path) {
  14321. return Post(path, std::string(), std::string());
  14322. }
  14323. inline Result ClientImpl::Post(const std::string &path,
  14324. const Headers &headers) {
  14325. return Post(path, headers, nullptr, 0, std::string());
  14326. }
  14327. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14328. size_t content_length,
  14329. const std::string &content_type,
  14330. UploadProgress progress) {
  14331. return Post(path, Headers(), body, content_length, content_type, progress);
  14332. }
  14333. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14334. const std::string &content_type,
  14335. UploadProgress progress) {
  14336. return Post(path, Headers(), body, content_type, progress);
  14337. }
  14338. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14339. return Post(path, Headers(), params);
  14340. }
  14341. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14342. ContentProvider content_provider,
  14343. const std::string &content_type,
  14344. UploadProgress progress) {
  14345. return Post(path, Headers(), content_length, std::move(content_provider),
  14346. content_type, progress);
  14347. }
  14348. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14349. ContentProvider content_provider,
  14350. const std::string &content_type,
  14351. ContentReceiver content_receiver,
  14352. UploadProgress progress) {
  14353. return Post(path, Headers(), content_length, std::move(content_provider),
  14354. content_type, std::move(content_receiver), progress);
  14355. }
  14356. inline Result ClientImpl::Post(const std::string &path,
  14357. ContentProviderWithoutLength content_provider,
  14358. const std::string &content_type,
  14359. UploadProgress progress) {
  14360. return Post(path, Headers(), std::move(content_provider), content_type,
  14361. progress);
  14362. }
  14363. inline Result ClientImpl::Post(const std::string &path,
  14364. ContentProviderWithoutLength content_provider,
  14365. const std::string &content_type,
  14366. ContentReceiver content_receiver,
  14367. UploadProgress progress) {
  14368. return Post(path, Headers(), std::move(content_provider), content_type,
  14369. std::move(content_receiver), progress);
  14370. }
  14371. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14372. const Params &params) {
  14373. auto query = detail::params_to_query_str(params);
  14374. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14375. }
  14376. inline Result ClientImpl::Post(const std::string &path,
  14377. const UploadFormDataItems &items,
  14378. UploadProgress progress) {
  14379. return Post(path, Headers(), items, progress);
  14380. }
  14381. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14382. const UploadFormDataItems &items,
  14383. UploadProgress progress) {
  14384. const auto &boundary = detail::make_multipart_data_boundary();
  14385. const auto &content_type =
  14386. detail::serialize_multipart_formdata_get_content_type(boundary);
  14387. auto content_length = detail::get_multipart_content_length(items, boundary);
  14388. return Post(path, headers, content_length,
  14389. detail::make_multipart_content_provider(items, boundary),
  14390. content_type, progress);
  14391. }
  14392. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14393. const UploadFormDataItems &items,
  14394. const std::string &boundary,
  14395. UploadProgress progress) {
  14396. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14397. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14398. }
  14399. const auto &content_type =
  14400. detail::serialize_multipart_formdata_get_content_type(boundary);
  14401. auto content_length = detail::get_multipart_content_length(items, boundary);
  14402. return Post(path, headers, content_length,
  14403. detail::make_multipart_content_provider(items, boundary),
  14404. content_type, progress);
  14405. }
  14406. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14407. const char *body, size_t content_length,
  14408. const std::string &content_type,
  14409. UploadProgress progress) {
  14410. return send_with_content_provider_and_receiver(
  14411. "POST", path, headers, body, content_length, nullptr, nullptr,
  14412. content_type, nullptr, progress);
  14413. }
  14414. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14415. const std::string &body,
  14416. const std::string &content_type,
  14417. UploadProgress progress) {
  14418. return send_with_content_provider_and_receiver(
  14419. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14420. content_type, nullptr, progress);
  14421. }
  14422. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14423. size_t content_length,
  14424. ContentProvider content_provider,
  14425. const std::string &content_type,
  14426. UploadProgress progress) {
  14427. return send_with_content_provider_and_receiver(
  14428. "POST", path, headers, nullptr, content_length,
  14429. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14430. }
  14431. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14432. size_t content_length,
  14433. ContentProvider content_provider,
  14434. const std::string &content_type,
  14435. ContentReceiver content_receiver,
  14436. DownloadProgress progress) {
  14437. return send_with_content_provider_and_receiver(
  14438. "POST", path, headers, nullptr, content_length,
  14439. std::move(content_provider), nullptr, content_type,
  14440. std::move(content_receiver), std::move(progress));
  14441. }
  14442. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14443. ContentProviderWithoutLength content_provider,
  14444. const std::string &content_type,
  14445. UploadProgress progress) {
  14446. return send_with_content_provider_and_receiver(
  14447. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14448. content_type, nullptr, progress);
  14449. }
  14450. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14451. ContentProviderWithoutLength content_provider,
  14452. const std::string &content_type,
  14453. ContentReceiver content_receiver,
  14454. DownloadProgress progress) {
  14455. return send_with_content_provider_and_receiver(
  14456. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14457. content_type, std::move(content_receiver), std::move(progress));
  14458. }
  14459. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14460. const UploadFormDataItems &items,
  14461. const FormDataProviderItems &provider_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. return send_with_content_provider_and_receiver(
  14467. "POST", path, headers, nullptr, 0, nullptr,
  14468. get_multipart_content_provider(boundary, items, provider_items),
  14469. content_type, nullptr, progress);
  14470. }
  14471. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14472. const std::string &body,
  14473. const std::string &content_type,
  14474. ContentReceiver content_receiver,
  14475. DownloadProgress progress) {
  14476. Request req;
  14477. req.method = "POST";
  14478. req.path = path;
  14479. req.headers = headers;
  14480. req.body = body;
  14481. req.content_receiver =
  14482. [content_receiver](const char *data, size_t data_length,
  14483. size_t /*offset*/, size_t /*total_length*/) {
  14484. return content_receiver(data, data_length);
  14485. };
  14486. req.download_progress = std::move(progress);
  14487. if (max_timeout_msec_ > 0) {
  14488. req.start_time_ = std::chrono::steady_clock::now();
  14489. }
  14490. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14491. return send_(std::move(req));
  14492. }
  14493. inline Result ClientImpl::Put(const std::string &path) {
  14494. return Put(path, std::string(), std::string());
  14495. }
  14496. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14497. return Put(path, headers, nullptr, 0, std::string());
  14498. }
  14499. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14500. size_t content_length,
  14501. const std::string &content_type,
  14502. UploadProgress progress) {
  14503. return Put(path, Headers(), body, content_length, content_type, progress);
  14504. }
  14505. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14506. const std::string &content_type,
  14507. UploadProgress progress) {
  14508. return Put(path, Headers(), body, content_type, progress);
  14509. }
  14510. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14511. return Put(path, Headers(), params);
  14512. }
  14513. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14514. ContentProvider content_provider,
  14515. const std::string &content_type,
  14516. UploadProgress progress) {
  14517. return Put(path, Headers(), content_length, std::move(content_provider),
  14518. content_type, progress);
  14519. }
  14520. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14521. ContentProvider content_provider,
  14522. const std::string &content_type,
  14523. ContentReceiver content_receiver,
  14524. UploadProgress progress) {
  14525. return Put(path, Headers(), content_length, std::move(content_provider),
  14526. content_type, std::move(content_receiver), progress);
  14527. }
  14528. inline Result ClientImpl::Put(const std::string &path,
  14529. ContentProviderWithoutLength content_provider,
  14530. const std::string &content_type,
  14531. UploadProgress progress) {
  14532. return Put(path, Headers(), std::move(content_provider), content_type,
  14533. progress);
  14534. }
  14535. inline Result ClientImpl::Put(const std::string &path,
  14536. ContentProviderWithoutLength content_provider,
  14537. const std::string &content_type,
  14538. ContentReceiver content_receiver,
  14539. UploadProgress progress) {
  14540. return Put(path, Headers(), std::move(content_provider), content_type,
  14541. std::move(content_receiver), progress);
  14542. }
  14543. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14544. const Params &params) {
  14545. auto query = detail::params_to_query_str(params);
  14546. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14547. }
  14548. inline Result ClientImpl::Put(const std::string &path,
  14549. const UploadFormDataItems &items,
  14550. UploadProgress progress) {
  14551. return Put(path, Headers(), items, progress);
  14552. }
  14553. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14554. const UploadFormDataItems &items,
  14555. UploadProgress progress) {
  14556. const auto &boundary = detail::make_multipart_data_boundary();
  14557. const auto &content_type =
  14558. detail::serialize_multipart_formdata_get_content_type(boundary);
  14559. auto content_length = detail::get_multipart_content_length(items, boundary);
  14560. return Put(path, headers, content_length,
  14561. detail::make_multipart_content_provider(items, boundary),
  14562. content_type, progress);
  14563. }
  14564. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14565. const UploadFormDataItems &items,
  14566. const std::string &boundary,
  14567. UploadProgress progress) {
  14568. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14569. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14570. }
  14571. const auto &content_type =
  14572. detail::serialize_multipart_formdata_get_content_type(boundary);
  14573. auto content_length = detail::get_multipart_content_length(items, boundary);
  14574. return Put(path, headers, content_length,
  14575. detail::make_multipart_content_provider(items, boundary),
  14576. content_type, progress);
  14577. }
  14578. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14579. const char *body, size_t content_length,
  14580. const std::string &content_type,
  14581. UploadProgress progress) {
  14582. return send_with_content_provider_and_receiver(
  14583. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14584. content_type, nullptr, progress);
  14585. }
  14586. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14587. const std::string &body,
  14588. const std::string &content_type,
  14589. UploadProgress progress) {
  14590. return send_with_content_provider_and_receiver(
  14591. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14592. content_type, nullptr, progress);
  14593. }
  14594. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14595. size_t content_length,
  14596. ContentProvider content_provider,
  14597. const std::string &content_type,
  14598. UploadProgress progress) {
  14599. return send_with_content_provider_and_receiver(
  14600. "PUT", path, headers, nullptr, content_length,
  14601. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14602. }
  14603. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14604. size_t content_length,
  14605. ContentProvider content_provider,
  14606. const std::string &content_type,
  14607. ContentReceiver content_receiver,
  14608. UploadProgress progress) {
  14609. return send_with_content_provider_and_receiver(
  14610. "PUT", path, headers, nullptr, content_length,
  14611. std::move(content_provider), nullptr, content_type,
  14612. std::move(content_receiver), progress);
  14613. }
  14614. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14615. ContentProviderWithoutLength content_provider,
  14616. const std::string &content_type,
  14617. UploadProgress progress) {
  14618. return send_with_content_provider_and_receiver(
  14619. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14620. content_type, nullptr, progress);
  14621. }
  14622. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14623. ContentProviderWithoutLength content_provider,
  14624. const std::string &content_type,
  14625. ContentReceiver content_receiver,
  14626. UploadProgress progress) {
  14627. return send_with_content_provider_and_receiver(
  14628. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14629. content_type, std::move(content_receiver), progress);
  14630. }
  14631. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14632. const UploadFormDataItems &items,
  14633. const FormDataProviderItems &provider_items,
  14634. UploadProgress progress) {
  14635. const auto &boundary = detail::make_multipart_data_boundary();
  14636. const auto &content_type =
  14637. detail::serialize_multipart_formdata_get_content_type(boundary);
  14638. return send_with_content_provider_and_receiver(
  14639. "PUT", path, headers, nullptr, 0, nullptr,
  14640. get_multipart_content_provider(boundary, items, provider_items),
  14641. content_type, nullptr, progress);
  14642. }
  14643. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14644. const std::string &body,
  14645. const std::string &content_type,
  14646. ContentReceiver content_receiver,
  14647. DownloadProgress progress) {
  14648. Request req;
  14649. req.method = "PUT";
  14650. req.path = path;
  14651. req.headers = headers;
  14652. req.body = body;
  14653. req.content_receiver =
  14654. [content_receiver](const char *data, size_t data_length,
  14655. size_t /*offset*/, size_t /*total_length*/) {
  14656. return content_receiver(data, data_length);
  14657. };
  14658. req.download_progress = std::move(progress);
  14659. if (max_timeout_msec_ > 0) {
  14660. req.start_time_ = std::chrono::steady_clock::now();
  14661. }
  14662. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14663. return send_(std::move(req));
  14664. }
  14665. inline Result ClientImpl::Patch(const std::string &path) {
  14666. return Patch(path, std::string(), std::string());
  14667. }
  14668. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14669. UploadProgress progress) {
  14670. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14671. }
  14672. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14673. size_t content_length,
  14674. const std::string &content_type,
  14675. UploadProgress progress) {
  14676. return Patch(path, Headers(), body, content_length, content_type, progress);
  14677. }
  14678. inline Result ClientImpl::Patch(const std::string &path,
  14679. const std::string &body,
  14680. const std::string &content_type,
  14681. UploadProgress progress) {
  14682. return Patch(path, Headers(), body, content_type, progress);
  14683. }
  14684. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14685. return Patch(path, Headers(), params);
  14686. }
  14687. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14688. ContentProvider content_provider,
  14689. const std::string &content_type,
  14690. UploadProgress progress) {
  14691. return Patch(path, Headers(), content_length, std::move(content_provider),
  14692. content_type, progress);
  14693. }
  14694. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14695. ContentProvider content_provider,
  14696. const std::string &content_type,
  14697. ContentReceiver content_receiver,
  14698. UploadProgress progress) {
  14699. return Patch(path, Headers(), content_length, std::move(content_provider),
  14700. content_type, std::move(content_receiver), progress);
  14701. }
  14702. inline Result ClientImpl::Patch(const std::string &path,
  14703. ContentProviderWithoutLength content_provider,
  14704. const std::string &content_type,
  14705. UploadProgress progress) {
  14706. return Patch(path, Headers(), std::move(content_provider), content_type,
  14707. progress);
  14708. }
  14709. inline Result ClientImpl::Patch(const std::string &path,
  14710. ContentProviderWithoutLength content_provider,
  14711. const std::string &content_type,
  14712. ContentReceiver content_receiver,
  14713. UploadProgress progress) {
  14714. return Patch(path, Headers(), std::move(content_provider), content_type,
  14715. std::move(content_receiver), progress);
  14716. }
  14717. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14718. const Params &params) {
  14719. auto query = detail::params_to_query_str(params);
  14720. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14721. }
  14722. inline Result ClientImpl::Patch(const std::string &path,
  14723. const UploadFormDataItems &items,
  14724. UploadProgress progress) {
  14725. return Patch(path, Headers(), items, progress);
  14726. }
  14727. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14728. const UploadFormDataItems &items,
  14729. UploadProgress progress) {
  14730. const auto &boundary = detail::make_multipart_data_boundary();
  14731. const auto &content_type =
  14732. detail::serialize_multipart_formdata_get_content_type(boundary);
  14733. auto content_length = detail::get_multipart_content_length(items, boundary);
  14734. return Patch(path, headers, content_length,
  14735. detail::make_multipart_content_provider(items, boundary),
  14736. content_type, progress);
  14737. }
  14738. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14739. const UploadFormDataItems &items,
  14740. const std::string &boundary,
  14741. UploadProgress progress) {
  14742. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14743. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14744. }
  14745. const auto &content_type =
  14746. detail::serialize_multipart_formdata_get_content_type(boundary);
  14747. auto content_length = detail::get_multipart_content_length(items, boundary);
  14748. return Patch(path, headers, content_length,
  14749. detail::make_multipart_content_provider(items, boundary),
  14750. content_type, progress);
  14751. }
  14752. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14753. const char *body, size_t content_length,
  14754. const std::string &content_type,
  14755. UploadProgress progress) {
  14756. return send_with_content_provider_and_receiver(
  14757. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14758. content_type, nullptr, progress);
  14759. }
  14760. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14761. const std::string &body,
  14762. const std::string &content_type,
  14763. UploadProgress progress) {
  14764. return send_with_content_provider_and_receiver(
  14765. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14766. content_type, nullptr, progress);
  14767. }
  14768. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14769. size_t content_length,
  14770. ContentProvider content_provider,
  14771. const std::string &content_type,
  14772. UploadProgress progress) {
  14773. return send_with_content_provider_and_receiver(
  14774. "PATCH", path, headers, nullptr, content_length,
  14775. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14776. }
  14777. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14778. size_t content_length,
  14779. ContentProvider content_provider,
  14780. const std::string &content_type,
  14781. ContentReceiver content_receiver,
  14782. UploadProgress progress) {
  14783. return send_with_content_provider_and_receiver(
  14784. "PATCH", path, headers, nullptr, content_length,
  14785. std::move(content_provider), nullptr, content_type,
  14786. std::move(content_receiver), progress);
  14787. }
  14788. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14789. ContentProviderWithoutLength content_provider,
  14790. const std::string &content_type,
  14791. UploadProgress progress) {
  14792. return send_with_content_provider_and_receiver(
  14793. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14794. content_type, nullptr, progress);
  14795. }
  14796. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14797. ContentProviderWithoutLength content_provider,
  14798. const std::string &content_type,
  14799. ContentReceiver content_receiver,
  14800. UploadProgress progress) {
  14801. return send_with_content_provider_and_receiver(
  14802. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14803. content_type, std::move(content_receiver), progress);
  14804. }
  14805. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14806. const UploadFormDataItems &items,
  14807. const FormDataProviderItems &provider_items,
  14808. UploadProgress progress) {
  14809. const auto &boundary = detail::make_multipart_data_boundary();
  14810. const auto &content_type =
  14811. detail::serialize_multipart_formdata_get_content_type(boundary);
  14812. return send_with_content_provider_and_receiver(
  14813. "PATCH", path, headers, nullptr, 0, nullptr,
  14814. get_multipart_content_provider(boundary, items, provider_items),
  14815. content_type, nullptr, progress);
  14816. }
  14817. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14818. const std::string &body,
  14819. const std::string &content_type,
  14820. ContentReceiver content_receiver,
  14821. DownloadProgress progress) {
  14822. Request req;
  14823. req.method = "PATCH";
  14824. req.path = path;
  14825. req.headers = headers;
  14826. req.body = body;
  14827. req.content_receiver =
  14828. [content_receiver](const char *data, size_t data_length,
  14829. size_t /*offset*/, size_t /*total_length*/) {
  14830. return content_receiver(data, data_length);
  14831. };
  14832. req.download_progress = std::move(progress);
  14833. if (max_timeout_msec_ > 0) {
  14834. req.start_time_ = std::chrono::steady_clock::now();
  14835. }
  14836. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14837. return send_(std::move(req));
  14838. }
  14839. inline Result ClientImpl::Delete(const std::string &path,
  14840. DownloadProgress progress) {
  14841. return Delete(path, Headers(), std::string(), std::string(), progress);
  14842. }
  14843. inline Result ClientImpl::Delete(const std::string &path,
  14844. const Headers &headers,
  14845. DownloadProgress progress) {
  14846. return Delete(path, headers, std::string(), std::string(), progress);
  14847. }
  14848. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14849. size_t content_length,
  14850. const std::string &content_type,
  14851. DownloadProgress progress) {
  14852. return Delete(path, Headers(), body, content_length, content_type, progress);
  14853. }
  14854. inline Result ClientImpl::Delete(const std::string &path,
  14855. const std::string &body,
  14856. const std::string &content_type,
  14857. DownloadProgress progress) {
  14858. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14859. progress);
  14860. }
  14861. inline Result ClientImpl::Delete(const std::string &path,
  14862. const Headers &headers,
  14863. const std::string &body,
  14864. const std::string &content_type,
  14865. DownloadProgress progress) {
  14866. return Delete(path, headers, body.data(), body.size(), content_type,
  14867. progress);
  14868. }
  14869. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14870. DownloadProgress progress) {
  14871. return Delete(path, Headers(), params, progress);
  14872. }
  14873. inline Result ClientImpl::Delete(const std::string &path,
  14874. const Headers &headers, const Params &params,
  14875. DownloadProgress progress) {
  14876. auto query = detail::params_to_query_str(params);
  14877. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14878. progress);
  14879. }
  14880. inline Result ClientImpl::Delete(const std::string &path,
  14881. const Headers &headers, const char *body,
  14882. size_t content_length,
  14883. const std::string &content_type,
  14884. DownloadProgress progress) {
  14885. Request req;
  14886. req.method = "DELETE";
  14887. req.headers = headers;
  14888. req.path = path;
  14889. req.download_progress = std::move(progress);
  14890. if (max_timeout_msec_ > 0) {
  14891. req.start_time_ = std::chrono::steady_clock::now();
  14892. }
  14893. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14894. req.body.assign(body, content_length);
  14895. return send_(std::move(req));
  14896. }
  14897. inline Result ClientImpl::Options(const std::string &path) {
  14898. return Options(path, Headers());
  14899. }
  14900. inline Result ClientImpl::Options(const std::string &path,
  14901. const Headers &headers) {
  14902. Request req;
  14903. req.method = "OPTIONS";
  14904. req.headers = headers;
  14905. req.path = path;
  14906. if (max_timeout_msec_ > 0) {
  14907. req.start_time_ = std::chrono::steady_clock::now();
  14908. }
  14909. return send_(std::move(req));
  14910. }
  14911. inline void ClientImpl::stop() {
  14912. std::lock_guard<std::mutex> guard(socket_mutex_);
  14913. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14914. // do is to shutdown_socket, so that threads using this socket suddenly
  14915. // discover they can't read/write any more and error out. Everything else
  14916. // (closing the socket, shutting ssl down) is unsafe because these actions
  14917. // are not thread-safe.
  14918. if (socket_requests_in_flight_ > 0) {
  14919. shutdown_socket(socket_);
  14920. // Aside from that, we set a flag for the socket to be closed when we're
  14921. // done.
  14922. socket_should_be_closed_when_request_is_done_ = true;
  14923. return;
  14924. }
  14925. disconnect(/*gracefully=*/true);
  14926. }
  14927. inline std::string ClientImpl::host() const { return host_; }
  14928. inline int ClientImpl::port() const { return port_; }
  14929. inline size_t ClientImpl::is_socket_open() const {
  14930. std::lock_guard<std::mutex> guard(socket_mutex_);
  14931. return socket_.is_open();
  14932. }
  14933. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14934. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14935. connection_timeout_sec_ = sec;
  14936. connection_timeout_usec_ = usec;
  14937. }
  14938. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14939. read_timeout_sec_ = sec;
  14940. read_timeout_usec_ = usec;
  14941. }
  14942. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14943. write_timeout_sec_ = sec;
  14944. write_timeout_usec_ = usec;
  14945. }
  14946. inline void ClientImpl::set_max_timeout(time_t msec) {
  14947. max_timeout_msec_ = msec;
  14948. }
  14949. inline void ClientImpl::set_basic_auth(const std::string &username,
  14950. const std::string &password) {
  14951. basic_auth_username_ = username;
  14952. basic_auth_password_ = password;
  14953. }
  14954. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14955. bearer_token_auth_token_ = token;
  14956. }
  14957. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14958. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14959. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14960. inline void
  14961. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14962. addr_map_ = std::move(addr_map);
  14963. }
  14964. inline void ClientImpl::set_default_headers(Headers headers) {
  14965. default_headers_ = std::move(headers);
  14966. }
  14967. inline void ClientImpl::set_header_writer(
  14968. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14969. header_writer_ = writer;
  14970. }
  14971. inline void ClientImpl::set_address_family(int family) {
  14972. address_family_ = family;
  14973. }
  14974. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14975. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14976. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14977. socket_options_ = std::move(socket_options);
  14978. }
  14979. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14980. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14981. inline void ClientImpl::set_payload_max_length(size_t length) {
  14982. payload_max_length_ = length;
  14983. has_payload_max_length_ = true;
  14984. }
  14985. inline void ClientImpl::set_interface(const std::string &intf) {
  14986. interface_ = intf;
  14987. }
  14988. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14989. proxy_host_ = host;
  14990. proxy_port_ = port;
  14991. std::lock_guard<std::mutex> guard(socket_mutex_);
  14992. disconnect(/*gracefully=*/true);
  14993. }
  14994. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14995. const std::string &password) {
  14996. proxy_basic_auth_username_ = username;
  14997. proxy_basic_auth_password_ = password;
  14998. }
  14999. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15000. proxy_bearer_token_auth_token_ = token;
  15001. }
  15002. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15003. std::vector<detail::NoProxyEntry> parsed;
  15004. parsed.reserve(patterns.size());
  15005. for (const auto &p : patterns) {
  15006. auto trimmed = detail::trim_copy(p);
  15007. if (trimmed.empty()) { continue; }
  15008. detail::NoProxyEntry entry;
  15009. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  15010. parsed.push_back(std::move(entry));
  15011. }
  15012. }
  15013. no_proxy_entries_ = std::move(parsed);
  15014. std::lock_guard<std::mutex> guard(socket_mutex_);
  15015. disconnect(/*gracefully=*/true);
  15016. }
  15017. #ifdef CPPHTTPLIB_SSL_ENABLED
  15018. inline void ClientImpl::set_digest_auth(const std::string &username,
  15019. const std::string &password) {
  15020. digest_auth_username_ = username;
  15021. digest_auth_password_ = password;
  15022. }
  15023. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15024. const std::string &ca_cert_dir_path) {
  15025. ca_cert_file_path_ = ca_cert_file_path;
  15026. ca_cert_dir_path_ = ca_cert_dir_path;
  15027. }
  15028. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15029. const std::string &password) {
  15030. proxy_digest_auth_username_ = username;
  15031. proxy_digest_auth_password_ = password;
  15032. }
  15033. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15034. server_certificate_verification_ = enabled;
  15035. }
  15036. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15037. server_hostname_verification_ = enabled;
  15038. }
  15039. inline void ClientImpl::enable_system_ca(bool enabled) {
  15040. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15041. }
  15042. #endif
  15043. inline void ClientImpl::set_logger(Logger logger) {
  15044. logger_ = std::move(logger);
  15045. }
  15046. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15047. error_logger_ = std::move(error_logger);
  15048. }
  15049. /*
  15050. * SSL/TLS Common Implementation
  15051. */
  15052. inline ClientConnection::~ClientConnection() {
  15053. #ifdef CPPHTTPLIB_SSL_ENABLED
  15054. if (session) {
  15055. tls::shutdown(session, true);
  15056. tls::free_session(session);
  15057. session = nullptr;
  15058. }
  15059. #endif
  15060. if (sock != INVALID_SOCKET) {
  15061. detail::close_socket(sock);
  15062. sock = INVALID_SOCKET;
  15063. }
  15064. }
  15065. // Universal client implementation
  15066. inline Client::Client(const std::string &scheme_host_port)
  15067. : Client(scheme_host_port, std::string(), std::string()) {}
  15068. inline Client::Client(const std::string &scheme_host_port,
  15069. const std::string &client_cert_path,
  15070. const std::string &client_key_path) {
  15071. detail::UrlComponents uc;
  15072. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15073. auto &scheme = uc.scheme;
  15074. #ifdef CPPHTTPLIB_SSL_ENABLED
  15075. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15076. #else
  15077. if (!scheme.empty() && scheme != "http") {
  15078. #endif
  15079. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15080. std::string msg = "'" + scheme + "' scheme is not supported.";
  15081. throw std::invalid_argument(msg);
  15082. #endif
  15083. return;
  15084. }
  15085. auto is_ssl = scheme == "https";
  15086. auto host = std::move(uc.host);
  15087. auto port = is_ssl ? 443 : 80;
  15088. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  15089. if (is_ssl) {
  15090. #ifdef CPPHTTPLIB_SSL_ENABLED
  15091. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15092. client_key_path);
  15093. is_ssl_ = is_ssl;
  15094. #endif
  15095. } else {
  15096. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15097. client_key_path);
  15098. }
  15099. } else {
  15100. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15101. // if port param below changes.
  15102. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15103. client_cert_path, client_key_path);
  15104. }
  15105. }
  15106. inline Client::Client(const std::string &host, int port)
  15107. : Client(host, port, std::string(), std::string()) {}
  15108. inline Client::Client(const std::string &host, int port,
  15109. const std::string &client_cert_path,
  15110. const std::string &client_key_path)
  15111. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15112. client_key_path)) {}
  15113. inline Client::~Client() = default;
  15114. inline bool Client::is_valid() const {
  15115. return cli_ != nullptr && cli_->is_valid();
  15116. }
  15117. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15118. return cli_->Get(path, std::move(progress));
  15119. }
  15120. inline Result Client::Get(const std::string &path, const Headers &headers,
  15121. DownloadProgress progress) {
  15122. return cli_->Get(path, headers, std::move(progress));
  15123. }
  15124. inline Result Client::Get(const std::string &path,
  15125. ContentReceiver content_receiver,
  15126. DownloadProgress progress) {
  15127. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15128. }
  15129. inline Result Client::Get(const std::string &path, const Headers &headers,
  15130. ContentReceiver content_receiver,
  15131. DownloadProgress progress) {
  15132. return cli_->Get(path, headers, std::move(content_receiver),
  15133. std::move(progress));
  15134. }
  15135. inline Result Client::Get(const std::string &path,
  15136. ResponseHandler response_handler,
  15137. ContentReceiver content_receiver,
  15138. DownloadProgress progress) {
  15139. return cli_->Get(path, std::move(response_handler),
  15140. std::move(content_receiver), std::move(progress));
  15141. }
  15142. inline Result Client::Get(const std::string &path, const Headers &headers,
  15143. ResponseHandler response_handler,
  15144. ContentReceiver content_receiver,
  15145. DownloadProgress progress) {
  15146. return cli_->Get(path, headers, std::move(response_handler),
  15147. std::move(content_receiver), std::move(progress));
  15148. }
  15149. inline Result Client::Get(const std::string &path, const Params &params,
  15150. DownloadProgress progress) {
  15151. return cli_->Get(path, params, std::move(progress));
  15152. }
  15153. inline Result Client::Get(const std::string &path, const Params &params,
  15154. const Headers &headers, DownloadProgress progress) {
  15155. return cli_->Get(path, params, headers, std::move(progress));
  15156. }
  15157. inline Result Client::Get(const std::string &path, const Params &params,
  15158. const Headers &headers,
  15159. ContentReceiver content_receiver,
  15160. DownloadProgress progress) {
  15161. return cli_->Get(path, params, headers, std::move(content_receiver),
  15162. std::move(progress));
  15163. }
  15164. inline Result Client::Get(const std::string &path, const Params &params,
  15165. const Headers &headers,
  15166. ResponseHandler response_handler,
  15167. ContentReceiver content_receiver,
  15168. DownloadProgress progress) {
  15169. return cli_->Get(path, params, headers, std::move(response_handler),
  15170. std::move(content_receiver), std::move(progress));
  15171. }
  15172. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15173. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15174. return cli_->Head(path, headers);
  15175. }
  15176. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15177. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15178. return cli_->Post(path, headers);
  15179. }
  15180. inline Result Client::Post(const std::string &path, const char *body,
  15181. size_t content_length,
  15182. const std::string &content_type,
  15183. UploadProgress progress) {
  15184. return cli_->Post(path, body, content_length, content_type, progress);
  15185. }
  15186. inline Result Client::Post(const std::string &path, const Headers &headers,
  15187. const char *body, size_t content_length,
  15188. const std::string &content_type,
  15189. UploadProgress progress) {
  15190. return cli_->Post(path, headers, body, content_length, content_type,
  15191. progress);
  15192. }
  15193. inline Result Client::Post(const std::string &path, const std::string &body,
  15194. const std::string &content_type,
  15195. UploadProgress progress) {
  15196. return cli_->Post(path, body, content_type, progress);
  15197. }
  15198. inline Result Client::Post(const std::string &path, const Headers &headers,
  15199. const std::string &body,
  15200. const std::string &content_type,
  15201. UploadProgress progress) {
  15202. return cli_->Post(path, headers, body, content_type, progress);
  15203. }
  15204. inline Result Client::Post(const std::string &path, size_t content_length,
  15205. ContentProvider content_provider,
  15206. const std::string &content_type,
  15207. UploadProgress progress) {
  15208. return cli_->Post(path, content_length, std::move(content_provider),
  15209. content_type, progress);
  15210. }
  15211. inline Result Client::Post(const std::string &path, size_t content_length,
  15212. ContentProvider content_provider,
  15213. const std::string &content_type,
  15214. ContentReceiver content_receiver,
  15215. UploadProgress progress) {
  15216. return cli_->Post(path, content_length, std::move(content_provider),
  15217. content_type, std::move(content_receiver), progress);
  15218. }
  15219. inline Result Client::Post(const std::string &path,
  15220. ContentProviderWithoutLength content_provider,
  15221. const std::string &content_type,
  15222. UploadProgress progress) {
  15223. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15224. }
  15225. inline Result Client::Post(const std::string &path,
  15226. ContentProviderWithoutLength content_provider,
  15227. const std::string &content_type,
  15228. ContentReceiver content_receiver,
  15229. UploadProgress progress) {
  15230. return cli_->Post(path, std::move(content_provider), content_type,
  15231. std::move(content_receiver), progress);
  15232. }
  15233. inline Result Client::Post(const std::string &path, const Headers &headers,
  15234. size_t content_length,
  15235. ContentProvider content_provider,
  15236. const std::string &content_type,
  15237. UploadProgress progress) {
  15238. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15239. content_type, progress);
  15240. }
  15241. inline Result Client::Post(const std::string &path, const Headers &headers,
  15242. size_t content_length,
  15243. ContentProvider content_provider,
  15244. const std::string &content_type,
  15245. ContentReceiver content_receiver,
  15246. DownloadProgress progress) {
  15247. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15248. content_type, std::move(content_receiver), progress);
  15249. }
  15250. inline Result Client::Post(const std::string &path, const Headers &headers,
  15251. ContentProviderWithoutLength content_provider,
  15252. const std::string &content_type,
  15253. UploadProgress progress) {
  15254. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15255. progress);
  15256. }
  15257. inline Result Client::Post(const std::string &path, const Headers &headers,
  15258. ContentProviderWithoutLength content_provider,
  15259. const std::string &content_type,
  15260. ContentReceiver content_receiver,
  15261. DownloadProgress progress) {
  15262. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15263. std::move(content_receiver), progress);
  15264. }
  15265. inline Result Client::Post(const std::string &path, const Params &params) {
  15266. return cli_->Post(path, params);
  15267. }
  15268. inline Result Client::Post(const std::string &path, const Headers &headers,
  15269. const Params &params) {
  15270. return cli_->Post(path, headers, params);
  15271. }
  15272. inline Result Client::Post(const std::string &path,
  15273. const UploadFormDataItems &items,
  15274. UploadProgress progress) {
  15275. return cli_->Post(path, items, progress);
  15276. }
  15277. inline Result Client::Post(const std::string &path, const Headers &headers,
  15278. const UploadFormDataItems &items,
  15279. UploadProgress progress) {
  15280. return cli_->Post(path, headers, items, progress);
  15281. }
  15282. inline Result Client::Post(const std::string &path, const Headers &headers,
  15283. const UploadFormDataItems &items,
  15284. const std::string &boundary,
  15285. UploadProgress progress) {
  15286. return cli_->Post(path, headers, items, boundary, progress);
  15287. }
  15288. inline Result Client::Post(const std::string &path, const Headers &headers,
  15289. const UploadFormDataItems &items,
  15290. const FormDataProviderItems &provider_items,
  15291. UploadProgress progress) {
  15292. return cli_->Post(path, headers, items, provider_items, progress);
  15293. }
  15294. inline Result Client::Post(const std::string &path, const Headers &headers,
  15295. const std::string &body,
  15296. const std::string &content_type,
  15297. ContentReceiver content_receiver,
  15298. DownloadProgress progress) {
  15299. return cli_->Post(path, headers, body, content_type,
  15300. std::move(content_receiver), progress);
  15301. }
  15302. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15303. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15304. return cli_->Put(path, headers);
  15305. }
  15306. inline Result Client::Put(const std::string &path, const char *body,
  15307. size_t content_length,
  15308. const std::string &content_type,
  15309. UploadProgress progress) {
  15310. return cli_->Put(path, body, content_length, content_type, progress);
  15311. }
  15312. inline Result Client::Put(const std::string &path, const Headers &headers,
  15313. const char *body, size_t content_length,
  15314. const std::string &content_type,
  15315. UploadProgress progress) {
  15316. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15317. }
  15318. inline Result Client::Put(const std::string &path, const std::string &body,
  15319. const std::string &content_type,
  15320. UploadProgress progress) {
  15321. return cli_->Put(path, body, content_type, progress);
  15322. }
  15323. inline Result Client::Put(const std::string &path, const Headers &headers,
  15324. const std::string &body,
  15325. const std::string &content_type,
  15326. UploadProgress progress) {
  15327. return cli_->Put(path, headers, body, content_type, progress);
  15328. }
  15329. inline Result Client::Put(const std::string &path, size_t content_length,
  15330. ContentProvider content_provider,
  15331. const std::string &content_type,
  15332. UploadProgress progress) {
  15333. return cli_->Put(path, content_length, std::move(content_provider),
  15334. content_type, progress);
  15335. }
  15336. inline Result Client::Put(const std::string &path, size_t content_length,
  15337. ContentProvider content_provider,
  15338. const std::string &content_type,
  15339. ContentReceiver content_receiver,
  15340. UploadProgress progress) {
  15341. return cli_->Put(path, content_length, std::move(content_provider),
  15342. content_type, std::move(content_receiver), progress);
  15343. }
  15344. inline Result Client::Put(const std::string &path,
  15345. ContentProviderWithoutLength content_provider,
  15346. const std::string &content_type,
  15347. UploadProgress progress) {
  15348. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15349. }
  15350. inline Result Client::Put(const std::string &path,
  15351. ContentProviderWithoutLength content_provider,
  15352. const std::string &content_type,
  15353. ContentReceiver content_receiver,
  15354. UploadProgress progress) {
  15355. return cli_->Put(path, std::move(content_provider), content_type,
  15356. std::move(content_receiver), progress);
  15357. }
  15358. inline Result Client::Put(const std::string &path, const Headers &headers,
  15359. size_t content_length,
  15360. ContentProvider content_provider,
  15361. const std::string &content_type,
  15362. UploadProgress progress) {
  15363. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15364. content_type, progress);
  15365. }
  15366. inline Result Client::Put(const std::string &path, const Headers &headers,
  15367. size_t content_length,
  15368. ContentProvider content_provider,
  15369. const std::string &content_type,
  15370. ContentReceiver content_receiver,
  15371. UploadProgress progress) {
  15372. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15373. content_type, std::move(content_receiver), progress);
  15374. }
  15375. inline Result Client::Put(const std::string &path, const Headers &headers,
  15376. ContentProviderWithoutLength content_provider,
  15377. const std::string &content_type,
  15378. UploadProgress progress) {
  15379. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15380. progress);
  15381. }
  15382. inline Result Client::Put(const std::string &path, const Headers &headers,
  15383. ContentProviderWithoutLength content_provider,
  15384. const std::string &content_type,
  15385. ContentReceiver content_receiver,
  15386. UploadProgress progress) {
  15387. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15388. std::move(content_receiver), progress);
  15389. }
  15390. inline Result Client::Put(const std::string &path, const Params &params) {
  15391. return cli_->Put(path, params);
  15392. }
  15393. inline Result Client::Put(const std::string &path, const Headers &headers,
  15394. const Params &params) {
  15395. return cli_->Put(path, headers, params);
  15396. }
  15397. inline Result Client::Put(const std::string &path,
  15398. const UploadFormDataItems &items,
  15399. UploadProgress progress) {
  15400. return cli_->Put(path, items, progress);
  15401. }
  15402. inline Result Client::Put(const std::string &path, const Headers &headers,
  15403. const UploadFormDataItems &items,
  15404. UploadProgress progress) {
  15405. return cli_->Put(path, headers, items, progress);
  15406. }
  15407. inline Result Client::Put(const std::string &path, const Headers &headers,
  15408. const UploadFormDataItems &items,
  15409. const std::string &boundary,
  15410. UploadProgress progress) {
  15411. return cli_->Put(path, headers, items, boundary, progress);
  15412. }
  15413. inline Result Client::Put(const std::string &path, const Headers &headers,
  15414. const UploadFormDataItems &items,
  15415. const FormDataProviderItems &provider_items,
  15416. UploadProgress progress) {
  15417. return cli_->Put(path, headers, items, provider_items, progress);
  15418. }
  15419. inline Result Client::Put(const std::string &path, const Headers &headers,
  15420. const std::string &body,
  15421. const std::string &content_type,
  15422. ContentReceiver content_receiver,
  15423. DownloadProgress progress) {
  15424. return cli_->Put(path, headers, body, content_type, content_receiver,
  15425. progress);
  15426. }
  15427. inline Result Client::Patch(const std::string &path) {
  15428. return cli_->Patch(path);
  15429. }
  15430. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15431. return cli_->Patch(path, headers);
  15432. }
  15433. inline Result Client::Patch(const std::string &path, const char *body,
  15434. size_t content_length,
  15435. const std::string &content_type,
  15436. UploadProgress progress) {
  15437. return cli_->Patch(path, body, content_length, content_type, progress);
  15438. }
  15439. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15440. const char *body, size_t content_length,
  15441. const std::string &content_type,
  15442. UploadProgress progress) {
  15443. return cli_->Patch(path, headers, body, content_length, content_type,
  15444. progress);
  15445. }
  15446. inline Result Client::Patch(const std::string &path, const std::string &body,
  15447. const std::string &content_type,
  15448. UploadProgress progress) {
  15449. return cli_->Patch(path, body, content_type, progress);
  15450. }
  15451. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15452. const std::string &body,
  15453. const std::string &content_type,
  15454. UploadProgress progress) {
  15455. return cli_->Patch(path, headers, body, content_type, progress);
  15456. }
  15457. inline Result Client::Patch(const std::string &path, size_t content_length,
  15458. ContentProvider content_provider,
  15459. const std::string &content_type,
  15460. UploadProgress progress) {
  15461. return cli_->Patch(path, content_length, std::move(content_provider),
  15462. content_type, progress);
  15463. }
  15464. inline Result Client::Patch(const std::string &path, size_t content_length,
  15465. ContentProvider content_provider,
  15466. const std::string &content_type,
  15467. ContentReceiver content_receiver,
  15468. UploadProgress progress) {
  15469. return cli_->Patch(path, content_length, std::move(content_provider),
  15470. content_type, std::move(content_receiver), progress);
  15471. }
  15472. inline Result Client::Patch(const std::string &path,
  15473. ContentProviderWithoutLength content_provider,
  15474. const std::string &content_type,
  15475. UploadProgress progress) {
  15476. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15477. }
  15478. inline Result Client::Patch(const std::string &path,
  15479. ContentProviderWithoutLength content_provider,
  15480. const std::string &content_type,
  15481. ContentReceiver content_receiver,
  15482. UploadProgress progress) {
  15483. return cli_->Patch(path, std::move(content_provider), content_type,
  15484. std::move(content_receiver), progress);
  15485. }
  15486. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15487. size_t content_length,
  15488. ContentProvider content_provider,
  15489. const std::string &content_type,
  15490. UploadProgress progress) {
  15491. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15492. content_type, progress);
  15493. }
  15494. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15495. size_t content_length,
  15496. ContentProvider content_provider,
  15497. const std::string &content_type,
  15498. ContentReceiver content_receiver,
  15499. UploadProgress progress) {
  15500. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15501. content_type, std::move(content_receiver), progress);
  15502. }
  15503. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15504. ContentProviderWithoutLength content_provider,
  15505. const std::string &content_type,
  15506. UploadProgress progress) {
  15507. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15508. progress);
  15509. }
  15510. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15511. ContentProviderWithoutLength content_provider,
  15512. const std::string &content_type,
  15513. ContentReceiver content_receiver,
  15514. UploadProgress progress) {
  15515. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15516. std::move(content_receiver), progress);
  15517. }
  15518. inline Result Client::Patch(const std::string &path, const Params &params) {
  15519. return cli_->Patch(path, params);
  15520. }
  15521. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15522. const Params &params) {
  15523. return cli_->Patch(path, headers, params);
  15524. }
  15525. inline Result Client::Patch(const std::string &path,
  15526. const UploadFormDataItems &items,
  15527. UploadProgress progress) {
  15528. return cli_->Patch(path, items, progress);
  15529. }
  15530. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15531. const UploadFormDataItems &items,
  15532. UploadProgress progress) {
  15533. return cli_->Patch(path, headers, items, progress);
  15534. }
  15535. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15536. const UploadFormDataItems &items,
  15537. const std::string &boundary,
  15538. UploadProgress progress) {
  15539. return cli_->Patch(path, headers, items, boundary, progress);
  15540. }
  15541. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15542. const UploadFormDataItems &items,
  15543. const FormDataProviderItems &provider_items,
  15544. UploadProgress progress) {
  15545. return cli_->Patch(path, headers, items, provider_items, progress);
  15546. }
  15547. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15548. const std::string &body,
  15549. const std::string &content_type,
  15550. ContentReceiver content_receiver,
  15551. DownloadProgress progress) {
  15552. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15553. progress);
  15554. }
  15555. inline Result Client::Delete(const std::string &path,
  15556. DownloadProgress progress) {
  15557. return cli_->Delete(path, progress);
  15558. }
  15559. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15560. DownloadProgress progress) {
  15561. return cli_->Delete(path, headers, progress);
  15562. }
  15563. inline Result Client::Delete(const std::string &path, const char *body,
  15564. size_t content_length,
  15565. const std::string &content_type,
  15566. DownloadProgress progress) {
  15567. return cli_->Delete(path, body, content_length, content_type, progress);
  15568. }
  15569. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15570. const char *body, size_t content_length,
  15571. const std::string &content_type,
  15572. DownloadProgress progress) {
  15573. return cli_->Delete(path, headers, body, content_length, content_type,
  15574. progress);
  15575. }
  15576. inline Result Client::Delete(const std::string &path, const std::string &body,
  15577. const std::string &content_type,
  15578. DownloadProgress progress) {
  15579. return cli_->Delete(path, body, content_type, progress);
  15580. }
  15581. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15582. const std::string &body,
  15583. const std::string &content_type,
  15584. DownloadProgress progress) {
  15585. return cli_->Delete(path, headers, body, content_type, progress);
  15586. }
  15587. inline Result Client::Delete(const std::string &path, const Params &params,
  15588. DownloadProgress progress) {
  15589. return cli_->Delete(path, params, progress);
  15590. }
  15591. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15592. const Params &params, DownloadProgress progress) {
  15593. return cli_->Delete(path, headers, params, progress);
  15594. }
  15595. inline Result Client::Options(const std::string &path) {
  15596. return cli_->Options(path);
  15597. }
  15598. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15599. return cli_->Options(path, headers);
  15600. }
  15601. inline ClientImpl::StreamHandle
  15602. Client::open_stream(const std::string &method, const std::string &path,
  15603. const Params &params, const Headers &headers,
  15604. const std::string &body, const std::string &content_type) {
  15605. return cli_->open_stream(method, path, params, headers, body, content_type);
  15606. }
  15607. inline bool Client::send(Request &req, Response &res, Error &error) {
  15608. return cli_->send(req, res, error);
  15609. }
  15610. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15611. inline void Client::stop() { cli_->stop(); }
  15612. inline std::string Client::host() const { return cli_->host(); }
  15613. inline int Client::port() const { return cli_->port(); }
  15614. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15615. inline socket_t Client::socket() const { return cli_->socket(); }
  15616. inline void
  15617. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15618. cli_->set_hostname_addr_map(std::move(addr_map));
  15619. }
  15620. inline void Client::set_default_headers(Headers headers) {
  15621. cli_->set_default_headers(std::move(headers));
  15622. }
  15623. inline void Client::set_header_writer(
  15624. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15625. cli_->set_header_writer(writer);
  15626. }
  15627. inline void Client::set_address_family(int family) {
  15628. cli_->set_address_family(family);
  15629. }
  15630. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15631. inline void Client::set_socket_options(SocketOptions socket_options) {
  15632. cli_->set_socket_options(std::move(socket_options));
  15633. }
  15634. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15635. cli_->set_connection_timeout(sec, usec);
  15636. }
  15637. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15638. cli_->set_read_timeout(sec, usec);
  15639. }
  15640. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15641. cli_->set_write_timeout(sec, usec);
  15642. }
  15643. inline void Client::set_basic_auth(const std::string &username,
  15644. const std::string &password) {
  15645. cli_->set_basic_auth(username, password);
  15646. }
  15647. inline void Client::set_bearer_token_auth(const std::string &token) {
  15648. cli_->set_bearer_token_auth(token);
  15649. }
  15650. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15651. inline void Client::set_follow_location(bool on) {
  15652. cli_->set_follow_location(on);
  15653. }
  15654. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15655. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15656. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15657. inline void Client::set_payload_max_length(size_t length) {
  15658. cli_->set_payload_max_length(length);
  15659. }
  15660. inline void Client::set_interface(const std::string &intf) {
  15661. cli_->set_interface(intf);
  15662. }
  15663. inline void Client::set_proxy(const std::string &host, int port) {
  15664. cli_->set_proxy(host, port);
  15665. }
  15666. inline void Client::set_proxy_basic_auth(const std::string &username,
  15667. const std::string &password) {
  15668. cli_->set_proxy_basic_auth(username, password);
  15669. }
  15670. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15671. cli_->set_proxy_bearer_token_auth(token);
  15672. }
  15673. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15674. cli_->set_no_proxy(patterns);
  15675. }
  15676. inline void Client::set_logger(Logger logger) {
  15677. cli_->set_logger(std::move(logger));
  15678. }
  15679. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15680. cli_->set_error_logger(std::move(error_logger));
  15681. }
  15682. /*
  15683. * Group 6: SSL Server and Client implementation
  15684. */
  15685. #ifdef CPPHTTPLIB_SSL_ENABLED
  15686. // SSL HTTP server implementation
  15687. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15688. const char *client_ca_cert_file_path,
  15689. const char *client_ca_cert_dir_path,
  15690. const char *private_key_password) {
  15691. using namespace tls;
  15692. ctx_ = create_server_context();
  15693. if (!ctx_) { return; }
  15694. // Load server certificate and private key
  15695. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15696. private_key_password)) {
  15697. last_ssl_error_ = static_cast<int>(get_error());
  15698. free_context(ctx_);
  15699. ctx_ = nullptr;
  15700. return;
  15701. }
  15702. // Load client CA certificates for client authentication
  15703. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15704. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15705. client_ca_cert_dir_path)) {
  15706. last_ssl_error_ = static_cast<int>(get_error());
  15707. free_context(ctx_);
  15708. ctx_ = nullptr;
  15709. return;
  15710. }
  15711. // Enable client certificate verification
  15712. set_verify_client(ctx_, true);
  15713. }
  15714. }
  15715. inline SSLServer::SSLServer(const PemMemory &pem) {
  15716. using namespace tls;
  15717. ctx_ = create_server_context();
  15718. if (ctx_) {
  15719. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15720. pem.private_key_password)) {
  15721. last_ssl_error_ = static_cast<int>(get_error());
  15722. free_context(ctx_);
  15723. ctx_ = nullptr;
  15724. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15725. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15726. last_ssl_error_ = static_cast<int>(get_error());
  15727. free_context(ctx_);
  15728. ctx_ = nullptr;
  15729. } else {
  15730. set_verify_client(ctx_, true);
  15731. }
  15732. }
  15733. }
  15734. }
  15735. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15736. using namespace tls;
  15737. ctx_ = create_server_context();
  15738. if (ctx_) {
  15739. if (!setup_callback(ctx_)) {
  15740. free_context(ctx_);
  15741. ctx_ = nullptr;
  15742. }
  15743. }
  15744. }
  15745. inline SSLServer::~SSLServer() {
  15746. if (ctx_) { tls::free_context(ctx_); }
  15747. }
  15748. inline bool SSLServer::is_valid() const {
  15749. return ctx_ != nullptr && Server::is_valid();
  15750. }
  15751. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15752. using namespace tls;
  15753. // Create TLS session with mutex protection
  15754. session_t session = nullptr;
  15755. {
  15756. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15757. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15758. }
  15759. if (!session) {
  15760. last_ssl_error_ = static_cast<int>(get_error());
  15761. detail::shutdown_socket(sock);
  15762. detail::close_socket(sock);
  15763. return false;
  15764. }
  15765. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15766. bool handshake_done = false;
  15767. bool ret = false;
  15768. bool websocket_upgraded = false;
  15769. auto cleanup = detail::scope_exit([&] {
  15770. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15771. free_session(session);
  15772. detail::shutdown_socket(sock);
  15773. detail::close_socket(sock);
  15774. });
  15775. // Perform TLS accept handshake with timeout
  15776. TlsError tls_err;
  15777. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15778. &tls_err)) {
  15779. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15780. // Map TlsError to legacy ssl_error for backward compatibility
  15781. if (tls_err.code == ErrorCode::WantRead) {
  15782. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15783. } else if (tls_err.code == ErrorCode::WantWrite) {
  15784. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15785. } else {
  15786. last_ssl_error_ = SSL_ERROR_SSL;
  15787. }
  15788. #else
  15789. last_ssl_error_ = static_cast<int>(get_error());
  15790. #endif
  15791. return false;
  15792. }
  15793. handshake_done = true;
  15794. std::string remote_addr;
  15795. int remote_port = 0;
  15796. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15797. std::string local_addr;
  15798. int local_port = 0;
  15799. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15800. ret = serve_guarded([&]() {
  15801. return detail::process_server_socket_ssl(
  15802. svr_sock_, session, sock, keep_alive_max_count_,
  15803. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15804. write_timeout_sec_, write_timeout_usec_,
  15805. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15806. return process_request(
  15807. strm, remote_addr, remote_port, local_addr, local_port,
  15808. close_connection, connection_closed,
  15809. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15810. });
  15811. });
  15812. return ret;
  15813. }
  15814. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15815. const char *key_pem,
  15816. const char *client_ca_pem,
  15817. const char *password) {
  15818. if (!ctx_) { return false; }
  15819. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15820. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15821. return false;
  15822. }
  15823. if (client_ca_pem) {
  15824. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15825. }
  15826. return true;
  15827. }
  15828. // SSL HTTP client implementation
  15829. inline SSLClient::~SSLClient() {
  15830. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15831. // base function rather than the derived function once we get to the
  15832. // base class destructor, and won't free the SSL (causing a leak).
  15833. // This must happen before the context is freed below: some backends
  15834. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15835. // context, so freeing the context first leaves close_notify reading
  15836. // freed memory.
  15837. shutdown_ssl_impl(socket_, true);
  15838. if (ctx_) {
  15839. tls::free_context(ctx_);
  15840. ctx_ = nullptr;
  15841. }
  15842. }
  15843. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15844. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15845. shutdown_ssl_impl(socket, shutdown_gracefully);
  15846. }
  15847. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15848. bool shutdown_gracefully) {
  15849. if (socket.sock == INVALID_SOCKET) {
  15850. assert(socket.ssl == nullptr);
  15851. return;
  15852. }
  15853. if (socket.ssl) {
  15854. tls::shutdown(socket.ssl, shutdown_gracefully);
  15855. {
  15856. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15857. tls::free_session(socket.ssl);
  15858. }
  15859. socket.ssl = nullptr;
  15860. }
  15861. assert(socket.ssl == nullptr);
  15862. }
  15863. inline bool SSLClient::process_socket(
  15864. const Socket &socket,
  15865. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15866. std::function<bool(Stream &strm)> callback) {
  15867. assert(socket.ssl);
  15868. return detail::process_client_socket_ssl(
  15869. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15870. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15871. std::move(callback));
  15872. }
  15873. inline bool SSLClient::is_ssl() const { return true; }
  15874. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15875. if (!is_valid()) {
  15876. error = Error::SSLConnection;
  15877. return false;
  15878. }
  15879. return ClientImpl::create_and_connect_socket(socket, error);
  15880. }
  15881. inline bool SSLClient::setup_proxy_connection(
  15882. Socket &socket,
  15883. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15884. Response &res, bool &success, Error &error) {
  15885. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15886. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15887. return false;
  15888. }
  15889. if (!initialize_ssl(socket, error)) {
  15890. success = false;
  15891. return false;
  15892. }
  15893. return true;
  15894. }
  15895. // Assumes that socket_mutex_ is locked and that there are no requests in
  15896. // flight
  15897. inline bool SSLClient::connect_with_proxy(
  15898. Socket &socket,
  15899. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15900. Response &res, bool &success, Error &error) {
  15901. success = true;
  15902. Response proxy_res;
  15903. if (!detail::process_client_socket(
  15904. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15905. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15906. start_time, [&](Stream &strm) {
  15907. Request req2;
  15908. req2.method = "CONNECT";
  15909. req2.path =
  15910. detail::make_host_and_port_string_always_port(host_, port_);
  15911. if (max_timeout_msec_ > 0) {
  15912. req2.start_time_ = std::chrono::steady_clock::now();
  15913. }
  15914. return process_request(strm, req2, proxy_res, false, error);
  15915. })) {
  15916. // Thread-safe to close everything because we are assuming there are no
  15917. // requests in flight
  15918. shutdown_ssl(socket, true);
  15919. shutdown_socket(socket);
  15920. close_socket(socket);
  15921. success = false;
  15922. return false;
  15923. }
  15924. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15925. if (!proxy_digest_auth_username_.empty() &&
  15926. !proxy_digest_auth_password_.empty()) {
  15927. std::map<std::string, std::string> auth;
  15928. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15929. // Close the current socket and create a new one for the authenticated
  15930. // request
  15931. shutdown_ssl(socket, true);
  15932. shutdown_socket(socket);
  15933. close_socket(socket);
  15934. // Create a new socket for the authenticated CONNECT request
  15935. if (!ensure_socket_connection(socket, error)) {
  15936. success = false;
  15937. output_error_log(error, nullptr);
  15938. return false;
  15939. }
  15940. proxy_res = Response();
  15941. if (!detail::process_client_socket(
  15942. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15943. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15944. start_time, [&](Stream &strm) {
  15945. Request req3;
  15946. req3.method = "CONNECT";
  15947. req3.path = detail::make_host_and_port_string_always_port(
  15948. host_, port_);
  15949. req3.headers.insert(detail::make_digest_authentication_header(
  15950. req3, auth, 1, detail::random_string(10),
  15951. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15952. true));
  15953. if (max_timeout_msec_ > 0) {
  15954. req3.start_time_ = std::chrono::steady_clock::now();
  15955. }
  15956. return process_request(strm, req3, proxy_res, false, error);
  15957. })) {
  15958. // Thread-safe to close everything because we are assuming there are
  15959. // no requests in flight
  15960. shutdown_ssl(socket, true);
  15961. shutdown_socket(socket);
  15962. close_socket(socket);
  15963. success = false;
  15964. return false;
  15965. }
  15966. }
  15967. }
  15968. }
  15969. // If status code is not 200, proxy request is failed.
  15970. // Set error to ProxyConnection and return proxy response
  15971. // as the response of the request
  15972. if (proxy_res.status != StatusCode::OK_200) {
  15973. error = Error::ProxyConnection;
  15974. output_error_log(error, nullptr);
  15975. res = std::move(proxy_res);
  15976. // Thread-safe to close everything because we are assuming there are
  15977. // no requests in flight
  15978. shutdown_ssl(socket, true);
  15979. shutdown_socket(socket);
  15980. close_socket(socket);
  15981. return false;
  15982. }
  15983. return true;
  15984. }
  15985. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15986. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15987. if (is_proxy_enabled_for_host(host_)) { return true; }
  15988. if (!initialize_ssl(socket, error)) {
  15989. shutdown_socket(socket);
  15990. close_socket(socket);
  15991. return false;
  15992. }
  15993. return true;
  15994. }
  15995. // SSL HTTP client implementation
  15996. inline SSLClient::SSLClient(const std::string &host)
  15997. : SSLClient(host, 443, std::string(), std::string()) {}
  15998. inline SSLClient::SSLClient(const std::string &host, int port)
  15999. : SSLClient(host, port, std::string(), std::string()) {}
  16000. inline void SSLClient::init_ctx() {
  16001. ctx_ = tls::create_client_context();
  16002. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16003. }
  16004. inline void SSLClient::reset_ctx_on_error() {
  16005. last_backend_error_ = tls::get_error();
  16006. tls::free_context(ctx_);
  16007. ctx_ = nullptr;
  16008. }
  16009. inline SSLClient::SSLClient(const std::string &host, int port,
  16010. const std::string &client_cert_path,
  16011. const std::string &client_key_path,
  16012. const std::string &private_key_password)
  16013. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16014. init_ctx();
  16015. if (!ctx_) { return; }
  16016. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16017. const char *password =
  16018. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16019. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16020. client_key_path.c_str(), password)) {
  16021. reset_ctx_on_error();
  16022. }
  16023. }
  16024. }
  16025. inline SSLClient::SSLClient(const std::string &host, int port,
  16026. const PemMemory &pem)
  16027. : ClientImpl(host, port) {
  16028. init_ctx();
  16029. if (!ctx_) { return; }
  16030. if (pem.cert_pem && pem.key_pem) {
  16031. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16032. pem.private_key_password)) {
  16033. reset_ctx_on_error();
  16034. }
  16035. }
  16036. }
  16037. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16038. if (ca_cert_store && ctx_) {
  16039. // set_ca_store takes ownership of ca_cert_store
  16040. tls::set_ca_store(ctx_, ca_cert_store);
  16041. ca_cert_store_set_ = true;
  16042. } else if (ca_cert_store) {
  16043. tls::free_ca_store(ca_cert_store);
  16044. }
  16045. }
  16046. inline void
  16047. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16048. if (!ctx_) { return; }
  16049. server_certificate_verifier_ = verifier;
  16050. tls::set_verify_callback(ctx_, std::move(verifier));
  16051. }
  16052. inline void SSLClient::set_session_verifier(
  16053. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16054. session_verifier_ = std::move(verifier);
  16055. }
  16056. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16057. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16058. enable_windows_cert_verification_ = enabled;
  16059. }
  16060. #endif
  16061. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16062. std::size_t size) {
  16063. if (ctx_ && ca_cert && size > 0) {
  16064. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16065. tls::load_ca_pem(ctx_, ca_cert, size);
  16066. }
  16067. }
  16068. inline bool SSLClient::load_certs() {
  16069. auto ret = true;
  16070. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16071. // one client is shared across concurrent requests here.
  16072. std::call_once(initialize_cert_, [&]() {
  16073. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16074. ret = detail::load_client_ca_config(
  16075. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16076. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16077. last_backend_error_);
  16078. });
  16079. return ret;
  16080. }
  16081. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16082. // Load CA certificates if server verification is enabled
  16083. if (server_certificate_verification_) {
  16084. if (!load_certs()) {
  16085. error = Error::SSLLoadingCerts;
  16086. output_error_log(error, nullptr);
  16087. return false;
  16088. }
  16089. }
  16090. detail::ClientTlsSessionOptions options;
  16091. options.server_hostname_verification = server_hostname_verification_;
  16092. options.session_verifier = session_verifier_;
  16093. options.ctx_mutex = &ctx_mutex_;
  16094. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16095. // Skip Schannel when a custom CA cert is specified, as the Windows
  16096. // certificate store would not know about user-provided CA certificates.
  16097. // Also skip when system CA trust is explicitly disabled.
  16098. options.windows_cert_verification =
  16099. enable_windows_cert_verification_ &&
  16100. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16101. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16102. // Only a verifier set through set_server_certificate_verifier() is seen
  16103. // here, not one installed with tls::set_verify_callback() directly.
  16104. options.server_certificate_verifier_set =
  16105. static_cast<bool>(server_certificate_verifier_);
  16106. #endif
  16107. tls::session_t session = nullptr;
  16108. // Use scope_exit to ensure session is freed on error paths
  16109. bool success = false;
  16110. auto session_guard = detail::scope_exit([&] {
  16111. if (!success) { tls::free_session(session); }
  16112. });
  16113. detail::ClientTlsSessionError tls_error;
  16114. if (!detail::setup_client_tls_session(
  16115. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16116. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16117. options)) {
  16118. error = tls_error.error;
  16119. last_ssl_error_ = tls_error.ssl_error;
  16120. last_backend_error_ = tls_error.backend_error;
  16121. output_error_log(error, nullptr);
  16122. return false;
  16123. }
  16124. success = true;
  16125. socket.ssl = session;
  16126. return true;
  16127. }
  16128. inline void Client::set_digest_auth(const std::string &username,
  16129. const std::string &password) {
  16130. cli_->set_digest_auth(username, password);
  16131. }
  16132. inline void Client::set_proxy_digest_auth(const std::string &username,
  16133. const std::string &password) {
  16134. cli_->set_proxy_digest_auth(username, password);
  16135. }
  16136. inline void Client::enable_server_certificate_verification(bool enabled) {
  16137. cli_->enable_server_certificate_verification(enabled);
  16138. }
  16139. inline void Client::enable_server_hostname_verification(bool enabled) {
  16140. cli_->enable_server_hostname_verification(enabled);
  16141. }
  16142. inline void Client::enable_system_ca(bool enabled) {
  16143. cli_->enable_system_ca(enabled);
  16144. }
  16145. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16146. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16147. if (is_ssl_) {
  16148. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16149. enabled);
  16150. }
  16151. }
  16152. #endif
  16153. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16154. const std::string &ca_cert_dir_path) {
  16155. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16156. }
  16157. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16158. if (is_ssl_) {
  16159. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16160. } else if (ca_cert_store) {
  16161. tls::free_ca_store(ca_cert_store);
  16162. }
  16163. }
  16164. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16165. if (is_ssl_) {
  16166. // Use the PEM-based path so the CA data is retained for redirect transfer
  16167. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16168. }
  16169. }
  16170. inline void
  16171. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16172. if (is_ssl_) {
  16173. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16174. std::move(verifier));
  16175. }
  16176. }
  16177. inline void Client::set_session_verifier(
  16178. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16179. if (is_ssl_) {
  16180. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16181. }
  16182. }
  16183. inline tls::ctx_t Client::tls_context() const {
  16184. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16185. return nullptr;
  16186. }
  16187. #endif // CPPHTTPLIB_SSL_ENABLED
  16188. /*
  16189. * Group 7: TLS abstraction layer - Common API
  16190. */
  16191. #ifdef CPPHTTPLIB_SSL_ENABLED
  16192. namespace tls {
  16193. // Helper for PeerCert construction
  16194. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16195. return PeerCert(get_peer_cert(session));
  16196. }
  16197. namespace impl {
  16198. // Check if a string is an IPv4 address
  16199. inline bool is_ipv4_address(const std::string &str) {
  16200. int dots = 0;
  16201. for (char c : str) {
  16202. if (c == '.') {
  16203. dots++;
  16204. } else if (!detail::is_ascii_digit(c)) {
  16205. return false;
  16206. }
  16207. }
  16208. return dots == 3;
  16209. }
  16210. // Parse IPv4 address string to bytes
  16211. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16212. const char *p = str.c_str();
  16213. for (int i = 0; i < 4; i++) {
  16214. if (i > 0) {
  16215. if (*p != '.') { return false; }
  16216. p++;
  16217. }
  16218. int val = 0;
  16219. int digits = 0;
  16220. while (detail::is_ascii_digit(*p)) {
  16221. val = val * 10 + (*p - '0');
  16222. if (val > 255) { return false; }
  16223. p++;
  16224. digits++;
  16225. }
  16226. if (digits == 0) { return false; }
  16227. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16228. if (digits > 1 && *(p - digits) == '0') { return false; }
  16229. out[i] = static_cast<unsigned char>(val);
  16230. }
  16231. return *p == '\0';
  16232. }
  16233. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16234. // `out` must have room for at least 16 bytes. Returns the address length
  16235. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16236. // literal. Used to match a host against iPAddress SANs the same way the
  16237. // OpenSSL backend does via X509_check_ip.
  16238. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16239. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16240. struct in6_addr addr6 = {};
  16241. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16242. memcpy(out, &addr6, 16);
  16243. return 16;
  16244. }
  16245. return 0;
  16246. }
  16247. #ifdef _WIN32
  16248. // Enumerate Windows system certificates and call callback with DER data
  16249. template <typename Callback>
  16250. inline bool enumerate_windows_system_certs(Callback cb) {
  16251. bool loaded = false;
  16252. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16253. for (auto store_name : store_names) {
  16254. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16255. if (hStore) {
  16256. PCCERT_CONTEXT pContext = nullptr;
  16257. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16258. nullptr) {
  16259. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16260. loaded = true;
  16261. }
  16262. }
  16263. CertCloseStore(hStore, 0);
  16264. }
  16265. }
  16266. return loaded;
  16267. }
  16268. #endif
  16269. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16270. // Enumerate macOS Keychain certificates and call callback with DER data
  16271. template <typename Callback>
  16272. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16273. bool loaded = false;
  16274. const SecTrustSettingsDomain domains[] = {
  16275. kSecTrustSettingsDomainSystem,
  16276. kSecTrustSettingsDomainAdmin,
  16277. kSecTrustSettingsDomainUser,
  16278. };
  16279. for (auto domain : domains) {
  16280. CFArrayRef certs = nullptr;
  16281. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16282. if (status != errSecSuccess || !certs) {
  16283. if (certs) CFRelease(certs);
  16284. continue;
  16285. }
  16286. CFIndex count = CFArrayGetCount(certs);
  16287. for (CFIndex i = 0; i < count; i++) {
  16288. SecCertificateRef cert =
  16289. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16290. CFDataRef data = SecCertificateCopyData(cert);
  16291. if (data) {
  16292. if (cb(CFDataGetBytePtr(data),
  16293. static_cast<size_t>(CFDataGetLength(data)))) {
  16294. loaded = true;
  16295. }
  16296. CFRelease(data);
  16297. }
  16298. }
  16299. CFRelease(certs);
  16300. }
  16301. return loaded;
  16302. }
  16303. #endif
  16304. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16305. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16306. // Common CA certificate file paths on Linux/Unix
  16307. inline const char **system_ca_paths() {
  16308. static const char *paths[] = {
  16309. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16310. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16311. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16312. "/etc/pki/tls/cacert.pem", // OpenELEC
  16313. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16314. nullptr};
  16315. return paths;
  16316. }
  16317. // Common CA certificate directory paths on Linux/Unix
  16318. inline const char **system_ca_dirs() {
  16319. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16320. "/etc/pki/tls/certs", // RHEL/CentOS
  16321. "/usr/share/ca-certificates", // Other
  16322. nullptr};
  16323. return dirs;
  16324. }
  16325. #endif
  16326. } // namespace impl
  16327. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16328. const char *ca_dir) {
  16329. if (!ctx) { return false; }
  16330. bool success = true;
  16331. if (ca_file && *ca_file) {
  16332. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16333. }
  16334. if (ca_dir && *ca_dir) {
  16335. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16336. }
  16337. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16338. // Set CA list for client certificate request (CertificateRequest message)
  16339. if (ca_file && *ca_file) {
  16340. auto list = SSL_load_client_CA_file(ca_file);
  16341. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16342. }
  16343. #endif
  16344. return success;
  16345. }
  16346. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16347. const char *password) {
  16348. return set_client_cert_pem(ctx, cert, key, password);
  16349. }
  16350. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16351. const char *key_path, const char *password) {
  16352. return set_client_cert_file(ctx, cert_path, key_path, password);
  16353. }
  16354. // PeerCert implementation
  16355. inline PeerCert::PeerCert() = default;
  16356. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16357. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16358. other.cert_ = nullptr;
  16359. }
  16360. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16361. if (this != &other) {
  16362. if (cert_) { free_cert(cert_); }
  16363. cert_ = other.cert_;
  16364. other.cert_ = nullptr;
  16365. }
  16366. return *this;
  16367. }
  16368. inline PeerCert::~PeerCert() {
  16369. if (cert_) { free_cert(cert_); }
  16370. }
  16371. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16372. inline std::string PeerCert::subject_cn() const {
  16373. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16374. }
  16375. inline std::string PeerCert::issuer_name() const {
  16376. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16377. }
  16378. inline bool PeerCert::check_hostname(const char *hostname) const {
  16379. return cert_ ? verify_hostname(cert_, hostname) : false;
  16380. }
  16381. inline std::vector<SanEntry> PeerCert::sans() const {
  16382. std::vector<SanEntry> result;
  16383. if (cert_) { get_cert_sans(cert_, result); }
  16384. return result;
  16385. }
  16386. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16387. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16388. }
  16389. inline std::string PeerCert::serial() const {
  16390. return cert_ ? get_cert_serial(cert_) : std::string();
  16391. }
  16392. // VerifyContext method implementations
  16393. inline std::string VerifyContext::subject_cn() const {
  16394. return cert ? get_cert_subject_cn(cert) : std::string();
  16395. }
  16396. inline std::string VerifyContext::issuer_name() const {
  16397. return cert ? get_cert_issuer_name(cert) : std::string();
  16398. }
  16399. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16400. return cert ? verify_hostname(cert, hostname) : false;
  16401. }
  16402. inline std::vector<SanEntry> VerifyContext::sans() const {
  16403. std::vector<SanEntry> result;
  16404. if (cert) { get_cert_sans(cert, result); }
  16405. return result;
  16406. }
  16407. inline bool VerifyContext::validity(time_t &not_before,
  16408. time_t &not_after) const {
  16409. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16410. }
  16411. inline std::string VerifyContext::serial() const {
  16412. return cert ? get_cert_serial(cert) : std::string();
  16413. }
  16414. // TlsError static method implementation
  16415. inline std::string TlsError::verify_error_to_string(long error_code) {
  16416. return verify_error_string(error_code);
  16417. }
  16418. } // namespace tls
  16419. // Request::peer_cert() implementation
  16420. inline tls::PeerCert Request::peer_cert() const {
  16421. return tls::get_peer_cert_from_session(ssl);
  16422. }
  16423. // Request::sni() implementation
  16424. inline std::string Request::sni() const {
  16425. if (!ssl) { return std::string(); }
  16426. const char *s = tls::get_sni(ssl);
  16427. return s ? std::string(s) : std::string();
  16428. }
  16429. #endif // CPPHTTPLIB_SSL_ENABLED
  16430. /*
  16431. * Group 8: TLS abstraction layer - OpenSSL backend
  16432. */
  16433. /*
  16434. * OpenSSL Backend Implementation
  16435. */
  16436. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16437. namespace tls {
  16438. namespace impl {
  16439. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16440. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16441. switch (ssl_error) {
  16442. case SSL_ERROR_NONE: return ErrorCode::Success;
  16443. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16444. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16445. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16446. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16447. case SSL_ERROR_SSL:
  16448. default: return ErrorCode::Fatal;
  16449. }
  16450. }
  16451. // Helper: Create client CA list from PEM string
  16452. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16453. // Caller takes ownership of returned list
  16454. inline STACK_OF(X509_NAME) *
  16455. create_client_ca_list_from_pem(const char *ca_pem) {
  16456. if (!ca_pem) { return nullptr; }
  16457. auto ca_list = sk_X509_NAME_new_null();
  16458. if (!ca_list) { return nullptr; }
  16459. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16460. if (!bio) {
  16461. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16462. return nullptr;
  16463. }
  16464. X509 *cert = nullptr;
  16465. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16466. nullptr) {
  16467. const X509_NAME *name = X509_get_subject_name(cert);
  16468. if (name) {
  16469. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16470. }
  16471. X509_free(cert);
  16472. }
  16473. BIO_free(bio);
  16474. return ca_list;
  16475. }
  16476. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16477. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16478. long /*argl*/, void * /*argp*/) {
  16479. delete static_cast<VerifyCallback *>(ptr);
  16480. }
  16481. // The SSL_CTX owns its verify callback, so each client or server sees only
  16482. // its own, on whichever thread runs the handshake.
  16483. inline int verify_callback_index() {
  16484. static const auto index = SSL_CTX_get_ex_new_index(
  16485. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16486. return index;
  16487. }
  16488. // OpenSSL verify callback wrapper
  16489. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16490. // Get SSL object from X509_STORE_CTX
  16491. auto ssl = static_cast<SSL *>(
  16492. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16493. if (!ssl) { return preverify_ok; }
  16494. auto callback = static_cast<VerifyCallback *>(
  16495. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16496. if (!callback) { return preverify_ok; }
  16497. // Get current certificate and depth
  16498. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16499. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16500. int error = X509_STORE_CTX_get_error(ctx);
  16501. // Build context
  16502. VerifyContext verify_ctx;
  16503. verify_ctx.session = static_cast<session_t>(ssl);
  16504. verify_ctx.cert = static_cast<cert_t>(cert);
  16505. verify_ctx.depth = depth;
  16506. verify_ctx.preverify_ok = (preverify_ok != 0);
  16507. verify_ctx.error_code = error;
  16508. verify_ctx.error_string =
  16509. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16510. return (*callback)(verify_ctx) ? 1 : 0;
  16511. }
  16512. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16513. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16514. // that must be released with release_store_objects
  16515. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16516. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16517. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16518. #endif
  16519. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16520. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16521. return X509_STORE_get1_objects(store);
  16522. #else
  16523. return X509_STORE_get0_objects(store);
  16524. #endif
  16525. }
  16526. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16527. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16528. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16529. #else
  16530. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16531. #endif
  16532. }
  16533. } // namespace impl
  16534. inline ctx_t create_client_context() {
  16535. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16536. if (ctx) {
  16537. // Disable auto-retry to properly handle non-blocking I/O
  16538. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16539. // Set minimum TLS version
  16540. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16541. }
  16542. return static_cast<ctx_t>(ctx);
  16543. }
  16544. inline void free_context(ctx_t ctx) {
  16545. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16546. }
  16547. inline bool set_min_version(ctx_t ctx, Version version) {
  16548. if (!ctx) return false;
  16549. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16550. static_cast<int>(version)) == 1;
  16551. }
  16552. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16553. if (!ctx || !pem || len == 0) return false;
  16554. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16555. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16556. if (!store) return false;
  16557. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16558. if (!bio) return false;
  16559. bool ok = true;
  16560. X509 *cert = nullptr;
  16561. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16562. nullptr) {
  16563. if (X509_STORE_add_cert(store, cert) != 1) {
  16564. // Ignore duplicate errors
  16565. auto err = ERR_peek_last_error();
  16566. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16567. ok = false;
  16568. }
  16569. }
  16570. X509_free(cert);
  16571. if (!ok) break;
  16572. }
  16573. BIO_free(bio);
  16574. // Clear any "no more certificates" errors
  16575. ERR_clear_error();
  16576. return ok;
  16577. }
  16578. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16579. if (!ctx || !file_path) return false;
  16580. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16581. nullptr) == 1;
  16582. }
  16583. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16584. if (!ctx || !dir_path) return false;
  16585. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16586. dir_path) == 1;
  16587. }
  16588. inline bool load_system_certs(ctx_t ctx) {
  16589. if (!ctx) return false;
  16590. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16591. #ifdef _WIN32
  16592. // Windows: Load from system certificate store (ROOT and CA)
  16593. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16594. if (!store) return false;
  16595. bool loaded_any = false;
  16596. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16597. for (auto store_name : store_names) {
  16598. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16599. if (!hStore) continue;
  16600. PCCERT_CONTEXT pContext = nullptr;
  16601. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16602. nullptr) {
  16603. const unsigned char *data = pContext->pbCertEncoded;
  16604. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16605. if (x509) {
  16606. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16607. X509_free(x509);
  16608. }
  16609. }
  16610. CertCloseStore(hStore, 0);
  16611. }
  16612. return loaded_any;
  16613. #elif defined(__APPLE__)
  16614. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16615. // macOS: Load from Keychain
  16616. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16617. if (!store) return false;
  16618. bool loaded_any = false;
  16619. const SecTrustSettingsDomain domains[] = {
  16620. kSecTrustSettingsDomainSystem,
  16621. kSecTrustSettingsDomainAdmin,
  16622. kSecTrustSettingsDomainUser,
  16623. };
  16624. for (auto domain : domains) {
  16625. CFArrayRef certs = nullptr;
  16626. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16627. !certs) {
  16628. if (certs) CFRelease(certs);
  16629. continue;
  16630. }
  16631. auto count = CFArrayGetCount(certs);
  16632. for (CFIndex i = 0; i < count; i++) {
  16633. auto cert = reinterpret_cast<SecCertificateRef>(
  16634. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16635. CFDataRef der = SecCertificateCopyData(cert);
  16636. if (der) {
  16637. const unsigned char *data = CFDataGetBytePtr(der);
  16638. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16639. if (x509) {
  16640. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16641. X509_free(x509);
  16642. }
  16643. CFRelease(der);
  16644. }
  16645. }
  16646. CFRelease(certs);
  16647. }
  16648. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16649. #else
  16650. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16651. #endif
  16652. #else
  16653. // Other Unix: use default verify paths
  16654. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16655. #endif
  16656. }
  16657. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16658. const char *password) {
  16659. if (!ctx || !cert || !key) return false;
  16660. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16661. // Load certificate
  16662. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16663. if (!cert_bio) return false;
  16664. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16665. BIO_free(cert_bio);
  16666. if (!x509) return false;
  16667. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16668. X509_free(x509);
  16669. if (!cert_ok) return false;
  16670. // Load private key
  16671. auto key_bio = BIO_new_mem_buf(key, -1);
  16672. if (!key_bio) return false;
  16673. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16674. password ? const_cast<char *>(password)
  16675. : nullptr);
  16676. BIO_free(key_bio);
  16677. if (!pkey) return false;
  16678. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16679. EVP_PKEY_free(pkey);
  16680. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16681. }
  16682. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16683. const char *key_path, const char *password) {
  16684. if (!ctx || !cert_path || !key_path) return false;
  16685. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16686. if (password && password[0] != '\0') {
  16687. SSL_CTX_set_default_passwd_cb_userdata(
  16688. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16689. }
  16690. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16691. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16692. }
  16693. inline ctx_t create_server_context() {
  16694. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16695. if (ctx) {
  16696. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16697. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16698. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16699. }
  16700. return static_cast<ctx_t>(ctx);
  16701. }
  16702. inline void set_verify_client(ctx_t ctx, bool require) {
  16703. if (!ctx) return;
  16704. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16705. require
  16706. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16707. : SSL_VERIFY_NONE,
  16708. nullptr);
  16709. }
  16710. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16711. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16712. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16713. SSL *ssl = SSL_new(ssl_ctx);
  16714. if (!ssl) return nullptr;
  16715. // Disable auto-retry for proper non-blocking I/O handling
  16716. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16717. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16718. if (!bio) {
  16719. SSL_free(ssl);
  16720. return nullptr;
  16721. }
  16722. SSL_set_bio(ssl, bio, bio);
  16723. return static_cast<session_t>(ssl);
  16724. }
  16725. inline void free_session(session_t session) {
  16726. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16727. }
  16728. inline bool set_sni(session_t session, const char *hostname,
  16729. bool /*verify_hostname*/) {
  16730. if (!session || !hostname) return false;
  16731. auto ssl = static_cast<SSL *>(session);
  16732. // Set SNI (Server Name Indication) only - does not enable verification.
  16733. // OpenSSL never binds identity checking to SNI (that happens post-
  16734. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16735. #if defined(OPENSSL_IS_BORINGSSL)
  16736. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16737. #else
  16738. // Direct call instead of macro to suppress -Wold-style-cast warning
  16739. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16740. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16741. #endif
  16742. }
  16743. inline TlsError connect(session_t session) {
  16744. if (!session) { return TlsError(); }
  16745. auto ssl = static_cast<SSL *>(session);
  16746. auto ret = SSL_connect(ssl);
  16747. TlsError err;
  16748. if (ret == 1) {
  16749. err.code = ErrorCode::Success;
  16750. } else {
  16751. auto ssl_err = SSL_get_error(ssl, ret);
  16752. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16753. err.backend_code = ERR_get_error();
  16754. }
  16755. return err;
  16756. }
  16757. inline TlsError accept(session_t session) {
  16758. if (!session) { return TlsError(); }
  16759. auto ssl = static_cast<SSL *>(session);
  16760. auto ret = SSL_accept(ssl);
  16761. TlsError err;
  16762. if (ret == 1) {
  16763. err.code = ErrorCode::Success;
  16764. } else {
  16765. auto ssl_err = SSL_get_error(ssl, ret);
  16766. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16767. err.backend_code = ERR_get_error();
  16768. }
  16769. return err;
  16770. }
  16771. inline bool connect_nonblocking(session_t session, socket_t sock,
  16772. time_t timeout_sec, time_t timeout_usec,
  16773. TlsError *err) {
  16774. if (!session) {
  16775. if (err) { err->code = ErrorCode::Fatal; }
  16776. return false;
  16777. }
  16778. auto ssl = static_cast<SSL *>(session);
  16779. auto bio = SSL_get_rbio(ssl);
  16780. // Set non-blocking mode for handshake
  16781. detail::set_nonblocking(sock, true);
  16782. if (bio) { BIO_set_nbio(bio, 1); }
  16783. auto cleanup = detail::scope_exit([&]() {
  16784. // Restore blocking mode after handshake
  16785. if (bio) { BIO_set_nbio(bio, 0); }
  16786. detail::set_nonblocking(sock, false);
  16787. });
  16788. auto res = 0;
  16789. while ((res = SSL_connect(ssl)) != 1) {
  16790. auto ssl_err = SSL_get_error(ssl, res);
  16791. switch (ssl_err) {
  16792. case SSL_ERROR_WANT_READ:
  16793. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16794. continue;
  16795. }
  16796. break;
  16797. case SSL_ERROR_WANT_WRITE:
  16798. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16799. continue;
  16800. }
  16801. break;
  16802. default: break;
  16803. }
  16804. if (err) {
  16805. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16806. err->backend_code = ERR_get_error();
  16807. }
  16808. return false;
  16809. }
  16810. if (err) { err->code = ErrorCode::Success; }
  16811. return true;
  16812. }
  16813. inline bool accept_nonblocking(session_t session, socket_t sock,
  16814. time_t timeout_sec, time_t timeout_usec,
  16815. TlsError *err) {
  16816. if (!session) {
  16817. if (err) { err->code = ErrorCode::Fatal; }
  16818. return false;
  16819. }
  16820. auto ssl = static_cast<SSL *>(session);
  16821. auto bio = SSL_get_rbio(ssl);
  16822. // Set non-blocking mode for handshake
  16823. detail::set_nonblocking(sock, true);
  16824. if (bio) { BIO_set_nbio(bio, 1); }
  16825. auto cleanup = detail::scope_exit([&]() {
  16826. // Restore blocking mode after handshake
  16827. if (bio) { BIO_set_nbio(bio, 0); }
  16828. detail::set_nonblocking(sock, false);
  16829. });
  16830. auto res = 0;
  16831. while ((res = SSL_accept(ssl)) != 1) {
  16832. auto ssl_err = SSL_get_error(ssl, res);
  16833. switch (ssl_err) {
  16834. case SSL_ERROR_WANT_READ:
  16835. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16836. continue;
  16837. }
  16838. break;
  16839. case SSL_ERROR_WANT_WRITE:
  16840. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16841. continue;
  16842. }
  16843. break;
  16844. default: break;
  16845. }
  16846. if (err) {
  16847. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16848. err->backend_code = ERR_get_error();
  16849. }
  16850. return false;
  16851. }
  16852. if (err) { err->code = ErrorCode::Success; }
  16853. return true;
  16854. }
  16855. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16856. if (!session || !buf) {
  16857. err.code = ErrorCode::Fatal;
  16858. return -1;
  16859. }
  16860. auto ssl = static_cast<SSL *>(session);
  16861. constexpr auto max_len =
  16862. static_cast<size_t>((std::numeric_limits<int>::max)());
  16863. if (len > max_len) { len = max_len; }
  16864. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16865. if (ret > 0) {
  16866. err.code = ErrorCode::Success;
  16867. return ret;
  16868. }
  16869. auto ssl_err = SSL_get_error(ssl, ret);
  16870. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16871. if (err.code == ErrorCode::PeerClosed) {
  16872. return 0;
  16873. } // Gracefully handle the peer closed state.
  16874. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16875. return -1;
  16876. }
  16877. inline ssize_t write(session_t session, const void *buf, size_t len,
  16878. TlsError &err) {
  16879. if (!session || !buf) {
  16880. err.code = ErrorCode::Fatal;
  16881. return -1;
  16882. }
  16883. auto ssl = static_cast<SSL *>(session);
  16884. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16885. if (ret > 0) {
  16886. err.code = ErrorCode::Success;
  16887. return ret;
  16888. }
  16889. auto ssl_err = SSL_get_error(ssl, ret);
  16890. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16891. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16892. return -1;
  16893. }
  16894. inline int pending(const_session_t session) {
  16895. if (!session) return 0;
  16896. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16897. }
  16898. inline void shutdown(session_t session, bool graceful) {
  16899. if (!session) return;
  16900. auto ssl = static_cast<SSL *>(session);
  16901. if (graceful) {
  16902. // Send close_notify without waiting for the peer's. The connection is
  16903. // closed right after this, so a unidirectional shutdown is enough, and an
  16904. // idle peer that never answers would otherwise hold this thread until the
  16905. // read timeout. The other backends do not wait either.
  16906. SSL_shutdown(ssl);
  16907. }
  16908. }
  16909. inline bool is_peer_closed(session_t session, socket_t sock) {
  16910. if (!session) return true;
  16911. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16912. detail::set_nonblocking(sock, true);
  16913. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16914. auto ssl = static_cast<SSL *>(session);
  16915. char buf;
  16916. auto ret = SSL_peek(ssl, &buf, 1);
  16917. if (ret > 0) return false;
  16918. auto err = SSL_get_error(ssl, ret);
  16919. return err == SSL_ERROR_ZERO_RETURN;
  16920. }
  16921. inline cert_t get_peer_cert(const_session_t session) {
  16922. if (!session) return nullptr;
  16923. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16924. static_cast<SSL *>(const_cast<void *>(session))));
  16925. }
  16926. inline size_t get_peer_certs(const_session_t session,
  16927. std::vector<cert_t> &certs) {
  16928. certs.clear();
  16929. if (!session) { return 0; }
  16930. auto ssl = static_cast<const SSL *>(session);
  16931. // On the server side, the chain leaves out the peer's own certificate
  16932. if (SSL_is_server(ssl)) {
  16933. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16934. }
  16935. auto sk = SSL_get_peer_cert_chain(ssl);
  16936. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16937. auto x509 = sk_X509_value(sk, i);
  16938. X509_up_ref(x509);
  16939. certs.push_back(static_cast<cert_t>(x509));
  16940. }
  16941. return certs.size();
  16942. }
  16943. inline void free_cert(cert_t cert) {
  16944. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16945. }
  16946. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16947. if (!cert || !hostname) return false;
  16948. auto x509 = static_cast<X509 *>(cert);
  16949. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16950. if (detail::is_ip_address(hostname)) {
  16951. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16952. }
  16953. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16954. }
  16955. inline uint64_t hostname_mismatch_code() {
  16956. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16957. }
  16958. inline long get_verify_result(const_session_t session) {
  16959. if (!session) return X509_V_ERR_UNSPECIFIED;
  16960. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16961. }
  16962. inline std::string get_cert_subject_cn(cert_t cert) {
  16963. if (!cert) return "";
  16964. auto x509 = static_cast<X509 *>(cert);
  16965. auto subject_name = X509_get_subject_name(x509);
  16966. if (!subject_name) return "";
  16967. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16968. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16969. if (idx < 0) return "";
  16970. auto entry = X509_NAME_get_entry(subject_name, idx);
  16971. if (!entry) return "";
  16972. auto data = X509_NAME_ENTRY_get_data(entry);
  16973. if (!data) return "";
  16974. return std::string(
  16975. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16976. static_cast<size_t>(ASN1_STRING_length(data)));
  16977. }
  16978. inline std::string get_cert_issuer_name(cert_t cert) {
  16979. if (!cert) return "";
  16980. auto x509 = static_cast<X509 *>(cert);
  16981. auto issuer_name = X509_get_issuer_name(x509);
  16982. if (!issuer_name) return "";
  16983. char buf[256];
  16984. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16985. return std::string(buf);
  16986. }
  16987. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16988. sans.clear();
  16989. if (!cert) return false;
  16990. auto x509 = static_cast<X509 *>(cert);
  16991. auto names = static_cast<GENERAL_NAMES *>(
  16992. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16993. if (!names) return true; // No SANs is valid
  16994. auto count = sk_GENERAL_NAME_num(names);
  16995. for (decltype(count) i = 0; i < count; i++) {
  16996. auto gen = sk_GENERAL_NAME_value(names, i);
  16997. if (!gen) continue;
  16998. SanEntry entry;
  16999. switch (gen->type) {
  17000. case GEN_DNS:
  17001. entry.type = SanType::DNS;
  17002. if (gen->d.dNSName) {
  17003. entry.value = std::string(
  17004. reinterpret_cast<const char *>(
  17005. ASN1_STRING_get0_data(gen->d.dNSName)),
  17006. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17007. }
  17008. break;
  17009. case GEN_IPADD:
  17010. entry.type = SanType::IP;
  17011. if (gen->d.iPAddress) {
  17012. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17013. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17014. if (len == 4) {
  17015. // IPv4
  17016. char buf[INET_ADDRSTRLEN];
  17017. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17018. entry.value = buf;
  17019. } else if (len == 16) {
  17020. // IPv6
  17021. char buf[INET6_ADDRSTRLEN];
  17022. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17023. entry.value = buf;
  17024. }
  17025. }
  17026. break;
  17027. case GEN_EMAIL:
  17028. entry.type = SanType::EMAIL;
  17029. if (gen->d.rfc822Name) {
  17030. entry.value = std::string(
  17031. reinterpret_cast<const char *>(
  17032. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17033. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17034. }
  17035. break;
  17036. case GEN_URI:
  17037. entry.type = SanType::URI;
  17038. if (gen->d.uniformResourceIdentifier) {
  17039. entry.value = std::string(
  17040. reinterpret_cast<const char *>(
  17041. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17042. static_cast<size_t>(
  17043. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17044. }
  17045. break;
  17046. default: entry.type = SanType::OTHER; break;
  17047. }
  17048. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17049. }
  17050. GENERAL_NAMES_free(names);
  17051. return true;
  17052. }
  17053. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17054. time_t &not_after) {
  17055. if (!cert) return false;
  17056. auto x509 = static_cast<X509 *>(cert);
  17057. auto nb = X509_get0_notBefore(x509);
  17058. auto na = X509_get0_notAfter(x509);
  17059. if (!nb || !na) return false;
  17060. ASN1_TIME *epoch = ASN1_TIME_new();
  17061. if (!epoch) return false;
  17062. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17063. if (!ASN1_TIME_set(epoch, 0)) return false;
  17064. int pday, psec;
  17065. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17066. not_before = 86400 * (time_t)pday + psec;
  17067. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17068. not_after = 86400 * (time_t)pday + psec;
  17069. return true;
  17070. }
  17071. inline std::string get_cert_serial(cert_t cert) {
  17072. if (!cert) return "";
  17073. auto x509 = static_cast<X509 *>(cert);
  17074. auto serial = X509_get_serialNumber(x509);
  17075. if (!serial) return "";
  17076. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17077. if (!bn) return "";
  17078. auto hex = BN_bn2hex(bn);
  17079. BN_free(bn);
  17080. if (!hex) return "";
  17081. std::string result(hex);
  17082. OPENSSL_free(hex);
  17083. return result;
  17084. }
  17085. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17086. if (!cert) return false;
  17087. auto x509 = static_cast<X509 *>(cert);
  17088. auto len = i2d_X509(x509, nullptr);
  17089. if (len < 0) return false;
  17090. der.resize(static_cast<size_t>(len));
  17091. auto p = der.data();
  17092. i2d_X509(x509, &p);
  17093. return true;
  17094. }
  17095. inline const char *get_sni(const_session_t session) {
  17096. if (!session) return nullptr;
  17097. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17098. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17099. }
  17100. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17101. inline uint64_t get_error() { return ERR_get_error(); }
  17102. inline std::string error_string(uint64_t code) {
  17103. char buf[256];
  17104. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17105. return std::string(buf);
  17106. }
  17107. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17108. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17109. if (!mem) { return nullptr; }
  17110. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17111. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17112. if (!inf) { return nullptr; }
  17113. auto store = X509_STORE_new();
  17114. if (store) {
  17115. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17116. auto itmp = sk_X509_INFO_value(inf, i);
  17117. if (!itmp) { continue; }
  17118. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17119. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17120. }
  17121. }
  17122. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17123. return static_cast<ca_store_t>(store);
  17124. }
  17125. inline void free_ca_store(ca_store_t store) {
  17126. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17127. }
  17128. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17129. if (!ctx || !store) { return false; }
  17130. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17131. auto x509_store = static_cast<X509_STORE *>(store);
  17132. // Check if same store is already set
  17133. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17134. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17135. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17136. return true;
  17137. }
  17138. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17139. certs.clear();
  17140. if (!ctx) { return 0; }
  17141. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17142. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17143. if (!store) { return 0; }
  17144. auto objs = impl::get_store_objects(store);
  17145. if (!objs) { return 0; }
  17146. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17147. auto count = sk_X509_OBJECT_num(objs);
  17148. for (decltype(count) i = 0; i < count; i++) {
  17149. auto obj = sk_X509_OBJECT_value(objs, i);
  17150. if (!obj) { continue; }
  17151. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17152. auto x509 = X509_OBJECT_get0_X509(obj);
  17153. if (x509) {
  17154. // Increment reference count so caller can free it
  17155. X509_up_ref(x509);
  17156. certs.push_back(static_cast<cert_t>(x509));
  17157. }
  17158. }
  17159. }
  17160. return certs.size();
  17161. }
  17162. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17163. std::vector<std::string> names;
  17164. if (!ctx) { return names; }
  17165. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17166. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17167. if (!store) { return names; }
  17168. auto objs = impl::get_store_objects(store);
  17169. if (!objs) { return names; }
  17170. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17171. auto count = sk_X509_OBJECT_num(objs);
  17172. for (decltype(count) i = 0; i < count; i++) {
  17173. auto obj = sk_X509_OBJECT_value(objs, i);
  17174. if (!obj) { continue; }
  17175. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17176. auto x509 = X509_OBJECT_get0_X509(obj);
  17177. if (x509) {
  17178. auto subject = X509_get_subject_name(x509);
  17179. if (subject) {
  17180. char buf[512];
  17181. X509_NAME_oneline(subject, buf, sizeof(buf));
  17182. names.push_back(buf);
  17183. }
  17184. }
  17185. }
  17186. }
  17187. return names;
  17188. }
  17189. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17190. const char *key_pem, const char *password) {
  17191. if (!ctx || !cert_pem || !key_pem) { return false; }
  17192. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17193. // Load certificate from PEM
  17194. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17195. if (!cert_bio) { return false; }
  17196. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17197. BIO_free(cert_bio);
  17198. if (!cert) { return false; }
  17199. // Load private key from PEM
  17200. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17201. if (!key_bio) {
  17202. X509_free(cert);
  17203. return false;
  17204. }
  17205. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17206. password ? const_cast<char *>(password)
  17207. : nullptr);
  17208. BIO_free(key_bio);
  17209. if (!key) {
  17210. X509_free(cert);
  17211. return false;
  17212. }
  17213. // Update certificate and key
  17214. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17215. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17216. X509_free(cert);
  17217. EVP_PKEY_free(key);
  17218. return ret;
  17219. }
  17220. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17221. if (!ctx || !ca_pem) { return false; }
  17222. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17223. // Create new X509_STORE from PEM
  17224. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17225. if (!store) { return false; }
  17226. // SSL_CTX_set_cert_store takes ownership
  17227. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17228. // Set client CA list for client certificate request
  17229. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17230. if (ca_list) {
  17231. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17232. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17233. }
  17234. return true;
  17235. }
  17236. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17237. if (!ctx) { return false; }
  17238. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17239. auto index = impl::verify_callback_index();
  17240. if (index < 0) { return false; }
  17241. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17242. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17243. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17244. if (stored) {
  17245. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17246. } else {
  17247. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17248. }
  17249. return true;
  17250. }
  17251. inline long get_verify_error(const_session_t session) {
  17252. if (!session) { return -1; }
  17253. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17254. return SSL_get_verify_result(ssl);
  17255. }
  17256. inline std::string verify_error_string(long error_code) {
  17257. if (error_code == X509_V_OK) { return ""; }
  17258. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17259. return str ? str : "unknown error";
  17260. }
  17261. } // namespace tls
  17262. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17263. /*
  17264. * Group 9: TLS abstraction layer - Mbed TLS backend
  17265. */
  17266. /*
  17267. * Mbed TLS Backend Implementation
  17268. */
  17269. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17270. namespace tls {
  17271. namespace impl {
  17272. // Mbed TLS session wrapper
  17273. struct MbedTlsSession {
  17274. mbedtls_ssl_context ssl;
  17275. socket_t sock = INVALID_SOCKET;
  17276. std::string hostname; // For client: set via set_sni
  17277. std::string sni_hostname; // For server: received from client via SNI callback
  17278. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17279. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17280. // (e.g. a response that arrived while this side was still in its post-write
  17281. // check), the byte is pushed back here and served by the next read().
  17282. unsigned char peeked_byte = 0;
  17283. bool has_peeked_byte = false;
  17284. // Set by set_sni() when the caller disabled hostname verification, so the
  17285. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17286. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17287. // OpenSSL and wolfSSL keep them independent).
  17288. bool suppress_hostname_mismatch = false;
  17289. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17290. // ever runs the callback of its own context.
  17291. VerifyCallback verify_callback;
  17292. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17293. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17294. MbedTlsSession(const MbedTlsSession &) = delete;
  17295. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17296. };
  17297. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17298. // queue)
  17299. inline int &mbedtls_last_error() {
  17300. static thread_local int err = 0;
  17301. return err;
  17302. }
  17303. // Helper to map Mbed TLS error to ErrorCode
  17304. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17305. uint32_t verify_flags) {
  17306. if (ret == 0) { return ErrorCode::Success; }
  17307. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17308. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17309. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17310. return ErrorCode::PeerClosed;
  17311. }
  17312. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17313. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17314. out_errno = errno;
  17315. return ErrorCode::SyscallError;
  17316. }
  17317. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17318. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17319. // the handshake's chain verification (see set_sni()); a mismatch there
  17320. // is reported the same way as any other verify_flags bit. Report it as
  17321. // HostnameMismatch, matching the other backends and the post-handshake
  17322. // identity check below, but only when naming is the sole problem -
  17323. // if the chain itself is also untrusted/expired/etc., that takes
  17324. // priority over the naming detail.
  17325. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17326. return ErrorCode::HostnameMismatch;
  17327. }
  17328. return ErrorCode::CertVerifyFailed;
  17329. }
  17330. return ErrorCode::Fatal;
  17331. }
  17332. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17333. // return value, including the verify-flags-dependent HostnameMismatch
  17334. // mapping; shared by connect() and connect_nonblocking() so the
  17335. // backend_code policy for that mapping only lives in one place.
  17336. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17337. int ret) {
  17338. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17339. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17340. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17341. ? static_cast<uint64_t>(verify_flags)
  17342. : static_cast<uint64_t>(-ret);
  17343. }
  17344. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17345. // non-fatal notification delivered between records, not an error and not
  17346. // application data, so I/O calls that see it should just be retried. Kept in
  17347. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17348. // splitting the closing brace across an #if.
  17349. inline bool mbedtls_is_session_ticket(int ret) {
  17350. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17351. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17352. #else
  17353. (void)ret;
  17354. return false;
  17355. #endif
  17356. }
  17357. // BIO-like send callback for Mbed TLS
  17358. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17359. size_t len) {
  17360. auto sock = *static_cast<socket_t *>(ctx);
  17361. #ifdef _WIN32
  17362. auto ret =
  17363. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17364. if (ret == SOCKET_ERROR) {
  17365. int err = WSAGetLastError();
  17366. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17367. return MBEDTLS_ERR_NET_SEND_FAILED;
  17368. }
  17369. #else
  17370. auto ret = send(sock, buf, len, 0);
  17371. if (ret < 0) {
  17372. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17373. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17374. }
  17375. return MBEDTLS_ERR_NET_SEND_FAILED;
  17376. }
  17377. #endif
  17378. return static_cast<int>(ret);
  17379. }
  17380. // BIO-like recv callback for Mbed TLS
  17381. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17382. auto sock = *static_cast<socket_t *>(ctx);
  17383. #ifdef _WIN32
  17384. auto ret =
  17385. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17386. if (ret == SOCKET_ERROR) {
  17387. int err = WSAGetLastError();
  17388. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17389. return MBEDTLS_ERR_NET_RECV_FAILED;
  17390. }
  17391. #else
  17392. auto ret = recv(sock, buf, len, 0);
  17393. if (ret < 0) {
  17394. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17395. return MBEDTLS_ERR_SSL_WANT_READ;
  17396. }
  17397. return MBEDTLS_ERR_NET_RECV_FAILED;
  17398. }
  17399. #endif
  17400. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17401. return static_cast<int>(ret);
  17402. }
  17403. // MbedTlsContext constructor/destructor implementations
  17404. inline MbedTlsContext::MbedTlsContext() {
  17405. mbedtls_ssl_config_init(&conf);
  17406. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17407. mbedtls_entropy_init(&entropy);
  17408. mbedtls_ctr_drbg_init(&ctr_drbg);
  17409. #endif
  17410. mbedtls_x509_crt_init(&ca_chain);
  17411. mbedtls_x509_crt_init(&own_cert);
  17412. mbedtls_pk_init(&own_key);
  17413. }
  17414. inline MbedTlsContext::~MbedTlsContext() {
  17415. mbedtls_pk_free(&own_key);
  17416. mbedtls_x509_crt_free(&own_cert);
  17417. mbedtls_x509_crt_free(&ca_chain);
  17418. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17419. mbedtls_ctr_drbg_free(&ctr_drbg);
  17420. mbedtls_entropy_free(&entropy);
  17421. #endif
  17422. mbedtls_ssl_config_free(&conf);
  17423. }
  17424. // Thread-local storage for SNI captured during handshake
  17425. // This is needed because the SNI callback doesn't have a way to pass
  17426. // session-specific data before the session is fully set up
  17427. inline std::string &mbedpending_sni() {
  17428. static thread_local std::string sni;
  17429. return sni;
  17430. }
  17431. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17432. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17433. const unsigned char *name, size_t name_len) {
  17434. (void)p_ctx;
  17435. (void)ssl;
  17436. // Store SNI name in thread-local storage
  17437. // It will be retrieved and stored in the session after handshake
  17438. if (name && name_len > 0) {
  17439. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17440. } else {
  17441. mbedpending_sni().clear();
  17442. }
  17443. return 0; // Accept any SNI
  17444. }
  17445. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17446. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17447. }
  17448. // Verify callback used when hostname verification is disabled for a session
  17449. // that has no user-supplied verify callback of its own.
  17450. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17451. mbedtls_x509_crt *, int,
  17452. uint32_t *flags) {
  17453. (void)data;
  17454. mbedtls_clear_cn_mismatch(flags);
  17455. return 0;
  17456. }
  17457. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17458. int cert_depth, uint32_t *flags);
  17459. // MbedTLS verify callback wrapper
  17460. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17461. int cert_depth, uint32_t *flags) {
  17462. // data points to the MbedTlsSession
  17463. auto *session = static_cast<MbedTlsSession *>(data);
  17464. // set_sni() disabled hostname verification for this session: drop the
  17465. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17466. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17467. // SNI. The final pass/fail decision still comes from the remaining flags
  17468. // (or, below, from the user's own verify callback).
  17469. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17470. // Build context
  17471. VerifyContext verify_ctx;
  17472. verify_ctx.session = static_cast<session_t>(session);
  17473. verify_ctx.cert = static_cast<cert_t>(crt);
  17474. verify_ctx.depth = cert_depth;
  17475. verify_ctx.preverify_ok = (*flags == 0);
  17476. verify_ctx.error_code = static_cast<long>(*flags);
  17477. // Convert Mbed TLS flags to error string
  17478. static thread_local char error_buf[256];
  17479. if (*flags != 0) {
  17480. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17481. verify_ctx.error_string = error_buf;
  17482. } else {
  17483. verify_ctx.error_string = nullptr;
  17484. }
  17485. bool accepted = session->verify_callback(verify_ctx);
  17486. if (accepted) {
  17487. *flags = 0; // Clear all error flags
  17488. return 0;
  17489. }
  17490. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17491. }
  17492. } // namespace impl
  17493. inline ctx_t create_client_context() {
  17494. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17495. if (!ctx) { return nullptr; }
  17496. ctx->is_server = false;
  17497. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17498. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17499. if (!detail::ensure_mbedtls_psa_crypto()) {
  17500. delete ctx;
  17501. return nullptr;
  17502. }
  17503. int ret;
  17504. #else
  17505. // Seed the random number generator
  17506. const char *pers = "httplib_client";
  17507. int ret = mbedtls_ctr_drbg_seed(
  17508. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17509. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17510. if (ret != 0) {
  17511. impl::mbedtls_last_error() = ret;
  17512. delete ctx;
  17513. return nullptr;
  17514. }
  17515. #endif
  17516. // Set up SSL config for client
  17517. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17518. MBEDTLS_SSL_TRANSPORT_STREAM,
  17519. MBEDTLS_SSL_PRESET_DEFAULT);
  17520. if (ret != 0) {
  17521. impl::mbedtls_last_error() = ret;
  17522. delete ctx;
  17523. return nullptr;
  17524. }
  17525. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17526. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17527. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17528. #endif
  17529. // Default: verify peer certificate
  17530. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17531. // Set minimum TLS version to 1.2
  17532. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17533. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17534. #else
  17535. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17536. MBEDTLS_SSL_MINOR_VERSION_3);
  17537. #endif
  17538. return static_cast<ctx_t>(ctx);
  17539. }
  17540. inline ctx_t create_server_context() {
  17541. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17542. if (!ctx) { return nullptr; }
  17543. ctx->is_server = true;
  17544. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17545. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17546. if (!detail::ensure_mbedtls_psa_crypto()) {
  17547. delete ctx;
  17548. return nullptr;
  17549. }
  17550. int ret;
  17551. #else
  17552. // Seed the random number generator
  17553. const char *pers = "httplib_server";
  17554. int ret = mbedtls_ctr_drbg_seed(
  17555. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17556. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17557. if (ret != 0) {
  17558. impl::mbedtls_last_error() = ret;
  17559. delete ctx;
  17560. return nullptr;
  17561. }
  17562. #endif
  17563. // Set up SSL config for server
  17564. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17565. MBEDTLS_SSL_TRANSPORT_STREAM,
  17566. MBEDTLS_SSL_PRESET_DEFAULT);
  17567. if (ret != 0) {
  17568. impl::mbedtls_last_error() = ret;
  17569. delete ctx;
  17570. return nullptr;
  17571. }
  17572. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17573. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17574. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17575. #endif
  17576. // Default: don't verify client
  17577. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17578. // Set minimum TLS version to 1.2
  17579. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17580. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17581. #else
  17582. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17583. MBEDTLS_SSL_MINOR_VERSION_3);
  17584. #endif
  17585. // Set SNI callback to capture client's SNI hostname
  17586. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17587. return static_cast<ctx_t>(ctx);
  17588. }
  17589. inline void free_context(ctx_t ctx) {
  17590. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17591. }
  17592. inline bool set_min_version(ctx_t ctx, Version version) {
  17593. if (!ctx) { return false; }
  17594. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17595. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17596. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17597. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17598. if (version >= Version::TLS1_3) {
  17599. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17600. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17601. #endif
  17602. }
  17603. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17604. #else
  17605. // Mbed TLS 2.x uses major/minor version numbers
  17606. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17607. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17608. if (version >= Version::TLS1_3) {
  17609. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17610. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17611. #else
  17612. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17613. #endif
  17614. }
  17615. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17616. #endif
  17617. return true;
  17618. }
  17619. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17620. if (!ctx || !pem) { return false; }
  17621. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17622. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17623. // Add null terminator if not present
  17624. std::string pem_str(pem, len);
  17625. int ret = mbedtls_x509_crt_parse(
  17626. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17627. pem_str.size() + 1);
  17628. if (ret != 0) {
  17629. impl::mbedtls_last_error() = ret;
  17630. return false;
  17631. }
  17632. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17633. return true;
  17634. }
  17635. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17636. if (!ctx || !file_path) { return false; }
  17637. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17638. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17639. if (ret != 0) {
  17640. impl::mbedtls_last_error() = ret;
  17641. return false;
  17642. }
  17643. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17644. return true;
  17645. }
  17646. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17647. if (!ctx || !dir_path) { return false; }
  17648. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17649. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17650. if (ret < 0) { // Returns number of certs on success, negative on error
  17651. impl::mbedtls_last_error() = ret;
  17652. return false;
  17653. }
  17654. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17655. return true;
  17656. }
  17657. inline bool load_system_certs(ctx_t ctx) {
  17658. if (!ctx) { return false; }
  17659. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17660. bool loaded = false;
  17661. #ifdef _WIN32
  17662. loaded = impl::enumerate_windows_system_certs(
  17663. [&](const unsigned char *data, size_t len) {
  17664. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17665. });
  17666. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17667. loaded = impl::enumerate_macos_keychain_certs(
  17668. [&](const unsigned char *data, size_t len) {
  17669. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17670. });
  17671. #else
  17672. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17673. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17674. loaded = true;
  17675. break;
  17676. }
  17677. }
  17678. if (!loaded) {
  17679. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17680. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17681. loaded = true;
  17682. break;
  17683. }
  17684. }
  17685. }
  17686. #endif
  17687. if (loaded) {
  17688. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17689. }
  17690. return loaded;
  17691. }
  17692. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17693. const char *password) {
  17694. if (!ctx || !cert || !key) { return false; }
  17695. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17696. // Parse certificate
  17697. std::string cert_str(cert);
  17698. int ret = mbedtls_x509_crt_parse(
  17699. &mctx->own_cert,
  17700. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17701. cert_str.size() + 1);
  17702. if (ret != 0) {
  17703. impl::mbedtls_last_error() = ret;
  17704. return false;
  17705. }
  17706. // Parse private key
  17707. std::string key_str(key);
  17708. const unsigned char *pwd =
  17709. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17710. size_t pwd_len = password ? strlen(password) : 0;
  17711. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17712. ret = mbedtls_pk_parse_key(
  17713. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17714. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17715. &mctx->ctr_drbg);
  17716. #else
  17717. ret = mbedtls_pk_parse_key(
  17718. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17719. key_str.size() + 1, pwd, pwd_len);
  17720. #endif
  17721. if (ret != 0) {
  17722. impl::mbedtls_last_error() = ret;
  17723. return false;
  17724. }
  17725. // Verify that the certificate and private key match.
  17726. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17727. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17728. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17729. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17730. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17731. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17732. #else
  17733. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17734. #endif
  17735. if (ret != 0) {
  17736. impl::mbedtls_last_error() = ret;
  17737. return false;
  17738. }
  17739. #endif
  17740. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17741. if (ret != 0) {
  17742. impl::mbedtls_last_error() = ret;
  17743. return false;
  17744. }
  17745. return true;
  17746. }
  17747. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17748. const char *key_path, const char *password) {
  17749. if (!ctx || !cert_path || !key_path) { return false; }
  17750. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17751. // Parse certificate file
  17752. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17753. if (ret != 0) {
  17754. impl::mbedtls_last_error() = ret;
  17755. return false;
  17756. }
  17757. // Parse private key file
  17758. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17759. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17760. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17761. #else
  17762. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17763. #endif
  17764. if (ret != 0) {
  17765. impl::mbedtls_last_error() = ret;
  17766. return false;
  17767. }
  17768. // Verify that the certificate and private key match.
  17769. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17770. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17771. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17772. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17773. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17774. #else
  17775. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17776. #endif
  17777. if (ret != 0) {
  17778. impl::mbedtls_last_error() = ret;
  17779. return false;
  17780. }
  17781. #endif
  17782. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17783. if (ret != 0) {
  17784. impl::mbedtls_last_error() = ret;
  17785. return false;
  17786. }
  17787. return true;
  17788. }
  17789. inline void set_verify_client(ctx_t ctx, bool require) {
  17790. if (!ctx) { return; }
  17791. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17792. mctx->verify_client = require;
  17793. if (require) {
  17794. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17795. } else {
  17796. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17797. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17798. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  17799. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17800. : MBEDTLS_SSL_VERIFY_NONE);
  17801. }
  17802. }
  17803. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17804. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17805. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17806. auto session = new (std::nothrow) impl::MbedTlsSession();
  17807. if (!session) { return nullptr; }
  17808. session->sock = sock;
  17809. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17810. if (ret != 0) {
  17811. impl::mbedtls_last_error() = ret;
  17812. delete session;
  17813. return nullptr;
  17814. }
  17815. // Explicitly opt out of in-handshake hostname verification by default;
  17816. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17817. // fails outright when no hostname was set. set_sni() installs the real
  17818. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17819. // caller verifies the certificate identity post-handshake via
  17820. // verify_hostname().
  17821. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17822. // Set BIO callbacks
  17823. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17824. impl::mbedtls_net_recv_cb, nullptr);
  17825. // Set per-session verify callback with session pointer if callback is
  17826. // registered
  17827. session->verify_callback = mctx->verify_callback;
  17828. if (session->verify_callback) {
  17829. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17830. session);
  17831. }
  17832. return static_cast<session_t>(session);
  17833. }
  17834. inline void free_session(session_t session) {
  17835. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17836. }
  17837. inline bool set_sni(session_t session, const char *hostname,
  17838. bool verify_hostname) {
  17839. if (!session || !hostname) { return false; }
  17840. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17841. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17842. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17843. // independently, so a disabled hostname check is handled below by masking
  17844. // the resulting mismatch flag instead of skipping this call.
  17845. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17846. if (ret != 0) {
  17847. impl::mbedtls_last_error() = ret;
  17848. return false;
  17849. }
  17850. msession->hostname = hostname;
  17851. if (!verify_hostname) {
  17852. msession->suppress_hostname_mismatch = true;
  17853. // If a user verify callback is already wired for this session,
  17854. // mbedtls_verify_callback() masks the mismatch flag itself before
  17855. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17856. // here would be redundant. Otherwise install the masking callback alone.
  17857. if (!msession->verify_callback) {
  17858. mbedtls_ssl_set_verify(&msession->ssl,
  17859. impl::mbedtls_mask_hostname_mismatch_callback,
  17860. msession);
  17861. }
  17862. }
  17863. return true;
  17864. }
  17865. inline TlsError connect(session_t session) {
  17866. TlsError err;
  17867. if (!session) {
  17868. err.code = ErrorCode::Fatal;
  17869. return err;
  17870. }
  17871. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17872. int ret;
  17873. do {
  17874. ret = mbedtls_ssl_handshake(&msession->ssl);
  17875. } while (impl::mbedtls_is_session_ticket(ret));
  17876. if (ret == 0) {
  17877. err.code = ErrorCode::Success;
  17878. } else {
  17879. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17880. impl::mbedtls_last_error() = ret;
  17881. }
  17882. return err;
  17883. }
  17884. inline TlsError accept(session_t session) {
  17885. // Same as connect for Mbed TLS - handshake works for both client and server
  17886. auto result = connect(session);
  17887. // After successful handshake, capture SNI from thread-local storage
  17888. if (result.code == ErrorCode::Success && session) {
  17889. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17890. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17891. impl::mbedpending_sni().clear();
  17892. }
  17893. return result;
  17894. }
  17895. inline bool connect_nonblocking(session_t session, socket_t sock,
  17896. time_t timeout_sec, time_t timeout_usec,
  17897. TlsError *err) {
  17898. if (!session) {
  17899. if (err) { err->code = ErrorCode::Fatal; }
  17900. return false;
  17901. }
  17902. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17903. // Set socket to non-blocking mode
  17904. detail::set_nonblocking(sock, true);
  17905. auto cleanup =
  17906. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17907. int ret;
  17908. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17909. // Non-fatal TLS 1.3 ticket; retry immediately.
  17910. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17911. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17912. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17913. continue;
  17914. }
  17915. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17916. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17917. continue;
  17918. }
  17919. }
  17920. // TlsError or timeout
  17921. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17922. impl::mbedtls_last_error() = ret;
  17923. return false;
  17924. }
  17925. if (err) { err->code = ErrorCode::Success; }
  17926. return true;
  17927. }
  17928. inline bool accept_nonblocking(session_t session, socket_t sock,
  17929. time_t timeout_sec, time_t timeout_usec,
  17930. TlsError *err) {
  17931. // Same implementation as connect for Mbed TLS
  17932. bool result =
  17933. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17934. // After successful handshake, capture SNI from thread-local storage
  17935. if (result && session) {
  17936. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17937. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17938. impl::mbedpending_sni().clear();
  17939. }
  17940. return result;
  17941. }
  17942. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17943. if (!session || !buf) {
  17944. err.code = ErrorCode::Fatal;
  17945. return -1;
  17946. }
  17947. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17948. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17949. if (msession->has_peeked_byte) {
  17950. if (len == 0) { return 0; }
  17951. auto p = static_cast<unsigned char *>(buf);
  17952. p[0] = msession->peeked_byte;
  17953. msession->has_peeked_byte = false;
  17954. size_t n = 1;
  17955. // Top up with any already-decrypted bytes without risking a block.
  17956. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17957. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17958. if (extra > 0) { n += static_cast<size_t>(extra); }
  17959. }
  17960. err.code = ErrorCode::Success;
  17961. return static_cast<ssize_t>(n);
  17962. }
  17963. int ret;
  17964. do {
  17965. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17966. len);
  17967. } while (impl::mbedtls_is_session_ticket(ret));
  17968. if (ret > 0) {
  17969. err.code = ErrorCode::Success;
  17970. return static_cast<ssize_t>(ret);
  17971. }
  17972. if (ret == 0) {
  17973. err.code = ErrorCode::PeerClosed;
  17974. return 0;
  17975. }
  17976. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17977. err.backend_code = static_cast<uint64_t>(-ret);
  17978. impl::mbedtls_last_error() = ret;
  17979. // mbedTLS signals a clean close_notify via a negative error code rather
  17980. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17981. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17982. return -1;
  17983. }
  17984. inline ssize_t write(session_t session, const void *buf, size_t len,
  17985. TlsError &err) {
  17986. if (!session || !buf) {
  17987. err.code = ErrorCode::Fatal;
  17988. return -1;
  17989. }
  17990. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17991. int ret;
  17992. do {
  17993. ret = mbedtls_ssl_write(&msession->ssl,
  17994. static_cast<const unsigned char *>(buf), len);
  17995. } while (impl::mbedtls_is_session_ticket(ret));
  17996. if (ret > 0) {
  17997. err.code = ErrorCode::Success;
  17998. return static_cast<ssize_t>(ret);
  17999. }
  18000. if (ret == 0) {
  18001. err.code = ErrorCode::PeerClosed;
  18002. return 0;
  18003. }
  18004. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18005. err.backend_code = static_cast<uint64_t>(-ret);
  18006. impl::mbedtls_last_error() = ret;
  18007. return -1;
  18008. }
  18009. inline int pending(const_session_t session) {
  18010. if (!session) { return 0; }
  18011. auto msession =
  18012. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18013. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18014. (msession->has_peeked_byte ? 1 : 0);
  18015. }
  18016. inline void shutdown(session_t session, bool graceful) {
  18017. if (!session) { return; }
  18018. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18019. if (graceful) {
  18020. // Try to send close_notify, but don't block forever
  18021. int ret;
  18022. int attempts = 0;
  18023. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18024. attempts < 3) {
  18025. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18026. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18027. break;
  18028. }
  18029. attempts++;
  18030. }
  18031. }
  18032. }
  18033. inline bool is_peer_closed(session_t session, socket_t sock) {
  18034. if (!session || sock == INVALID_SOCKET) { return true; }
  18035. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18036. // Check if there's already decrypted or pushed-back data available.
  18037. // If so, the connection is definitely alive.
  18038. if (msession->has_peeked_byte ||
  18039. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18040. return false;
  18041. }
  18042. // Set socket to non-blocking to avoid blocking on read
  18043. detail::set_nonblocking(sock, true);
  18044. auto cleanup =
  18045. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18046. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18047. // on application data — e.g. a response that already arrived — push the
  18048. // byte back so the next read() delivers it instead of losing it.
  18049. unsigned char buf;
  18050. int ret;
  18051. do {
  18052. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18053. } while (impl::mbedtls_is_session_ticket(ret));
  18054. // If we got data or WANT_READ (would block), connection is alive
  18055. if (ret > 0) {
  18056. msession->peeked_byte = buf;
  18057. msession->has_peeked_byte = true;
  18058. return false;
  18059. }
  18060. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18061. // If we get a peer close notify or a connection reset, the peer is closed
  18062. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18063. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18064. }
  18065. inline cert_t get_peer_cert(const_session_t session) {
  18066. if (!session) { return nullptr; }
  18067. auto msession =
  18068. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18069. // Mbed TLS returns a pointer to the internal peer cert chain.
  18070. // WARNING: This pointer is only valid while the session is active.
  18071. // Do not use the certificate after calling free_session().
  18072. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18073. return const_cast<mbedtls_x509_crt *>(cert);
  18074. }
  18075. inline size_t get_peer_certs(const_session_t session,
  18076. std::vector<cert_t> &certs) {
  18077. certs.clear();
  18078. // Mbed TLS parses the whole received chain into a list headed by the peer
  18079. // certificate, owned by the session like get_peer_cert()'s result
  18080. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18081. crt && crt->raw.len > 0; crt = crt->next) {
  18082. certs.push_back(static_cast<cert_t>(crt));
  18083. }
  18084. return certs.size();
  18085. }
  18086. inline void free_cert(cert_t cert) {
  18087. // Mbed TLS: peer certificate is owned by the SSL context.
  18088. // No-op here, but callers should still call this for cross-backend
  18089. // portability.
  18090. (void)cert;
  18091. }
  18092. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18093. if (!cert || !hostname) { return false; }
  18094. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18095. std::string host_str(hostname);
  18096. // Check if hostname is an IP address (IPv4 or IPv6)
  18097. unsigned char ip_bytes[16];
  18098. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18099. auto is_ip = ip_len > 0;
  18100. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18101. // in buf.tag and the raw value in buf.p / buf.len.
  18102. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18103. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18104. const unsigned char *p = san->buf.p;
  18105. size_t len = san->buf.len;
  18106. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18107. if (is_ip) {
  18108. // For an IP host, only a matching iPAddress SAN of the same family
  18109. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18110. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18111. memcmp(p, ip_bytes, ip_len) == 0) {
  18112. return true;
  18113. }
  18114. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18115. std::string san_name(reinterpret_cast<const char *>(p), len);
  18116. if (detail::match_hostname(san_name, host_str)) { return true; }
  18117. }
  18118. san = san->next;
  18119. }
  18120. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18121. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18122. // the OpenSSL backend's X509_check_ip behaves the same way).
  18123. if (!is_ip) {
  18124. char cn[256];
  18125. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18126. if (ret > 0) {
  18127. std::string cn_str(cn);
  18128. // Look for "CN=" in the DN string
  18129. size_t cn_pos = cn_str.find("CN=");
  18130. if (cn_pos != std::string::npos) {
  18131. size_t start = cn_pos + 3;
  18132. size_t end = cn_str.find(',', start);
  18133. std::string cn_value =
  18134. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18135. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18136. }
  18137. }
  18138. }
  18139. return false;
  18140. }
  18141. inline uint64_t hostname_mismatch_code() {
  18142. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18143. }
  18144. inline long get_verify_result(const_session_t session) {
  18145. if (!session) { return -1; }
  18146. auto msession =
  18147. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18148. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18149. // Return 0 (X509_V_OK equivalent) if verification passed
  18150. return flags == 0 ? 0 : static_cast<long>(flags);
  18151. }
  18152. inline std::string get_cert_subject_cn(cert_t cert) {
  18153. if (!cert) return "";
  18154. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18155. // Find the CN in the subject
  18156. const mbedtls_x509_name *name = &x509->subject;
  18157. while (name != nullptr) {
  18158. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18159. return std::string(reinterpret_cast<const char *>(name->val.p),
  18160. name->val.len);
  18161. }
  18162. name = name->next;
  18163. }
  18164. return "";
  18165. }
  18166. inline std::string get_cert_issuer_name(cert_t cert) {
  18167. if (!cert) return "";
  18168. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18169. // Build a human-readable issuer name string
  18170. char buf[512];
  18171. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18172. if (ret < 0) return "";
  18173. return std::string(buf);
  18174. }
  18175. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18176. sans.clear();
  18177. if (!cert) return false;
  18178. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18179. // Parse the Subject Alternative Name extension
  18180. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18181. while (cur != nullptr) {
  18182. if (cur->buf.len > 0) {
  18183. const unsigned char *p = cur->buf.p;
  18184. size_t value_len = cur->buf.len;
  18185. SanEntry entry;
  18186. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18187. case MBEDTLS_X509_SAN_DNS_NAME:
  18188. entry.type = SanType::DNS;
  18189. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18190. break;
  18191. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18192. entry.type = SanType::IP;
  18193. if (value_len == 4) {
  18194. // IPv4
  18195. char buf[16];
  18196. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18197. entry.value = buf;
  18198. } else if (value_len == 16) {
  18199. // IPv6
  18200. char buf[64];
  18201. snprintf(buf, sizeof(buf),
  18202. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18203. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18204. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18205. p[10], p[11], p[12], p[13], p[14], p[15]);
  18206. entry.value = buf;
  18207. }
  18208. break;
  18209. case MBEDTLS_X509_SAN_RFC822_NAME:
  18210. entry.type = SanType::EMAIL;
  18211. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18212. break;
  18213. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18214. entry.type = SanType::URI;
  18215. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18216. break;
  18217. default: entry.type = SanType::OTHER; break;
  18218. }
  18219. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18220. }
  18221. cur = cur->next;
  18222. }
  18223. return true;
  18224. }
  18225. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18226. time_t &not_after) {
  18227. if (!cert) return false;
  18228. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18229. // Convert mbedtls_x509_time to time_t
  18230. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18231. struct tm tm_time = {};
  18232. tm_time.tm_year = t.year - 1900;
  18233. tm_time.tm_mon = t.mon - 1;
  18234. tm_time.tm_mday = t.day;
  18235. tm_time.tm_hour = t.hour;
  18236. tm_time.tm_min = t.min;
  18237. tm_time.tm_sec = t.sec;
  18238. #ifdef _WIN32
  18239. return _mkgmtime(&tm_time);
  18240. #else
  18241. return timegm(&tm_time);
  18242. #endif
  18243. };
  18244. not_before = to_time_t(x509->valid_from);
  18245. not_after = to_time_t(x509->valid_to);
  18246. return true;
  18247. }
  18248. inline std::string get_cert_serial(cert_t cert) {
  18249. if (!cert) return "";
  18250. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18251. // Convert serial number to hex string
  18252. std::string result;
  18253. result.reserve(x509->serial.len * 2);
  18254. for (size_t i = 0; i < x509->serial.len; i++) {
  18255. char hex[3];
  18256. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18257. result += hex;
  18258. }
  18259. return result;
  18260. }
  18261. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18262. if (!cert) return false;
  18263. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18264. if (!crt->raw.p || crt->raw.len == 0) return false;
  18265. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18266. return true;
  18267. }
  18268. inline const char *get_sni(const_session_t session) {
  18269. if (!session) return nullptr;
  18270. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18271. // For server: return SNI received from client during handshake
  18272. if (!msession->sni_hostname.empty()) {
  18273. return msession->sni_hostname.c_str();
  18274. }
  18275. // For client: return the hostname set via set_sni
  18276. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18277. return nullptr;
  18278. }
  18279. inline uint64_t peek_error() {
  18280. // Mbed TLS doesn't have an error queue, return the last error
  18281. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18282. }
  18283. inline uint64_t get_error() {
  18284. // Mbed TLS doesn't have an error queue, return and clear the last error
  18285. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18286. impl::mbedtls_last_error() = 0;
  18287. return err;
  18288. }
  18289. inline std::string error_string(uint64_t code) {
  18290. char buf[256];
  18291. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18292. return std::string(buf);
  18293. }
  18294. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18295. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18296. if (!ca_chain) { return nullptr; }
  18297. mbedtls_x509_crt_init(ca_chain);
  18298. // mbedtls_x509_crt_parse expects null-terminated PEM
  18299. int ret = mbedtls_x509_crt_parse(ca_chain,
  18300. reinterpret_cast<const unsigned char *>(pem),
  18301. len + 1); // +1 for null terminator
  18302. if (ret != 0) {
  18303. // Try without +1 in case PEM is already null-terminated
  18304. ret = mbedtls_x509_crt_parse(
  18305. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18306. if (ret != 0) {
  18307. mbedtls_x509_crt_free(ca_chain);
  18308. delete ca_chain;
  18309. return nullptr;
  18310. }
  18311. }
  18312. return static_cast<ca_store_t>(ca_chain);
  18313. }
  18314. inline void free_ca_store(ca_store_t store) {
  18315. if (store) {
  18316. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18317. mbedtls_x509_crt_free(ca_chain);
  18318. delete ca_chain;
  18319. }
  18320. }
  18321. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18322. if (!ctx || !store) { return false; }
  18323. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18324. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18325. // Free existing CA chain
  18326. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18327. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18328. // Copy the CA chain (deep copy)
  18329. // Parse from the raw data of the source cert
  18330. mbedtls_x509_crt *src = ca_chain;
  18331. while (src != nullptr) {
  18332. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18333. src->raw.len);
  18334. if (ret != 0) {
  18335. free_ca_store(store);
  18336. return false;
  18337. }
  18338. src = src->next;
  18339. }
  18340. // This function takes ownership of the store; the chain was deep-copied
  18341. // above, so release the source
  18342. free_ca_store(store);
  18343. // Update the SSL config to use the new CA chain
  18344. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18345. return true;
  18346. }
  18347. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18348. certs.clear();
  18349. if (!ctx) { return 0; }
  18350. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18351. // Iterate through the CA chain
  18352. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18353. while (cert != nullptr && cert->raw.len > 0) {
  18354. // Create a copy of the certificate for the caller
  18355. auto *copy = new mbedtls_x509_crt;
  18356. mbedtls_x509_crt_init(copy);
  18357. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18358. if (ret == 0) {
  18359. certs.push_back(static_cast<cert_t>(copy));
  18360. } else {
  18361. mbedtls_x509_crt_free(copy);
  18362. delete copy;
  18363. }
  18364. cert = cert->next;
  18365. }
  18366. return certs.size();
  18367. }
  18368. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18369. std::vector<std::string> names;
  18370. if (!ctx) { return names; }
  18371. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18372. // Iterate through the CA chain
  18373. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18374. while (cert != nullptr && cert->raw.len > 0) {
  18375. char buf[512];
  18376. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18377. if (ret > 0) { names.push_back(buf); }
  18378. cert = cert->next;
  18379. }
  18380. return names;
  18381. }
  18382. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18383. const char *key_pem, const char *password) {
  18384. if (!ctx || !cert_pem || !key_pem) { return false; }
  18385. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18386. // Free existing certificate and key
  18387. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18388. mbedtls_pk_free(&mbed_ctx->own_key);
  18389. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18390. mbedtls_pk_init(&mbed_ctx->own_key);
  18391. // Parse certificate PEM
  18392. int ret = mbedtls_x509_crt_parse(
  18393. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18394. strlen(cert_pem) + 1);
  18395. if (ret != 0) {
  18396. impl::mbedtls_last_error() = ret;
  18397. return false;
  18398. }
  18399. // Parse private key PEM
  18400. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18401. ret = mbedtls_pk_parse_key(
  18402. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18403. strlen(key_pem) + 1,
  18404. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18405. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18406. &mbed_ctx->ctr_drbg);
  18407. #else
  18408. ret = mbedtls_pk_parse_key(
  18409. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18410. strlen(key_pem) + 1,
  18411. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18412. password ? strlen(password) : 0);
  18413. #endif
  18414. if (ret != 0) {
  18415. impl::mbedtls_last_error() = ret;
  18416. return false;
  18417. }
  18418. // Configure SSL to use the new certificate and key
  18419. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18420. &mbed_ctx->own_key);
  18421. if (ret != 0) {
  18422. impl::mbedtls_last_error() = ret;
  18423. return false;
  18424. }
  18425. return true;
  18426. }
  18427. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18428. if (!ctx || !ca_pem) { return false; }
  18429. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18430. // Free existing CA chain
  18431. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18432. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18433. // Parse CA PEM
  18434. int ret = mbedtls_x509_crt_parse(
  18435. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18436. strlen(ca_pem) + 1);
  18437. if (ret != 0) {
  18438. impl::mbedtls_last_error() = ret;
  18439. return false;
  18440. }
  18441. // Update SSL config to use new CA chain
  18442. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18443. return true;
  18444. }
  18445. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18446. if (!ctx) { return false; }
  18447. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18448. // create_session() hands each session its own copy to run.
  18449. mbed_ctx->verify_callback = std::move(callback);
  18450. if (mbed_ctx->verify_callback) {
  18451. // Set OPTIONAL mode to ensure callback is called even when verification
  18452. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18453. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18454. }
  18455. return true;
  18456. }
  18457. inline long get_verify_error(const_session_t session) {
  18458. if (!session) { return -1; }
  18459. auto *msession =
  18460. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18461. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18462. }
  18463. inline std::string verify_error_string(long error_code) {
  18464. if (error_code == 0) { return ""; }
  18465. char buf[256];
  18466. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18467. static_cast<uint32_t>(error_code));
  18468. // Remove trailing newline if present
  18469. std::string result(buf);
  18470. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18471. result.pop_back();
  18472. }
  18473. return result;
  18474. }
  18475. } // namespace tls
  18476. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18477. /*
  18478. * Group 10: TLS abstraction layer - wolfSSL backend
  18479. */
  18480. /*
  18481. * wolfSSL Backend Implementation
  18482. */
  18483. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18484. namespace tls {
  18485. namespace impl {
  18486. // wolfSSL session wrapper
  18487. struct WolfSSLSession {
  18488. WOLFSSL *ssl = nullptr;
  18489. socket_t sock = INVALID_SOCKET;
  18490. std::string hostname; // For client: set via set_sni
  18491. std::string sni_hostname; // For server: received from client via SNI callback
  18492. WolfSSLSession() = default;
  18493. ~WolfSSLSession() {
  18494. if (ssl) { wolfSSL_free(ssl); }
  18495. }
  18496. WolfSSLSession(const WolfSSLSession &) = delete;
  18497. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18498. };
  18499. // Thread-local error code accessor for wolfSSL
  18500. inline uint64_t &wolfssl_last_error() {
  18501. static thread_local uint64_t err = 0;
  18502. return err;
  18503. }
  18504. // Helper to map wolfSSL error to ErrorCode.
  18505. // ssl_error is the value from wolfSSL_get_error().
  18506. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18507. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18508. int &out_errno) {
  18509. switch (ssl_error) {
  18510. case SSL_ERROR_NONE: return ErrorCode::Success;
  18511. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18512. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18513. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18514. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18515. default:
  18516. if (ssl) {
  18517. // wolfSSL stores the low-level error code as a negative value.
  18518. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18519. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18520. if (low_err == DOMAIN_NAME_MISMATCH) {
  18521. return ErrorCode::HostnameMismatch;
  18522. }
  18523. // Check verify result to distinguish cert verification from generic SSL
  18524. // errors.
  18525. long vr = wolfSSL_get_verify_result(ssl);
  18526. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18527. }
  18528. return ErrorCode::Fatal;
  18529. }
  18530. }
  18531. // WolfSSLContext constructor/destructor implementations
  18532. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18533. inline WolfSSLContext::~WolfSSLContext() {
  18534. if (ctx) { wolfSSL_CTX_free(ctx); }
  18535. }
  18536. // Thread-local storage for SNI captured during handshake
  18537. inline std::string &wolfssl_pending_sni() {
  18538. static thread_local std::string sni;
  18539. return sni;
  18540. }
  18541. // SNI callback for wolfSSL server to capture client's SNI hostname
  18542. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18543. (void)ret;
  18544. (void)exArg;
  18545. void *name_data = nullptr;
  18546. unsigned short name_len =
  18547. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18548. if (name_data && name_len > 0) {
  18549. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18550. name_len);
  18551. } else {
  18552. wolfssl_pending_sni().clear();
  18553. }
  18554. return 0; // Continue regardless
  18555. }
  18556. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18557. // runs the verify callback of its own context.
  18558. inline int context_ex_data_index() {
  18559. static const auto index =
  18560. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18561. return index;
  18562. }
  18563. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18564. // other tls:: function takes.
  18565. inline int session_ex_data_index() {
  18566. static const auto index =
  18567. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18568. return index;
  18569. }
  18570. // wolfSSL verify callback wrapper
  18571. inline int wolfssl_verify_callback(int preverify_ok,
  18572. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18573. // Get the WOLFSSL object from the X509_STORE_CTX
  18574. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18575. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18576. if (!ssl) { return preverify_ok; }
  18577. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18578. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18579. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18580. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18581. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18582. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18583. VerifyContext verify_ctx;
  18584. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18585. verify_ctx.cert = static_cast<cert_t>(cert);
  18586. verify_ctx.depth = depth;
  18587. verify_ctx.preverify_ok = (preverify_ok != 0);
  18588. verify_ctx.error_code = static_cast<long>(err);
  18589. if (err != 0) {
  18590. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18591. } else {
  18592. verify_ctx.error_string = nullptr;
  18593. }
  18594. bool accepted = wctx->verify_callback(verify_ctx);
  18595. return accepted ? 1 : 0;
  18596. }
  18597. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18598. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18599. wolfSSL_CTX_set_default_passwd_cb(
  18600. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18601. auto *pwd = static_cast<const char *>(userdata);
  18602. if (!pwd) return 0;
  18603. auto len = static_cast<int>(strlen(pwd));
  18604. if (len > size) len = size;
  18605. memcpy(buf, pwd, static_cast<size_t>(len));
  18606. return len;
  18607. });
  18608. }
  18609. } // namespace impl
  18610. inline ctx_t create_client_context() {
  18611. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18612. if (!ctx) { return nullptr; }
  18613. ctx->is_server = false;
  18614. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18615. if (!method) {
  18616. delete ctx;
  18617. return nullptr;
  18618. }
  18619. ctx->ctx = wolfSSL_CTX_new(method);
  18620. if (!ctx->ctx ||
  18621. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18622. WOLFSSL_SUCCESS) {
  18623. delete ctx;
  18624. return nullptr;
  18625. }
  18626. // Default: verify peer certificate
  18627. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18628. return static_cast<ctx_t>(ctx);
  18629. }
  18630. inline ctx_t create_server_context() {
  18631. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18632. if (!ctx) { return nullptr; }
  18633. ctx->is_server = true;
  18634. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18635. if (!method) {
  18636. delete ctx;
  18637. return nullptr;
  18638. }
  18639. ctx->ctx = wolfSSL_CTX_new(method);
  18640. if (!ctx->ctx ||
  18641. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18642. WOLFSSL_SUCCESS) {
  18643. delete ctx;
  18644. return nullptr;
  18645. }
  18646. // Default: don't verify client
  18647. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18648. // Enable SNI on server
  18649. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18650. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18651. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18652. return static_cast<ctx_t>(ctx);
  18653. }
  18654. inline void free_context(ctx_t ctx) {
  18655. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18656. }
  18657. inline bool set_min_version(ctx_t ctx, Version version) {
  18658. if (!ctx) { return false; }
  18659. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18660. int min_ver = WOLFSSL_TLSV1_2;
  18661. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18662. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18663. }
  18664. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18665. if (!ctx || !pem) { return false; }
  18666. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18667. int ret = wolfSSL_CTX_load_verify_buffer(
  18668. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18669. static_cast<long>(len), SSL_FILETYPE_PEM);
  18670. if (ret != SSL_SUCCESS) {
  18671. impl::wolfssl_last_error() =
  18672. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18673. return false;
  18674. }
  18675. wctx->ca_pem_data_.append(pem, len);
  18676. return true;
  18677. }
  18678. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18679. if (!ctx || !file_path) { return false; }
  18680. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18681. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18682. if (ret != SSL_SUCCESS) {
  18683. impl::wolfssl_last_error() =
  18684. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18685. return false;
  18686. }
  18687. return true;
  18688. }
  18689. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18690. if (!ctx || !dir_path) { return false; }
  18691. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18692. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18693. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18694. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18695. // immediately. Return true even on failure since the CA file may have
  18696. // already been loaded, matching OpenSSL's lenient behavior.
  18697. (void)ret;
  18698. return true;
  18699. }
  18700. inline bool load_system_certs(ctx_t ctx) {
  18701. if (!ctx) { return false; }
  18702. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18703. bool loaded = false;
  18704. #ifdef _WIN32
  18705. loaded = impl::enumerate_windows_system_certs(
  18706. [&](const unsigned char *data, size_t len) {
  18707. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18708. static_cast<long>(len),
  18709. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18710. });
  18711. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18712. loaded = impl::enumerate_macos_keychain_certs(
  18713. [&](const unsigned char *data, size_t len) {
  18714. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18715. static_cast<long>(len),
  18716. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18717. });
  18718. #else
  18719. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18720. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18721. SSL_SUCCESS) {
  18722. loaded = true;
  18723. break;
  18724. }
  18725. }
  18726. if (!loaded) {
  18727. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18728. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18729. SSL_SUCCESS) {
  18730. loaded = true;
  18731. break;
  18732. }
  18733. }
  18734. }
  18735. #endif
  18736. return loaded;
  18737. }
  18738. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18739. const char *password) {
  18740. if (!ctx || !cert || !key) { return false; }
  18741. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18742. // Load certificate
  18743. int ret = wolfSSL_CTX_use_certificate_buffer(
  18744. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18745. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18746. if (ret != SSL_SUCCESS) {
  18747. impl::wolfssl_last_error() =
  18748. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18749. return false;
  18750. }
  18751. // Set password callback if password is provided
  18752. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18753. // Load private key
  18754. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18755. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18756. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18757. if (ret != SSL_SUCCESS) {
  18758. impl::wolfssl_last_error() =
  18759. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18760. return false;
  18761. }
  18762. // Verify that the certificate and private key match
  18763. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18764. }
  18765. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18766. const char *key_path, const char *password) {
  18767. if (!ctx || !cert_path || !key_path) { return false; }
  18768. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18769. // Load certificate file
  18770. int ret =
  18771. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18772. if (ret != SSL_SUCCESS) {
  18773. impl::wolfssl_last_error() =
  18774. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18775. return false;
  18776. }
  18777. // Set password callback if password is provided
  18778. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18779. // Load private key file
  18780. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18781. if (ret != SSL_SUCCESS) {
  18782. impl::wolfssl_last_error() =
  18783. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18784. return false;
  18785. }
  18786. // Verify that the certificate and private key match
  18787. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18788. }
  18789. inline void set_verify_client(ctx_t ctx, bool require) {
  18790. if (!ctx) { return; }
  18791. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18792. wctx->verify_client = require;
  18793. if (require) {
  18794. wolfSSL_CTX_set_verify(
  18795. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18796. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18797. } else {
  18798. if (wctx->verify_callback) {
  18799. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18800. impl::wolfssl_verify_callback);
  18801. } else {
  18802. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18803. }
  18804. }
  18805. }
  18806. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18807. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18808. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18809. auto session = new (std::nothrow) impl::WolfSSLSession();
  18810. if (!session) { return nullptr; }
  18811. session->sock = sock;
  18812. session->ssl = wolfSSL_new(wctx->ctx);
  18813. if (!session->ssl) {
  18814. impl::wolfssl_last_error() =
  18815. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18816. delete session;
  18817. return nullptr;
  18818. }
  18819. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  18820. session) != WOLFSSL_SUCCESS) {
  18821. delete session;
  18822. return nullptr;
  18823. }
  18824. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18825. return static_cast<session_t>(session);
  18826. }
  18827. inline void free_session(session_t session) {
  18828. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18829. }
  18830. inline bool set_sni(session_t session, const char *hostname,
  18831. bool verify_hostname) {
  18832. if (!session || !hostname) { return false; }
  18833. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18834. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18835. static_cast<word16>(strlen(hostname)));
  18836. if (ret != WOLFSSL_SUCCESS) {
  18837. impl::wolfssl_last_error() =
  18838. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18839. return false;
  18840. }
  18841. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18842. // separately from the SNI extension sent above; skip it when hostname
  18843. // verification is disabled so only the chain is checked, matching OpenSSL.
  18844. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18845. wsession->hostname = hostname;
  18846. return true;
  18847. }
  18848. inline TlsError connect(session_t session) {
  18849. TlsError err;
  18850. if (!session) {
  18851. err.code = ErrorCode::Fatal;
  18852. return err;
  18853. }
  18854. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18855. int ret = wolfSSL_connect(wsession->ssl);
  18856. if (ret == SSL_SUCCESS) {
  18857. err.code = ErrorCode::Success;
  18858. } else {
  18859. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18860. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18861. err.backend_code = static_cast<uint64_t>(ssl_error);
  18862. impl::wolfssl_last_error() = err.backend_code;
  18863. }
  18864. return err;
  18865. }
  18866. inline TlsError accept(session_t session) {
  18867. TlsError err;
  18868. if (!session) {
  18869. err.code = ErrorCode::Fatal;
  18870. return err;
  18871. }
  18872. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18873. int ret = wolfSSL_accept(wsession->ssl);
  18874. if (ret == SSL_SUCCESS) {
  18875. err.code = ErrorCode::Success;
  18876. // Capture SNI from thread-local storage after successful handshake
  18877. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18878. impl::wolfssl_pending_sni().clear();
  18879. } else {
  18880. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18881. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18882. err.backend_code = static_cast<uint64_t>(ssl_error);
  18883. impl::wolfssl_last_error() = err.backend_code;
  18884. }
  18885. return err;
  18886. }
  18887. inline bool connect_nonblocking(session_t session, socket_t sock,
  18888. time_t timeout_sec, time_t timeout_usec,
  18889. TlsError *err) {
  18890. if (!session) {
  18891. if (err) { err->code = ErrorCode::Fatal; }
  18892. return false;
  18893. }
  18894. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18895. // Set socket to non-blocking mode
  18896. detail::set_nonblocking(sock, true);
  18897. auto cleanup =
  18898. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18899. int ret;
  18900. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18901. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18902. if (ssl_error == SSL_ERROR_WANT_READ) {
  18903. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18904. continue;
  18905. }
  18906. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18907. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18908. continue;
  18909. }
  18910. }
  18911. // Error or timeout
  18912. if (err) {
  18913. err->code =
  18914. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18915. err->backend_code = static_cast<uint64_t>(ssl_error);
  18916. }
  18917. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18918. return false;
  18919. }
  18920. if (err) { err->code = ErrorCode::Success; }
  18921. return true;
  18922. }
  18923. inline bool accept_nonblocking(session_t session, socket_t sock,
  18924. time_t timeout_sec, time_t timeout_usec,
  18925. TlsError *err) {
  18926. if (!session) {
  18927. if (err) { err->code = ErrorCode::Fatal; }
  18928. return false;
  18929. }
  18930. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18931. // Set socket to non-blocking mode
  18932. detail::set_nonblocking(sock, true);
  18933. auto cleanup =
  18934. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18935. int ret;
  18936. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18937. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18938. if (ssl_error == SSL_ERROR_WANT_READ) {
  18939. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18940. continue;
  18941. }
  18942. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18943. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18944. continue;
  18945. }
  18946. }
  18947. // Error or timeout
  18948. if (err) {
  18949. err->code =
  18950. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18951. err->backend_code = static_cast<uint64_t>(ssl_error);
  18952. }
  18953. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18954. return false;
  18955. }
  18956. if (err) { err->code = ErrorCode::Success; }
  18957. // Capture SNI from thread-local storage after successful handshake
  18958. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18959. impl::wolfssl_pending_sni().clear();
  18960. return true;
  18961. }
  18962. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18963. if (!session || !buf) {
  18964. err.code = ErrorCode::Fatal;
  18965. return -1;
  18966. }
  18967. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18968. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18969. if (ret > 0) {
  18970. err.code = ErrorCode::Success;
  18971. return static_cast<ssize_t>(ret);
  18972. }
  18973. if (ret == 0) {
  18974. err.code = ErrorCode::PeerClosed;
  18975. return 0;
  18976. }
  18977. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18978. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18979. err.backend_code = static_cast<uint64_t>(ssl_error);
  18980. impl::wolfssl_last_error() = err.backend_code;
  18981. return -1;
  18982. }
  18983. inline ssize_t write(session_t session, const void *buf, size_t len,
  18984. TlsError &err) {
  18985. if (!session || !buf) {
  18986. err.code = ErrorCode::Fatal;
  18987. return -1;
  18988. }
  18989. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18990. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18991. if (ret > 0) {
  18992. err.code = ErrorCode::Success;
  18993. return static_cast<ssize_t>(ret);
  18994. }
  18995. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18996. // Treat this as an error (return -1) so callers don't spin in a
  18997. // write loop adding zero to the offset.
  18998. if (ret == 0) {
  18999. err.code = ErrorCode::PeerClosed;
  19000. return -1;
  19001. }
  19002. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19003. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19004. err.backend_code = static_cast<uint64_t>(ssl_error);
  19005. impl::wolfssl_last_error() = err.backend_code;
  19006. return -1;
  19007. }
  19008. inline int pending(const_session_t session) {
  19009. if (!session) { return 0; }
  19010. auto wsession =
  19011. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19012. return wolfSSL_pending(wsession->ssl);
  19013. }
  19014. inline void shutdown(session_t session, bool graceful) {
  19015. if (!session) { return; }
  19016. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19017. if (graceful) {
  19018. int ret;
  19019. int attempts = 0;
  19020. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19021. attempts < 3) {
  19022. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19023. if (ssl_error != SSL_ERROR_WANT_READ &&
  19024. ssl_error != SSL_ERROR_WANT_WRITE) {
  19025. break;
  19026. }
  19027. attempts++;
  19028. }
  19029. } else {
  19030. wolfSSL_shutdown(wsession->ssl);
  19031. }
  19032. }
  19033. inline bool is_peer_closed(session_t session, socket_t sock) {
  19034. if (!session || sock == INVALID_SOCKET) { return true; }
  19035. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19036. // Check if there's already decrypted data available
  19037. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19038. // Set socket to non-blocking to avoid blocking on read
  19039. detail::set_nonblocking(sock, true);
  19040. auto cleanup =
  19041. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19042. // Peek 1 byte to check connection status without consuming data
  19043. unsigned char buf;
  19044. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19045. // If we got data or WANT_READ (would block), connection is alive
  19046. if (ret > 0) { return false; }
  19047. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19048. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19049. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19050. ret == 0;
  19051. }
  19052. inline cert_t get_peer_cert(const_session_t session) {
  19053. if (!session) { return nullptr; }
  19054. auto wsession =
  19055. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19056. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19057. return static_cast<cert_t>(cert);
  19058. }
  19059. inline size_t get_peer_certs(const_session_t session,
  19060. std::vector<cert_t> &certs) {
  19061. certs.clear();
  19062. if (!session) { return 0; }
  19063. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19064. #ifdef SESSION_CERTS
  19065. auto wsession =
  19066. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19067. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19068. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19069. for (int i = 0; i < count; i++) {
  19070. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19071. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19072. }
  19073. #endif
  19074. return certs.size();
  19075. }
  19076. inline void free_cert(cert_t cert) {
  19077. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19078. }
  19079. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19080. if (!cert || !hostname) { return false; }
  19081. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19082. std::string host_str(hostname);
  19083. // Check if hostname is an IP address (IPv4 or IPv6)
  19084. unsigned char ip_bytes[16];
  19085. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19086. auto is_ip = ip_len > 0;
  19087. // Check Subject Alternative Names
  19088. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19089. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19090. if (san_names) {
  19091. int san_count = wolfSSL_sk_num(san_names);
  19092. for (int i = 0; i < san_count; i++) {
  19093. auto *names =
  19094. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19095. if (!names) continue;
  19096. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19097. // DNS name
  19098. unsigned char *dns_name = nullptr;
  19099. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19100. if (dns_name && dns_len > 0) {
  19101. std::string san_name(reinterpret_cast<char *>(dns_name),
  19102. static_cast<size_t>(dns_len));
  19103. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19104. if (detail::match_hostname(san_name, host_str)) {
  19105. wolfSSL_sk_free(san_names);
  19106. return true;
  19107. }
  19108. }
  19109. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19110. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19111. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19112. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19113. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19114. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19115. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19116. wolfSSL_sk_free(san_names);
  19117. return true;
  19118. }
  19119. }
  19120. }
  19121. wolfSSL_sk_free(san_names);
  19122. }
  19123. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19124. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19125. // the OpenSSL backend's X509_check_ip behaves the same way).
  19126. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19127. if (subject) {
  19128. char cn[256] = {};
  19129. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19130. sizeof(cn));
  19131. if (cn_len > 0) {
  19132. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19133. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19134. }
  19135. }
  19136. return false;
  19137. }
  19138. inline uint64_t hostname_mismatch_code() {
  19139. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19140. }
  19141. inline long get_verify_result(const_session_t session) {
  19142. if (!session) { return -1; }
  19143. auto wsession =
  19144. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19145. long result = wolfSSL_get_verify_result(wsession->ssl);
  19146. return result;
  19147. }
  19148. inline std::string get_cert_subject_cn(cert_t cert) {
  19149. if (!cert) return "";
  19150. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19151. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19152. if (!subject) return "";
  19153. char cn[256] = {};
  19154. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19155. sizeof(cn));
  19156. if (cn_len <= 0) return "";
  19157. return std::string(cn, static_cast<size_t>(cn_len));
  19158. }
  19159. inline std::string get_cert_issuer_name(cert_t cert) {
  19160. if (!cert) return "";
  19161. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19162. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19163. if (!issuer) return "";
  19164. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19165. if (!name_str) return "";
  19166. std::string result(name_str);
  19167. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19168. return result;
  19169. }
  19170. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19171. sans.clear();
  19172. if (!cert) return false;
  19173. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19174. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19175. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19176. if (!san_names) return true; // No SANs is not an error
  19177. int count = wolfSSL_sk_num(san_names);
  19178. for (int i = 0; i < count; i++) {
  19179. auto *name =
  19180. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19181. if (!name) continue;
  19182. SanEntry entry;
  19183. switch (name->type) {
  19184. case WOLFSSL_GEN_DNS: {
  19185. entry.type = SanType::DNS;
  19186. unsigned char *dns_name = nullptr;
  19187. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19188. if (dns_name && dns_len > 0) {
  19189. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19190. static_cast<size_t>(dns_len));
  19191. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19192. }
  19193. break;
  19194. }
  19195. case WOLFSSL_GEN_IPADD: {
  19196. entry.type = SanType::IP;
  19197. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19198. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19199. if (ip_data && ip_len == 4) {
  19200. char buf[16];
  19201. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19202. ip_data[2], ip_data[3]);
  19203. entry.value = buf;
  19204. } else if (ip_data && ip_len == 16) {
  19205. char buf[64];
  19206. snprintf(buf, sizeof(buf),
  19207. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19208. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19209. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19210. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19211. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19212. ip_data[14], ip_data[15]);
  19213. entry.value = buf;
  19214. }
  19215. break;
  19216. }
  19217. case WOLFSSL_GEN_EMAIL:
  19218. entry.type = SanType::EMAIL;
  19219. {
  19220. unsigned char *email = nullptr;
  19221. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19222. if (email && email_len > 0) {
  19223. entry.value = std::string(reinterpret_cast<char *>(email),
  19224. static_cast<size_t>(email_len));
  19225. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19226. }
  19227. }
  19228. break;
  19229. case WOLFSSL_GEN_URI:
  19230. entry.type = SanType::URI;
  19231. {
  19232. unsigned char *uri = nullptr;
  19233. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19234. &uri, name->d.uniformResourceIdentifier);
  19235. if (uri && uri_len > 0) {
  19236. entry.value = std::string(reinterpret_cast<char *>(uri),
  19237. static_cast<size_t>(uri_len));
  19238. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19239. }
  19240. }
  19241. break;
  19242. default: entry.type = SanType::OTHER; break;
  19243. }
  19244. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19245. }
  19246. wolfSSL_sk_free(san_names);
  19247. return true;
  19248. }
  19249. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19250. time_t &not_after) {
  19251. if (!cert) return false;
  19252. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19253. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19254. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19255. if (!nb || !na) return false;
  19256. // wolfSSL_ASN1_TIME_to_tm is available
  19257. struct tm tm_nb = {}, tm_na = {};
  19258. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19259. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19260. #ifdef _WIN32
  19261. not_before = _mkgmtime(&tm_nb);
  19262. not_after = _mkgmtime(&tm_na);
  19263. #else
  19264. not_before = timegm(&tm_nb);
  19265. not_after = timegm(&tm_na);
  19266. #endif
  19267. return true;
  19268. }
  19269. inline std::string get_cert_serial(cert_t cert) {
  19270. if (!cert) return "";
  19271. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19272. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19273. if (!serial_asn1) return "";
  19274. // Get the serial number data
  19275. int len = serial_asn1->length;
  19276. unsigned char *data = serial_asn1->data;
  19277. if (!data || len <= 0) return "";
  19278. std::string result;
  19279. result.reserve(static_cast<size_t>(len) * 2);
  19280. for (int i = 0; i < len; i++) {
  19281. char hex[3];
  19282. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19283. result += hex;
  19284. }
  19285. return result;
  19286. }
  19287. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19288. if (!cert) return false;
  19289. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19290. int der_len = 0;
  19291. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19292. if (!der_data || der_len <= 0) return false;
  19293. der.assign(der_data, der_data + der_len);
  19294. return true;
  19295. }
  19296. inline const char *get_sni(const_session_t session) {
  19297. if (!session) return nullptr;
  19298. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19299. // For server: return SNI received from client during handshake
  19300. if (!wsession->sni_hostname.empty()) {
  19301. return wsession->sni_hostname.c_str();
  19302. }
  19303. // For client: return the hostname set via set_sni
  19304. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19305. return nullptr;
  19306. }
  19307. inline uint64_t peek_error() {
  19308. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19309. }
  19310. inline uint64_t get_error() {
  19311. uint64_t err = impl::wolfssl_last_error();
  19312. impl::wolfssl_last_error() = 0;
  19313. return err;
  19314. }
  19315. inline std::string error_string(uint64_t code) {
  19316. char buf[256];
  19317. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19318. return std::string(buf);
  19319. }
  19320. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19321. if (!pem || len == 0) { return nullptr; }
  19322. // Validate by attempting to load into a temporary ctx
  19323. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19324. if (!tmp_ctx) { return nullptr; }
  19325. int ret = wolfSSL_CTX_load_verify_buffer(
  19326. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19327. static_cast<long>(len), SSL_FILETYPE_PEM);
  19328. wolfSSL_CTX_free(tmp_ctx);
  19329. if (ret != SSL_SUCCESS) { return nullptr; }
  19330. return static_cast<ca_store_t>(
  19331. new impl::WolfSSLCAStore{std::string(pem, len)});
  19332. }
  19333. inline void free_ca_store(ca_store_t store) {
  19334. delete static_cast<impl::WolfSSLCAStore *>(store);
  19335. }
  19336. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19337. if (!ctx || !store) { return false; }
  19338. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19339. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19340. int ret = wolfSSL_CTX_load_verify_buffer(
  19341. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19342. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19343. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19344. // This function takes ownership of the store; the PEM data was copied into
  19345. // the context, so release the source
  19346. free_ca_store(store);
  19347. return ret == SSL_SUCCESS;
  19348. }
  19349. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19350. certs.clear();
  19351. if (!ctx) { return 0; }
  19352. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19353. if (wctx->ca_pem_data_.empty()) { return 0; }
  19354. const std::string &pem = wctx->ca_pem_data_;
  19355. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19356. const std::string end_marker = "-----END CERTIFICATE-----";
  19357. size_t pos = 0;
  19358. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19359. size_t end_pos = pem.find(end_marker, pos);
  19360. if (end_pos == std::string::npos) { break; }
  19361. end_pos += end_marker.size();
  19362. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19363. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19364. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19365. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19366. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19367. pos = end_pos;
  19368. }
  19369. return certs.size();
  19370. }
  19371. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19372. std::vector<std::string> names;
  19373. if (!ctx) { return names; }
  19374. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19375. if (wctx->ca_pem_data_.empty()) { return names; }
  19376. const std::string &pem = wctx->ca_pem_data_;
  19377. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19378. const std::string end_marker = "-----END CERTIFICATE-----";
  19379. size_t pos = 0;
  19380. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19381. size_t end_pos = pem.find(end_marker, pos);
  19382. if (end_pos == std::string::npos) { break; }
  19383. end_pos += end_marker.size();
  19384. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19385. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19386. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19387. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19388. if (x509) {
  19389. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19390. if (subject) {
  19391. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19392. if (name_str) {
  19393. names.push_back(name_str);
  19394. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19395. }
  19396. }
  19397. wolfSSL_X509_free(x509);
  19398. }
  19399. pos = end_pos;
  19400. }
  19401. return names;
  19402. }
  19403. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19404. const char *key_pem, const char *password) {
  19405. if (!ctx || !cert_pem || !key_pem) { return false; }
  19406. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19407. // Load new certificate
  19408. int ret = wolfSSL_CTX_use_certificate_buffer(
  19409. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19410. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19411. if (ret != SSL_SUCCESS) {
  19412. impl::wolfssl_last_error() =
  19413. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19414. return false;
  19415. }
  19416. // Set password if provided
  19417. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19418. // Load new private key
  19419. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19420. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19421. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19422. if (ret != SSL_SUCCESS) {
  19423. impl::wolfssl_last_error() =
  19424. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19425. return false;
  19426. }
  19427. return true;
  19428. }
  19429. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19430. if (!ctx || !ca_pem) { return false; }
  19431. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19432. int ret = wolfSSL_CTX_load_verify_buffer(
  19433. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19434. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19435. if (ret != SSL_SUCCESS) {
  19436. impl::wolfssl_last_error() =
  19437. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19438. return false;
  19439. }
  19440. return true;
  19441. }
  19442. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19443. if (!ctx) { return false; }
  19444. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19445. wctx->verify_callback = std::move(callback);
  19446. if (wctx->verify_callback) {
  19447. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19448. impl::wolfssl_verify_callback);
  19449. } else {
  19450. wolfSSL_CTX_set_verify(
  19451. wctx->ctx,
  19452. wctx->verify_client
  19453. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19454. : SSL_VERIFY_NONE,
  19455. nullptr);
  19456. }
  19457. return true;
  19458. }
  19459. inline long get_verify_error(const_session_t session) {
  19460. if (!session) { return -1; }
  19461. auto *wsession =
  19462. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19463. return wolfSSL_get_verify_result(wsession->ssl);
  19464. }
  19465. inline std::string verify_error_string(long error_code) {
  19466. if (error_code == 0) { return ""; }
  19467. const char *str =
  19468. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19469. return str ? std::string(str) : std::string();
  19470. }
  19471. } // namespace tls
  19472. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19473. // WebSocket implementation
  19474. namespace ws {
  19475. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19476. bool fin) {
  19477. std::lock_guard<std::mutex> lock(write_mutex_);
  19478. if (closed_) { return false; }
  19479. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19480. }
  19481. inline ReadResult WebSocket::read(std::string &msg) {
  19482. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19483. while (!closed_) {
  19484. Opcode opcode;
  19485. std::string payload;
  19486. bool fin;
  19487. impl::FrameRead r =
  19488. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19489. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19490. // A timeout landed on a frame boundary: the connection is untouched and
  19491. // still usable, so hand control back without closing it. That is only
  19492. // useful to a caller who asked for the timeout; the compile-time default
  19493. // is a backstop against a peer gone quiet, and elapsing it closes the
  19494. // connection so a plain `while (ws.read(msg))` loop ends.
  19495. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19496. if (r != impl::FrameRead::Ok) {
  19497. closed_ = true;
  19498. return Fail;
  19499. }
  19500. switch (opcode) {
  19501. case Opcode::Ping: {
  19502. std::lock_guard<std::mutex> lock(write_mutex_);
  19503. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19504. payload.size(), true, !is_server_);
  19505. continue;
  19506. }
  19507. case Opcode::Pong: {
  19508. std::lock_guard<std::mutex> lock(ping_mutex_);
  19509. unacked_pings_ = 0;
  19510. continue;
  19511. }
  19512. case Opcode::Close: {
  19513. if (!closed_.exchange(true)) {
  19514. // Echo close frame back
  19515. std::lock_guard<std::mutex> lock(write_mutex_);
  19516. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19517. payload.size(), true, !is_server_);
  19518. }
  19519. return Fail;
  19520. }
  19521. case Opcode::Text:
  19522. case Opcode::Binary: {
  19523. auto result = opcode == Opcode::Text ? Text : Binary;
  19524. msg = std::move(payload);
  19525. // Handle fragmentation
  19526. if (!fin) {
  19527. while (true) {
  19528. Opcode cont_opcode;
  19529. std::string cont_payload;
  19530. bool cont_fin;
  19531. // A timeout is not reportable here: half of a fragmented message is
  19532. // already in `msg` and read() has no way to resume it, so it is a
  19533. // failure like any other. Timeouts are only ever seen on a message
  19534. // boundary.
  19535. if (impl::read_websocket_frame(
  19536. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19537. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19538. impl::FrameRead::Ok) {
  19539. closed_ = true;
  19540. return Fail;
  19541. }
  19542. if (cont_opcode == Opcode::Ping) {
  19543. std::lock_guard<std::mutex> lock(write_mutex_);
  19544. detail::write_websocket_frame(
  19545. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19546. true, !is_server_);
  19547. continue;
  19548. }
  19549. if (cont_opcode == Opcode::Pong) {
  19550. std::lock_guard<std::mutex> lock(ping_mutex_);
  19551. unacked_pings_ = 0;
  19552. continue;
  19553. }
  19554. if (cont_opcode == Opcode::Close) {
  19555. if (!closed_.exchange(true)) {
  19556. std::lock_guard<std::mutex> lock(write_mutex_);
  19557. detail::write_websocket_frame(
  19558. strm_, Opcode::Close, cont_payload.data(),
  19559. cont_payload.size(), true, !is_server_);
  19560. }
  19561. return Fail;
  19562. }
  19563. // RFC 6455: continuation frames must use opcode 0x0
  19564. if (cont_opcode != Opcode::Continuation) {
  19565. closed_ = true;
  19566. return Fail;
  19567. }
  19568. msg += cont_payload;
  19569. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19570. closed_ = true;
  19571. return Fail;
  19572. }
  19573. if (cont_fin) { break; }
  19574. }
  19575. }
  19576. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19577. if (result == Text && !impl::is_valid_utf8(msg)) {
  19578. // close() takes the read lock to wait for the peer's Close reply, so
  19579. // it must not run while this thread still holds it.
  19580. read_lock.unlock();
  19581. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19582. return Fail;
  19583. }
  19584. return result;
  19585. }
  19586. default: closed_ = true; return Fail;
  19587. }
  19588. }
  19589. return Fail;
  19590. }
  19591. inline bool WebSocket::send(const std::string &data) {
  19592. return send_frame(Opcode::Text, data.data(), data.size());
  19593. }
  19594. inline bool WebSocket::send(const char *data, size_t len) {
  19595. return send_frame(Opcode::Binary, data, len);
  19596. }
  19597. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19598. if (closed_.exchange(true)) { return; }
  19599. ping_cv_.notify_all();
  19600. std::string payload;
  19601. auto code = static_cast<uint16_t>(status);
  19602. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19603. payload.push_back(static_cast<char>(code & 0xFF));
  19604. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19605. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19606. payload += reason.substr(0, 123);
  19607. {
  19608. std::lock_guard<std::mutex> lock(write_mutex_);
  19609. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19610. payload.size(), true, !is_server_);
  19611. }
  19612. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19613. // Close response before closing the TCP connection.
  19614. //
  19615. // Wait only when no other thread is parsing frames. When one is, it is the
  19616. // thread positioned to see the peer's reply, and reading here would take
  19617. // bytes out of the message it is assembling. Bailing out also leaves the
  19618. // stream, including its read timeout, entirely to that thread.
  19619. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19620. if (!read_lock.owns_lock()) { return; }
  19621. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19622. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19623. Opcode op;
  19624. std::string resp;
  19625. bool fin;
  19626. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19627. impl::FrameRead::Ok) {
  19628. if (op == Opcode::Close) { break; }
  19629. }
  19630. }
  19631. inline WebSocket::~WebSocket() {
  19632. {
  19633. std::lock_guard<std::mutex> lock(ping_mutex_);
  19634. closed_ = true;
  19635. }
  19636. ping_cv_.notify_all();
  19637. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19638. }
  19639. inline void WebSocket::start_heartbeat() {
  19640. if (ping_interval_sec_ == 0) { return; }
  19641. ping_thread_ = std::thread([this]() {
  19642. std::unique_lock<std::mutex> lock(ping_mutex_);
  19643. // The predicate keeps a spurious wakeup from sending a ping early
  19644. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19645. [this]() { return closed_.load(); })) {
  19646. // If the peer has failed to respond to the previous pings, give up.
  19647. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19648. // opt-in liveness check controlled by max_missed_pongs_.
  19649. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19650. lock.unlock();
  19651. close(CloseStatus::GoingAway, "pong timeout");
  19652. // Wake a read() blocked on the unresponsive peer. Only the read side
  19653. // is shut down: a TLS backend answers the EOF with an alert, and
  19654. // writing it to a socket closed for writing raises SIGPIPE.
  19655. #ifdef _WIN32
  19656. shutdown(strm_.socket(), SD_RECEIVE);
  19657. #else
  19658. shutdown(strm_.socket(), SHUT_RD);
  19659. #endif
  19660. return;
  19661. }
  19662. lock.unlock();
  19663. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19664. lock.lock();
  19665. closed_ = true;
  19666. break;
  19667. }
  19668. lock.lock();
  19669. unacked_pings_++;
  19670. }
  19671. });
  19672. }
  19673. inline const Request &WebSocket::request() const { return req_; }
  19674. inline bool WebSocket::is_open() const { return !closed_; }
  19675. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19676. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19677. // poll(), where 0 would instead mean "return immediately", so hand it the
  19678. // negative poll uses for an unbounded wait.
  19679. if (sec == 0 && usec == 0) { sec = -1; }
  19680. strm_.set_read_timeout(sec, usec);
  19681. read_timeout_set_ = true;
  19682. }
  19683. // WebSocketClient implementation
  19684. inline WebSocketClient::WebSocketClient(
  19685. const std::string &scheme_host_port_path, const Headers &headers)
  19686. : headers_(headers) {
  19687. detail::UrlComponents uc;
  19688. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19689. !uc.host.empty() && !uc.path.empty()) {
  19690. auto &scheme = uc.scheme;
  19691. #ifdef CPPHTTPLIB_SSL_ENABLED
  19692. if (scheme != "ws" && scheme != "wss") {
  19693. #else
  19694. if (scheme != "ws") {
  19695. #endif
  19696. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19697. std::string msg = "'" + scheme + "' scheme is not supported.";
  19698. throw std::invalid_argument(msg);
  19699. #endif
  19700. return;
  19701. }
  19702. auto is_ssl = scheme == "wss";
  19703. host_ = std::move(uc.host);
  19704. port_ = is_ssl ? 443 : 80;
  19705. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19706. path_ = std::move(uc.path);
  19707. if (!uc.query.empty()) { path_ += uc.query; }
  19708. #ifdef CPPHTTPLIB_SSL_ENABLED
  19709. is_ssl_ = is_ssl;
  19710. if (is_ssl_) {
  19711. // The context lives as long as the client so that CA configuration
  19712. // survives reconnects; sessions are created per connection.
  19713. tls_ctx_ = tls::create_client_context();
  19714. if (!tls_ctx_) { return; }
  19715. }
  19716. #else
  19717. if (is_ssl) { return; }
  19718. #endif
  19719. is_valid_ = true;
  19720. }
  19721. }
  19722. #ifdef CPPHTTPLIB_SSL_ENABLED
  19723. inline WebSocketClient::WebSocketClient(
  19724. const std::string &scheme_host_port_path, const PemMemory &pem,
  19725. const Headers &headers)
  19726. : WebSocketClient(scheme_host_port_path, headers) {
  19727. // For ws:// URLs the client certificate is silently ignored, consistent
  19728. // with the TLS-only setters such as set_ca_cert_path().
  19729. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19730. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19731. pem.private_key_password)) {
  19732. tls::free_context(tls_ctx_);
  19733. tls_ctx_ = nullptr;
  19734. is_valid_ = false;
  19735. }
  19736. }
  19737. }
  19738. #endif
  19739. inline WebSocketClient::~WebSocketClient() {
  19740. shutdown_and_close();
  19741. #ifdef CPPHTTPLIB_SSL_ENABLED
  19742. if (tls_ctx_) {
  19743. tls::free_context(tls_ctx_);
  19744. tls_ctx_ = nullptr;
  19745. }
  19746. #endif
  19747. }
  19748. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19749. inline void WebSocketClient::shutdown_and_close() {
  19750. // Send the close frame while the TLS session is still alive: ws_ holds an
  19751. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19752. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19753. if (ws_ && ws_->is_open()) { ws_->close(); }
  19754. ws_.reset();
  19755. #ifdef CPPHTTPLIB_SSL_ENABLED
  19756. if (is_ssl_) {
  19757. if (tls_session_) {
  19758. tls::shutdown(tls_session_, true);
  19759. tls::free_session(tls_session_);
  19760. tls_session_ = nullptr;
  19761. }
  19762. }
  19763. #endif
  19764. if (sock_ != INVALID_SOCKET) {
  19765. detail::shutdown_socket(sock_);
  19766. detail::close_socket(sock_);
  19767. sock_ = INVALID_SOCKET;
  19768. }
  19769. }
  19770. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19771. Error &error, int &ssl_error,
  19772. uint64_t &ssl_backend_error) {
  19773. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19774. // The streams wait with poll(), where 0 instead means "return immediately",
  19775. // so they are given the negative poll uses for an unbounded wait.
  19776. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19777. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19778. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19779. // The handshake belongs to establishing the connection, so an unset read
  19780. // timeout leaves it bounded by the connection timeout instead of forever.
  19781. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19782. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19783. #ifdef CPPHTTPLIB_SSL_ENABLED
  19784. if (is_ssl_) {
  19785. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19786. // is not safe to call concurrently on one client to begin with, since
  19787. // nothing else here is guarded either.
  19788. if (server_certificate_verification_ && !certs_loaded_) {
  19789. uint64_t backend_error = 0;
  19790. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19791. ca_cert_dir_path_, custom_ca_loaded_,
  19792. system_ca_mode_, backend_error);
  19793. certs_loaded_ = true;
  19794. }
  19795. detail::ClientTlsSessionOptions options;
  19796. options.server_hostname_verification = server_hostname_verification_;
  19797. detail::ClientTlsSessionError tls_error;
  19798. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19799. server_certificate_verification_,
  19800. hs_sec, hs_usec, &tls_error,
  19801. options)) {
  19802. error = tls_error.error;
  19803. ssl_error = tls_error.ssl_error;
  19804. ssl_backend_error = tls_error.backend_error;
  19805. return false;
  19806. }
  19807. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19808. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19809. write_timeout_usec_));
  19810. return true;
  19811. }
  19812. #else
  19813. (void)error;
  19814. (void)ssl_error;
  19815. (void)ssl_backend_error;
  19816. (void)hs_sec;
  19817. (void)hs_usec;
  19818. #endif
  19819. strm = std::unique_ptr<Stream>(
  19820. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19821. write_timeout_sec_, write_timeout_usec_));
  19822. return true;
  19823. }
  19824. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19825. #ifdef CPPHTTPLIB_SSL_ENABLED
  19826. auto is_ssl = is_ssl_;
  19827. #else
  19828. auto is_ssl = false;
  19829. #endif
  19830. if (!req.has_header("Host")) {
  19831. req.headers.emplace("Host", detail::make_default_host_header_value(
  19832. host_, port_, is_ssl, address_family_));
  19833. }
  19834. detail::add_default_user_agent_header(req);
  19835. }
  19836. inline Result WebSocketClient::connect() {
  19837. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19838. shutdown_and_close();
  19839. // Check is custom IP or hostname specified for host_
  19840. std::string connect_host;
  19841. std::string ip;
  19842. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19843. auto error = Error::Success;
  19844. sock_ = detail::create_client_socket(
  19845. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19846. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19847. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19848. write_timeout_usec_, interface_, error);
  19849. if (sock_ == INVALID_SOCKET) {
  19850. if (error == Error::Success) { error = Error::Connection; }
  19851. return Result{error, -1, Headers{}};
  19852. }
  19853. std::unique_ptr<Stream> strm;
  19854. auto stream_error = Error::SSLConnection;
  19855. int ssl_error = 0;
  19856. uint64_t ssl_backend_error = 0;
  19857. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19858. shutdown_and_close();
  19859. #ifdef CPPHTTPLIB_SSL_ENABLED
  19860. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19861. #else
  19862. return Result{stream_error, -1, Headers{}};
  19863. #endif
  19864. }
  19865. Request req;
  19866. req.method = "GET";
  19867. req.path = path_;
  19868. req.headers = headers_;
  19869. prepare_default_headers(req);
  19870. detail::WebSocketUpgradeResponse upgrade;
  19871. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19872. shutdown_and_close();
  19873. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19874. }
  19875. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19876. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19877. websocket_ping_interval_sec_,
  19878. websocket_max_missed_pongs_));
  19879. // The stream was created with the timeout already; tell the WebSocket
  19880. // whether it came from the caller, so read() knows to report it as Timeout.
  19881. ws_->read_timeout_set_ = read_timeout_set_;
  19882. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19883. }
  19884. inline ReadResult WebSocketClient::read(std::string &msg) {
  19885. if (!ws_) { return Fail; }
  19886. return ws_->read(msg);
  19887. }
  19888. inline bool WebSocketClient::send(const std::string &data) {
  19889. if (!ws_) { return false; }
  19890. return ws_->send(data);
  19891. }
  19892. inline bool WebSocketClient::send(const char *data, size_t len) {
  19893. if (!ws_) { return false; }
  19894. return ws_->send(data, len);
  19895. }
  19896. inline void WebSocketClient::close(CloseStatus status,
  19897. const std::string &reason) {
  19898. if (ws_) { ws_->close(status, reason); }
  19899. }
  19900. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19901. inline const std::string &WebSocketClient::subprotocol() const {
  19902. return subprotocol_;
  19903. }
  19904. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19905. read_timeout_sec_ = sec;
  19906. read_timeout_usec_ = usec;
  19907. read_timeout_set_ = true;
  19908. // The members above only seed the next connect(); read() consults the
  19909. // stream, so an already-open connection has to be told directly.
  19910. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19911. }
  19912. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19913. write_timeout_sec_ = sec;
  19914. write_timeout_usec_ = usec;
  19915. }
  19916. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19917. websocket_ping_interval_sec_ = sec;
  19918. }
  19919. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19920. websocket_max_missed_pongs_ = count;
  19921. }
  19922. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19923. inline void WebSocketClient::set_address_family(int family) {
  19924. address_family_ = family;
  19925. }
  19926. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19927. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19928. socket_options_ = std::move(socket_options);
  19929. }
  19930. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19931. connection_timeout_sec_ = sec;
  19932. connection_timeout_usec_ = usec;
  19933. }
  19934. inline void WebSocketClient::set_interface(const std::string &intf) {
  19935. interface_ = intf;
  19936. }
  19937. inline void WebSocketClient::set_hostname_addr_map(
  19938. std::map<std::string, std::string> addr_map) {
  19939. addr_map_ = std::move(addr_map);
  19940. }
  19941. #ifdef CPPHTTPLIB_SSL_ENABLED
  19942. inline void
  19943. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19944. const std::string &ca_cert_dir_path) {
  19945. ca_cert_file_path_ = ca_cert_file_path;
  19946. ca_cert_dir_path_ = ca_cert_dir_path;
  19947. }
  19948. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19949. if (store && tls_ctx_) {
  19950. // set_ca_store takes ownership of store
  19951. tls::set_ca_store(tls_ctx_, store);
  19952. custom_ca_loaded_ = true;
  19953. } else if (store) {
  19954. tls::free_ca_store(store);
  19955. }
  19956. }
  19957. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19958. std::size_t size) {
  19959. if (tls_ctx_ && ca_cert && size > 0) {
  19960. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19961. custom_ca_loaded_ = true;
  19962. }
  19963. }
  19964. inline void
  19965. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19966. server_certificate_verification_ = enabled;
  19967. }
  19968. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19969. server_hostname_verification_ = enabled;
  19970. }
  19971. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19972. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19973. }
  19974. #endif // CPPHTTPLIB_SSL_ENABLED
  19975. } // namespace ws
  19976. // ----------------------------------------------------------------------------
  19977. } // namespace httplib
  19978. #endif // CPPHTTPLIB_HTTPLIB_H