httplib.h 798 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381
  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. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2853. bool enable_windows_cert_verification_ = true;
  2854. // Like ca_cert_store_set_, tracks what ctx_ cannot report back: whether
  2855. // set_server_certificate_verifier() installed a verifier.
  2856. bool server_certificate_verifier_set_ = false;
  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. // The parts of session setup that only SSLClient needs, plus the handful
  9276. // WebSocketClient also exposes; everything else takes the defaults, which is
  9277. // what keeps the two clients on one implementation.
  9278. struct ClientTlsSessionOptions {
  9279. // Both SSLClient and WebSocketClient expose this independently of
  9280. // certificate verification.
  9281. bool server_hostname_verification = true;
  9282. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9283. // When non-null, guards session creation against concurrent use of the
  9284. // context. A WebSocketClient is not safe to use from several threads to
  9285. // begin with, so it passes nothing.
  9286. std::mutex *ctx_mutex = nullptr;
  9287. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9288. // The caller decides whether Schannel has anything to say about this
  9289. // connection; see SSLClient::initialize_ssl().
  9290. bool windows_cert_verification = false;
  9291. // A server certificate verifier works on the backend's chain verification,
  9292. // so the backend keeps deciding and Schannel only adds its own check.
  9293. bool server_certificate_verifier_set = false;
  9294. #endif
  9295. };
  9296. // Filled in on failure for callers that report error details.
  9297. struct ClientTlsSessionError {
  9298. Error error = Error::Success;
  9299. int ssl_error = 0;
  9300. uint64_t backend_error = 0;
  9301. };
  9302. // Establishes a client TLS session on an already connected socket. On failure
  9303. // the session is left for the caller to free: SSLClient frees it right away,
  9304. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9305. inline bool setup_client_tls_session(
  9306. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9307. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9308. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9309. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9310. using namespace tls;
  9311. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9312. if (out_error) {
  9313. out_error->error = error;
  9314. out_error->ssl_error = ssl_error;
  9315. out_error->backend_error = backend_error;
  9316. }
  9317. return false;
  9318. };
  9319. if (!ctx) {
  9320. session = nullptr;
  9321. return fail(Error::SSLConnection, 0, 0);
  9322. }
  9323. // With Windows verification on and no server certificate verifier set,
  9324. // Schannel is the only chain verifier. The backend's trust store is a
  9325. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9326. // demand, so the backend's verdict is not used.
  9327. auto windows_verifies_chain = false;
  9328. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9329. windows_verifies_chain = options.windows_cert_verification &&
  9330. !options.server_certificate_verifier_set;
  9331. #endif
  9332. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9333. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9334. // uses SSL_VERIFY_NONE and does all verification post-handshake. Unless
  9335. // Schannel verifies the chain instead, chain verification happens during
  9336. // the handshake even for IP hosts; the certificate identity is verified
  9337. // post-handshake via verify_hostname().
  9338. set_verify_client(ctx,
  9339. server_certificate_verification && !windows_verifies_chain);
  9340. #endif
  9341. {
  9342. std::unique_lock<std::mutex> guard;
  9343. if (options.ctx_mutex) {
  9344. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9345. }
  9346. session = create_session(ctx, sock);
  9347. }
  9348. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9349. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9350. // their identity is checked post-handshake below instead. On Mbed TLS and
  9351. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9352. // options.server_hostname_verification is threaded through here.
  9353. if (!is_ip_address(host)) {
  9354. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9355. return fail(Error::SSLConnection, 0, get_error());
  9356. }
  9357. }
  9358. TlsError tls_err;
  9359. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9360. &tls_err)) {
  9361. auto error = Error::SSLConnection;
  9362. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9363. error = Error::SSLServerVerification;
  9364. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9365. error = Error::SSLServerHostnameVerification;
  9366. }
  9367. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9368. }
  9369. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9370. if (options.session_verifier) {
  9371. verification_status = options.session_verifier(session);
  9372. }
  9373. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9374. return fail(Error::SSLServerVerification, 0, get_error());
  9375. }
  9376. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9377. server_certificate_verification) {
  9378. if (!windows_verifies_chain) {
  9379. auto verify_result = get_verify_result(session);
  9380. if (verify_result != 0) {
  9381. return fail(Error::SSLServerVerification, 0,
  9382. static_cast<uint64_t>(verify_result));
  9383. }
  9384. }
  9385. auto server_cert = get_peer_cert(session);
  9386. if (!server_cert) {
  9387. return fail(Error::SSLServerVerification, 0, get_error());
  9388. }
  9389. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9390. // Identity check against the peer certificate, post-handshake for all
  9391. // backends. For IP hosts this is the only identity verification, since no
  9392. // hostname is bound during the handshake.
  9393. if (options.server_hostname_verification) {
  9394. if (!verify_hostname(server_cert, host.c_str())) {
  9395. return fail(Error::SSLServerHostnameVerification, 0,
  9396. hostname_mismatch_code());
  9397. }
  9398. }
  9399. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9400. // Windows Schannel verification, which lets Windows fetch missing roots
  9401. // and intermediates on demand. It must not be skipped: unless a server
  9402. // certificate verifier is set, it is the only chain check.
  9403. if (options.windows_cert_verification) {
  9404. std::vector<unsigned char> der;
  9405. uint64_t wincrypt_error = 0;
  9406. if (!get_cert_der(server_cert, der) ||
  9407. !verify_cert_with_windows_schannel(
  9408. der, host, options.server_hostname_verification, wincrypt_error,
  9409. session)) {
  9410. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9411. }
  9412. }
  9413. #endif
  9414. }
  9415. return true;
  9416. }
  9417. } // namespace detail
  9418. #endif // CPPHTTPLIB_SSL_ENABLED
  9419. /*
  9420. * Group 3: httplib namespace - Non-SSL public API implementations
  9421. */
  9422. inline void default_socket_options(socket_t sock) {
  9423. set_socket_opt(sock, SOL_SOCKET,
  9424. #ifdef SO_REUSEPORT
  9425. SO_REUSEPORT,
  9426. #else
  9427. SO_REUSEADDR,
  9428. #endif
  9429. 1);
  9430. }
  9431. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9432. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9433. sizeof(optval));
  9434. }
  9435. inline std::string get_bearer_token_auth(const Request &req) {
  9436. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9437. // than the prefix carries no token.
  9438. constexpr const char bearer_prefix[] = "Bearer ";
  9439. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9440. auto value = req.get_header_value("Authorization");
  9441. if (value.size() >= bearer_prefix_len &&
  9442. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9443. bearer_prefix)) {
  9444. return value.substr(bearer_prefix_len);
  9445. }
  9446. return "";
  9447. }
  9448. inline const char *status_message(int status) {
  9449. switch (status) {
  9450. case StatusCode::Continue_100: return "Continue";
  9451. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9452. case StatusCode::Processing_102: return "Processing";
  9453. case StatusCode::EarlyHints_103: return "Early Hints";
  9454. case StatusCode::OK_200: return "OK";
  9455. case StatusCode::Created_201: return "Created";
  9456. case StatusCode::Accepted_202: return "Accepted";
  9457. case StatusCode::NonAuthoritativeInformation_203:
  9458. return "Non-Authoritative Information";
  9459. case StatusCode::NoContent_204: return "No Content";
  9460. case StatusCode::ResetContent_205: return "Reset Content";
  9461. case StatusCode::PartialContent_206: return "Partial Content";
  9462. case StatusCode::MultiStatus_207: return "Multi-Status";
  9463. case StatusCode::AlreadyReported_208: return "Already Reported";
  9464. case StatusCode::IMUsed_226: return "IM Used";
  9465. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9466. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9467. case StatusCode::Found_302: return "Found";
  9468. case StatusCode::SeeOther_303: return "See Other";
  9469. case StatusCode::NotModified_304: return "Not Modified";
  9470. case StatusCode::UseProxy_305: return "Use Proxy";
  9471. case StatusCode::unused_306: return "unused";
  9472. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9473. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9474. case StatusCode::BadRequest_400: return "Bad Request";
  9475. case StatusCode::Unauthorized_401: return "Unauthorized";
  9476. case StatusCode::PaymentRequired_402: return "Payment Required";
  9477. case StatusCode::Forbidden_403: return "Forbidden";
  9478. case StatusCode::NotFound_404: return "Not Found";
  9479. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9480. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9481. case StatusCode::ProxyAuthenticationRequired_407:
  9482. return "Proxy Authentication Required";
  9483. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9484. case StatusCode::Conflict_409: return "Conflict";
  9485. case StatusCode::Gone_410: return "Gone";
  9486. case StatusCode::LengthRequired_411: return "Length Required";
  9487. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9488. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9489. case StatusCode::UriTooLong_414: return "URI Too Long";
  9490. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9491. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9492. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9493. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9494. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9495. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9496. case StatusCode::Locked_423: return "Locked";
  9497. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9498. case StatusCode::TooEarly_425: return "Too Early";
  9499. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9500. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9501. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9502. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9503. return "Request Header Fields Too Large";
  9504. case StatusCode::UnavailableForLegalReasons_451:
  9505. return "Unavailable For Legal Reasons";
  9506. case StatusCode::NotImplemented_501: return "Not Implemented";
  9507. case StatusCode::BadGateway_502: return "Bad Gateway";
  9508. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9509. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9510. case StatusCode::HttpVersionNotSupported_505:
  9511. return "HTTP Version Not Supported";
  9512. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9513. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9514. case StatusCode::LoopDetected_508: return "Loop Detected";
  9515. case StatusCode::NotExtended_510: return "Not Extended";
  9516. case StatusCode::NetworkAuthenticationRequired_511:
  9517. return "Network Authentication Required";
  9518. default:
  9519. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9520. }
  9521. }
  9522. inline std::string to_string(const Error error) {
  9523. switch (error) {
  9524. case Error::Success: return "Success (no error)";
  9525. case Error::Unknown: return "Unknown";
  9526. case Error::Connection: return "Could not establish connection";
  9527. case Error::BindIPAddress: return "Failed to bind IP address";
  9528. case Error::Read: return "Failed to read connection";
  9529. case Error::Write: return "Failed to write connection";
  9530. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9531. case Error::Canceled: return "Connection handling canceled";
  9532. case Error::SSLConnection: return "SSL connection failed";
  9533. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9534. case Error::SSLServerVerification: return "SSL server verification failed";
  9535. case Error::SSLServerHostnameVerification:
  9536. return "SSL server hostname verification failed";
  9537. case Error::UnsupportedMultipartBoundaryChars:
  9538. return "Unsupported HTTP multipart boundary characters";
  9539. case Error::Compression: return "Compression failed";
  9540. case Error::ConnectionTimeout: return "Connection timed out";
  9541. case Error::ProxyConnection: return "Proxy connection failed";
  9542. case Error::ConnectionClosed: return "Connection closed by server";
  9543. case Error::Timeout: return "Read timeout";
  9544. case Error::ResourceExhaustion: return "Resource exhaustion";
  9545. case Error::TooManyFormDataFiles: return "Too many form data files";
  9546. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9547. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9548. case Error::ExceedMaxSocketDescriptorCount:
  9549. return "Exceeded maximum socket descriptor count";
  9550. case Error::InvalidRequestLine: return "Invalid request line";
  9551. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9552. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9553. case Error::InvalidHeaders: return "Invalid headers";
  9554. case Error::MultipartParsing: return "Multipart parsing failed";
  9555. case Error::OpenFile: return "Failed to open file";
  9556. case Error::Listen: return "Failed to listen on socket";
  9557. case Error::GetSockName: return "Failed to get socket name";
  9558. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9559. case Error::HTTPParsing: return "HTTP parsing failed";
  9560. case Error::InvalidRangeHeader: return "Invalid Range header";
  9561. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9562. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9563. case Error::UserCallbackException: return "User callback threw an exception";
  9564. default: break;
  9565. }
  9566. return "Invalid";
  9567. }
  9568. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9569. os << to_string(obj);
  9570. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9571. return os;
  9572. }
  9573. inline std::string hosted_at(const std::string &hostname) {
  9574. std::vector<std::string> addrs;
  9575. hosted_at(hostname, addrs);
  9576. if (addrs.empty()) { return std::string(); }
  9577. return addrs[0];
  9578. }
  9579. inline void hosted_at(const std::string &hostname,
  9580. std::vector<std::string> &addrs) {
  9581. struct addrinfo hints;
  9582. struct addrinfo *result;
  9583. memset(&hints, 0, sizeof(struct addrinfo));
  9584. hints.ai_family = AF_UNSPEC;
  9585. hints.ai_socktype = SOCK_STREAM;
  9586. hints.ai_protocol = 0;
  9587. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9588. &result, 0)) {
  9589. #if defined __linux__ && !defined __ANDROID__
  9590. res_init();
  9591. #endif
  9592. return;
  9593. }
  9594. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9595. for (auto rp = result; rp; rp = rp->ai_next) {
  9596. const auto &addr =
  9597. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9598. std::string ip;
  9599. auto dummy = -1;
  9600. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9601. dummy)) {
  9602. addrs.emplace_back(std::move(ip));
  9603. }
  9604. }
  9605. }
  9606. inline std::string encode_uri_component(const std::string &value) {
  9607. std::ostringstream escaped;
  9608. escaped.fill('0');
  9609. escaped << std::hex;
  9610. for (auto c : value) {
  9611. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9612. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9613. escaped << c;
  9614. } else {
  9615. escaped << std::uppercase;
  9616. escaped << '%' << std::setw(2)
  9617. << static_cast<int>(static_cast<unsigned char>(c));
  9618. escaped << std::nouppercase;
  9619. }
  9620. }
  9621. return escaped.str();
  9622. }
  9623. inline std::string encode_uri(const std::string &value) {
  9624. std::ostringstream escaped;
  9625. escaped.fill('0');
  9626. escaped << std::hex;
  9627. for (auto c : value) {
  9628. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9629. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9630. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9631. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9632. escaped << c;
  9633. } else {
  9634. escaped << std::uppercase;
  9635. escaped << '%' << std::setw(2)
  9636. << static_cast<int>(static_cast<unsigned char>(c));
  9637. escaped << std::nouppercase;
  9638. }
  9639. }
  9640. return escaped.str();
  9641. }
  9642. inline std::string decode_uri_component(const std::string &value) {
  9643. std::string result;
  9644. for (size_t i = 0; i < value.size(); i++) {
  9645. if (value[i] == '%' && i + 2 < value.size()) {
  9646. auto val = 0;
  9647. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9648. result += static_cast<char>(val);
  9649. i += 2;
  9650. } else {
  9651. result += value[i];
  9652. }
  9653. } else {
  9654. result += value[i];
  9655. }
  9656. }
  9657. return result;
  9658. }
  9659. inline std::string decode_uri(const std::string &value) {
  9660. std::string result;
  9661. for (size_t i = 0; i < value.size(); i++) {
  9662. if (value[i] == '%' && i + 2 < value.size()) {
  9663. auto val = 0;
  9664. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9665. auto c = static_cast<char>(val);
  9666. // Keep escapes of the reserved characters that encode_uri leaves
  9667. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9668. // delimiter is not promoted into a real one (as with JS decodeURI).
  9669. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9670. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9671. c == '#') {
  9672. result += value[i];
  9673. result += value[i + 1];
  9674. result += value[i + 2];
  9675. } else {
  9676. result += c;
  9677. }
  9678. i += 2;
  9679. } else {
  9680. result += value[i];
  9681. }
  9682. } else {
  9683. result += value[i];
  9684. }
  9685. }
  9686. return result;
  9687. }
  9688. inline std::string encode_path_component(const std::string &component) {
  9689. std::string result;
  9690. result.reserve(component.size() * 3);
  9691. for (size_t i = 0; i < component.size(); i++) {
  9692. auto c = static_cast<unsigned char>(component[i]);
  9693. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9694. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9695. c == '_' || c == '~') {
  9696. result += static_cast<char>(c);
  9697. }
  9698. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9699. // "," / ";" / "="
  9700. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9701. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9702. c == '=') {
  9703. result += static_cast<char>(c);
  9704. }
  9705. // Colon is allowed in path segments except first segment
  9706. else if (c == ':') {
  9707. result += static_cast<char>(c);
  9708. }
  9709. // @ is allowed in path
  9710. else if (c == '@') {
  9711. result += static_cast<char>(c);
  9712. } else {
  9713. result += '%';
  9714. char hex[3];
  9715. snprintf(hex, sizeof(hex), "%02X", c);
  9716. result.append(hex, 2);
  9717. }
  9718. }
  9719. return result;
  9720. }
  9721. inline std::string decode_path_component(const std::string &component) {
  9722. std::string result;
  9723. result.reserve(component.size());
  9724. for (size_t i = 0; i < component.size(); i++) {
  9725. if (component[i] == '%' && i + 1 < component.size()) {
  9726. if (component[i + 1] == 'u') {
  9727. // Unicode %uXXXX encoding
  9728. auto val = 0;
  9729. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9730. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9731. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9732. char buff[4];
  9733. size_t len = detail::to_utf8(val, buff);
  9734. if (len > 0) { result.append(buff, len); }
  9735. i += 5; // 'u0000'
  9736. } else {
  9737. result += component[i];
  9738. }
  9739. } else {
  9740. // Standard %XX encoding
  9741. auto val = 0;
  9742. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9743. // 2 digits hex codes
  9744. result += static_cast<char>(val);
  9745. i += 2; // 'XX'
  9746. } else {
  9747. result += component[i];
  9748. }
  9749. }
  9750. } else {
  9751. result += component[i];
  9752. }
  9753. }
  9754. return result;
  9755. }
  9756. inline std::string encode_query_component(const std::string &component,
  9757. bool space_as_plus) {
  9758. std::string result;
  9759. result.reserve(component.size() * 3);
  9760. for (size_t i = 0; i < component.size(); i++) {
  9761. auto c = static_cast<unsigned char>(component[i]);
  9762. // Unreserved characters per RFC 3986
  9763. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9764. c == '_' || c == '~') {
  9765. result += static_cast<char>(c);
  9766. }
  9767. // Space handling
  9768. else if (c == ' ') {
  9769. if (space_as_plus) {
  9770. result += '+';
  9771. } else {
  9772. result += "%20";
  9773. }
  9774. }
  9775. // Plus sign handling
  9776. else if (c == '+') {
  9777. if (space_as_plus) {
  9778. result += "%2B";
  9779. } else {
  9780. result += static_cast<char>(c);
  9781. }
  9782. }
  9783. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9784. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9785. c == '*' || c == ',' || c == ';') {
  9786. result += static_cast<char>(c);
  9787. }
  9788. // Colon and @ are allowed in query
  9789. else if (c == ':' || c == '@') {
  9790. result += static_cast<char>(c);
  9791. }
  9792. // Forward slash is allowed in query values
  9793. else if (c == '/') {
  9794. result += static_cast<char>(c);
  9795. }
  9796. // Question mark is allowed in query values (after first ?)
  9797. else if (c == '?') {
  9798. result += static_cast<char>(c);
  9799. } else {
  9800. result += '%';
  9801. char hex[3];
  9802. snprintf(hex, sizeof(hex), "%02X", c);
  9803. result.append(hex, 2);
  9804. }
  9805. }
  9806. return result;
  9807. }
  9808. inline std::string decode_query_component(const std::string &component,
  9809. bool plus_as_space) {
  9810. std::string result;
  9811. result.reserve(component.size());
  9812. for (size_t i = 0; i < component.size(); i++) {
  9813. if (component[i] == '%' && i + 2 < component.size()) {
  9814. auto val = 0;
  9815. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9816. result += static_cast<char>(val);
  9817. i += 2;
  9818. } else {
  9819. result += component[i];
  9820. }
  9821. } else if (component[i] == '+' && plus_as_space) {
  9822. result += ' '; // + becomes space in form-urlencoded
  9823. } else {
  9824. result += component[i];
  9825. }
  9826. }
  9827. return result;
  9828. }
  9829. inline std::string sanitize_filename(const std::string &filename) {
  9830. // Extract basename: find the last path separator (/ or \)
  9831. auto pos = filename.find_last_of("/\\");
  9832. auto result =
  9833. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9834. // Strip null bytes
  9835. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9836. // Trim whitespace
  9837. {
  9838. auto start = result.find_first_not_of(" \t");
  9839. auto end = result.find_last_not_of(" \t");
  9840. result = (start == std::string::npos)
  9841. ? ""
  9842. : result.substr(start, end - start + 1);
  9843. }
  9844. // Reject . and ..
  9845. if (result == "." || result == "..") { return ""; }
  9846. return result;
  9847. }
  9848. inline std::string append_query_params(const std::string &path,
  9849. const Params &params) {
  9850. std::string path_with_query = path;
  9851. path_with_query += path.find('?') == std::string::npos ? '?' : '&';
  9852. path_with_query += detail::params_to_query_str(params);
  9853. return path_with_query;
  9854. }
  9855. // Header utilities
  9856. inline std::pair<std::string, std::string>
  9857. make_range_header(const Ranges &ranges) {
  9858. std::string field = "bytes=";
  9859. auto i = 0;
  9860. for (const auto &r : ranges) {
  9861. if (i != 0) { field += ", "; }
  9862. if (r.first != -1) { field += std::to_string(r.first); }
  9863. field += '-';
  9864. if (r.second != -1) { field += std::to_string(r.second); }
  9865. i++;
  9866. }
  9867. return std::make_pair("Range", std::move(field));
  9868. }
  9869. inline std::pair<std::string, std::string>
  9870. make_basic_authentication_header(const std::string &username,
  9871. const std::string &password, bool is_proxy) {
  9872. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9873. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9874. return std::make_pair(key, std::move(field));
  9875. }
  9876. inline std::pair<std::string, std::string>
  9877. make_bearer_token_authentication_header(const std::string &token,
  9878. bool is_proxy = false) {
  9879. auto field = "Bearer " + token;
  9880. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9881. return std::make_pair(key, std::move(field));
  9882. }
  9883. // Request implementation
  9884. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9885. size_t id) const {
  9886. return detail::get_header_value_u64(headers, key, def, id);
  9887. }
  9888. inline bool Request::has_header(const std::string &key) const {
  9889. return detail::has_header(headers, key);
  9890. }
  9891. inline std::string Request::get_header_value(const std::string &key,
  9892. const char *def, size_t id) const {
  9893. return detail::get_header_value(headers, key, def, id);
  9894. }
  9895. inline size_t Request::get_header_value_count(const std::string &key) const {
  9896. return detail::get_header_value_count(headers, key);
  9897. }
  9898. inline void Request::set_header(const std::string &key,
  9899. const std::string &val) {
  9900. detail::set_header(headers, key, val);
  9901. }
  9902. inline bool Request::has_trailer(const std::string &key) const {
  9903. return trailers.find(key) != trailers.end();
  9904. }
  9905. inline std::string Request::get_trailer_value(const std::string &key,
  9906. size_t id) const {
  9907. return detail::get_multimap_value(trailers, key, id);
  9908. }
  9909. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9910. return trailers.count(key);
  9911. }
  9912. inline bool Request::has_param(const std::string &key) const {
  9913. return params.find(key) != params.end();
  9914. }
  9915. inline std::string Request::get_param_value(const std::string &key,
  9916. size_t id) const {
  9917. return detail::get_multimap_value(params, key, id);
  9918. }
  9919. inline std::vector<std::string>
  9920. Request::get_param_values(const std::string &key) const {
  9921. auto rng = params.equal_range(key);
  9922. std::vector<std::string> values;
  9923. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9924. for (auto it = rng.first; it != rng.second; ++it) {
  9925. values.push_back(it->second);
  9926. }
  9927. return values;
  9928. }
  9929. inline size_t Request::get_param_value_count(const std::string &key) const {
  9930. return params.count(key);
  9931. }
  9932. inline bool Request::is_multipart_form_data() const {
  9933. const auto &content_type = get_header_value("Content-Type");
  9934. return detail::extract_media_type(content_type) == "multipart/form-data";
  9935. }
  9936. // Multipart FormData implementation
  9937. inline std::string MultipartFormData::get_field(const std::string &key,
  9938. size_t id) const {
  9939. auto rng = fields.equal_range(key);
  9940. auto it = detail::bounded_next(rng.first, id, rng.second);
  9941. if (it != rng.second) { return it->second.content; }
  9942. return std::string();
  9943. }
  9944. inline std::vector<std::string>
  9945. MultipartFormData::get_fields(const std::string &key) const {
  9946. std::vector<std::string> values;
  9947. auto rng = fields.equal_range(key);
  9948. for (auto it = rng.first; it != rng.second; it++) {
  9949. values.push_back(it->second.content);
  9950. }
  9951. return values;
  9952. }
  9953. inline bool MultipartFormData::has_field(const std::string &key) const {
  9954. return fields.find(key) != fields.end();
  9955. }
  9956. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9957. return fields.count(key);
  9958. }
  9959. inline FormData MultipartFormData::get_file(const std::string &key,
  9960. size_t id) const {
  9961. return detail::get_multimap_value(files, key, id);
  9962. }
  9963. inline std::vector<FormData>
  9964. MultipartFormData::get_files(const std::string &key) const {
  9965. std::vector<FormData> values;
  9966. auto rng = files.equal_range(key);
  9967. for (auto it = rng.first; it != rng.second; it++) {
  9968. values.push_back(it->second);
  9969. }
  9970. return values;
  9971. }
  9972. inline bool MultipartFormData::has_file(const std::string &key) const {
  9973. return files.find(key) != files.end();
  9974. }
  9975. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9976. return files.count(key);
  9977. }
  9978. // Multipart FormData writer implementation
  9979. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9980. return detail::is_multipart_boundary_chars_valid(boundary);
  9981. }
  9982. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9983. : boundary_(detail::make_multipart_data_boundary()) {}
  9984. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9985. : boundary_(std::move(boundary)) {}
  9986. inline const std::string &MultipartFormDataWriter::boundary() const {
  9987. return boundary_;
  9988. }
  9989. inline std::string MultipartFormDataWriter::content_type() const {
  9990. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9991. }
  9992. inline std::string
  9993. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9994. return detail::serialize_multipart_formdata(items, boundary_);
  9995. }
  9996. inline size_t MultipartFormDataWriter::content_length(
  9997. const UploadFormDataItems &items) const {
  9998. return detail::get_multipart_content_length(items, boundary_);
  9999. }
  10000. inline std::string
  10001. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10002. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10003. }
  10004. inline std::string MultipartFormDataWriter::item_end() {
  10005. return detail::serialize_multipart_formdata_item_end();
  10006. }
  10007. inline std::string MultipartFormDataWriter::finish() const {
  10008. return detail::serialize_multipart_formdata_finish(boundary_);
  10009. }
  10010. // Response implementation
  10011. namespace detail {
  10012. // A response has one content source: `body`, a content provider, or a file.
  10013. // Each content setter calls this so that the one called last wins.
  10014. inline void clear_content_provider(Response &res) {
  10015. auto releaser = std::move(res.content_provider_resource_releaser_);
  10016. auto success = res.content_provider_success_;
  10017. res.content_length_ = 0;
  10018. res.content_provider_ = nullptr;
  10019. res.content_provider_resource_releaser_ = nullptr;
  10020. res.is_chunked_content_provider_ = false;
  10021. res.is_file_content_provider_ = false;
  10022. res.content_provider_success_ = false;
  10023. res.content_coding_ = EncodingType::None;
  10024. res.file_content_path_.clear();
  10025. res.file_content_content_type_.clear();
  10026. if (releaser) { releaser(success); }
  10027. }
  10028. inline void clear_content(Response &res) {
  10029. res.body.clear();
  10030. clear_content_provider(res);
  10031. }
  10032. // `body` is public, so it can be assigned directly after a provider or a file
  10033. // was set. It came last, so it wins.
  10034. inline void prefer_assigned_body(Response &res) {
  10035. if (!res.body.empty() &&
  10036. (res.content_provider_ || !res.file_content_path_.empty())) {
  10037. clear_content_provider(res);
  10038. }
  10039. }
  10040. } // namespace detail
  10041. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10042. size_t id) const {
  10043. return detail::get_header_value_u64(headers, key, def, id);
  10044. }
  10045. inline bool Response::has_header(const std::string &key) const {
  10046. return headers.find(key) != headers.end();
  10047. }
  10048. inline std::string Response::get_header_value(const std::string &key,
  10049. const char *def,
  10050. size_t id) const {
  10051. return detail::get_header_value(headers, key, def, id);
  10052. }
  10053. inline size_t Response::get_header_value_count(const std::string &key) const {
  10054. return detail::get_header_value_count(headers, key);
  10055. }
  10056. inline void Response::set_header(const std::string &key,
  10057. const std::string &val) {
  10058. detail::set_header(headers, key, val);
  10059. }
  10060. inline bool Response::has_trailer(const std::string &key) const {
  10061. return trailers.find(key) != trailers.end();
  10062. }
  10063. inline std::string Response::get_trailer_value(const std::string &key,
  10064. size_t id) const {
  10065. return detail::get_multimap_value(trailers, key, id);
  10066. }
  10067. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10068. return trailers.count(key);
  10069. }
  10070. inline void Response::set_redirect(const std::string &url, int stat) {
  10071. if (detail::fields::is_field_value(url)) {
  10072. set_header("Location", url);
  10073. if (300 <= stat && stat < 400) {
  10074. this->status = stat;
  10075. } else {
  10076. this->status = StatusCode::Found_302;
  10077. }
  10078. }
  10079. }
  10080. inline void Response::set_content(const char *s, size_t n,
  10081. const std::string &content_type) {
  10082. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10083. detail::clear_content_provider(*this);
  10084. auto rng = headers.equal_range("Content-Type");
  10085. headers.erase(rng.first, rng.second);
  10086. set_header("Content-Type", content_type);
  10087. }
  10088. inline void Response::set_content(const std::string &s,
  10089. const std::string &content_type) {
  10090. set_content(s.data(), s.size(), content_type);
  10091. }
  10092. inline void Response::set_content(std::string &&s,
  10093. const std::string &content_type) {
  10094. body = std::move(s);
  10095. detail::clear_content_provider(*this);
  10096. auto rng = headers.equal_range("Content-Type");
  10097. headers.erase(rng.first, rng.second);
  10098. set_header("Content-Type", content_type);
  10099. }
  10100. inline void Response::set_content_provider(
  10101. size_t in_length, const std::string &content_type, ContentProvider provider,
  10102. ContentProviderResourceReleaser resource_releaser) {
  10103. detail::clear_content(*this);
  10104. set_header("Content-Type", content_type);
  10105. content_length_ = in_length;
  10106. if (in_length > 0) { content_provider_ = std::move(provider); }
  10107. content_provider_resource_releaser_ = std::move(resource_releaser);
  10108. }
  10109. inline void Response::set_content_provider(
  10110. const std::string &content_type, ContentProviderWithoutLength provider,
  10111. ContentProviderResourceReleaser resource_releaser) {
  10112. detail::clear_content(*this);
  10113. set_header("Content-Type", content_type);
  10114. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10115. content_provider_resource_releaser_ = std::move(resource_releaser);
  10116. }
  10117. inline void Response::set_chunked_content_provider(
  10118. const std::string &content_type, ContentProviderWithoutLength provider,
  10119. ContentProviderResourceReleaser resource_releaser) {
  10120. set_content_provider(content_type, std::move(provider),
  10121. std::move(resource_releaser));
  10122. is_chunked_content_provider_ = true;
  10123. }
  10124. inline void Response::set_file_content(const std::string &path,
  10125. const std::string &content_type) {
  10126. detail::clear_content(*this);
  10127. file_content_path_ = path;
  10128. file_content_content_type_ = content_type;
  10129. }
  10130. inline void Response::set_file_content(const std::string &path) {
  10131. set_file_content(path, std::string());
  10132. }
  10133. // Result implementation
  10134. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10135. size_t def,
  10136. size_t id) const {
  10137. return detail::get_header_value_u64(request_headers_, key, def, id);
  10138. }
  10139. inline bool Result::has_request_header(const std::string &key) const {
  10140. return request_headers_.find(key) != request_headers_.end();
  10141. }
  10142. inline std::string Result::get_request_header_value(const std::string &key,
  10143. const char *def,
  10144. size_t id) const {
  10145. return detail::get_header_value(request_headers_, key, def, id);
  10146. }
  10147. inline size_t
  10148. Result::get_request_header_value_count(const std::string &key) const {
  10149. return request_headers_.count(key);
  10150. }
  10151. // Stream implementation
  10152. inline ssize_t Stream::write(const char *ptr) {
  10153. return write(ptr, strlen(ptr));
  10154. }
  10155. inline ssize_t Stream::write(const std::string &s) {
  10156. return write(s.data(), s.size());
  10157. }
  10158. // BodyReader implementation
  10159. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10160. if (!stream) {
  10161. last_error = Error::Connection;
  10162. return -1;
  10163. }
  10164. if (eof) { return 0; }
  10165. if (!chunked) {
  10166. // Content-Length based reading
  10167. if (has_content_length && bytes_read >= content_length) {
  10168. eof = true;
  10169. return 0;
  10170. }
  10171. auto to_read = len;
  10172. if (has_content_length) {
  10173. auto remaining = content_length - bytes_read;
  10174. to_read = (std::min)(len, remaining);
  10175. }
  10176. auto n = stream->read(buf, to_read);
  10177. if (n < 0) {
  10178. last_error = stream->get_error();
  10179. if (last_error == Error::Success) { last_error = Error::Read; }
  10180. eof = true;
  10181. return n;
  10182. }
  10183. if (n == 0) {
  10184. // Unexpected EOF before content_length
  10185. last_error = stream->get_error();
  10186. if (last_error == Error::Success) { last_error = Error::Read; }
  10187. eof = true;
  10188. return 0;
  10189. }
  10190. bytes_read += static_cast<size_t>(n);
  10191. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10192. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10193. last_error = Error::ExceedMaxPayloadSize;
  10194. eof = true;
  10195. return -1;
  10196. }
  10197. return n;
  10198. }
  10199. // Chunked transfer encoding: delegate to shared decoder instance.
  10200. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10201. size_t chunk_offset = 0;
  10202. size_t chunk_total = 0;
  10203. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10204. if (n < 0) {
  10205. last_error = stream->get_error();
  10206. if (last_error == Error::Success) { last_error = Error::Read; }
  10207. eof = true;
  10208. return n;
  10209. }
  10210. if (n == 0) {
  10211. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10212. eof = true;
  10213. return 0;
  10214. }
  10215. bytes_read += static_cast<size_t>(n);
  10216. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10217. last_error = Error::ExceedMaxPayloadSize;
  10218. eof = true;
  10219. return -1;
  10220. }
  10221. return n;
  10222. }
  10223. // ThreadPool implementation
  10224. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10225. time_t idle_timeout_sec)
  10226. : base_thread_count_(n), max_queued_requests_(mqr),
  10227. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10228. shutdown_(false) {
  10229. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10230. if (max_n != 0 && max_n < n) {
  10231. std::string msg = "max_threads must be >= base_threads";
  10232. throw std::invalid_argument(msg);
  10233. }
  10234. #endif
  10235. max_thread_count_ = max_n == 0 ? n : max_n;
  10236. threads_.reserve(base_thread_count_);
  10237. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10238. try {
  10239. #endif
  10240. for (size_t i = 0; i < base_thread_count_; i++) {
  10241. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10242. }
  10243. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10244. } catch (...) {
  10245. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10246. // signal the workers we already spawned to exit and join them so the
  10247. // vector destructor does not see joinable threads (which would call
  10248. // std::terminate). Then rethrow so the caller learns of the failure.
  10249. {
  10250. std::unique_lock<std::mutex> lock(mutex_);
  10251. shutdown_ = true;
  10252. }
  10253. cond_.notify_all();
  10254. for (auto &t : threads_) {
  10255. if (t.joinable()) { t.join(); }
  10256. }
  10257. throw;
  10258. }
  10259. #endif
  10260. }
  10261. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10262. {
  10263. std::unique_lock<std::mutex> lock(mutex_);
  10264. if (shutdown_) { return false; }
  10265. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10266. return false;
  10267. }
  10268. jobs_.push_back(std::move(fn));
  10269. // Spawn a dynamic thread if no idle threads and under max
  10270. if (idle_thread_count_ == 0 &&
  10271. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10272. cleanup_finished_threads();
  10273. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10274. }
  10275. }
  10276. cond_.notify_one();
  10277. return true;
  10278. }
  10279. inline void ThreadPool::shutdown() {
  10280. {
  10281. std::unique_lock<std::mutex> lock(mutex_);
  10282. shutdown_ = true;
  10283. }
  10284. cond_.notify_all();
  10285. for (auto &t : threads_) {
  10286. if (t.joinable()) { t.join(); }
  10287. }
  10288. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10289. // with worker threads that call move_to_finished() concurrently.
  10290. std::list<std::thread> remaining_dynamic;
  10291. {
  10292. std::unique_lock<std::mutex> lock(mutex_);
  10293. remaining_dynamic = std::move(dynamic_threads_);
  10294. }
  10295. for (auto &t : remaining_dynamic) {
  10296. if (t.joinable()) { t.join(); }
  10297. }
  10298. std::unique_lock<std::mutex> lock(mutex_);
  10299. cleanup_finished_threads();
  10300. }
  10301. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10302. // Must be called with mutex_ held
  10303. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10304. if (it->get_id() == id) {
  10305. finished_threads_.push_back(std::move(*it));
  10306. dynamic_threads_.erase(it);
  10307. return;
  10308. }
  10309. }
  10310. }
  10311. inline void ThreadPool::cleanup_finished_threads() {
  10312. // Must be called with mutex_ held
  10313. for (auto &t : finished_threads_) {
  10314. if (t.joinable()) { t.join(); }
  10315. }
  10316. finished_threads_.clear();
  10317. }
  10318. inline void ThreadPool::worker(bool is_dynamic) {
  10319. for (;;) {
  10320. std::function<void()> fn;
  10321. {
  10322. std::unique_lock<std::mutex> lock(mutex_);
  10323. idle_thread_count_++;
  10324. if (is_dynamic) {
  10325. auto has_work =
  10326. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10327. [&] { return !jobs_.empty() || shutdown_; });
  10328. if (!has_work) {
  10329. // Timed out with no work - exit this dynamic thread
  10330. idle_thread_count_--;
  10331. move_to_finished(std::this_thread::get_id());
  10332. break;
  10333. }
  10334. } else {
  10335. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10336. }
  10337. idle_thread_count_--;
  10338. if (shutdown_ && jobs_.empty()) { break; }
  10339. fn = std::move(jobs_.front());
  10340. jobs_.pop_front();
  10341. }
  10342. assert(true == static_cast<bool>(fn));
  10343. fn();
  10344. }
  10345. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10346. !defined(LIBRESSL_VERSION_NUMBER)
  10347. OPENSSL_thread_stop();
  10348. #endif
  10349. }
  10350. /*
  10351. * Group 1 (continued): detail namespace - Stream implementations
  10352. */
  10353. namespace detail {
  10354. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10355. time_t timeout_sec, time_t timeout_usec,
  10356. time_t &actual_timeout_sec,
  10357. time_t &actual_timeout_usec) {
  10358. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10359. auto actual_timeout_msec =
  10360. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10361. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10362. actual_timeout_sec = actual_timeout_msec / 1000;
  10363. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10364. }
  10365. // Socket stream implementation
  10366. inline SocketStream::SocketStream(
  10367. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10368. time_t write_timeout_sec, time_t write_timeout_usec,
  10369. time_t max_timeout_msec,
  10370. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10371. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10372. read_timeout_usec_(read_timeout_usec),
  10373. write_timeout_sec_(write_timeout_sec),
  10374. write_timeout_usec_(write_timeout_usec),
  10375. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10376. read_buff_(read_buff_size_, 0) {}
  10377. inline SocketStream::~SocketStream() = default;
  10378. inline bool SocketStream::is_readable() const {
  10379. return read_buff_off_ < read_buff_content_size_;
  10380. }
  10381. inline bool SocketStream::wait_readable() const {
  10382. if (max_timeout_msec_ <= 0) {
  10383. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10384. }
  10385. time_t read_timeout_sec;
  10386. time_t read_timeout_usec;
  10387. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10388. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10389. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10390. }
  10391. inline bool SocketStream::wait_writable() const {
  10392. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10393. }
  10394. inline bool SocketStream::ensure_readable() {
  10395. if (readable_hint_) {
  10396. readable_hint_ = false;
  10397. return true;
  10398. }
  10399. return wait_readable();
  10400. }
  10401. inline const char *SocketStream::buffered_data(size_t &size) const {
  10402. size = read_buff_content_size_ - read_buff_off_;
  10403. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10404. }
  10405. inline void SocketStream::consume_buffered(size_t size) {
  10406. assert(size <= read_buff_content_size_ - read_buff_off_);
  10407. read_buff_off_ += size;
  10408. }
  10409. inline bool SocketStream::is_peer_alive() const {
  10410. return detail::is_socket_alive(sock_);
  10411. }
  10412. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10413. #ifdef _WIN32
  10414. size =
  10415. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10416. #else
  10417. size = (std::min)(size,
  10418. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10419. #endif
  10420. if (read_buff_off_ < read_buff_content_size_) {
  10421. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10422. if (size <= remaining_size) {
  10423. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10424. read_buff_off_ += size;
  10425. return static_cast<ssize_t>(size);
  10426. } else {
  10427. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10428. read_buff_off_ += remaining_size;
  10429. return static_cast<ssize_t>(remaining_size);
  10430. }
  10431. }
  10432. if (!ensure_readable()) {
  10433. error_ = Error::Timeout;
  10434. return -1;
  10435. }
  10436. read_buff_off_ = 0;
  10437. read_buff_content_size_ = 0;
  10438. if (size < read_buff_size_) {
  10439. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10440. CPPHTTPLIB_RECV_FLAGS);
  10441. if (n <= 0) {
  10442. if (n == 0) {
  10443. error_ = Error::ConnectionClosed;
  10444. } else {
  10445. error_ = Error::Read;
  10446. }
  10447. return n;
  10448. } else if (n <= static_cast<ssize_t>(size)) {
  10449. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10450. return n;
  10451. } else {
  10452. memcpy(ptr, read_buff_.data(), size);
  10453. read_buff_off_ = size;
  10454. read_buff_content_size_ = static_cast<size_t>(n);
  10455. return static_cast<ssize_t>(size);
  10456. }
  10457. } else {
  10458. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10459. if (n <= 0) {
  10460. if (n == 0) {
  10461. error_ = Error::ConnectionClosed;
  10462. } else {
  10463. error_ = Error::Read;
  10464. }
  10465. }
  10466. return n;
  10467. }
  10468. }
  10469. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10470. if (!wait_writable()) { return -1; }
  10471. #if defined(_WIN32) && !defined(_WIN64)
  10472. size =
  10473. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10474. #endif
  10475. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10476. }
  10477. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10478. int &port) const {
  10479. return detail::get_remote_ip_and_port(sock_, ip, port);
  10480. }
  10481. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10482. int &port) const {
  10483. return detail::get_local_ip_and_port(sock_, ip, port);
  10484. }
  10485. inline socket_t SocketStream::socket() const { return sock_; }
  10486. inline time_t SocketStream::duration() const {
  10487. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10488. std::chrono::steady_clock::now() - start_time_)
  10489. .count();
  10490. }
  10491. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10492. read_timeout_sec_ = sec;
  10493. read_timeout_usec_ = usec;
  10494. }
  10495. // Buffer stream implementation
  10496. inline bool BufferStream::is_readable() const { return true; }
  10497. inline bool BufferStream::wait_readable() const { return true; }
  10498. inline bool BufferStream::wait_writable() const { return true; }
  10499. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10500. #if defined(_MSC_VER) && _MSC_VER < 1910
  10501. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10502. #else
  10503. auto len_read = buffer.copy(ptr, size, position);
  10504. #endif
  10505. position += static_cast<size_t>(len_read);
  10506. return static_cast<ssize_t>(len_read);
  10507. }
  10508. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10509. buffer.append(ptr, size);
  10510. return static_cast<ssize_t>(size);
  10511. }
  10512. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10513. int & /*port*/) const {}
  10514. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10515. int & /*port*/) const {}
  10516. inline socket_t BufferStream::socket() const { return 0; }
  10517. inline time_t BufferStream::duration() const { return 0; }
  10518. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10519. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10520. : MatcherBase(pattern) {
  10521. constexpr const char marker[] = "/:";
  10522. // One past the last ending position of a path param substring
  10523. std::size_t last_param_end = 0;
  10524. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10525. // Needed to ensure that parameter names are unique during matcher
  10526. // construction
  10527. // If exceptions are disabled, only last duplicate path
  10528. // parameter will be set
  10529. std::unordered_set<std::string> param_name_set;
  10530. #endif
  10531. while (true) {
  10532. const auto marker_pos = pattern.find(
  10533. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10534. if (marker_pos == std::string::npos) { break; }
  10535. static_fragments_.push_back(
  10536. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10537. const auto param_name_start = marker_pos + str_len(marker);
  10538. auto sep_pos = pattern.find(separator, param_name_start);
  10539. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10540. auto param_name =
  10541. pattern.substr(param_name_start, sep_pos - param_name_start);
  10542. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10543. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10544. std::string msg = "Encountered path parameter '" + param_name +
  10545. "' multiple times in route pattern '" + pattern + "'.";
  10546. throw std::invalid_argument(msg);
  10547. }
  10548. #endif
  10549. param_names_.push_back(std::move(param_name));
  10550. last_param_end = sep_pos + 1;
  10551. }
  10552. if (last_param_end < pattern.length()) {
  10553. static_fragments_.push_back(pattern.substr(last_param_end));
  10554. }
  10555. }
  10556. inline bool PathParamsMatcher::match(Request &request) const {
  10557. request.matches = std::smatch();
  10558. request.path_params.clear();
  10559. // A pattern without parameters is just a literal path to compare against
  10560. if (param_names_.empty()) { return request.path == pattern(); }
  10561. request.path_params.reserve(param_names_.size());
  10562. // One past the position at which the path matched the pattern last time
  10563. std::size_t starting_pos = 0;
  10564. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10565. const auto &fragment = static_fragments_[i];
  10566. if (starting_pos + fragment.length() > request.path.length()) {
  10567. return false;
  10568. }
  10569. // Avoid unnecessary allocation by using strncmp instead of substr +
  10570. // comparison
  10571. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10572. fragment.length()) != 0) {
  10573. return false;
  10574. }
  10575. starting_pos += fragment.length();
  10576. // Should only happen when we have a static fragment after a param
  10577. // Example: '/users/:id/subscriptions'
  10578. // The 'subscriptions' fragment here does not have a corresponding param
  10579. if (i >= param_names_.size()) { continue; }
  10580. auto sep_pos = request.path.find(separator, starting_pos);
  10581. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10582. const auto &param_name = param_names_[i];
  10583. request.path_params.emplace(
  10584. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10585. // Mark everything up to '/' as matched
  10586. starting_pos = sep_pos + 1;
  10587. }
  10588. // Returns false if the path is longer than the pattern
  10589. return starting_pos >= request.path.length();
  10590. }
  10591. inline bool RegexMatcher::match(Request &request) const {
  10592. request.path_params.clear();
  10593. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10594. // a non-match rather than risking a stack overflow in std::regex_match.
  10595. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10596. return false;
  10597. }
  10598. return std::regex_match(request.path, request.matches, regex_);
  10599. }
  10600. // Enclose IPv6 address in brackets if needed
  10601. inline std::string prepare_host_string(const std::string &host) {
  10602. // Enclose IPv6 address in brackets (but not if already enclosed)
  10603. if (host.find(':') == std::string::npos ||
  10604. (!host.empty() && host[0] == '[')) {
  10605. // IPv4, hostname, or already bracketed IPv6
  10606. return host;
  10607. } else {
  10608. // IPv6 address without brackets
  10609. return "[" + host + "]";
  10610. }
  10611. }
  10612. inline std::string make_host_and_port_string(const std::string &host, int port,
  10613. bool is_ssl) {
  10614. auto result = prepare_host_string(host);
  10615. // Append port if not default
  10616. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10617. ; // do nothing
  10618. } else {
  10619. result += ":" + std::to_string(port);
  10620. }
  10621. return result;
  10622. }
  10623. // Create "host:port" string always including port number (for CONNECT method)
  10624. inline std::string
  10625. make_host_and_port_string_always_port(const std::string &host, int port) {
  10626. return prepare_host_string(host) + ":" + std::to_string(port);
  10627. }
  10628. // Value for the Host header a client sends when the caller supplied none.
  10629. // Only the value: callers decide where in their header list it goes.
  10630. inline std::string make_default_host_header_value(const std::string &host,
  10631. int port, bool is_ssl,
  10632. int address_family) {
  10633. if (address_family == AF_UNIX) { return "localhost"; }
  10634. return make_host_and_port_string(host, port, is_ssl);
  10635. }
  10636. inline void add_default_user_agent_header(Request &req) {
  10637. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10638. if (!req.has_header("User-Agent")) {
  10639. req.set_header("User-Agent",
  10640. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10641. }
  10642. #else
  10643. (void)req;
  10644. #endif
  10645. }
  10646. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10647. NormalizedTarget normalize_target(const std::string &host);
  10648. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10649. bool host_matches_no_proxy(const NormalizedTarget &target,
  10650. const std::vector<NoProxyEntry> &entries);
  10651. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10652. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10653. if (prefix_bits == 0) { return true; }
  10654. int full_bytes = prefix_bits / 8;
  10655. int rem_bits = prefix_bits % 8;
  10656. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10657. static_cast<size_t>(full_bytes)) != 0) {
  10658. return false;
  10659. }
  10660. if (rem_bits == 0) { return true; }
  10661. auto i = static_cast<size_t>(full_bytes);
  10662. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10663. return (ip[i] & mask) == (net[i] & mask);
  10664. }
  10665. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10666. if (token.empty()) { return false; }
  10667. if (token == "*") {
  10668. out.kind = NoProxyKind::Wildcard;
  10669. return true;
  10670. }
  10671. auto slash = token.find('/');
  10672. std::string addr_part =
  10673. (slash == std::string::npos) ? token : token.substr(0, slash);
  10674. std::string prefix_part =
  10675. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10676. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10677. // don't silently treat it as a /32 (or /128).
  10678. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10679. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10680. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10681. // when brackets are present.
  10682. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10683. addr_part.back() == ']';
  10684. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10685. if (!bracketed) {
  10686. struct in_addr v4;
  10687. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10688. int prefix = 32;
  10689. if (!prefix_part.empty() &&
  10690. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10691. prefix)) {
  10692. return false;
  10693. }
  10694. out.kind = NoProxyKind::IPv4Cidr;
  10695. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10696. out.prefix_bits = prefix;
  10697. return true;
  10698. }
  10699. }
  10700. struct in6_addr v6;
  10701. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10702. int prefix = 128;
  10703. if (!prefix_part.empty() &&
  10704. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10705. prefix)) {
  10706. return false;
  10707. }
  10708. out.kind = NoProxyKind::IPv6Cidr;
  10709. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10710. out.prefix_bits = prefix;
  10711. return true;
  10712. }
  10713. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10714. // the entry is malformed — don't fall through to the hostname branch.
  10715. if (bracketed) { return false; }
  10716. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10717. if (slash != std::string::npos) { return false; }
  10718. // Port-specific entries (host:port) are not supported.
  10719. if (token.find(':') != std::string::npos) { return false; }
  10720. std::string hostname = case_ignore::to_lower(token);
  10721. while (!hostname.empty() && hostname.front() == '.') {
  10722. hostname.erase(hostname.begin());
  10723. }
  10724. while (!hostname.empty() && hostname.back() == '.') {
  10725. hostname.pop_back();
  10726. }
  10727. if (hostname.empty()) { return false; }
  10728. out.kind = NoProxyKind::HostnameSuffix;
  10729. out.hostname_pattern = std::move(hostname);
  10730. return true;
  10731. }
  10732. inline NormalizedTarget normalize_target(const std::string &host) {
  10733. NormalizedTarget t;
  10734. std::string h = host;
  10735. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10736. h = h.substr(1, h.size() - 2);
  10737. }
  10738. // Strip a single trailing dot so "example.com." canonicalizes to
  10739. // "example.com".
  10740. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10741. t.hostname = case_ignore::to_lower(h);
  10742. if (!t.hostname.empty()) {
  10743. struct in_addr v4;
  10744. struct in6_addr v6;
  10745. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10746. t.is_ipv4 = true;
  10747. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10748. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10749. t.is_ipv6 = true;
  10750. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10751. }
  10752. }
  10753. return t;
  10754. }
  10755. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10756. const std::vector<NoProxyEntry> &entries) {
  10757. if (target.hostname.empty()) { return false; }
  10758. for (const auto &e : entries) {
  10759. switch (e.kind) {
  10760. case NoProxyKind::Wildcard: return true;
  10761. case NoProxyKind::IPv4Cidr:
  10762. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10763. return true;
  10764. }
  10765. break;
  10766. case NoProxyKind::IPv6Cidr:
  10767. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10768. return true;
  10769. }
  10770. break;
  10771. case NoProxyKind::HostnameSuffix:
  10772. if (target.is_ipv4 || target.is_ipv6) { break; }
  10773. if (target.hostname == e.hostname_pattern) { return true; }
  10774. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10775. // an entry of "example.com".
  10776. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10777. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10778. if (target.hostname[offset - 1] == '.' &&
  10779. target.hostname.compare(offset, e.hostname_pattern.size(),
  10780. e.hostname_pattern) == 0) {
  10781. return true;
  10782. }
  10783. }
  10784. break;
  10785. }
  10786. }
  10787. return false;
  10788. }
  10789. template <typename T>
  10790. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10791. T header_writer, Error &error) {
  10792. for (const auto &h : headers) {
  10793. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10794. error = Error::InvalidHeaders;
  10795. return false;
  10796. }
  10797. }
  10798. if (header_writer(strm, headers) <= 0) {
  10799. error = Error::Write;
  10800. return false;
  10801. }
  10802. return true;
  10803. }
  10804. } // namespace detail
  10805. /*
  10806. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10807. */
  10808. #ifdef CPPHTTPLIB_SSL_ENABLED
  10809. namespace detail {
  10810. // SSL socket stream implementation
  10811. inline SSLSocketStream::SSLSocketStream(
  10812. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10813. time_t read_timeout_usec, time_t write_timeout_sec,
  10814. time_t write_timeout_usec, time_t max_timeout_msec,
  10815. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10816. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10817. read_timeout_usec_(read_timeout_usec),
  10818. write_timeout_sec_(write_timeout_sec),
  10819. write_timeout_usec_(write_timeout_usec),
  10820. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10821. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10822. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10823. // Note: create_session() also clears this, but SSLClient currently
  10824. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10825. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10826. // SSL session was created.
  10827. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10828. #endif
  10829. }
  10830. inline SSLSocketStream::~SSLSocketStream() = default;
  10831. inline bool SSLSocketStream::is_readable() const {
  10832. return tls::pending(session_) > 0;
  10833. }
  10834. inline bool SSLSocketStream::wait_readable() const {
  10835. if (max_timeout_msec_ <= 0) {
  10836. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10837. }
  10838. time_t read_timeout_sec;
  10839. time_t read_timeout_usec;
  10840. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10841. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10842. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10843. }
  10844. inline bool SSLSocketStream::wait_writable() const {
  10845. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10846. !tls::is_peer_closed(session_, sock_);
  10847. }
  10848. inline bool SSLSocketStream::ensure_readable() {
  10849. if (readable_hint_) {
  10850. readable_hint_ = false;
  10851. return true;
  10852. }
  10853. return wait_readable();
  10854. }
  10855. inline bool SSLSocketStream::is_peer_alive() const {
  10856. return !tls::is_peer_closed(session_, sock_);
  10857. }
  10858. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10859. if (tls::pending(session_) > 0) {
  10860. tls::TlsError err;
  10861. auto ret = tls::read(session_, ptr, size, err);
  10862. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10863. error_ = Error::ConnectionClosed;
  10864. }
  10865. return ret;
  10866. } else if (ensure_readable()) {
  10867. tls::TlsError err;
  10868. auto ret = tls::read(session_, ptr, size, err);
  10869. if (ret < 0) {
  10870. auto n = 1000;
  10871. #ifdef _WIN32
  10872. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10873. (err.code == tls::ErrorCode::SyscallError &&
  10874. WSAGetLastError() == WSAETIMEDOUT))) {
  10875. #else
  10876. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10877. #endif
  10878. if (tls::pending(session_) > 0) {
  10879. return tls::read(session_, ptr, size, err);
  10880. } else if (wait_readable()) {
  10881. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10882. ret = tls::read(session_, ptr, size, err);
  10883. if (ret >= 0) { return ret; }
  10884. } else {
  10885. break;
  10886. }
  10887. }
  10888. assert(ret < 0);
  10889. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10890. error_ = Error::ConnectionClosed;
  10891. }
  10892. return ret;
  10893. } else {
  10894. error_ = Error::Timeout;
  10895. return -1;
  10896. }
  10897. }
  10898. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10899. if (wait_writable()) {
  10900. auto handle_size =
  10901. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10902. tls::TlsError err;
  10903. auto ret = tls::write(session_, ptr, handle_size, err);
  10904. if (ret < 0) {
  10905. auto n = 1000;
  10906. #ifdef _WIN32
  10907. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10908. (err.code == tls::ErrorCode::SyscallError &&
  10909. WSAGetLastError() == WSAETIMEDOUT))) {
  10910. #else
  10911. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10912. #endif
  10913. if (wait_writable()) {
  10914. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10915. ret = tls::write(session_, ptr, handle_size, err);
  10916. if (ret >= 0) { return ret; }
  10917. } else {
  10918. break;
  10919. }
  10920. }
  10921. assert(ret < 0);
  10922. }
  10923. return ret;
  10924. }
  10925. return -1;
  10926. }
  10927. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10928. int &port) const {
  10929. detail::get_remote_ip_and_port(sock_, ip, port);
  10930. }
  10931. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10932. int &port) const {
  10933. detail::get_local_ip_and_port(sock_, ip, port);
  10934. }
  10935. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10936. inline time_t SSLSocketStream::duration() const {
  10937. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10938. std::chrono::steady_clock::now() - start_time_)
  10939. .count();
  10940. }
  10941. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10942. read_timeout_sec_ = sec;
  10943. read_timeout_usec_ = usec;
  10944. }
  10945. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10946. tls::session_t session,
  10947. time_t read_timeout_sec,
  10948. time_t read_timeout_usec,
  10949. time_t write_timeout_sec,
  10950. time_t write_timeout_usec)
  10951. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10952. read_timeout_usec_(read_timeout_usec),
  10953. write_timeout_sec_(write_timeout_sec),
  10954. write_timeout_usec_(write_timeout_usec),
  10955. start_time_(std::chrono::steady_clock::now()) {
  10956. // The receive and send paths run on different threads, so each TLS call is
  10957. // driven in non-blocking mode and readiness is awaited with select()
  10958. // outside the session lock. Set the socket non-blocking once here; it is
  10959. // never flipped back, so no thread races on the flag.
  10960. detail::set_nonblocking(sock_, true);
  10961. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10962. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10963. #endif
  10964. }
  10965. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10966. inline bool WebSocketSSLStream::is_readable() const {
  10967. std::lock_guard<std::mutex> guard(session_mutex_);
  10968. return tls::pending(session_) > 0;
  10969. }
  10970. inline bool WebSocketSSLStream::wait_readable() const {
  10971. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10972. }
  10973. inline bool WebSocketSSLStream::wait_writable() const {
  10974. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10975. // that probe toggles the socket's blocking flag, which would race with the
  10976. // concurrent reader on a permanently non-blocking socket.
  10977. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10978. }
  10979. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10980. tls::TlsError err;
  10981. auto n = 1000;
  10982. while (--n >= 0) {
  10983. {
  10984. std::lock_guard<std::mutex> guard(session_mutex_);
  10985. auto ret = tls::read(session_, ptr, size, err);
  10986. if (ret > 0) { return ret; }
  10987. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10988. error_ = Error::ConnectionClosed;
  10989. return ret;
  10990. }
  10991. }
  10992. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10993. // direction: the send path shares this session, so output it left pending
  10994. // has to be flushed before more input can be decrypted. Anything else is
  10995. // a hard error.
  10996. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10997. #ifdef _WIN32
  10998. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10999. needs_readable =
  11000. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11001. WSAGetLastError() == WSAETIMEDOUT);
  11002. #endif
  11003. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11004. error_ = Error::Read;
  11005. return -1;
  11006. }
  11007. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11008. error_ = Error::Timeout;
  11009. return -1;
  11010. }
  11011. }
  11012. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11013. // to tell a timeout from a close would otherwise see whatever the previous
  11014. // failure left behind (error_ is never cleared on success).
  11015. error_ = Error::Read;
  11016. return -1;
  11017. }
  11018. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11019. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11020. tls::TlsError err;
  11021. auto n = 1000;
  11022. while (--n >= 0) {
  11023. {
  11024. std::lock_guard<std::mutex> guard(session_mutex_);
  11025. auto ret = tls::write(session_, ptr, handle_size, err);
  11026. if (ret >= 0) { return ret; }
  11027. }
  11028. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11029. // or a post-handshake message must be consumed before the record goes
  11030. // out. Anything else is a hard error.
  11031. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11032. #ifdef _WIN32
  11033. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11034. needs_writable =
  11035. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11036. WSAGetLastError() == WSAETIMEDOUT);
  11037. #endif
  11038. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11039. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11040. }
  11041. return -1;
  11042. }
  11043. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11044. int &port) const {
  11045. detail::get_remote_ip_and_port(sock_, ip, port);
  11046. }
  11047. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11048. int &port) const {
  11049. detail::get_local_ip_and_port(sock_, ip, port);
  11050. }
  11051. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11052. inline time_t WebSocketSSLStream::duration() const {
  11053. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11054. std::chrono::steady_clock::now() - start_time_)
  11055. .count();
  11056. }
  11057. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11058. read_timeout_sec_ = sec;
  11059. read_timeout_usec_ = usec;
  11060. }
  11061. } // namespace detail
  11062. #endif // CPPHTTPLIB_SSL_ENABLED
  11063. /*
  11064. * Group 4: Server implementation
  11065. */
  11066. // HTTP server implementation
  11067. inline Server::Server()
  11068. : new_task_queue([] {
  11069. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11070. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11071. }) {
  11072. #ifndef _WIN32
  11073. signal(SIGPIPE, SIG_IGN);
  11074. #endif
  11075. }
  11076. inline Server::~Server() = default;
  11077. inline std::unique_ptr<detail::MatcherBase>
  11078. Server::make_matcher(const std::string &pattern) {
  11079. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11080. // a path params pattern
  11081. if (pattern.find("/:") != std::string::npos) {
  11082. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11083. }
  11084. // A pattern with no regex metacharacter only has to be compared literally,
  11085. // which is what PathParamsMatcher already does when it captures no
  11086. // parameter, so std::regex is only worth building for the patterns that
  11087. // actually need it
  11088. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11089. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11090. }
  11091. return detail::make_unique<detail::RegexMatcher>(pattern);
  11092. }
  11093. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11094. return add_handler(get_handlers_, pattern, std::move(handler));
  11095. }
  11096. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11097. return add_handler(post_handlers_, pattern, std::move(handler));
  11098. }
  11099. inline Server &Server::Post(const std::string &pattern,
  11100. HandlerWithContentReader handler) {
  11101. return add_handler(post_handlers_for_content_reader_, pattern,
  11102. std::move(handler));
  11103. }
  11104. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11105. return add_handler(put_handlers_, pattern, std::move(handler));
  11106. }
  11107. inline Server &Server::Put(const std::string &pattern,
  11108. HandlerWithContentReader handler) {
  11109. return add_handler(put_handlers_for_content_reader_, pattern,
  11110. std::move(handler));
  11111. }
  11112. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11113. return add_handler(patch_handlers_, pattern, std::move(handler));
  11114. }
  11115. inline Server &Server::Patch(const std::string &pattern,
  11116. HandlerWithContentReader handler) {
  11117. return add_handler(patch_handlers_for_content_reader_, pattern,
  11118. std::move(handler));
  11119. }
  11120. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11121. return add_handler(delete_handlers_, pattern, std::move(handler));
  11122. }
  11123. inline Server &Server::Delete(const std::string &pattern,
  11124. HandlerWithContentReader handler) {
  11125. return add_handler(delete_handlers_for_content_reader_, pattern,
  11126. std::move(handler));
  11127. }
  11128. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11129. return add_handler(options_handlers_, pattern, std::move(handler));
  11130. }
  11131. inline const std::set<std::string> &Server::builtin_methods() {
  11132. thread_local const std::set<std::string> methods{
  11133. "GET", "HEAD", "POST", "PUT", "DELETE",
  11134. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11135. return methods;
  11136. }
  11137. inline Server::CustomHandlerEntry *
  11138. Server::custom_entry_for_registration(const std::string &method) {
  11139. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11140. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11141. // routing() before the custom tables are consulted, so a route registered
  11142. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11143. // there and would be reachable, but they carry protocol-level meaning
  11144. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11145. // library does not route.
  11146. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11147. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11148. has_invalid_registration_ = true;
  11149. return nullptr;
  11150. }
  11151. return &custom_handlers_[method];
  11152. }
  11153. inline Server &Server::CustomRoute(const std::string &method,
  11154. const std::string &pattern,
  11155. Handler handler) {
  11156. auto *entry = custom_entry_for_registration(method);
  11157. if (!entry) { return *this; }
  11158. return add_handler(entry->handlers, pattern, std::move(handler));
  11159. }
  11160. inline Server &Server::CustomRoute(const std::string &method,
  11161. const std::string &pattern,
  11162. HandlerWithContentReader handler) {
  11163. auto *entry = custom_entry_for_registration(method);
  11164. if (!entry) { return *this; }
  11165. return add_handler(entry->handlers_for_content_reader, pattern,
  11166. std::move(handler));
  11167. }
  11168. inline const Server::CustomHandlerEntry *
  11169. Server::find_custom_entry(const std::string &method) const {
  11170. // find() alone would be correct here. The empty() check is what keeps the
  11171. // per-request cost off servers that never call CustomRoute(), which is the
  11172. // overwhelmingly common case; keep it rather than walking into the tree.
  11173. if (custom_handlers_.empty()) { return nullptr; }
  11174. auto it = custom_handlers_.find(method);
  11175. return it == custom_handlers_.end() ? nullptr : &it->second;
  11176. }
  11177. inline Server &Server::WebSocket(const std::string &pattern,
  11178. WebSocketHandler handler) {
  11179. websocket_handlers_.push_back(
  11180. {make_matcher(pattern), std::move(handler), nullptr});
  11181. return *this;
  11182. }
  11183. inline Server &Server::WebSocket(const std::string &pattern,
  11184. WebSocketHandler handler,
  11185. SubProtocolSelector sub_protocol_selector) {
  11186. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11187. std::move(sub_protocol_selector)});
  11188. return *this;
  11189. }
  11190. inline bool Server::set_base_dir(const std::string &dir,
  11191. const std::string &mount_point) {
  11192. return set_mount_point(mount_point, dir);
  11193. }
  11194. inline bool Server::set_mount_point(const std::string &mount_point,
  11195. const std::string &dir, Headers headers) {
  11196. detail::FileStat stat(dir);
  11197. if (stat.is_dir()) {
  11198. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11199. if (!mnt.empty() && mnt[0] == '/') {
  11200. std::string resolved_base;
  11201. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11202. #if defined(_WIN32)
  11203. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11204. resolved_base += '\\';
  11205. }
  11206. #else
  11207. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11208. #endif
  11209. }
  11210. base_dirs_.push_back(
  11211. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11212. return true;
  11213. }
  11214. }
  11215. return false;
  11216. }
  11217. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11218. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11219. if (it->mount_point == mount_point) {
  11220. base_dirs_.erase(it);
  11221. return true;
  11222. }
  11223. }
  11224. return false;
  11225. }
  11226. inline Server &
  11227. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11228. const std::string &mime) {
  11229. file_extension_and_mimetype_map_[ext] = mime;
  11230. return *this;
  11231. }
  11232. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11233. default_file_mimetype_ = mime;
  11234. return *this;
  11235. }
  11236. inline Server &Server::set_file_request_handler(Handler handler) {
  11237. file_request_handler_ = std::move(handler);
  11238. return *this;
  11239. }
  11240. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11241. std::true_type) {
  11242. error_handler_ = std::move(handler);
  11243. return *this;
  11244. }
  11245. inline Server &Server::set_error_handler_core(Handler handler,
  11246. std::false_type) {
  11247. error_handler_ = [handler](const Request &req, Response &res) {
  11248. handler(req, res);
  11249. return HandlerResponse::Handled;
  11250. };
  11251. return *this;
  11252. }
  11253. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11254. exception_handler_ = std::move(handler);
  11255. return *this;
  11256. }
  11257. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11258. pre_routing_handler_ = std::move(handler);
  11259. return *this;
  11260. }
  11261. inline Server &Server::set_post_routing_handler(Handler handler) {
  11262. post_routing_handler_ = std::move(handler);
  11263. return *this;
  11264. }
  11265. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11266. pre_request_handler_ = std::move(handler);
  11267. return *this;
  11268. }
  11269. inline Server &Server::set_logger(Logger logger) {
  11270. logger_ = std::move(logger);
  11271. return *this;
  11272. }
  11273. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11274. error_logger_ = std::move(error_logger);
  11275. return *this;
  11276. }
  11277. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11278. pre_compression_logger_ = std::move(logger);
  11279. return *this;
  11280. }
  11281. inline Server &
  11282. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11283. expect_100_continue_handler_ = std::move(handler);
  11284. return *this;
  11285. }
  11286. inline Server &Server::set_start_handler(StartHandler handler) {
  11287. start_handler_ = std::move(handler);
  11288. return *this;
  11289. }
  11290. inline Server &Server::set_address_family(int family) {
  11291. address_family_ = family;
  11292. return *this;
  11293. }
  11294. inline Server &Server::set_tcp_nodelay(bool on) {
  11295. tcp_nodelay_ = on;
  11296. return *this;
  11297. }
  11298. inline Server &Server::set_ipv6_v6only(bool on) {
  11299. ipv6_v6only_ = on;
  11300. return *this;
  11301. }
  11302. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11303. socket_options_ = std::move(socket_options);
  11304. return *this;
  11305. }
  11306. inline Server &Server::set_default_headers(Headers headers) {
  11307. default_headers_ = std::move(headers);
  11308. return *this;
  11309. }
  11310. inline Server &Server::set_header_writer(
  11311. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11312. header_writer_ = writer;
  11313. return *this;
  11314. }
  11315. inline Server &
  11316. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11317. trusted_proxies_ = proxies;
  11318. return *this;
  11319. }
  11320. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11321. keep_alive_max_count_ = count;
  11322. return *this;
  11323. }
  11324. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11325. keep_alive_timeout_sec_ = sec;
  11326. return *this;
  11327. }
  11328. template <class Rep, class Period>
  11329. inline Server &Server::set_keep_alive_timeout(
  11330. const std::chrono::duration<Rep, Period> &duration) {
  11331. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11332. set_keep_alive_timeout(sec);
  11333. });
  11334. return *this;
  11335. }
  11336. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11337. read_timeout_sec_ = sec;
  11338. read_timeout_usec_ = usec;
  11339. return *this;
  11340. }
  11341. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11342. write_timeout_sec_ = sec;
  11343. write_timeout_usec_ = usec;
  11344. return *this;
  11345. }
  11346. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11347. idle_interval_sec_ = sec;
  11348. idle_interval_usec_ = usec;
  11349. return *this;
  11350. }
  11351. inline Server &Server::set_payload_max_length(size_t length) {
  11352. payload_max_length_ = length;
  11353. return *this;
  11354. }
  11355. inline Server &Server::set_static_file_compression(bool on) {
  11356. static_file_compression_ = on;
  11357. return *this;
  11358. }
  11359. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11360. static_file_compression_min_length_ = length;
  11361. return *this;
  11362. }
  11363. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11364. static_file_compression_max_length_ = length;
  11365. return *this;
  11366. }
  11367. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11368. websocket_max_missed_pongs_ = count;
  11369. return *this;
  11370. }
  11371. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11372. websocket_ping_interval_sec_ = sec;
  11373. return *this;
  11374. }
  11375. template <class Rep, class Period>
  11376. inline Server &Server::set_websocket_ping_interval(
  11377. const std::chrono::duration<Rep, Period> &duration) {
  11378. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11379. set_websocket_ping_interval(sec);
  11380. });
  11381. return *this;
  11382. }
  11383. inline bool Server::bind_to_port(const std::string &host, int port,
  11384. int socket_flags) {
  11385. auto ret = bind_internal(host, port, socket_flags);
  11386. if (ret == -1) { is_decommissioned = true; }
  11387. return ret >= 0;
  11388. }
  11389. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11390. auto ret = bind_internal(host, 0, socket_flags);
  11391. if (ret == -1) { is_decommissioned = true; }
  11392. return ret;
  11393. }
  11394. inline bool Server::listen_after_bind() { return listen_internal(); }
  11395. inline bool Server::listen(const std::string &host, int port,
  11396. int socket_flags) {
  11397. return bind_to_port(host, port, socket_flags) && listen_internal();
  11398. }
  11399. inline bool Server::is_running() const { return is_running_; }
  11400. inline void Server::wait_until_ready() const {
  11401. while (!is_running_ && !is_decommissioned) {
  11402. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11403. }
  11404. }
  11405. inline void Server::stop() noexcept {
  11406. // Release the listening socket whether or not the accept loop is running:
  11407. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11408. // exchange is what makes this safe to call concurrently with the accept loop.
  11409. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11410. if (sock != INVALID_SOCKET) {
  11411. detail::shutdown_socket(sock);
  11412. detail::close_socket(sock);
  11413. }
  11414. is_decommissioned = false;
  11415. }
  11416. inline void Server::decommission() { is_decommissioned = true; }
  11417. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11418. auto len = strlen(s);
  11419. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11420. len -= 2;
  11421. {
  11422. size_t count = 0;
  11423. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11424. switch (count) {
  11425. case 0: req.method = std::string(b, e); break;
  11426. case 1: req.target = std::string(b, e); break;
  11427. case 2: req.version = std::string(b, e); break;
  11428. default: break;
  11429. }
  11430. count++;
  11431. });
  11432. if (count != 3) { return false; }
  11433. }
  11434. // A method outside the built-in set is accepted only when a handler has been
  11435. // registered for it with CustomRoute().
  11436. const auto &methods = builtin_methods();
  11437. if (methods.find(req.method) == methods.end() &&
  11438. !find_custom_entry(req.method)) {
  11439. output_error_log(Error::InvalidHTTPMethod, &req);
  11440. return false;
  11441. }
  11442. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11443. output_error_log(Error::InvalidHTTPVersion, &req);
  11444. return false;
  11445. }
  11446. if (!detail::fields::is_request_target(req.target)) { return false; }
  11447. {
  11448. // Skip URL fragment
  11449. for (size_t i = 0; i < req.target.size(); i++) {
  11450. if (req.target[i] == '#') {
  11451. req.target.erase(i);
  11452. break;
  11453. }
  11454. }
  11455. detail::divide(req.target, '?',
  11456. [&](const char *lhs_data, std::size_t lhs_size,
  11457. const char *rhs_data, std::size_t rhs_size) {
  11458. req.path =
  11459. decode_path_component(std::string(lhs_data, lhs_size));
  11460. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11461. });
  11462. }
  11463. return true;
  11464. }
  11465. inline bool Server::write_response(Stream &strm, bool close_connection,
  11466. Request &req, Response &res) {
  11467. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11468. // incorrectly to the error content.
  11469. req.ranges.clear();
  11470. return write_response_core(strm, close_connection, req, res, false);
  11471. }
  11472. inline bool Server::write_response_with_content(Stream &strm,
  11473. bool close_connection,
  11474. const Request &req,
  11475. Response &res) {
  11476. return write_response_core(strm, close_connection, req, res, true);
  11477. }
  11478. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11479. const Request &req, Response &res,
  11480. bool need_apply_ranges) {
  11481. assert(res.status != -1);
  11482. if (400 <= res.status && error_handler_ &&
  11483. error_handler_(req, res) == HandlerResponse::Handled) {
  11484. need_apply_ranges = true;
  11485. }
  11486. detail::prefer_assigned_body(res);
  11487. std::string content_type;
  11488. std::string boundary;
  11489. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11490. // Prepare additional headers
  11491. if (close_connection ||
  11492. detail::has_header_token(req.headers, "Connection", "close") ||
  11493. 400 <= res.status || // Don't leave connections open after errors
  11494. // The client withholds the body until `100 Continue`, which was never
  11495. // sent, so whether and when the body follows is unknown.
  11496. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11497. // The body was left partway, e.g. by a content receiver that returned
  11498. // false, so the rest of it cannot be told from the next request.
  11499. (req.body_read_started_ && !req.body_consumed_)) {
  11500. res.set_header("Connection", "close");
  11501. } else {
  11502. std::string s = "timeout=";
  11503. s += std::to_string(keep_alive_timeout_sec_);
  11504. s += ", max=";
  11505. s += std::to_string(keep_alive_max_count_);
  11506. res.set_header("Keep-Alive", s);
  11507. }
  11508. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11509. !res.has_header("Content-Type")) {
  11510. res.set_header("Content-Type", "text/plain");
  11511. }
  11512. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11513. !res.has_header("Content-Length")) {
  11514. res.set_header("Content-Length", "0");
  11515. }
  11516. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11517. res.set_header("Accept-Ranges", "bytes");
  11518. }
  11519. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11520. // Response line and headers
  11521. detail::BufferStream bstrm;
  11522. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11523. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11524. // Combine a small body with the headers so the whole response leaves in a
  11525. // single write. A large body is written on its own instead: a copy of it
  11526. // costs more than the extra write saves.
  11527. auto send_body = req.method != "HEAD";
  11528. auto body_is_separate = false;
  11529. auto provider_done = false;
  11530. if (send_body && !res.body.empty() && !res.content_provider_) {
  11531. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11532. bstrm.write(res.body.data(), res.body.size());
  11533. } else {
  11534. body_is_separate = true;
  11535. }
  11536. } else if (send_body && res.content_provider_ &&
  11537. res.is_file_content_provider_ &&
  11538. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11539. // A small file is read into the same buffer. Other providers may produce
  11540. // their data over time, so they are never held back.
  11541. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11542. return false;
  11543. }
  11544. provider_done = true;
  11545. }
  11546. // Log before writing to avoid race condition with client-side code that
  11547. // accesses logger-captured data immediately after receiving the response.
  11548. output_log(req, res);
  11549. // Flush buffer
  11550. auto &data = bstrm.get_buffer();
  11551. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11552. if (body_is_separate) {
  11553. return detail::write_data(strm, res.body.data(), res.body.size());
  11554. }
  11555. // Streaming body
  11556. if (send_body && res.content_provider_) {
  11557. if (!provider_done &&
  11558. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11559. return false;
  11560. }
  11561. res.content_provider_success_ = true;
  11562. }
  11563. return true;
  11564. }
  11565. inline bool
  11566. Server::write_content_with_provider(Stream &strm, const Request &req,
  11567. Response &res, const std::string &boundary,
  11568. const std::string &content_type) {
  11569. auto is_shutting_down = [this]() {
  11570. return this->svr_sock_ == INVALID_SOCKET;
  11571. };
  11572. if (res.content_length_ > 0) {
  11573. // Only a 206 response is served as a partial representation, matching the
  11574. // condition `apply_ranges()` used to decide the Content-Length and the
  11575. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11576. // only for a 2xx status, slicing under any other status would write a body
  11577. // that disagrees with the header already sent, from an unchecked offset.
  11578. auto is_partial =
  11579. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11580. if (!is_partial) {
  11581. return detail::write_content(strm, res.content_provider_, 0,
  11582. res.content_length_, is_shutting_down);
  11583. } else if (req.ranges.size() == 1) {
  11584. auto offset_and_length = detail::get_range_offset_and_length(
  11585. req.ranges[0], res.content_length_);
  11586. return detail::write_content(strm, res.content_provider_,
  11587. offset_and_length.first,
  11588. offset_and_length.second, is_shutting_down);
  11589. } else {
  11590. return detail::write_multipart_ranges_data(
  11591. strm, req, res, boundary, content_type, res.content_length_,
  11592. is_shutting_down);
  11593. }
  11594. } else {
  11595. if (res.is_chunked_content_provider_) {
  11596. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11597. // re-negotiating here would disagree with them, e.g. once a handler's
  11598. // own Content-Encoding header suppresses the negotiation.
  11599. auto compressor = detail::make_compressor(res.content_coding_);
  11600. if (!compressor) {
  11601. compressor = detail::make_unique<detail::nocompressor>();
  11602. }
  11603. return detail::write_content_chunked(strm, res.content_provider_,
  11604. is_shutting_down, *compressor);
  11605. } else {
  11606. return detail::write_content_without_length(strm, res.content_provider_,
  11607. is_shutting_down);
  11608. }
  11609. }
  11610. }
  11611. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11612. FormFields::iterator cur_field;
  11613. FormFiles::iterator cur_file;
  11614. auto is_text_field = false;
  11615. size_t count = 0;
  11616. if (read_content_core(
  11617. strm, req, res,
  11618. // Regular
  11619. [&](const char *buf, size_t n) {
  11620. // Prevent arithmetic overflow when checking sizes.
  11621. // Avoid computing (req.body.size() + n) directly because
  11622. // adding two unsigned `size_t` values can wrap around and
  11623. // produce a small result instead of indicating overflow.
  11624. // Instead, check using subtraction: ensure `n` does not
  11625. // exceed the remaining capacity `max_size() - size()`.
  11626. if (req.body.size() >= req.body.max_size() ||
  11627. n > req.body.max_size() - req.body.size()) {
  11628. return false;
  11629. }
  11630. // Limit decompressed body size to payload_max_length_ to protect
  11631. // against "zip bomb" attacks where a small compressed payload
  11632. // decompresses to a massive size.
  11633. if (payload_max_length_ > 0 &&
  11634. (req.body.size() >= payload_max_length_ ||
  11635. n > payload_max_length_ - req.body.size())) {
  11636. return false;
  11637. }
  11638. req.body.append(buf, n);
  11639. return true;
  11640. },
  11641. // Multipart FormData
  11642. [&](const FormData &file) {
  11643. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11644. output_error_log(Error::TooManyFormDataFiles, &req);
  11645. return false;
  11646. }
  11647. if (file.filename.empty()) {
  11648. cur_field = req.form.fields.emplace(
  11649. file.name, FormField{file.name, file.content, file.headers});
  11650. is_text_field = true;
  11651. } else {
  11652. cur_file = req.form.files.emplace(file.name, file);
  11653. is_text_field = false;
  11654. }
  11655. return true;
  11656. },
  11657. [&](const char *buf, size_t n) {
  11658. if (is_text_field) {
  11659. auto &content = cur_field->second.content;
  11660. if (content.size() + n > content.max_size()) { return false; }
  11661. content.append(buf, n);
  11662. } else {
  11663. auto &content = cur_file->second.content;
  11664. if (content.size() + n > content.max_size()) { return false; }
  11665. content.append(buf, n);
  11666. }
  11667. return true;
  11668. })) {
  11669. const auto &content_type = req.get_header_value("Content-Type");
  11670. if (detail::extract_media_type(content_type) ==
  11671. "application/x-www-form-urlencoded") {
  11672. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11673. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11674. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11675. return false;
  11676. }
  11677. detail::parse_query_text(req.body, req.params);
  11678. }
  11679. return true;
  11680. }
  11681. return false;
  11682. }
  11683. inline bool Server::read_content_with_content_receiver(
  11684. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11685. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11686. return read_content_core(strm, req, res, std::move(receiver),
  11687. std::move(multipart_header),
  11688. std::move(multipart_receiver));
  11689. }
  11690. inline bool Server::read_content_core(
  11691. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11692. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11693. detail::FormDataParser multipart_form_data_parser;
  11694. ContentReceiverWithProgress out;
  11695. if (req.is_multipart_form_data()) {
  11696. const auto &content_type = req.get_header_value("Content-Type");
  11697. std::string boundary;
  11698. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11699. res.status = StatusCode::BadRequest_400;
  11700. output_error_log(Error::MultipartParsing, &req);
  11701. return false;
  11702. }
  11703. multipart_form_data_parser.set_boundary(std::move(boundary));
  11704. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11705. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11706. multipart_receiver);
  11707. };
  11708. } else {
  11709. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11710. size_t /*len*/) { return receiver(buf, n); };
  11711. }
  11712. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11713. // For non-SSL builds we still scan non-persistent connections for stray
  11714. // body bytes so the payload limit is enforced (413). On keep-alive,
  11715. // pending bytes may be the next request (issue #2450), so skip.
  11716. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11717. if (!req.has_header("Content-Length") &&
  11718. !detail::is_chunked_transfer_encoding(req.headers)) {
  11719. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11720. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11721. auto has_data = strm.is_readable();
  11722. if (!has_data) {
  11723. auto s = strm.socket();
  11724. if (s != INVALID_SOCKET) {
  11725. has_data = detail::select_read(s, 0, 0) > 0;
  11726. }
  11727. }
  11728. if (has_data) {
  11729. // Route through the same decompressing reader used by the
  11730. // length-framed and chunked paths below, so payload_max_length_ is
  11731. // enforced on the decompressed size here too instead of only on the
  11732. // compressed wire bytes.
  11733. return detail::read_content(strm, req, payload_max_length_, res.status,
  11734. nullptr, out, true);
  11735. }
  11736. }
  11737. return true;
  11738. }
  11739. #else
  11740. if (!req.has_header("Content-Length") &&
  11741. !detail::is_chunked_transfer_encoding(req.headers)) {
  11742. return true;
  11743. }
  11744. #endif
  11745. // A second read would start where the first one stopped, or in the next
  11746. // request.
  11747. if (req.body_read_started_) { return false; }
  11748. // The client is waiting for this before it sends the body.
  11749. if (req.expect_100_continue_pending_) {
  11750. req.expect_100_continue_pending_ = false;
  11751. detail::write_response_line(strm, StatusCode::Continue_100);
  11752. strm.write("\r\n");
  11753. }
  11754. // Set before reading, since a receiver may also stop by throwing.
  11755. req.body_read_started_ = true;
  11756. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11757. out, true)) {
  11758. return false;
  11759. }
  11760. req.body_consumed_ = true;
  11761. if (req.is_multipart_form_data()) {
  11762. if (!multipart_form_data_parser.is_valid()) {
  11763. res.status = StatusCode::BadRequest_400;
  11764. output_error_log(Error::MultipartParsing, &req);
  11765. return false;
  11766. }
  11767. }
  11768. return true;
  11769. }
  11770. inline bool Server::handle_file_request(Request &req, Response &res) {
  11771. for (const auto &entry : base_dirs_) {
  11772. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11773. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11774. // One that already ends in '/' (the root mount among them) carries its own
  11775. // boundary; set_mount_point() guarantees the mount point is not empty.
  11776. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11777. (entry.mount_point.back() == '/' ||
  11778. req.path.size() == entry.mount_point.size() ||
  11779. req.path[entry.mount_point.size()] == '/')) {
  11780. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11781. if (detail::is_valid_path(sub_path)) {
  11782. auto path = entry.base_dir + sub_path;
  11783. if (path.back() == '/') { path += "index.html"; }
  11784. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11785. // but symlinks/junctions can still escape the base directory.
  11786. if (!entry.resolved_base_dir.empty()) {
  11787. std::string resolved_path;
  11788. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11789. !detail::is_path_within_base(resolved_path,
  11790. entry.resolved_base_dir)) {
  11791. res.status = StatusCode::Forbidden_403;
  11792. return true;
  11793. }
  11794. }
  11795. detail::FileStat stat(path);
  11796. if (stat.is_dir()) {
  11797. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  11798. // in the name from reading as a scheme.
  11799. auto name = req.path.substr(req.path.rfind('/') + 1);
  11800. res.set_redirect("./" + encode_path_component(name) + "/",
  11801. StatusCode::MovedPermanently_301);
  11802. return true;
  11803. }
  11804. if (stat.is_file()) {
  11805. for (const auto &kv : entry.headers) {
  11806. res.set_header(kv.first, kv.second);
  11807. }
  11808. auto content_type = detail::find_content_type(
  11809. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11810. auto encoding = detail::EncodingType::None;
  11811. if (static_file_compression_) {
  11812. encoding =
  11813. static_file_encoding(req, res, content_type, stat.size());
  11814. }
  11815. // The ETag names the representation actually sent, so a client that
  11816. // cached the compressed form revalidates against the compressed ETag
  11817. // and still gets a 304, while one that took identity keeps the plain
  11818. // ETag.
  11819. auto etag = detail::compute_etag(
  11820. stat, encoding == detail::EncodingType::None
  11821. ? std::string()
  11822. : std::string("-") + detail::encoding_name(encoding));
  11823. if (!etag.empty()) { res.set_header("ETag", etag); }
  11824. auto mtime = stat.mtime();
  11825. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11826. if (!last_modified.empty()) {
  11827. res.set_header("Last-Modified", last_modified);
  11828. }
  11829. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11830. check_if_range(req, etag, mtime);
  11831. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11832. if (!mm->is_open()) {
  11833. output_error_log(Error::OpenFile, &req);
  11834. return false;
  11835. }
  11836. detail::set_file_content_provider(res, mm, content_type, encoding);
  11837. if (req.method != "HEAD" && file_request_handler_) {
  11838. file_request_handler_(req, res);
  11839. }
  11840. return true;
  11841. } else {
  11842. output_error_log(Error::OpenFile, &req);
  11843. }
  11844. }
  11845. }
  11846. }
  11847. return false;
  11848. }
  11849. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11850. const std::string &etag,
  11851. time_t mtime) const {
  11852. // Handle conditional GET:
  11853. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11854. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11855. if (req.has_header("If-None-Match")) {
  11856. if (!etag.empty()) {
  11857. auto val =
  11858. detail::get_combined_header_value(req.headers, "If-None-Match");
  11859. // NOTE: We use exact string matching here. This works correctly
  11860. // because our server always generates weak ETags (W/"..."), and
  11861. // clients typically send back the same ETag they received.
  11862. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11863. // If-None-Match, where W/"x" and "x" would match, but this
  11864. // simplified implementation requires exact matches.
  11865. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11866. [&](const char *b, const char *e) {
  11867. auto seg_len = static_cast<size_t>(e - b);
  11868. return (seg_len == 1 && *b == '*') ||
  11869. (seg_len == etag.size() &&
  11870. std::equal(b, e, etag.begin()));
  11871. });
  11872. if (ret) {
  11873. res.status = StatusCode::NotModified_304;
  11874. return true;
  11875. }
  11876. }
  11877. } else if (req.has_header("If-Modified-Since")) {
  11878. auto val = req.get_header_value("If-Modified-Since");
  11879. auto t = detail::parse_http_date(val);
  11880. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11881. res.status = StatusCode::NotModified_304;
  11882. return true;
  11883. }
  11884. }
  11885. return false;
  11886. }
  11887. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11888. time_t mtime) const {
  11889. // Handle If-Range for partial content requests (RFC 9110
  11890. // Section 13.1.5). If-Range is only evaluated when Range header is
  11891. // present. If the validator matches, serve partial content; otherwise
  11892. // serve full content.
  11893. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11894. auto val = req.get_header_value("If-Range");
  11895. auto is_valid_range = [&]() {
  11896. if (detail::is_strong_etag(val)) {
  11897. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11898. // comparison.
  11899. return (!etag.empty() && val == etag);
  11900. } else if (detail::is_weak_etag(val)) {
  11901. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11902. return false;
  11903. } else {
  11904. // HTTP-date comparison
  11905. auto t = detail::parse_http_date(val);
  11906. return (t != static_cast<time_t>(-1) && mtime <= t);
  11907. }
  11908. };
  11909. if (!is_valid_range()) {
  11910. // Validator doesn't match: ignore Range and serve full content
  11911. req.ranges.clear();
  11912. return false;
  11913. }
  11914. }
  11915. return true;
  11916. }
  11917. inline socket_t
  11918. Server::create_server_socket(const std::string &host, int port,
  11919. int socket_flags,
  11920. SocketOptions socket_options) const {
  11921. return detail::create_socket(
  11922. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11923. ipv6_v6only_, std::move(socket_options),
  11924. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11925. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11926. output_error_log(Error::BindIPAddress, nullptr);
  11927. return false;
  11928. }
  11929. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11930. output_error_log(Error::Listen, nullptr);
  11931. return false;
  11932. }
  11933. return true;
  11934. });
  11935. }
  11936. inline int Server::bind_internal(const std::string &host, int port,
  11937. int socket_flags) {
  11938. if (is_decommissioned) { return -1; }
  11939. if (!is_valid()) { return -1; }
  11940. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11941. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11942. if (port == 0) {
  11943. struct sockaddr_storage addr;
  11944. socklen_t addr_len = sizeof(addr);
  11945. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11946. &addr_len) == -1) {
  11947. output_error_log(Error::GetSockName, nullptr);
  11948. return -1;
  11949. }
  11950. if (addr.ss_family == AF_INET) {
  11951. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11952. } else if (addr.ss_family == AF_INET6) {
  11953. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11954. } else {
  11955. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11956. return -1;
  11957. }
  11958. } else {
  11959. return port;
  11960. }
  11961. }
  11962. inline bool Server::listen_internal() {
  11963. // A stop() between bind and listen leaves nothing to accept on. Report
  11964. // failure instead of returning success without ever serving, and mark the
  11965. // server decommissioned the way any failed listen does so that a concurrent
  11966. // wait_until_ready() wakes up instead of spinning forever.
  11967. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11968. is_decommissioned = true;
  11969. return false;
  11970. }
  11971. auto ret = true;
  11972. is_running_ = true;
  11973. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11974. if (start_handler_) { start_handler_(); }
  11975. {
  11976. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11977. while (svr_sock_ != INVALID_SOCKET) {
  11978. #ifndef _WIN32
  11979. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11980. #endif
  11981. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11982. idle_interval_usec_);
  11983. if (val == 0) { // Timeout
  11984. task_queue->on_idle();
  11985. continue;
  11986. }
  11987. #ifndef _WIN32
  11988. }
  11989. #endif
  11990. #if defined _WIN32
  11991. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11992. // OVERLAPPED
  11993. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11994. #elif defined SOCK_CLOEXEC
  11995. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11996. #else
  11997. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11998. #endif
  11999. if (sock == INVALID_SOCKET) {
  12000. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12001. // touches the CRT errno, so the two have to be asked platform by
  12002. // platform rather than by testing errno here.
  12003. if (detail::is_accept_resource_error()) {
  12004. // The per-process descriptor limit or the network stack's buffer
  12005. // space has been reached. Try to accept new connections after a
  12006. // short sleep.
  12007. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12008. continue;
  12009. } else if (detail::is_accept_transient_error()) {
  12010. continue;
  12011. }
  12012. // Take the descriptor out of svr_sock_ before closing it: a later
  12013. // stop() would otherwise shutdown()/close() a value the OS may have
  12014. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12015. // gone. The exchange also settles the race with a concurrent stop(),
  12016. // since whichever side takes the descriptor closes it exactly once.
  12017. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12018. if (listen_sock != INVALID_SOCKET) {
  12019. detail::close_socket(listen_sock);
  12020. ret = false;
  12021. output_error_log(Error::Connection, nullptr);
  12022. } else {
  12023. ; // The server socket was closed by user.
  12024. }
  12025. break;
  12026. }
  12027. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12028. read_timeout_sec_, read_timeout_usec_);
  12029. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12030. write_timeout_sec_, write_timeout_usec_);
  12031. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12032. if (!task_queue->enqueue(
  12033. [this, sock]() { process_and_close_socket(sock); })) {
  12034. output_error_log(Error::ResourceExhaustion, nullptr);
  12035. detail::shutdown_socket(sock);
  12036. detail::close_socket(sock);
  12037. }
  12038. }
  12039. task_queue->shutdown();
  12040. }
  12041. is_decommissioned = !ret;
  12042. return ret;
  12043. }
  12044. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12045. if (pre_routing_handler_ &&
  12046. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12047. return true;
  12048. }
  12049. // File handler
  12050. if ((req.method == "GET" || req.method == "HEAD") &&
  12051. handle_file_request(req, res)) {
  12052. return true;
  12053. }
  12054. const auto *custom = find_custom_entry(req.method);
  12055. // The second clause mirrors what expect_content() does unconditionally for
  12056. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12057. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12058. // `allprop`) would skip its handler and fall through to 404.
  12059. if (detail::expect_content(req) ||
  12060. (custom && !custom->handlers_for_content_reader.empty())) {
  12061. // Content reader handler
  12062. {
  12063. // Track whether the ContentReader was aborted due to the decompressed
  12064. // payload exceeding `payload_max_length_`.
  12065. // The user handler runs after the lambda returns, so we must restore the
  12066. // 413 status if the handler overwrites it.
  12067. bool content_reader_payload_too_large = false;
  12068. ContentReader reader(
  12069. [&](ContentReceiver receiver) {
  12070. auto result = read_content_with_content_receiver(
  12071. strm, req, res, std::move(receiver), nullptr, nullptr);
  12072. if (!result) {
  12073. output_error_log(Error::Read, &req);
  12074. if (res.status == StatusCode::PayloadTooLarge_413) {
  12075. content_reader_payload_too_large = true;
  12076. }
  12077. }
  12078. return result;
  12079. },
  12080. [&](FormDataHeader header, ContentReceiver receiver) {
  12081. auto result = read_content_with_content_receiver(
  12082. strm, req, res, nullptr, std::move(header),
  12083. std::move(receiver));
  12084. if (!result) {
  12085. output_error_log(Error::Read, &req);
  12086. if (res.status == StatusCode::PayloadTooLarge_413) {
  12087. content_reader_payload_too_large = true;
  12088. }
  12089. }
  12090. return result;
  12091. });
  12092. bool dispatched = false;
  12093. if (req.method == "POST") {
  12094. dispatched = dispatch_request_for_content_reader(
  12095. req, res, std::move(reader), post_handlers_for_content_reader_);
  12096. } else if (req.method == "PUT") {
  12097. dispatched = dispatch_request_for_content_reader(
  12098. req, res, std::move(reader), put_handlers_for_content_reader_);
  12099. } else if (req.method == "PATCH") {
  12100. dispatched = dispatch_request_for_content_reader(
  12101. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12102. } else if (req.method == "DELETE") {
  12103. dispatched = dispatch_request_for_content_reader(
  12104. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12105. } else if (custom) {
  12106. dispatched = dispatch_request_for_content_reader(
  12107. req, res, std::move(reader), custom->handlers_for_content_reader);
  12108. }
  12109. if (dispatched) {
  12110. if (content_reader_payload_too_large) {
  12111. // Enforce the limit: override any status the handler may have set
  12112. // and return false so the error path sends a plain 413 response.
  12113. res.status = StatusCode::PayloadTooLarge_413;
  12114. detail::clear_content(res);
  12115. return false;
  12116. }
  12117. return true;
  12118. }
  12119. }
  12120. // NOTE: `req.body` is not read here. For a regular handler the body is
  12121. // read inside dispatch_request(), after the route has matched and the
  12122. // pre-request handler has approved the request, so that a rejected
  12123. // request (e.g. failed authentication) never forces us to buffer a
  12124. // potentially large body.
  12125. }
  12126. // Regular handler
  12127. if (req.method == "GET" || req.method == "HEAD") {
  12128. return dispatch_request(req, res, get_handlers_, strm);
  12129. } else if (req.method == "POST") {
  12130. return dispatch_request(req, res, post_handlers_, strm);
  12131. } else if (req.method == "PUT") {
  12132. return dispatch_request(req, res, put_handlers_, strm);
  12133. } else if (req.method == "DELETE") {
  12134. return dispatch_request(req, res, delete_handlers_, strm);
  12135. } else if (req.method == "OPTIONS") {
  12136. return dispatch_request(req, res, options_handlers_, strm);
  12137. } else if (req.method == "PATCH") {
  12138. return dispatch_request(req, res, patch_handlers_, strm);
  12139. } else if (custom) {
  12140. return dispatch_request(req, res, custom->handlers, strm);
  12141. }
  12142. res.status = StatusCode::BadRequest_400;
  12143. return false;
  12144. }
  12145. inline bool Server::dispatch_request(Request &req, Response &res,
  12146. const Handlers &handlers, Stream &strm) {
  12147. for (const auto &x : handlers) {
  12148. const auto &matcher = x.first;
  12149. const auto &handler = x.second;
  12150. if (matcher->match(req)) {
  12151. req.matched_route = matcher->pattern();
  12152. // Run the pre-request handler before reading the body so a rejected
  12153. // request (e.g. failed authentication) never forces us to buffer a
  12154. // potentially large body. `req.matched_route` is available here.
  12155. if (pre_request_handler_ &&
  12156. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12157. return true;
  12158. }
  12159. // The route matched and the request was approved; read the body now.
  12160. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12161. output_error_log(Error::Read, &req);
  12162. return false;
  12163. }
  12164. handler(req, res);
  12165. return true;
  12166. }
  12167. }
  12168. return false;
  12169. }
  12170. // Decides the content coding for a response served straight from a file. Both
  12171. // the ETag, which has to name the representation actually sent, and
  12172. // `apply_static_file_compression()` go through this, so the two cannot drift
  12173. // apart.
  12174. inline detail::EncodingType
  12175. Server::static_file_encoding(const Request &req, const Response &res,
  12176. const std::string &content_type,
  12177. size_t length) const {
  12178. if (!static_file_compression_) { return detail::EncodingType::None; }
  12179. // Nothing to compress, and an empty file already answers with
  12180. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12181. // turn an empty body into a 20-byte gzip stream.
  12182. if (length == 0) { return detail::EncodingType::None; }
  12183. // A file that already fits in a single packet gains nothing from being made
  12184. // smaller, since it still travels in that one segment, and a file of a few
  12185. // bytes comes out larger than it went in.
  12186. if (length < static_file_compression_min_length_) {
  12187. return detail::EncodingType::None;
  12188. }
  12189. // RFC 9110 applies Range to the representation after content coding, so a
  12190. // compressed 206 would mean compressing the whole file and then slicing it.
  12191. // Serve ranges from the identity representation instead.
  12192. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12193. if (static_file_compression_max_length_ > 0 &&
  12194. length > static_file_compression_max_length_) {
  12195. return detail::EncodingType::None;
  12196. }
  12197. return detail::encoding_type(req, res, content_type);
  12198. }
  12199. // Compresses a file-backed content provider into `res.body` and takes over the
  12200. // framing headers. Returns false when the response is left untouched.
  12201. inline bool Server::apply_static_file_compression(const Request &req,
  12202. Response &res) const {
  12203. auto type = res.content_coding_;
  12204. if (type == detail::EncodingType::None || !res.content_provider_) {
  12205. return false;
  12206. }
  12207. auto compressor = detail::make_compressor(type);
  12208. if (!compressor) { return false; }
  12209. output_pre_compression_log(req, res);
  12210. std::string compressed;
  12211. if (!detail::compress_content_provider(res.content_provider_,
  12212. res.content_length_, *compressor,
  12213. compressed)) {
  12214. return false;
  12215. }
  12216. res.body.swap(compressed);
  12217. // The provider was consumed in full, so its releaser hears about a success.
  12218. res.content_provider_success_ = true;
  12219. detail::clear_content_provider(res);
  12220. res.set_header("Content-Encoding", detail::encoding_name(type));
  12221. res.set_header("Vary", "Accept-Encoding");
  12222. res.set_header("Content-Length", std::to_string(res.body.size()));
  12223. return true;
  12224. }
  12225. inline void Server::apply_ranges(const Request &req, Response &res,
  12226. std::string &content_type,
  12227. std::string &boundary) const {
  12228. // A known-length content provider leaves `res.body` empty, so the compressor
  12229. // at the end of this function never runs for one (issue #2545). A file-backed
  12230. // provider is fully readable right here, so compress it and answer with an
  12231. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12232. // takes the same path as `set_content()` from here on. Range requests never
  12233. // get a content coding, so `Content-Range` still names identity bytes and
  12234. // none of the framing below applies.
  12235. if (apply_static_file_compression(req, res)) { return; }
  12236. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12237. auto it = res.headers.find("Content-Type");
  12238. if (it != res.headers.end()) {
  12239. content_type = it->second;
  12240. res.headers.erase(it);
  12241. }
  12242. boundary = detail::make_multipart_data_boundary();
  12243. res.set_header("Content-Type",
  12244. "multipart/byteranges; boundary=" + boundary);
  12245. }
  12246. auto type = detail::encoding_type(req, res);
  12247. if (res.body.empty()) {
  12248. if (res.content_length_ > 0) {
  12249. size_t length = 0;
  12250. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12251. length = res.content_length_;
  12252. } else if (req.ranges.size() == 1) {
  12253. auto offset_and_length = detail::get_range_offset_and_length(
  12254. req.ranges[0], res.content_length_);
  12255. length = offset_and_length.second;
  12256. auto content_range = detail::make_content_range_header_field(
  12257. offset_and_length, res.content_length_);
  12258. res.set_header("Content-Range", content_range);
  12259. } else {
  12260. length = detail::get_multipart_ranges_data_length(
  12261. req, boundary, content_type, res.content_length_);
  12262. }
  12263. res.set_header("Content-Length", std::to_string(length));
  12264. } else {
  12265. if (res.content_provider_) {
  12266. if (res.is_chunked_content_provider_) {
  12267. res.set_header("Transfer-Encoding", "chunked");
  12268. res.content_coding_ = type;
  12269. if (type != detail::EncodingType::None) {
  12270. res.set_header("Content-Encoding", detail::encoding_name(type));
  12271. res.set_header("Vary", "Accept-Encoding");
  12272. }
  12273. }
  12274. }
  12275. }
  12276. } else {
  12277. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12278. ;
  12279. } else if (req.ranges.size() == 1) {
  12280. auto offset_and_length =
  12281. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12282. auto offset = offset_and_length.first;
  12283. auto length = offset_and_length.second;
  12284. auto content_range = detail::make_content_range_header_field(
  12285. offset_and_length, res.body.size());
  12286. res.set_header("Content-Range", content_range);
  12287. assert(offset + length <= res.body.size());
  12288. res.body = res.body.substr(offset, length);
  12289. } else {
  12290. std::string data;
  12291. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12292. res.body.size(), data);
  12293. res.body.swap(data);
  12294. }
  12295. if (type != detail::EncodingType::None) {
  12296. output_pre_compression_log(req, res);
  12297. if (auto compressor = detail::make_compressor(type)) {
  12298. std::string compressed;
  12299. if (compressor->compress(res.body.data(), res.body.size(), true,
  12300. [&](const char *data, size_t data_len) {
  12301. compressed.append(data, data_len);
  12302. return true;
  12303. })) {
  12304. res.body.swap(compressed);
  12305. res.set_header("Content-Encoding", detail::encoding_name(type));
  12306. res.set_header("Vary", "Accept-Encoding");
  12307. }
  12308. }
  12309. }
  12310. res.content_length_ = res.body.size();
  12311. res.set_header("Content-Length", std::to_string(res.content_length_));
  12312. }
  12313. }
  12314. inline bool Server::dispatch_request_for_content_reader(
  12315. Request &req, Response &res, ContentReader content_reader,
  12316. const HandlersForContentReader &handlers) const {
  12317. for (const auto &x : handlers) {
  12318. const auto &matcher = x.first;
  12319. const auto &handler = x.second;
  12320. if (matcher->match(req)) {
  12321. req.matched_route = matcher->pattern();
  12322. if (!pre_request_handler_ ||
  12323. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12324. handler(req, res, content_reader);
  12325. }
  12326. return true;
  12327. }
  12328. }
  12329. return false;
  12330. }
  12331. inline std::string
  12332. get_client_ip(const std::string &x_forwarded_for,
  12333. const std::vector<std::string> &trusted_proxies) {
  12334. // X-Forwarded-For is a comma-separated list per RFC 7239
  12335. std::vector<std::string> ip_list;
  12336. detail::split(x_forwarded_for.data(),
  12337. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12338. [&](const char *b, const char *e) {
  12339. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12340. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12341. });
  12342. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12343. // no segments. Signal "no client IP derived" with an empty string so the
  12344. // caller can fall back to the connection-level remote address.
  12345. if (ip_list.empty()) { return std::string(); }
  12346. // Each hop appends the address it received the request from, so the rightmost
  12347. // entries are the ones written by our own infrastructure while the leftmost
  12348. // are whatever the original client chose to send. Walk from the right and
  12349. // skip trusted proxies; the first address that is not a trusted proxy is the
  12350. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12351. // from the left instead lets a client forge an arbitrary address by following
  12352. // it with a trusted proxy's address, which the left-to-right scan then
  12353. // returned as the client.
  12354. for (size_t i = ip_list.size(); i-- > 0;) {
  12355. const auto &ip = ip_list[i];
  12356. auto is_trusted_proxy =
  12357. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12358. [&](const std::string &proxy) { return ip == proxy; });
  12359. if (!is_trusted_proxy) { return ip; }
  12360. }
  12361. // Every hop was a trusted proxy; fall back to the first entry.
  12362. return ip_list.front();
  12363. }
  12364. inline bool
  12365. Server::process_request(Stream &strm, const std::string &remote_addr,
  12366. int remote_port, const std::string &local_addr,
  12367. int local_port, bool close_connection,
  12368. bool &connection_closed,
  12369. const std::function<void(Request &)> &setup_request,
  12370. bool *websocket_upgraded) {
  12371. std::array<char, 2048> buf{};
  12372. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12373. // Connection has been closed on client
  12374. if (!line_reader.getline()) { return false; }
  12375. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12376. // clients send an extra CRLF after a request body, which would otherwise be
  12377. // parsed as the next request on a persistent connection.
  12378. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12379. return false;
  12380. }
  12381. Request req;
  12382. req.start_time_ = std::chrono::steady_clock::now();
  12383. req.remote_addr = remote_addr;
  12384. req.remote_port = remote_port;
  12385. req.local_addr = local_addr;
  12386. req.local_port = local_port;
  12387. Response res;
  12388. res.version = "HTTP/1.1";
  12389. res.headers = default_headers_;
  12390. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12391. // close the connection after that response, whichever path wrote it (an
  12392. // error status, a handler, or a rejected request). Reading on would also
  12393. // parse whatever the client sent next on a connection it considers done.
  12394. auto honor_connection_close = detail::scope_exit([&] {
  12395. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12396. connection_closed = true;
  12397. }
  12398. });
  12399. // Request line and headers. A rejected message leaves the rest of it (and
  12400. // any body) unread, so the connection cannot be reused: the leftover bytes
  12401. // would be parsed as the next request.
  12402. if (!parse_request_line(line_reader.ptr(), req)) {
  12403. connection_closed = true;
  12404. res.status = StatusCode::BadRequest_400;
  12405. output_error_log(Error::InvalidRequestLine, &req);
  12406. return write_response(strm, close_connection, req, res);
  12407. }
  12408. // Request headers
  12409. if (!detail::read_headers(strm, req.headers)) {
  12410. connection_closed = true;
  12411. res.status = StatusCode::BadRequest_400;
  12412. output_error_log(Error::InvalidHeaders, &req);
  12413. return write_response(strm, close_connection, req, res);
  12414. }
  12415. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12416. // which would otherwise let an intermediary and this parser disagree on
  12417. // where the body ends and enable request smuggling. Three cases: a
  12418. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12419. // or empty), which would otherwise be read as "no body"; a non-zero
  12420. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12421. // tolerated for compatibility with existing clients); and a
  12422. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12423. // length undeterminable. None of them may fall through to the "no body"
  12424. // path, or the body bytes are parsed as the next request on a persistent
  12425. // connection.
  12426. auto is_invalid_content_length = false;
  12427. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12428. is_invalid_content_length);
  12429. if (is_invalid_content_length ||
  12430. detail::has_conflicting_content_length(req.headers) ||
  12431. (req.has_header("Transfer-Encoding") &&
  12432. !detail::is_chunked_transfer_encoding(req.headers))) {
  12433. connection_closed = true;
  12434. res.status = StatusCode::BadRequest_400;
  12435. return write_response(strm, close_connection, req, res);
  12436. }
  12437. // RFC 9112 §3.2: Reject more than one Host field line or an invalid Host
  12438. // value, so that every recipient of the request sees the same authority.
  12439. if (req.get_header_value_count("Host") > 1 ||
  12440. !detail::fields::is_host(req.get_header_value("Host"))) {
  12441. connection_closed = true;
  12442. res.status = StatusCode::BadRequest_400;
  12443. output_error_log(Error::InvalidHeaders, &req);
  12444. return write_response(strm, close_connection, req, res);
  12445. }
  12446. // Check if the request URI doesn't exceed the limit
  12447. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12448. connection_closed = true;
  12449. res.status = StatusCode::UriTooLong_414;
  12450. output_error_log(Error::ExceedUriMaxLength, &req);
  12451. return write_response(strm, close_connection, req, res);
  12452. }
  12453. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12454. connection_closed = true;
  12455. }
  12456. if (req.version == "HTTP/1.0" &&
  12457. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12458. connection_closed = true;
  12459. }
  12460. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12461. // itself a trusted proxy. Otherwise any direct client could spoof
  12462. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12463. auto is_trusted_peer = std::any_of(
  12464. trusted_proxies_.begin(), trusted_proxies_.end(),
  12465. [&](const std::string &proxy) { return proxy == remote_addr; });
  12466. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12467. // Some proxies append the address they observed as a separate
  12468. // X-Forwarded-For field line instead of extending the one the client sent
  12469. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12470. // be scanned. Reading only the first occurrence would hand back the
  12471. // client-supplied, and therefore forgeable, value.
  12472. auto x_forwarded_for =
  12473. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12474. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12475. req.remote_addr = derived.empty() ? remote_addr : derived;
  12476. } else {
  12477. req.remote_addr = remote_addr;
  12478. }
  12479. req.remote_port = remote_port;
  12480. req.local_addr = local_addr;
  12481. req.local_port = local_port;
  12482. if (req.has_header("Accept")) {
  12483. auto accept_header =
  12484. detail::get_combined_header_value(req.headers, "Accept");
  12485. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12486. connection_closed = true;
  12487. res.status = StatusCode::BadRequest_400;
  12488. output_error_log(Error::HTTPParsing, &req);
  12489. return write_response(strm, close_connection, req, res);
  12490. }
  12491. }
  12492. if (req.has_header("Range")) {
  12493. const auto &range_header_value = req.get_header_value("Range");
  12494. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12495. connection_closed = true;
  12496. res.status = StatusCode::RangeNotSatisfiable_416;
  12497. output_error_log(Error::InvalidRangeHeader, &req);
  12498. return write_response(strm, close_connection, req, res);
  12499. }
  12500. }
  12501. if (setup_request) { setup_request(req); }
  12502. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12503. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12504. // must be ignored. An expectation we do not recognize is left alone; the
  12505. // 417 the section allows for one is a MAY, not a requirement.
  12506. //
  12507. // `100 Continue` itself is deferred until the body is actually read (see
  12508. // read_content_core), so a request rejected by a later handler never
  12509. // invites the client to send a body nobody will read.
  12510. if (req.version != "HTTP/1.0" &&
  12511. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12512. int status = StatusCode::Continue_100;
  12513. if (expect_100_continue_handler_) {
  12514. status = expect_100_continue_handler_(req, res);
  12515. }
  12516. if (status == StatusCode::Continue_100) {
  12517. req.expect_100_continue_pending_ = true;
  12518. } else {
  12519. if (res.status == -1) { res.status = status; }
  12520. connection_closed = true;
  12521. return write_response(strm, true, req, res);
  12522. }
  12523. }
  12524. // Setup `is_connection_closed` method
  12525. auto sock = strm.socket();
  12526. req.is_connection_closed = [sock]() {
  12527. return !detail::is_socket_alive(sock);
  12528. };
  12529. // WebSocket upgrade
  12530. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12531. // that authentication and other middleware can reject the request with an
  12532. // HTTP response (e.g., 401) before the protocol switches.
  12533. if (detail::is_websocket_upgrade(req)) {
  12534. if (pre_routing_handler_ &&
  12535. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12536. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12537. return write_response_with_content(strm, close_connection, req, res);
  12538. }
  12539. // Find matching WebSocket handler
  12540. for (const auto &entry : websocket_handlers_) {
  12541. if (entry.matcher->match(req)) {
  12542. req.matched_route = entry.matcher->pattern();
  12543. if (pre_request_handler_ &&
  12544. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12545. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12546. return write_response_with_content(strm, close_connection, req, res);
  12547. }
  12548. // Compute accept key
  12549. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12550. auto accept_key = detail::websocket_accept_key(client_key);
  12551. // Negotiate subprotocol
  12552. std::string selected_subprotocol;
  12553. if (entry.sub_protocol_selector) {
  12554. auto protocol_header = detail::get_combined_header_value(
  12555. req.headers, "Sec-WebSocket-Protocol");
  12556. if (!protocol_header.empty()) {
  12557. std::vector<std::string> protocols;
  12558. detail::split(protocol_header.data(),
  12559. protocol_header.data() + protocol_header.size(), ',',
  12560. [&](const char *b, const char *e) {
  12561. protocols.emplace_back(b, e);
  12562. });
  12563. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12564. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12565. if (std::find(protocols.begin(), protocols.end(),
  12566. selected_subprotocol) == protocols.end()) {
  12567. selected_subprotocol.clear();
  12568. }
  12569. }
  12570. }
  12571. // Send 101 Switching Protocols
  12572. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12573. "Upgrade: websocket\r\n"
  12574. "Connection: Upgrade\r\n"
  12575. "Sec-WebSocket-Accept: " +
  12576. accept_key + "\r\n";
  12577. if (!selected_subprotocol.empty()) {
  12578. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12579. return false;
  12580. }
  12581. handshake_response +=
  12582. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12583. }
  12584. handshake_response += "\r\n";
  12585. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12586. 0) {
  12587. return false;
  12588. }
  12589. connection_closed = true;
  12590. if (websocket_upgraded) { *websocket_upgraded = true; }
  12591. {
  12592. #ifdef CPPHTTPLIB_SSL_ENABLED
  12593. if (req.ssl) {
  12594. // wss: the heartbeat ping thread and the read path enter the same
  12595. // TLS session from different threads. Hand the WebSocket a stream
  12596. // that serializes every TLS call, so the shared SSLSocketStream on
  12597. // the plain HTTP/HTTPS paths stays untouched.
  12598. auto ws_strm =
  12599. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12600. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12601. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12602. write_timeout_sec_, write_timeout_usec_));
  12603. ws::WebSocket ws(std::move(ws_strm), req, true,
  12604. websocket_ping_interval_sec_,
  12605. websocket_max_missed_pongs_);
  12606. entry.handler(req, ws);
  12607. return true;
  12608. }
  12609. #endif
  12610. // Use WebSocket-specific read timeout instead of HTTP timeout
  12611. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12612. 0);
  12613. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12614. websocket_max_missed_pongs_);
  12615. entry.handler(req, ws);
  12616. }
  12617. return true;
  12618. }
  12619. }
  12620. // No matching handler - fall through to 404
  12621. }
  12622. // Routing
  12623. auto routed = false;
  12624. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12625. routed = routing(req, res, strm);
  12626. #else
  12627. try {
  12628. routed = routing(req, res, strm);
  12629. } catch (std::exception &) {
  12630. if (exception_handler_) {
  12631. auto ep = std::current_exception();
  12632. exception_handler_(req, res, ep);
  12633. routed = true;
  12634. } else {
  12635. res.status = StatusCode::InternalServerError_500;
  12636. }
  12637. } catch (...) {
  12638. if (exception_handler_) {
  12639. auto ep = std::current_exception();
  12640. exception_handler_(req, res, ep);
  12641. routed = true;
  12642. } else {
  12643. res.status = StatusCode::InternalServerError_500;
  12644. }
  12645. }
  12646. #endif
  12647. auto ret = false;
  12648. if (routed) {
  12649. if (res.status == -1) {
  12650. res.status = req.ranges.empty() ? StatusCode::OK_200
  12651. : StatusCode::PartialContent_206;
  12652. }
  12653. // Before the Range checks below, so they see the body's own length.
  12654. detail::prefer_assigned_body(res);
  12655. // Serve file content by using a content provider
  12656. auto file_open_error = false;
  12657. if (!res.file_content_path_.empty()) {
  12658. const auto &path = res.file_content_path_;
  12659. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12660. if (!mm->is_open()) {
  12661. res.status = StatusCode::NotFound_404;
  12662. output_error_log(Error::OpenFile, &req);
  12663. file_open_error = true;
  12664. } else {
  12665. auto content_type = res.file_content_content_type_;
  12666. if (content_type.empty()) {
  12667. content_type = detail::find_content_type(
  12668. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12669. }
  12670. detail::set_file_content_provider(
  12671. res, mm, content_type,
  12672. static_file_encoding(req, res, content_type, mm->size()));
  12673. }
  12674. }
  12675. if (file_open_error) {
  12676. ret = write_response(strm, close_connection, req, res);
  12677. } else if (detail::range_error(req, res)) {
  12678. detail::clear_content(res);
  12679. res.status = StatusCode::RangeNotSatisfiable_416;
  12680. ret = write_response(strm, close_connection, req, res);
  12681. } else {
  12682. ret = write_response_with_content(strm, close_connection, req, res);
  12683. }
  12684. } else {
  12685. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12686. ret = write_response(strm, close_connection, req, res);
  12687. }
  12688. // Drain any unconsumed framed body to prevent request smuggling on
  12689. // keep-alive. Without framing there is no body to drain — reading would
  12690. // consume the next request (issue #2450). If the response has committed the
  12691. // connection to close, there is no next request to protect. A body read in
  12692. // part cannot be drained from where it stopped, so the connection closes.
  12693. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12694. !detail::has_header_token(res.headers, "Connection", "close")) {
  12695. int dummy_status;
  12696. if (req.body_read_started_ ||
  12697. !detail::read_content(
  12698. strm, req, payload_max_length_, dummy_status, nullptr,
  12699. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12700. connection_closed = true;
  12701. }
  12702. }
  12703. return ret;
  12704. }
  12705. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12706. inline bool Server::process_and_close_socket(socket_t sock) {
  12707. std::string remote_addr;
  12708. int remote_port = 0;
  12709. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12710. std::string local_addr;
  12711. int local_port = 0;
  12712. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12713. bool websocket_upgraded = false;
  12714. auto ret = serve_guarded([&]() {
  12715. return detail::process_server_socket(
  12716. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12717. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12718. write_timeout_usec_,
  12719. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12720. return process_request(strm, remote_addr, remote_port, local_addr,
  12721. local_port, close_connection,
  12722. connection_closed, nullptr,
  12723. &websocket_upgraded);
  12724. });
  12725. });
  12726. detail::drain_and_close_socket(sock);
  12727. return ret;
  12728. }
  12729. inline void Server::output_log(const Request &req, const Response &res) const {
  12730. if (logger_) {
  12731. std::lock_guard<std::mutex> guard(logger_mutex_);
  12732. logger_(req, res);
  12733. }
  12734. }
  12735. inline void Server::output_pre_compression_log(const Request &req,
  12736. const Response &res) const {
  12737. if (pre_compression_logger_) {
  12738. std::lock_guard<std::mutex> guard(logger_mutex_);
  12739. pre_compression_logger_(req, res);
  12740. }
  12741. }
  12742. inline void Server::output_error_log(const Error &err,
  12743. const Request *req) const {
  12744. if (error_logger_) {
  12745. std::lock_guard<std::mutex> guard(logger_mutex_);
  12746. error_logger_(err, req);
  12747. }
  12748. }
  12749. /*
  12750. * Group 5: ClientImpl and Client (Universal) implementation
  12751. */
  12752. // HTTP client implementation
  12753. inline ClientImpl::ClientImpl(const std::string &host)
  12754. : ClientImpl(host, 80, std::string(), std::string()) {}
  12755. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12756. : ClientImpl(host, port, std::string(), std::string()) {}
  12757. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12758. const std::string &client_cert_path,
  12759. const std::string &client_key_path)
  12760. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12761. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12762. inline ClientImpl::~ClientImpl() {
  12763. // Wait until all the requests in flight are handled.
  12764. size_t retry_count = 10;
  12765. while (retry_count-- > 0) {
  12766. {
  12767. std::lock_guard<std::mutex> guard(socket_mutex_);
  12768. if (socket_requests_in_flight_ == 0) { break; }
  12769. }
  12770. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12771. }
  12772. std::lock_guard<std::mutex> guard(socket_mutex_);
  12773. shutdown_socket(socket_);
  12774. close_socket(socket_);
  12775. }
  12776. inline bool ClientImpl::is_valid() const { return true; }
  12777. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12778. client_cert_path_ = rhs.client_cert_path_;
  12779. client_key_path_ = rhs.client_key_path_;
  12780. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12781. read_timeout_sec_ = rhs.read_timeout_sec_;
  12782. read_timeout_usec_ = rhs.read_timeout_usec_;
  12783. write_timeout_sec_ = rhs.write_timeout_sec_;
  12784. write_timeout_usec_ = rhs.write_timeout_usec_;
  12785. max_timeout_msec_ = rhs.max_timeout_msec_;
  12786. basic_auth_username_ = rhs.basic_auth_username_;
  12787. basic_auth_password_ = rhs.basic_auth_password_;
  12788. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12789. keep_alive_ = rhs.keep_alive_;
  12790. follow_location_ = rhs.follow_location_;
  12791. path_encode_ = rhs.path_encode_;
  12792. address_family_ = rhs.address_family_;
  12793. tcp_nodelay_ = rhs.tcp_nodelay_;
  12794. ipv6_v6only_ = rhs.ipv6_v6only_;
  12795. socket_options_ = rhs.socket_options_;
  12796. compress_ = rhs.compress_;
  12797. decompress_ = rhs.decompress_;
  12798. payload_max_length_ = rhs.payload_max_length_;
  12799. has_payload_max_length_ = rhs.has_payload_max_length_;
  12800. interface_ = rhs.interface_;
  12801. proxy_host_ = rhs.proxy_host_;
  12802. proxy_port_ = rhs.proxy_port_;
  12803. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12804. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12805. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12806. no_proxy_entries_ = rhs.no_proxy_entries_;
  12807. logger_ = rhs.logger_;
  12808. error_logger_ = rhs.error_logger_;
  12809. #ifdef CPPHTTPLIB_SSL_ENABLED
  12810. digest_auth_username_ = rhs.digest_auth_username_;
  12811. digest_auth_password_ = rhs.digest_auth_password_;
  12812. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12813. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12814. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12815. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12816. server_certificate_verification_ = rhs.server_certificate_verification_;
  12817. server_hostname_verification_ = rhs.server_hostname_verification_;
  12818. system_ca_mode_ = rhs.system_ca_mode_;
  12819. #endif
  12820. }
  12821. inline bool
  12822. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12823. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12824. if (no_proxy_entries_.empty()) { return true; }
  12825. // host_ is const so its normalized form is invariant; cache it. The
  12826. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12827. if (host == host_) {
  12828. if (!host_normalized_valid_) {
  12829. host_normalized_ = detail::normalize_target(host_);
  12830. host_normalized_valid_ = true;
  12831. }
  12832. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12833. }
  12834. auto target = detail::normalize_target(host);
  12835. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12836. }
  12837. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12838. if (is_proxy_enabled_for_host(host_)) {
  12839. return detail::create_client_socket(
  12840. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12841. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12842. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12843. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12844. }
  12845. // Check is custom IP or hostname specified for host_
  12846. std::string connect_host;
  12847. std::string ip;
  12848. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12849. return detail::create_client_socket(
  12850. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12851. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12852. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12853. write_timeout_usec_, interface_, error);
  12854. }
  12855. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12856. Error &error) {
  12857. auto sock = create_client_socket(error);
  12858. if (sock == INVALID_SOCKET) { return false; }
  12859. socket.sock = sock;
  12860. return true;
  12861. }
  12862. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12863. return create_and_connect_socket(socket, error);
  12864. }
  12865. inline bool ClientImpl::setup_proxy_connection(
  12866. Socket & /*socket*/,
  12867. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12868. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12869. return true;
  12870. }
  12871. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12872. bool /*shutdown_gracefully*/) {
  12873. // If there are any requests in flight from threads other than us, then it's
  12874. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12875. assert(socket_requests_in_flight_ == 0 ||
  12876. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12877. }
  12878. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12879. if (socket.sock == INVALID_SOCKET) { return; }
  12880. detail::shutdown_socket(socket.sock);
  12881. }
  12882. inline void ClientImpl::close_socket(Socket &socket) {
  12883. // If there are requests in flight in another thread, usually closing
  12884. // the socket will be fine and they will simply receive an error when
  12885. // using the closed socket, but it is still a bug since rarely the OS
  12886. // may reassign the socket id to be used for a new socket, and then
  12887. // suddenly they will be operating on a live socket that is different
  12888. // than the one they intended!
  12889. assert(socket_requests_in_flight_ == 0 ||
  12890. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12891. // It is also a bug if this happens while SSL is still active
  12892. #ifdef CPPHTTPLIB_SSL_ENABLED
  12893. assert(socket.ssl == nullptr);
  12894. #endif
  12895. if (socket.sock == INVALID_SOCKET) { return; }
  12896. detail::close_socket(socket.sock);
  12897. socket.sock = INVALID_SOCKET;
  12898. }
  12899. inline void ClientImpl::disconnect(bool gracefully) {
  12900. shutdown_ssl(socket_, gracefully);
  12901. shutdown_socket(socket_);
  12902. close_socket(socket_);
  12903. }
  12904. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12905. Response &res,
  12906. bool skip_100_continue) const {
  12907. std::array<char, 2048> buf{};
  12908. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12909. if (!line_reader.getline()) { return false; }
  12910. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12911. res.reason)) {
  12912. return req.method == "CONNECT";
  12913. }
  12914. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12915. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12916. if (!line_reader.getline()) { return false; } // CRLF
  12917. if (!line_reader.getline()) { return false; } // next response line
  12918. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12919. res.reason)) {
  12920. return false;
  12921. }
  12922. }
  12923. return true;
  12924. }
  12925. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12926. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12927. auto ret = send_(req, res, error);
  12928. if (error == Error::SSLPeerCouldBeClosed_) {
  12929. assert(!ret);
  12930. ret = send_(req, res, error);
  12931. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12932. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12933. }
  12934. return ret;
  12935. }
  12936. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12937. {
  12938. std::lock_guard<std::mutex> guard(socket_mutex_);
  12939. // Set this to false immediately - if it ever gets set to true by the end
  12940. // of the request, we know another thread instructed us to close the
  12941. // socket.
  12942. socket_should_be_closed_when_request_is_done_ = false;
  12943. auto is_alive = false;
  12944. if (socket_.is_open()) {
  12945. is_alive = detail::is_socket_alive(socket_.sock);
  12946. #ifdef CPPHTTPLIB_SSL_ENABLED
  12947. if (is_alive && is_ssl()) {
  12948. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12949. is_alive = false;
  12950. }
  12951. }
  12952. #endif
  12953. if (!is_alive) {
  12954. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12955. disconnect(/*gracefully=*/false);
  12956. }
  12957. }
  12958. if (!is_alive) {
  12959. if (!ensure_socket_connection(socket_, error)) {
  12960. output_error_log(error, &req);
  12961. return false;
  12962. }
  12963. {
  12964. auto success = true;
  12965. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12966. error)) {
  12967. if (!success) { output_error_log(error, &req); }
  12968. return success;
  12969. }
  12970. }
  12971. }
  12972. // Mark the current socket as being in use so that it cannot be closed by
  12973. // anyone else while this request is ongoing, even though we will be
  12974. // releasing the mutex.
  12975. if (socket_requests_in_flight_ > 1) {
  12976. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12977. }
  12978. socket_requests_in_flight_ += 1;
  12979. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12980. }
  12981. for (const auto &header : default_headers_) {
  12982. if (req.headers.find(header.first) == req.headers.end()) {
  12983. req.headers.insert(header);
  12984. }
  12985. }
  12986. auto ret = false;
  12987. auto close_connection = !keep_alive_;
  12988. auto se = detail::scope_exit([&]() {
  12989. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12990. std::lock_guard<std::mutex> guard(socket_mutex_);
  12991. socket_requests_in_flight_ -= 1;
  12992. if (socket_requests_in_flight_ <= 0) {
  12993. assert(socket_requests_in_flight_ == 0);
  12994. socket_requests_are_from_thread_ = std::thread::id();
  12995. }
  12996. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12997. !ret) {
  12998. disconnect(/*gracefully=*/true);
  12999. }
  13000. });
  13001. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13002. return handle_request(strm, req, res, close_connection, error);
  13003. });
  13004. if (!ret) {
  13005. if (error == Error::Success) {
  13006. error = Error::Unknown;
  13007. output_error_log(error, &req);
  13008. }
  13009. }
  13010. return ret;
  13011. }
  13012. inline Result ClientImpl::send(const Request &req) {
  13013. auto req2 = req;
  13014. return send_(std::move(req2));
  13015. }
  13016. inline Result ClientImpl::send_(Request &&req) {
  13017. auto res = detail::make_unique<Response>();
  13018. auto error = Error::Success;
  13019. auto ret = send(req, *res, error);
  13020. #ifdef CPPHTTPLIB_SSL_ENABLED
  13021. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13022. last_ssl_error_, last_backend_error_};
  13023. #else
  13024. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13025. #endif
  13026. }
  13027. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13028. const std::string &ct) {
  13029. (void)for_stream;
  13030. // Default headers are meant for the origin and may carry its credentials, so
  13031. // keep them off the CONNECT request the proxy reads.
  13032. if (r.method != "CONNECT") {
  13033. for (const auto &header : default_headers_) {
  13034. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13035. }
  13036. }
  13037. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13038. // prepend it rather than appending it after the caller's own fields.
  13039. if (!r.has_header("Host")) {
  13040. r.headers.emplace_front(
  13041. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13042. address_family_));
  13043. }
  13044. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13045. if (!r.content_receiver) {
  13046. if (!r.has_header("Accept-Encoding")) {
  13047. std::string accept_encoding;
  13048. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13049. accept_encoding = "br";
  13050. #endif
  13051. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13052. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13053. accept_encoding += "gzip, deflate";
  13054. #endif
  13055. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13056. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13057. accept_encoding += "zstd";
  13058. #endif
  13059. r.set_header("Accept-Encoding", accept_encoding);
  13060. }
  13061. detail::add_default_user_agent_header(r);
  13062. }
  13063. if (!r.body.empty()) {
  13064. if (!ct.empty() && !r.has_header("Content-Type")) {
  13065. r.headers.emplace("Content-Type", ct);
  13066. }
  13067. if (!r.has_header("Content-Length")) {
  13068. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13069. }
  13070. }
  13071. }
  13072. inline ClientImpl::StreamHandle
  13073. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13074. const Params &params, const Headers &headers,
  13075. const std::string &body,
  13076. const std::string &content_type) {
  13077. StreamHandle handle;
  13078. handle.response = detail::make_unique<Response>();
  13079. handle.error = Error::Success;
  13080. // Encode the target exactly like the buffered send path does, so that the
  13081. // same `path` produces the same request line through either API.
  13082. auto raw_query_path =
  13083. params.empty() ? path : append_query_params(path, params);
  13084. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13085. handle.connection_ = detail::make_unique<ClientConnection>();
  13086. {
  13087. std::lock_guard<std::mutex> guard(socket_mutex_);
  13088. auto is_alive = false;
  13089. if (socket_.is_open()) {
  13090. is_alive = detail::is_socket_alive(socket_.sock);
  13091. #ifdef CPPHTTPLIB_SSL_ENABLED
  13092. if (is_alive && is_ssl()) {
  13093. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13094. is_alive = false;
  13095. }
  13096. }
  13097. #endif
  13098. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13099. }
  13100. if (!is_alive) {
  13101. if (!ensure_socket_connection(socket_, handle.error)) {
  13102. handle.response.reset();
  13103. return handle;
  13104. }
  13105. {
  13106. auto success = true;
  13107. auto start_time = std::chrono::steady_clock::now();
  13108. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13109. success, handle.error)) {
  13110. if (!success) { handle.response.reset(); }
  13111. return handle;
  13112. }
  13113. }
  13114. }
  13115. transfer_socket_ownership_to_handle(handle);
  13116. }
  13117. #ifdef CPPHTTPLIB_SSL_ENABLED
  13118. if (is_ssl() && handle.connection_->session) {
  13119. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13120. handle.connection_->sock, handle.connection_->session,
  13121. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13122. write_timeout_usec_);
  13123. } else {
  13124. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13125. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13126. write_timeout_sec_, write_timeout_usec_);
  13127. }
  13128. #else
  13129. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13130. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13131. write_timeout_sec_, write_timeout_usec_);
  13132. #endif
  13133. handle.stream_ = handle.socket_stream_.get();
  13134. Request req;
  13135. req.method = method;
  13136. req.path = query_path;
  13137. req.headers = headers;
  13138. req.body = body;
  13139. prepare_default_headers(req, true, content_type);
  13140. auto &strm = *handle.stream_;
  13141. // Build the request line and headers in memory first, like write_request()
  13142. // does, so that a rejected header leaves nothing on the wire.
  13143. {
  13144. detail::BufferStream bstrm;
  13145. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13146. handle.error = Error::Write;
  13147. handle.response.reset();
  13148. return handle;
  13149. }
  13150. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13151. handle.error)) {
  13152. handle.response.reset();
  13153. return handle;
  13154. }
  13155. const auto &data = bstrm.get_buffer();
  13156. if (!detail::write_data(strm, data.data(), data.size())) {
  13157. handle.error = Error::Write;
  13158. handle.response.reset();
  13159. return handle;
  13160. }
  13161. }
  13162. if (!body.empty()) {
  13163. if (strm.write(body.data(), body.size()) < 0) {
  13164. handle.error = Error::Write;
  13165. handle.response.reset();
  13166. return handle;
  13167. }
  13168. }
  13169. if (!read_response_line(strm, req, *handle.response) ||
  13170. !detail::read_headers(strm, handle.response->headers)) {
  13171. handle.error = Error::Read;
  13172. handle.response.reset();
  13173. return handle;
  13174. }
  13175. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13176. // (204/304) response legitimately carries framing headers with no body.
  13177. if (method != "HEAD" &&
  13178. handle.response->status != StatusCode::NoContent_204 &&
  13179. handle.response->status != StatusCode::NotModified_304 &&
  13180. detail::has_conflicting_content_length(handle.response->headers)) {
  13181. handle.error = Error::Read;
  13182. handle.response.reset();
  13183. return handle;
  13184. }
  13185. handle.body_reader_.stream = handle.stream_;
  13186. handle.body_reader_.payload_max_length = payload_max_length_;
  13187. if (handle.response->has_header("Content-Length")) {
  13188. bool is_invalid = false;
  13189. auto content_length = detail::get_header_value_u64(
  13190. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13191. if (is_invalid) {
  13192. handle.error = Error::Read;
  13193. handle.response.reset();
  13194. return handle;
  13195. }
  13196. handle.body_reader_.has_content_length = true;
  13197. handle.body_reader_.content_length = content_length;
  13198. }
  13199. handle.body_reader_.chunked =
  13200. detail::is_chunked_transfer_encoding(handle.response->headers);
  13201. auto content_encoding = detail::get_combined_header_value(
  13202. handle.response->headers, "Content-Encoding");
  13203. if (!content_encoding.empty()) {
  13204. // Same policy as prepare_content_receiver(): reject a coding we know about
  13205. // but were not built with, pass an unrecognized one through as-is.
  13206. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13207. if (!handle.decompressor_) {
  13208. if (detail::is_known_content_encoding(content_encoding)) {
  13209. handle.error = Error::UnsupportedContentEncoding;
  13210. handle.response.reset();
  13211. return handle;
  13212. }
  13213. } else if (!handle.decompressor_->is_valid()) {
  13214. handle.error = Error::Compression;
  13215. handle.response.reset();
  13216. return handle;
  13217. }
  13218. }
  13219. return handle;
  13220. }
  13221. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13222. if (!is_valid() || !response) { return -1; }
  13223. if (decompressor_) { return read_with_decompression(buf, len); }
  13224. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13225. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13226. trailers_parsed_ = true;
  13227. if (body_reader_.chunked_decoder) {
  13228. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13229. response->trailers, response->headers)) {
  13230. return n;
  13231. }
  13232. } else {
  13233. detail::ChunkedDecoder dec(*stream_);
  13234. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13235. return n;
  13236. }
  13237. }
  13238. }
  13239. return n;
  13240. }
  13241. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13242. size_t len) {
  13243. if (decompress_offset_ < decompress_buffer_.size()) {
  13244. auto available = decompress_buffer_.size() - decompress_offset_;
  13245. auto to_copy = (std::min)(len, available);
  13246. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13247. decompress_offset_ += to_copy;
  13248. decompressed_bytes_read_ += to_copy;
  13249. return static_cast<ssize_t>(to_copy);
  13250. }
  13251. decompress_buffer_.clear();
  13252. decompress_offset_ = 0;
  13253. constexpr size_t kDecompressionBufferSize = 8192;
  13254. char compressed_buf[kDecompressionBufferSize];
  13255. while (true) {
  13256. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13257. sizeof(compressed_buf));
  13258. if (n <= 0) { return n; }
  13259. bool decompress_ok = decompressor_->decompress(
  13260. compressed_buf, static_cast<size_t>(n),
  13261. [this](const char *data, size_t data_len) {
  13262. decompress_buffer_.append(data, data_len);
  13263. auto limit = body_reader_.payload_max_length;
  13264. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  13265. return false;
  13266. }
  13267. return true;
  13268. });
  13269. if (!decompress_ok) {
  13270. body_reader_.last_error = Error::Read;
  13271. return -1;
  13272. }
  13273. if (!decompress_buffer_.empty()) { break; }
  13274. }
  13275. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13276. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13277. decompress_offset_ = to_copy;
  13278. decompressed_bytes_read_ += to_copy;
  13279. return static_cast<ssize_t>(to_copy);
  13280. }
  13281. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13282. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13283. return;
  13284. }
  13285. trailers_parsed_ = true;
  13286. const auto bufsiz = 128;
  13287. char line_buf[bufsiz];
  13288. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13289. if (!line_reader.getline()) { return; }
  13290. if (!detail::parse_trailers(line_reader, response->trailers,
  13291. response->headers)) {
  13292. return;
  13293. }
  13294. }
  13295. namespace detail {
  13296. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13297. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13298. size_t &out_chunk_offset,
  13299. size_t &out_chunk_total) {
  13300. if (finished) { return 0; }
  13301. if (chunk_remaining == 0) {
  13302. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13303. if (!lr.getline()) { return -1; }
  13304. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13305. // the line terminator is never mistaken for line content.
  13306. const char *eol = lr.ptr() + lr.size();
  13307. if (lr.end_with_crlf()) {
  13308. eol -= 2;
  13309. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13310. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13311. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13312. // has to come off here or the check below would reject the line.
  13313. eol -= 1;
  13314. }
  13315. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13316. const char *p = lr.ptr();
  13317. int v = 0;
  13318. if (p == eol || !is_hex(*p, v)) { return -1; }
  13319. size_t chunk_len = 0;
  13320. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13321. for (; p < eol && is_hex(*p, v); ++p) {
  13322. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13323. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13324. }
  13325. while (p < eol && is_space_or_tab(*p)) {
  13326. ++p;
  13327. }
  13328. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13329. // terminator, and it is built from tokens and quoted-strings, so it never
  13330. // holds a CR, LF or any other control character. getline() reads up to the
  13331. // CRLF, so a bare LF left in here would be swallowed as extension text
  13332. // while an intermediary that ends the line on it delimits the chunks
  13333. // differently, and the two disagree on where the body ends (request
  13334. // smuggling).
  13335. if (p < eol && *p != ';') { return -1; }
  13336. for (; p < eol; ++p) {
  13337. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13338. }
  13339. if (chunk_len == 0) {
  13340. chunk_remaining = 0;
  13341. finished = true;
  13342. out_chunk_offset = 0;
  13343. out_chunk_total = 0;
  13344. return 0;
  13345. }
  13346. chunk_remaining = chunk_len;
  13347. last_chunk_total = chunk_remaining;
  13348. last_chunk_offset = 0;
  13349. }
  13350. auto to_read = (std::min)(chunk_remaining, len);
  13351. auto n = strm.read(buf, to_read);
  13352. if (n <= 0) { return -1; }
  13353. auto offset_before = last_chunk_offset;
  13354. last_chunk_offset += static_cast<size_t>(n);
  13355. chunk_remaining -= static_cast<size_t>(n);
  13356. out_chunk_offset = offset_before;
  13357. out_chunk_total = last_chunk_total;
  13358. if (chunk_remaining == 0) {
  13359. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13360. if (!lr.getline()) { return -1; }
  13361. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13362. }
  13363. return n;
  13364. }
  13365. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13366. const Headers &src_headers) {
  13367. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13368. if (!lr.getline()) { return false; }
  13369. return parse_trailers(lr, dest, src_headers);
  13370. }
  13371. } // namespace detail
  13372. inline void
  13373. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13374. handle.connection_->sock = socket_.sock;
  13375. #ifdef CPPHTTPLIB_SSL_ENABLED
  13376. handle.connection_->session = socket_.ssl;
  13377. socket_.ssl = nullptr;
  13378. #endif
  13379. socket_.sock = INVALID_SOCKET;
  13380. }
  13381. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13382. Response &res, bool close_connection,
  13383. Error &error) {
  13384. if (req.path.empty()) {
  13385. error = Error::Connection;
  13386. output_error_log(error, &req);
  13387. return false;
  13388. }
  13389. auto req_save = req;
  13390. bool ret;
  13391. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13392. auto req2 = req;
  13393. req2.path = "http://" +
  13394. detail::make_host_and_port_string(host_, port_, false) +
  13395. req.path;
  13396. ret = process_request(strm, req2, res, close_connection, error);
  13397. req = std::move(req2);
  13398. req.path = req_save.path;
  13399. } else {
  13400. ret = process_request(strm, req, res, close_connection, error);
  13401. }
  13402. if (!ret) { return false; }
  13403. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13404. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13405. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13406. // for this to be safe.
  13407. // This is safe to call because handle_request is only called by send_
  13408. // which locks the request mutex during the process. It would be a bug
  13409. // to call it from a different thread since it's a thread-safety issue
  13410. // to do these things to the socket if another thread is using the socket.
  13411. std::lock_guard<std::mutex> guard(socket_mutex_);
  13412. disconnect(/*gracefully=*/true);
  13413. }
  13414. if (300 < res.status && res.status < 400 && follow_location_) {
  13415. req = std::move(req_save);
  13416. ret = redirect(req, res, error);
  13417. }
  13418. #ifdef CPPHTTPLIB_SSL_ENABLED
  13419. if ((res.status == StatusCode::Unauthorized_401 ||
  13420. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13421. req.authorization_count_ < 5) {
  13422. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13423. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13424. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13425. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13426. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13427. return ret;
  13428. }
  13429. const auto &username =
  13430. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13431. const auto &password =
  13432. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13433. if (!username.empty() && !password.empty()) {
  13434. std::map<std::string, std::string> auth;
  13435. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13436. Request new_req = req;
  13437. new_req.authorization_count_ += 1;
  13438. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13439. : "Authorization");
  13440. new_req.headers.insert(detail::make_digest_authentication_header(
  13441. req, auth, new_req.authorization_count_, detail::random_string(10),
  13442. username, password, is_proxy));
  13443. Response new_res;
  13444. ret = send(new_req, new_res, error);
  13445. if (ret) { res = std::move(new_res); }
  13446. }
  13447. }
  13448. }
  13449. #endif
  13450. return ret;
  13451. }
  13452. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13453. if (req.redirect_count_ == 0) {
  13454. error = Error::ExceedRedirectCount;
  13455. output_error_log(error, &req);
  13456. return false;
  13457. }
  13458. auto location = res.get_header_value("location");
  13459. if (location.empty()) { return false; }
  13460. detail::UrlComponents uc;
  13461. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13462. uc)) {
  13463. return false;
  13464. }
  13465. // Only follow http/https redirects
  13466. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13467. return false;
  13468. }
  13469. auto scheme = is_ssl() ? "https" : "http";
  13470. auto next_scheme = std::move(uc.scheme);
  13471. auto next_host = std::move(uc.host);
  13472. auto port_str = std::move(uc.port);
  13473. auto next_path = std::move(uc.path);
  13474. auto next_query = std::move(uc.query);
  13475. auto next_port = port_;
  13476. if (!port_str.empty()) {
  13477. if (!detail::parse_port(port_str, next_port)) { return false; }
  13478. } else if (!next_scheme.empty()) {
  13479. next_port = next_scheme == "https" ? 443 : 80;
  13480. }
  13481. if (next_scheme.empty()) { next_scheme = scheme; }
  13482. if (next_host.empty()) { next_host = host_; }
  13483. if (next_path.empty()) { next_path = "/"; }
  13484. auto path = std::move(next_path) + next_query;
  13485. // Same host redirect - use current client
  13486. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13487. return detail::redirect(*this, req, res, path, location, error);
  13488. }
  13489. // Cross-host/scheme redirect - create new client with robust setup
  13490. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13491. path, location, error);
  13492. }
  13493. // New method for robust redirect client creation
  13494. inline bool ClientImpl::create_redirect_client(
  13495. const std::string &scheme, const std::string &host, int port, Request &req,
  13496. Response &res, const std::string &path, const std::string &location,
  13497. Error &error) {
  13498. // Determine if we need SSL
  13499. auto need_ssl = (scheme == "https");
  13500. // Clean up request headers that are host/client specific
  13501. // Remove headers that should not be carried over to new host
  13502. auto headers_to_remove = std::vector<std::string>{
  13503. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13504. for (const auto &header_name : headers_to_remove) {
  13505. auto it = req.headers.find(header_name);
  13506. while (it != req.headers.end()) {
  13507. it = req.headers.erase(it);
  13508. it = req.headers.find(header_name);
  13509. }
  13510. }
  13511. // Create appropriate client type and handle redirect
  13512. if (need_ssl) {
  13513. #ifdef CPPHTTPLIB_SSL_ENABLED
  13514. // Create SSL client for HTTPS redirect
  13515. SSLClient redirect_client(host, port);
  13516. // Setup basic client configuration first
  13517. setup_redirect_client(redirect_client);
  13518. redirect_client.enable_server_certificate_verification(
  13519. server_certificate_verification_);
  13520. redirect_client.enable_server_hostname_verification(
  13521. server_hostname_verification_);
  13522. redirect_client.system_ca_mode_ = system_ca_mode_;
  13523. // Transfer CA certificate to redirect client
  13524. if (!ca_cert_pem_.empty()) {
  13525. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13526. ca_cert_pem_.size());
  13527. }
  13528. if (!ca_cert_file_path_.empty()) {
  13529. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13530. }
  13531. // Client certificates are set through constructor for SSLClient
  13532. // NOTE: SSLClient constructor already takes client_cert_path and
  13533. // client_key_path so we need to create it properly if client certs are
  13534. // needed
  13535. // Execute the redirect
  13536. return detail::redirect(redirect_client, req, res, path, location, error);
  13537. #else
  13538. // SSL not supported - set appropriate error
  13539. error = Error::SSLConnection;
  13540. output_error_log(error, &req);
  13541. return false;
  13542. #endif
  13543. } else {
  13544. // HTTP redirect
  13545. ClientImpl redirect_client(host, port);
  13546. // Setup client with robust configuration
  13547. setup_redirect_client(redirect_client);
  13548. // Execute the redirect
  13549. return detail::redirect(redirect_client, req, res, path, location, error);
  13550. }
  13551. }
  13552. // New method for robust client setup (based on basic_manual_redirect.cpp
  13553. // logic)
  13554. template <typename ClientType>
  13555. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13556. // Copy basic settings first
  13557. client.set_connection_timeout(connection_timeout_sec_);
  13558. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13559. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13560. client.set_keep_alive(keep_alive_);
  13561. client.set_follow_location(
  13562. true); // Enable redirects to handle multi-step redirects
  13563. client.set_path_encode(path_encode_);
  13564. client.set_compress(compress_);
  13565. client.set_decompress(decompress_);
  13566. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13567. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13568. // 15.4, credentials must not be forwarded when redirecting to a different
  13569. // host. This function is only called for cross-host redirects; same-host
  13570. // redirects are handled directly in ClientImpl::redirect().
  13571. // Copy the proxy configuration unconditionally; the per-target bypass is
  13572. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13573. // still use the proxy.
  13574. client.no_proxy_entries_ = no_proxy_entries_;
  13575. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13576. client.set_proxy(proxy_host_, proxy_port_);
  13577. if (!proxy_basic_auth_username_.empty() ||
  13578. !proxy_basic_auth_password_.empty()) {
  13579. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13580. proxy_basic_auth_password_);
  13581. }
  13582. if (!proxy_bearer_token_auth_token_.empty()) {
  13583. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13584. }
  13585. #ifdef CPPHTTPLIB_SSL_ENABLED
  13586. if (!proxy_digest_auth_username_.empty()) {
  13587. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13588. proxy_digest_auth_password_);
  13589. }
  13590. #endif
  13591. }
  13592. // Copy network and socket settings
  13593. client.set_address_family(address_family_);
  13594. client.set_tcp_nodelay(tcp_nodelay_);
  13595. client.set_ipv6_v6only(ipv6_v6only_);
  13596. if (socket_options_) { client.set_socket_options(socket_options_); }
  13597. if (!interface_.empty()) { client.set_interface(interface_); }
  13598. // Copy logging and headers
  13599. if (logger_) { client.set_logger(logger_); }
  13600. if (error_logger_) { client.set_error_logger(error_logger_); }
  13601. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13602. // Each new client should generate its own headers based on its target host
  13603. }
  13604. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13605. const Request &req,
  13606. Error &error) const {
  13607. auto is_shutting_down = []() { return false; };
  13608. if (req.is_chunked_content_provider_) {
  13609. auto compressor = compress_ ? detail::create_compressor().first
  13610. : std::unique_ptr<detail::compressor>();
  13611. if (!compressor) {
  13612. compressor = detail::make_unique<detail::nocompressor>();
  13613. }
  13614. return detail::write_content_chunked(strm, req.content_provider_,
  13615. is_shutting_down, *compressor, error);
  13616. } else {
  13617. return detail::write_content_with_progress(
  13618. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13619. req.upload_progress, error);
  13620. }
  13621. }
  13622. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13623. bool close_connection, Error &error,
  13624. bool skip_body, bool &rejected_locally) {
  13625. rejected_locally = false;
  13626. // Prepare additional headers
  13627. if (close_connection) {
  13628. if (!req.has_header("Connection")) {
  13629. req.set_header("Connection", "close");
  13630. }
  13631. }
  13632. std::string ct_for_defaults;
  13633. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13634. ct_for_defaults = "text/plain";
  13635. }
  13636. prepare_default_headers(req, false, ct_for_defaults);
  13637. if (req.body.empty()) {
  13638. if (req.content_provider_) {
  13639. if (!req.is_chunked_content_provider_) {
  13640. if (!req.has_header("Content-Length")) {
  13641. auto length = std::to_string(req.content_length_);
  13642. req.set_header("Content-Length", length);
  13643. }
  13644. }
  13645. } else {
  13646. if (req.method == "POST" || req.method == "PUT" ||
  13647. req.method == "PATCH") {
  13648. req.set_header("Content-Length", "0");
  13649. }
  13650. }
  13651. }
  13652. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13653. // it opens is read by the origin. Each credential goes only to its own hop.
  13654. auto is_connect = req.method == "CONNECT";
  13655. if (!is_connect && !req.has_header("Authorization")) {
  13656. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13657. req.headers.insert(make_basic_authentication_header(
  13658. basic_auth_username_, basic_auth_password_, false));
  13659. } else if (!bearer_token_auth_token_.empty()) {
  13660. req.headers.insert(make_bearer_token_authentication_header(
  13661. bearer_token_auth_token_, false));
  13662. }
  13663. }
  13664. // Proxy-Authorization is only sent when the proxy reads this message —
  13665. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13666. // would leak proxy credentials to the destination server.
  13667. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13668. if ((!proxy_basic_auth_username_.empty() ||
  13669. !proxy_basic_auth_password_.empty()) &&
  13670. !req.has_header("Proxy-Authorization")) {
  13671. req.headers.insert(make_basic_authentication_header(
  13672. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13673. }
  13674. if (!proxy_bearer_token_auth_token_.empty() &&
  13675. !req.has_header("Proxy-Authorization")) {
  13676. req.headers.insert(make_bearer_token_authentication_header(
  13677. proxy_bearer_token_auth_token_, true));
  13678. }
  13679. }
  13680. // Request line and headers
  13681. {
  13682. detail::BufferStream bstrm;
  13683. // Extract the query from req.path. The encoding itself is delegated to
  13684. // `encode_request_target`; the raw query is still needed here to decide
  13685. // between populating `req.params` from it and falling back to building a
  13686. // query out of caller-supplied `req.params`.
  13687. auto query_pos = req.path.find('?');
  13688. auto query_part = query_pos == std::string::npos
  13689. ? std::string()
  13690. : req.path.substr(query_pos + 1);
  13691. auto path_with_query =
  13692. detail::encode_request_target(req.path, path_encode_);
  13693. if (!query_part.empty()) {
  13694. // The query already came in through `req.path`; still populate
  13695. // `req.params` for handlers/users who read them.
  13696. detail::parse_query_text(query_part, req.params);
  13697. } else if (!req.params.empty()) {
  13698. // No query in `req.path`; build one from `req.params` so existing
  13699. // callers that pass `Params` separately continue to work.
  13700. path_with_query = append_query_params(path_with_query, req.params);
  13701. }
  13702. // Write request line and headers
  13703. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13704. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13705. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13706. // fail the request cleanly instead of emitting a request-line-less,
  13707. // header-injecting request.
  13708. error = Error::Write;
  13709. rejected_locally = true;
  13710. output_error_log(error, &req);
  13711. return false;
  13712. }
  13713. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13714. error)) {
  13715. rejected_locally = true;
  13716. output_error_log(error, &req);
  13717. return false;
  13718. }
  13719. // Flush buffer
  13720. auto &data = bstrm.get_buffer();
  13721. if (!detail::write_data(strm, data.data(), data.size())) {
  13722. error = Error::Write;
  13723. output_error_log(error, &req);
  13724. return false;
  13725. }
  13726. }
  13727. // After sending request line and headers, wait briefly for an early server
  13728. // response (e.g. 4xx) and avoid sending a potentially large request body
  13729. // unnecessarily. This workaround is only enabled on Windows because Unix
  13730. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13731. // buffering can accept large writes even when the peer already responded.
  13732. // Check the stream first (which covers SSL via `is_readable()`), then
  13733. // fall back to select on the socket. Only perform the wait for very large
  13734. // request bodies to avoid interfering with normal small requests and
  13735. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13736. // response. Skip this check when using Expect: 100-continue, as the protocol
  13737. // handles early responses properly.
  13738. #if defined(_WIN32)
  13739. if (!skip_body &&
  13740. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13741. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13742. auto start = std::chrono::high_resolution_clock::now();
  13743. for (;;) {
  13744. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13745. // from SSL internals. If the underlying socket is readable, assume an
  13746. // early response may be present.
  13747. auto sock = strm.socket();
  13748. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13749. return false;
  13750. }
  13751. // Fallback to stream-level check for non-socket streams or when the
  13752. // socket isn't reporting readable. Avoid using `is_readable()` for
  13753. // SSL, since `SSL_pending()` may report buffered records that do not
  13754. // indicate a complete application-level response yet.
  13755. if (!is_ssl() && strm.is_readable()) { return false; }
  13756. auto now = std::chrono::high_resolution_clock::now();
  13757. auto elapsed =
  13758. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13759. .count();
  13760. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13761. break;
  13762. }
  13763. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13764. }
  13765. }
  13766. #endif
  13767. // Body
  13768. if (skip_body) { return true; }
  13769. return write_request_body(strm, req, error);
  13770. }
  13771. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13772. Error &error) {
  13773. if (req.body.empty()) {
  13774. return write_content_with_provider(strm, req, error);
  13775. }
  13776. if (req.upload_progress) {
  13777. auto body_size = req.body.size();
  13778. size_t written = 0;
  13779. auto data = req.body.data();
  13780. while (written < body_size) {
  13781. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13782. if (!detail::write_data(strm, data + written, to_write)) {
  13783. error = Error::Write;
  13784. output_error_log(error, &req);
  13785. return false;
  13786. }
  13787. written += to_write;
  13788. if (!req.upload_progress(written, body_size)) {
  13789. error = Error::Canceled;
  13790. output_error_log(error, &req);
  13791. return false;
  13792. }
  13793. }
  13794. } else {
  13795. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13796. error = Error::Write;
  13797. output_error_log(error, &req);
  13798. return false;
  13799. }
  13800. }
  13801. return true;
  13802. }
  13803. inline std::unique_ptr<Response>
  13804. ClientImpl::send_with_content_provider_and_receiver(
  13805. Request &req, const char *body, size_t content_length,
  13806. ContentProvider content_provider,
  13807. ContentProviderWithoutLength content_provider_without_length,
  13808. const std::string &content_type, ContentReceiver content_receiver,
  13809. Error &error) {
  13810. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13811. auto enc = compress_
  13812. ? detail::create_compressor()
  13813. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13814. nullptr, nullptr);
  13815. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13816. if (enc.first && !content_provider_without_length) {
  13817. auto &compressor = enc.first;
  13818. if (content_provider) {
  13819. auto ok = true;
  13820. auto finished = false;
  13821. size_t offset = 0;
  13822. DataSink data_sink;
  13823. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13824. if (ok) {
  13825. auto last = offset + data_len == content_length;
  13826. auto ret = compressor->compress(
  13827. data, data_len, last,
  13828. [&](const char *compressed_data, size_t compressed_data_len) {
  13829. req.body.append(compressed_data, compressed_data_len);
  13830. return true;
  13831. });
  13832. if (ret) {
  13833. offset += data_len;
  13834. } else {
  13835. ok = false;
  13836. }
  13837. }
  13838. return ok;
  13839. };
  13840. // As in detail::write_content_with_progress(): the body is framed by
  13841. // content_length, so a provider that finishes early has truncated it.
  13842. // Stop and report that instead of calling the provider forever.
  13843. data_sink.done = [&]() { finished = true; };
  13844. while (ok && !finished && offset < content_length) {
  13845. if (!content_provider(offset, content_length - offset, data_sink)) {
  13846. error = Error::Canceled;
  13847. output_error_log(error, &req);
  13848. return nullptr;
  13849. }
  13850. }
  13851. // A short body here means either the provider stopped early or the
  13852. // compressor gave up. The branch below reports a failing compressor as
  13853. // Error::Compression, so keep the two distinguishable.
  13854. if (offset < content_length) {
  13855. error = ok ? Error::Write : Error::Compression;
  13856. output_error_log(error, &req);
  13857. return nullptr;
  13858. }
  13859. } else {
  13860. if (!compressor->compress(body, content_length, true,
  13861. [&](const char *data, size_t data_len) {
  13862. req.body.append(data, data_len);
  13863. return true;
  13864. })) {
  13865. error = Error::Compression;
  13866. output_error_log(error, &req);
  13867. return nullptr;
  13868. }
  13869. }
  13870. } else {
  13871. if (content_provider) {
  13872. req.content_length_ = content_length;
  13873. req.content_provider_ = std::move(content_provider);
  13874. req.is_chunked_content_provider_ = false;
  13875. } else if (content_provider_without_length) {
  13876. req.content_length_ = 0;
  13877. req.content_provider_ = detail::ContentProviderAdapter(
  13878. std::move(content_provider_without_length));
  13879. req.is_chunked_content_provider_ = true;
  13880. req.set_header("Transfer-Encoding", "chunked");
  13881. } else {
  13882. req.body.assign(body, content_length);
  13883. }
  13884. }
  13885. if (content_receiver) {
  13886. req.content_receiver =
  13887. [content_receiver](const char *data, size_t data_length,
  13888. size_t /*offset*/, size_t /*total_length*/) {
  13889. return content_receiver(data, data_length);
  13890. };
  13891. }
  13892. auto res = detail::make_unique<Response>();
  13893. return send(req, *res, error) ? std::move(res) : nullptr;
  13894. }
  13895. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13896. const std::string &method, const std::string &path, const Headers &headers,
  13897. const char *body, size_t content_length, ContentProvider content_provider,
  13898. ContentProviderWithoutLength content_provider_without_length,
  13899. const std::string &content_type, ContentReceiver content_receiver,
  13900. UploadProgress progress) {
  13901. Request req;
  13902. req.method = method;
  13903. req.headers = headers;
  13904. req.path = path;
  13905. req.upload_progress = std::move(progress);
  13906. if (max_timeout_msec_ > 0) {
  13907. req.start_time_ = std::chrono::steady_clock::now();
  13908. }
  13909. auto error = Error::Success;
  13910. auto res = send_with_content_provider_and_receiver(
  13911. req, body, content_length, std::move(content_provider),
  13912. std::move(content_provider_without_length), content_type,
  13913. std::move(content_receiver), error);
  13914. #ifdef CPPHTTPLIB_SSL_ENABLED
  13915. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13916. last_backend_error_};
  13917. #else
  13918. return Result{std::move(res), error, std::move(req.headers)};
  13919. #endif
  13920. }
  13921. inline void ClientImpl::output_log(const Request &req,
  13922. const Response &res) const {
  13923. if (logger_) {
  13924. std::lock_guard<std::mutex> guard(logger_mutex_);
  13925. logger_(req, res);
  13926. }
  13927. }
  13928. inline void ClientImpl::output_error_log(const Error &err,
  13929. const Request *req) const {
  13930. if (error_logger_) {
  13931. std::lock_guard<std::mutex> guard(logger_mutex_);
  13932. error_logger_(err, req);
  13933. }
  13934. }
  13935. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13936. Response &res, bool close_connection,
  13937. Error &error) {
  13938. // Auto-add Expect: 100-continue for large bodies
  13939. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13940. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13941. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13942. req.set_header("Expect", "100-continue");
  13943. }
  13944. }
  13945. // Check for Expect: 100-continue
  13946. auto expect_100_continue =
  13947. detail::has_header_token(req.headers, "Expect", "100-continue");
  13948. // Send request (skip body if using Expect: 100-continue)
  13949. auto rejected_locally = false;
  13950. auto write_request_success =
  13951. write_request(strm, req, close_connection, error, expect_100_continue,
  13952. rejected_locally);
  13953. // A failed write normally still reads the response below, since the server
  13954. // may have answered early (e.g. 413/414) and closed while the body was being
  13955. // sent. A request rejected before any byte reached the socket gets no such
  13956. // response, and waiting for one would block until the read timeout.
  13957. if (rejected_locally) { return false; }
  13958. #ifdef CPPHTTPLIB_SSL_ENABLED
  13959. if (is_ssl() && !expect_100_continue) {
  13960. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13961. if (!is_proxy_enabled) {
  13962. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13963. error = Error::SSLPeerCouldBeClosed_;
  13964. output_error_log(error, &req);
  13965. return false;
  13966. }
  13967. }
  13968. }
  13969. #endif
  13970. // Handle Expect: 100-continue.
  13971. //
  13972. // Wait for an interim/early response by attempting to read the status line
  13973. // under a short timeout, instead of trusting raw socket readability. Over
  13974. // TLS, post-handshake records (e.g. session tickets) make the socket
  13975. // readable without any HTTP response being available; relying on
  13976. // `select_read` there caused the body to be withheld forever and the
  13977. // request to fail with `Read` (#2458). If no status line arrives within the
  13978. // timeout, send the body anyway (matching curl's behavior).
  13979. auto status_line_read = false;
  13980. if (expect_100_continue && write_request_success) {
  13981. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13982. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13983. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13984. strm.set_read_timeout(sec, usec);
  13985. status_line_read = read_response_line(strm, req, res, false);
  13986. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13987. }
  13988. if (!status_line_read) {
  13989. // No interim response within the timeout: send the body and handle the
  13990. // response as usual.
  13991. if (!write_request_body(strm, req, error)) { return false; }
  13992. expect_100_continue = false; // Switch to normal response handling
  13993. }
  13994. }
  13995. // Receive response and headers
  13996. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13997. if ((!status_line_read &&
  13998. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13999. !detail::read_headers(strm, res.headers)) {
  14000. if (write_request_success) { error = Error::Read; }
  14001. output_error_log(error, &req);
  14002. return false;
  14003. }
  14004. if (!write_request_success) { return false; }
  14005. // Handle Expect: 100-continue response
  14006. if (expect_100_continue) {
  14007. if (res.status == StatusCode::Continue_100) {
  14008. // Server accepted, send the body
  14009. if (!write_request_body(strm, req, error)) { return false; }
  14010. // Read the actual response
  14011. res.headers.clear();
  14012. res.body.clear();
  14013. if (!read_response_line(strm, req, res) ||
  14014. !detail::read_headers(strm, res.headers)) {
  14015. error = Error::Read;
  14016. output_error_log(error, &req);
  14017. return false;
  14018. }
  14019. }
  14020. // If not 100 Continue, server returned an error; proceed with that response
  14021. }
  14022. // Body
  14023. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14024. req.method != "CONNECT") {
  14025. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14026. // whose final transfer coding is not chunked is not ambiguous: its body
  14027. // runs until the server closes the connection, so it is not rejected.
  14028. // HEAD/204 are excluded above and a 304 carries no body.
  14029. if (res.status != StatusCode::NotModified_304 &&
  14030. detail::has_conflicting_content_length(res.headers)) {
  14031. error = Error::Read;
  14032. output_error_log(error, &req);
  14033. return false;
  14034. }
  14035. auto redirect = 300 < res.status && res.status < 400 &&
  14036. res.status != StatusCode::NotModified_304 &&
  14037. follow_location_;
  14038. if (req.response_handler && !redirect) {
  14039. if (!req.response_handler(res)) {
  14040. error = Error::Canceled;
  14041. output_error_log(error, &req);
  14042. return false;
  14043. }
  14044. }
  14045. auto out =
  14046. req.content_receiver
  14047. ? static_cast<ContentReceiverWithProgress>(
  14048. [&](const char *buf, size_t n, size_t off, size_t len) {
  14049. if (redirect) { return true; }
  14050. auto ret = req.content_receiver(buf, n, off, len);
  14051. if (!ret) {
  14052. error = Error::Canceled;
  14053. output_error_log(error, &req);
  14054. }
  14055. return ret;
  14056. })
  14057. : static_cast<ContentReceiverWithProgress>(
  14058. [&](const char *buf, size_t n, size_t /*off*/,
  14059. size_t /*len*/) {
  14060. assert(res.body.size() + n <= res.body.max_size());
  14061. if (payload_max_length_ > 0 &&
  14062. (res.body.size() >= payload_max_length_ ||
  14063. n > payload_max_length_ - res.body.size())) {
  14064. return false;
  14065. }
  14066. res.body.append(buf, n);
  14067. return true;
  14068. });
  14069. auto progress = [&](size_t current, size_t total) {
  14070. if (!req.download_progress || redirect) { return true; }
  14071. auto ret = req.download_progress(current, total);
  14072. if (!ret) {
  14073. error = Error::Canceled;
  14074. output_error_log(error, &req);
  14075. }
  14076. return ret;
  14077. };
  14078. if (res.has_header("Content-Length")) {
  14079. if (!req.content_receiver) {
  14080. auto len = res.get_header_value_u64("Content-Length");
  14081. if (len > res.body.max_size()) {
  14082. error = Error::Read;
  14083. output_error_log(error, &req);
  14084. return false;
  14085. }
  14086. // Cap the reservation by payload_max_length_ to avoid OOM when a
  14087. // hostile or malformed server sends an enormous Content-Length.
  14088. // The actual body read below is bounded by payload_max_length_,
  14089. // so reserving more than that is never useful.
  14090. auto reserve_len = static_cast<size_t>(len);
  14091. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  14092. reserve_len = payload_max_length_;
  14093. }
  14094. res.body.reserve(reserve_len);
  14095. }
  14096. }
  14097. if (res.status != StatusCode::NotModified_304) {
  14098. auto content_status = 0;
  14099. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14100. ? (std::numeric_limits<size_t>::max)()
  14101. : payload_max_length_;
  14102. if (!detail::read_content(strm, res, max_length, content_status,
  14103. std::move(progress), std::move(out),
  14104. decompress_)) {
  14105. if (error != Error::Canceled) {
  14106. // Tell the caller apart from a plain read failure when the body could
  14107. // not be decoded because of its Content-Encoding.
  14108. switch (content_status) {
  14109. case StatusCode::UnsupportedMediaType_415:
  14110. error = Error::UnsupportedContentEncoding;
  14111. break;
  14112. case StatusCode::InternalServerError_500:
  14113. error = Error::Compression;
  14114. break;
  14115. default: error = Error::Read; break;
  14116. }
  14117. }
  14118. output_error_log(error, &req);
  14119. return false;
  14120. }
  14121. }
  14122. }
  14123. // Log
  14124. output_log(req, res);
  14125. return true;
  14126. }
  14127. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14128. const std::string &boundary, const UploadFormDataItems &items,
  14129. const FormDataProviderItems &provider_items) const {
  14130. size_t cur_item = 0;
  14131. size_t cur_start = 0;
  14132. // cur_item and cur_start are copied to within the std::function and
  14133. // maintain state between successive calls
  14134. return [&, cur_item, cur_start](size_t offset,
  14135. DataSink &sink) mutable -> bool {
  14136. if (!offset && !items.empty()) {
  14137. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14138. return true;
  14139. } else if (cur_item < provider_items.size()) {
  14140. if (!cur_start) {
  14141. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14142. provider_items[cur_item], boundary);
  14143. offset += begin.size();
  14144. cur_start = offset;
  14145. sink.os << begin;
  14146. }
  14147. DataSink cur_sink;
  14148. auto has_data = true;
  14149. cur_sink.write = sink.write;
  14150. // Forward is_writable so a provider item asking whether it may keep
  14151. // going gets the outer sink's answer rather than the default `true`.
  14152. cur_sink.is_writable = sink.is_writable;
  14153. cur_sink.done = [&]() { has_data = false; };
  14154. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14155. return false;
  14156. }
  14157. if (!has_data) {
  14158. sink.os << detail::serialize_multipart_formdata_item_end();
  14159. cur_item++;
  14160. cur_start = 0;
  14161. }
  14162. return true;
  14163. } else {
  14164. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14165. sink.done();
  14166. return true;
  14167. }
  14168. };
  14169. }
  14170. inline bool ClientImpl::process_socket(
  14171. const Socket &socket,
  14172. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14173. std::function<bool(Stream &strm)> callback) {
  14174. return detail::process_client_socket(
  14175. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14176. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14177. }
  14178. inline bool ClientImpl::is_ssl() const { return false; }
  14179. inline Result ClientImpl::Get(const std::string &path,
  14180. DownloadProgress progress) {
  14181. return Get(path, Headers(), std::move(progress));
  14182. }
  14183. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14184. DownloadProgress progress) {
  14185. return Get(path, params, Headers(), std::move(progress));
  14186. }
  14187. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14188. const Headers &headers,
  14189. DownloadProgress progress) {
  14190. if (params.empty()) { return Get(path, headers); }
  14191. std::string path_with_query = append_query_params(path, params);
  14192. return Get(path_with_query, headers, std::move(progress));
  14193. }
  14194. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14195. DownloadProgress progress) {
  14196. Request req;
  14197. req.method = "GET";
  14198. req.path = path;
  14199. req.headers = headers;
  14200. req.download_progress = std::move(progress);
  14201. if (max_timeout_msec_ > 0) {
  14202. req.start_time_ = std::chrono::steady_clock::now();
  14203. }
  14204. return send_(std::move(req));
  14205. }
  14206. inline Result ClientImpl::Get(const std::string &path,
  14207. ContentReceiver content_receiver,
  14208. DownloadProgress progress) {
  14209. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14210. std::move(progress));
  14211. }
  14212. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14213. ContentReceiver content_receiver,
  14214. DownloadProgress progress) {
  14215. return Get(path, headers, nullptr, std::move(content_receiver),
  14216. std::move(progress));
  14217. }
  14218. inline Result ClientImpl::Get(const std::string &path,
  14219. ResponseHandler response_handler,
  14220. ContentReceiver content_receiver,
  14221. DownloadProgress progress) {
  14222. return Get(path, Headers(), std::move(response_handler),
  14223. std::move(content_receiver), std::move(progress));
  14224. }
  14225. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14226. ResponseHandler response_handler,
  14227. ContentReceiver content_receiver,
  14228. DownloadProgress progress) {
  14229. Request req;
  14230. req.method = "GET";
  14231. req.path = path;
  14232. req.headers = headers;
  14233. req.response_handler = std::move(response_handler);
  14234. req.content_receiver =
  14235. [content_receiver](const char *data, size_t data_length,
  14236. size_t /*offset*/, size_t /*total_length*/) {
  14237. return content_receiver(data, data_length);
  14238. };
  14239. req.download_progress = std::move(progress);
  14240. if (max_timeout_msec_ > 0) {
  14241. req.start_time_ = std::chrono::steady_clock::now();
  14242. }
  14243. return send_(std::move(req));
  14244. }
  14245. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14246. const Headers &headers,
  14247. ContentReceiver content_receiver,
  14248. DownloadProgress progress) {
  14249. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14250. std::move(progress));
  14251. }
  14252. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14253. const Headers &headers,
  14254. ResponseHandler response_handler,
  14255. ContentReceiver content_receiver,
  14256. DownloadProgress progress) {
  14257. if (params.empty()) {
  14258. return Get(path, headers, std::move(response_handler),
  14259. std::move(content_receiver), std::move(progress));
  14260. }
  14261. std::string path_with_query = append_query_params(path, params);
  14262. return Get(path_with_query, headers, std::move(response_handler),
  14263. std::move(content_receiver), std::move(progress));
  14264. }
  14265. inline Result ClientImpl::Head(const std::string &path) {
  14266. return Head(path, Headers());
  14267. }
  14268. inline Result ClientImpl::Head(const std::string &path,
  14269. const Headers &headers) {
  14270. Request req;
  14271. req.method = "HEAD";
  14272. req.headers = headers;
  14273. req.path = path;
  14274. if (max_timeout_msec_ > 0) {
  14275. req.start_time_ = std::chrono::steady_clock::now();
  14276. }
  14277. return send_(std::move(req));
  14278. }
  14279. inline Result ClientImpl::Post(const std::string &path) {
  14280. return Post(path, std::string(), std::string());
  14281. }
  14282. inline Result ClientImpl::Post(const std::string &path,
  14283. const Headers &headers) {
  14284. return Post(path, headers, nullptr, 0, std::string());
  14285. }
  14286. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14287. size_t content_length,
  14288. const std::string &content_type,
  14289. UploadProgress progress) {
  14290. return Post(path, Headers(), body, content_length, content_type, progress);
  14291. }
  14292. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14293. const std::string &content_type,
  14294. UploadProgress progress) {
  14295. return Post(path, Headers(), body, content_type, progress);
  14296. }
  14297. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14298. return Post(path, Headers(), params);
  14299. }
  14300. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14301. ContentProvider content_provider,
  14302. const std::string &content_type,
  14303. UploadProgress progress) {
  14304. return Post(path, Headers(), content_length, std::move(content_provider),
  14305. content_type, progress);
  14306. }
  14307. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14308. ContentProvider content_provider,
  14309. const std::string &content_type,
  14310. ContentReceiver content_receiver,
  14311. UploadProgress progress) {
  14312. return Post(path, Headers(), content_length, std::move(content_provider),
  14313. content_type, std::move(content_receiver), progress);
  14314. }
  14315. inline Result ClientImpl::Post(const std::string &path,
  14316. ContentProviderWithoutLength content_provider,
  14317. const std::string &content_type,
  14318. UploadProgress progress) {
  14319. return Post(path, Headers(), std::move(content_provider), content_type,
  14320. progress);
  14321. }
  14322. inline Result ClientImpl::Post(const std::string &path,
  14323. ContentProviderWithoutLength content_provider,
  14324. const std::string &content_type,
  14325. ContentReceiver content_receiver,
  14326. UploadProgress progress) {
  14327. return Post(path, Headers(), std::move(content_provider), content_type,
  14328. std::move(content_receiver), progress);
  14329. }
  14330. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14331. const Params &params) {
  14332. auto query = detail::params_to_query_str(params);
  14333. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14334. }
  14335. inline Result ClientImpl::Post(const std::string &path,
  14336. const UploadFormDataItems &items,
  14337. UploadProgress progress) {
  14338. return Post(path, Headers(), items, progress);
  14339. }
  14340. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14341. const UploadFormDataItems &items,
  14342. UploadProgress progress) {
  14343. const auto &boundary = detail::make_multipart_data_boundary();
  14344. const auto &content_type =
  14345. detail::serialize_multipart_formdata_get_content_type(boundary);
  14346. auto content_length = detail::get_multipart_content_length(items, boundary);
  14347. return Post(path, headers, content_length,
  14348. detail::make_multipart_content_provider(items, boundary),
  14349. content_type, progress);
  14350. }
  14351. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14352. const UploadFormDataItems &items,
  14353. const std::string &boundary,
  14354. UploadProgress progress) {
  14355. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14356. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14357. }
  14358. const auto &content_type =
  14359. detail::serialize_multipart_formdata_get_content_type(boundary);
  14360. auto content_length = detail::get_multipart_content_length(items, boundary);
  14361. return Post(path, headers, content_length,
  14362. detail::make_multipart_content_provider(items, boundary),
  14363. content_type, progress);
  14364. }
  14365. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14366. const char *body, size_t content_length,
  14367. const std::string &content_type,
  14368. UploadProgress progress) {
  14369. return send_with_content_provider_and_receiver(
  14370. "POST", path, headers, body, content_length, nullptr, nullptr,
  14371. content_type, nullptr, progress);
  14372. }
  14373. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14374. const std::string &body,
  14375. const std::string &content_type,
  14376. UploadProgress progress) {
  14377. return send_with_content_provider_and_receiver(
  14378. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14379. content_type, nullptr, progress);
  14380. }
  14381. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14382. size_t content_length,
  14383. ContentProvider content_provider,
  14384. const std::string &content_type,
  14385. UploadProgress progress) {
  14386. return send_with_content_provider_and_receiver(
  14387. "POST", path, headers, nullptr, content_length,
  14388. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14389. }
  14390. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14391. size_t content_length,
  14392. ContentProvider content_provider,
  14393. const std::string &content_type,
  14394. ContentReceiver content_receiver,
  14395. DownloadProgress progress) {
  14396. return send_with_content_provider_and_receiver(
  14397. "POST", path, headers, nullptr, content_length,
  14398. std::move(content_provider), nullptr, content_type,
  14399. std::move(content_receiver), std::move(progress));
  14400. }
  14401. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14402. ContentProviderWithoutLength content_provider,
  14403. const std::string &content_type,
  14404. UploadProgress progress) {
  14405. return send_with_content_provider_and_receiver(
  14406. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14407. content_type, nullptr, progress);
  14408. }
  14409. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14410. ContentProviderWithoutLength content_provider,
  14411. const std::string &content_type,
  14412. ContentReceiver content_receiver,
  14413. DownloadProgress progress) {
  14414. return send_with_content_provider_and_receiver(
  14415. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14416. content_type, std::move(content_receiver), std::move(progress));
  14417. }
  14418. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14419. const UploadFormDataItems &items,
  14420. const FormDataProviderItems &provider_items,
  14421. UploadProgress progress) {
  14422. const auto &boundary = detail::make_multipart_data_boundary();
  14423. const auto &content_type =
  14424. detail::serialize_multipart_formdata_get_content_type(boundary);
  14425. return send_with_content_provider_and_receiver(
  14426. "POST", path, headers, nullptr, 0, nullptr,
  14427. get_multipart_content_provider(boundary, items, provider_items),
  14428. content_type, nullptr, progress);
  14429. }
  14430. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14431. const std::string &body,
  14432. const std::string &content_type,
  14433. ContentReceiver content_receiver,
  14434. DownloadProgress progress) {
  14435. Request req;
  14436. req.method = "POST";
  14437. req.path = path;
  14438. req.headers = headers;
  14439. req.body = body;
  14440. req.content_receiver =
  14441. [content_receiver](const char *data, size_t data_length,
  14442. size_t /*offset*/, size_t /*total_length*/) {
  14443. return content_receiver(data, data_length);
  14444. };
  14445. req.download_progress = std::move(progress);
  14446. if (max_timeout_msec_ > 0) {
  14447. req.start_time_ = std::chrono::steady_clock::now();
  14448. }
  14449. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14450. return send_(std::move(req));
  14451. }
  14452. inline Result ClientImpl::Put(const std::string &path) {
  14453. return Put(path, std::string(), std::string());
  14454. }
  14455. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14456. return Put(path, headers, nullptr, 0, std::string());
  14457. }
  14458. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14459. size_t content_length,
  14460. const std::string &content_type,
  14461. UploadProgress progress) {
  14462. return Put(path, Headers(), body, content_length, content_type, progress);
  14463. }
  14464. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14465. const std::string &content_type,
  14466. UploadProgress progress) {
  14467. return Put(path, Headers(), body, content_type, progress);
  14468. }
  14469. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14470. return Put(path, Headers(), params);
  14471. }
  14472. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14473. ContentProvider content_provider,
  14474. const std::string &content_type,
  14475. UploadProgress progress) {
  14476. return Put(path, Headers(), content_length, std::move(content_provider),
  14477. content_type, progress);
  14478. }
  14479. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14480. ContentProvider content_provider,
  14481. const std::string &content_type,
  14482. ContentReceiver content_receiver,
  14483. UploadProgress progress) {
  14484. return Put(path, Headers(), content_length, std::move(content_provider),
  14485. content_type, std::move(content_receiver), progress);
  14486. }
  14487. inline Result ClientImpl::Put(const std::string &path,
  14488. ContentProviderWithoutLength content_provider,
  14489. const std::string &content_type,
  14490. UploadProgress progress) {
  14491. return Put(path, Headers(), std::move(content_provider), content_type,
  14492. progress);
  14493. }
  14494. inline Result ClientImpl::Put(const std::string &path,
  14495. ContentProviderWithoutLength content_provider,
  14496. const std::string &content_type,
  14497. ContentReceiver content_receiver,
  14498. UploadProgress progress) {
  14499. return Put(path, Headers(), std::move(content_provider), content_type,
  14500. std::move(content_receiver), progress);
  14501. }
  14502. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14503. const Params &params) {
  14504. auto query = detail::params_to_query_str(params);
  14505. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14506. }
  14507. inline Result ClientImpl::Put(const std::string &path,
  14508. const UploadFormDataItems &items,
  14509. UploadProgress progress) {
  14510. return Put(path, Headers(), items, progress);
  14511. }
  14512. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14513. const UploadFormDataItems &items,
  14514. UploadProgress progress) {
  14515. const auto &boundary = detail::make_multipart_data_boundary();
  14516. const auto &content_type =
  14517. detail::serialize_multipart_formdata_get_content_type(boundary);
  14518. auto content_length = detail::get_multipart_content_length(items, boundary);
  14519. return Put(path, headers, content_length,
  14520. detail::make_multipart_content_provider(items, boundary),
  14521. content_type, progress);
  14522. }
  14523. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14524. const UploadFormDataItems &items,
  14525. const std::string &boundary,
  14526. UploadProgress progress) {
  14527. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14528. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14529. }
  14530. const auto &content_type =
  14531. detail::serialize_multipart_formdata_get_content_type(boundary);
  14532. auto content_length = detail::get_multipart_content_length(items, boundary);
  14533. return Put(path, headers, content_length,
  14534. detail::make_multipart_content_provider(items, boundary),
  14535. content_type, progress);
  14536. }
  14537. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14538. const char *body, size_t content_length,
  14539. const std::string &content_type,
  14540. UploadProgress progress) {
  14541. return send_with_content_provider_and_receiver(
  14542. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14543. content_type, nullptr, progress);
  14544. }
  14545. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14546. const std::string &body,
  14547. const std::string &content_type,
  14548. UploadProgress progress) {
  14549. return send_with_content_provider_and_receiver(
  14550. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14551. content_type, nullptr, progress);
  14552. }
  14553. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14554. size_t content_length,
  14555. ContentProvider content_provider,
  14556. const std::string &content_type,
  14557. UploadProgress progress) {
  14558. return send_with_content_provider_and_receiver(
  14559. "PUT", path, headers, nullptr, content_length,
  14560. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14561. }
  14562. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14563. size_t content_length,
  14564. ContentProvider content_provider,
  14565. const std::string &content_type,
  14566. ContentReceiver content_receiver,
  14567. UploadProgress progress) {
  14568. return send_with_content_provider_and_receiver(
  14569. "PUT", path, headers, nullptr, content_length,
  14570. std::move(content_provider), nullptr, content_type,
  14571. std::move(content_receiver), progress);
  14572. }
  14573. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14574. ContentProviderWithoutLength content_provider,
  14575. const std::string &content_type,
  14576. UploadProgress progress) {
  14577. return send_with_content_provider_and_receiver(
  14578. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14579. content_type, nullptr, progress);
  14580. }
  14581. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14582. ContentProviderWithoutLength content_provider,
  14583. const std::string &content_type,
  14584. ContentReceiver content_receiver,
  14585. UploadProgress progress) {
  14586. return send_with_content_provider_and_receiver(
  14587. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14588. content_type, std::move(content_receiver), progress);
  14589. }
  14590. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14591. const UploadFormDataItems &items,
  14592. const FormDataProviderItems &provider_items,
  14593. UploadProgress progress) {
  14594. const auto &boundary = detail::make_multipart_data_boundary();
  14595. const auto &content_type =
  14596. detail::serialize_multipart_formdata_get_content_type(boundary);
  14597. return send_with_content_provider_and_receiver(
  14598. "PUT", path, headers, nullptr, 0, nullptr,
  14599. get_multipart_content_provider(boundary, items, provider_items),
  14600. content_type, nullptr, progress);
  14601. }
  14602. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14603. const std::string &body,
  14604. const std::string &content_type,
  14605. ContentReceiver content_receiver,
  14606. DownloadProgress progress) {
  14607. Request req;
  14608. req.method = "PUT";
  14609. req.path = path;
  14610. req.headers = headers;
  14611. req.body = body;
  14612. req.content_receiver =
  14613. [content_receiver](const char *data, size_t data_length,
  14614. size_t /*offset*/, size_t /*total_length*/) {
  14615. return content_receiver(data, data_length);
  14616. };
  14617. req.download_progress = std::move(progress);
  14618. if (max_timeout_msec_ > 0) {
  14619. req.start_time_ = std::chrono::steady_clock::now();
  14620. }
  14621. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14622. return send_(std::move(req));
  14623. }
  14624. inline Result ClientImpl::Patch(const std::string &path) {
  14625. return Patch(path, std::string(), std::string());
  14626. }
  14627. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14628. UploadProgress progress) {
  14629. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14630. }
  14631. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14632. size_t content_length,
  14633. const std::string &content_type,
  14634. UploadProgress progress) {
  14635. return Patch(path, Headers(), body, content_length, content_type, progress);
  14636. }
  14637. inline Result ClientImpl::Patch(const std::string &path,
  14638. const std::string &body,
  14639. const std::string &content_type,
  14640. UploadProgress progress) {
  14641. return Patch(path, Headers(), body, content_type, progress);
  14642. }
  14643. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14644. return Patch(path, Headers(), params);
  14645. }
  14646. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14647. ContentProvider content_provider,
  14648. const std::string &content_type,
  14649. UploadProgress progress) {
  14650. return Patch(path, Headers(), content_length, std::move(content_provider),
  14651. content_type, progress);
  14652. }
  14653. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14654. ContentProvider content_provider,
  14655. const std::string &content_type,
  14656. ContentReceiver content_receiver,
  14657. UploadProgress progress) {
  14658. return Patch(path, Headers(), content_length, std::move(content_provider),
  14659. content_type, std::move(content_receiver), progress);
  14660. }
  14661. inline Result ClientImpl::Patch(const std::string &path,
  14662. ContentProviderWithoutLength content_provider,
  14663. const std::string &content_type,
  14664. UploadProgress progress) {
  14665. return Patch(path, Headers(), std::move(content_provider), content_type,
  14666. progress);
  14667. }
  14668. inline Result ClientImpl::Patch(const std::string &path,
  14669. ContentProviderWithoutLength content_provider,
  14670. const std::string &content_type,
  14671. ContentReceiver content_receiver,
  14672. UploadProgress progress) {
  14673. return Patch(path, Headers(), std::move(content_provider), content_type,
  14674. std::move(content_receiver), progress);
  14675. }
  14676. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14677. const Params &params) {
  14678. auto query = detail::params_to_query_str(params);
  14679. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14680. }
  14681. inline Result ClientImpl::Patch(const std::string &path,
  14682. const UploadFormDataItems &items,
  14683. UploadProgress progress) {
  14684. return Patch(path, Headers(), items, progress);
  14685. }
  14686. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14687. const UploadFormDataItems &items,
  14688. UploadProgress progress) {
  14689. const auto &boundary = detail::make_multipart_data_boundary();
  14690. const auto &content_type =
  14691. detail::serialize_multipart_formdata_get_content_type(boundary);
  14692. auto content_length = detail::get_multipart_content_length(items, boundary);
  14693. return Patch(path, headers, content_length,
  14694. detail::make_multipart_content_provider(items, boundary),
  14695. content_type, progress);
  14696. }
  14697. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14698. const UploadFormDataItems &items,
  14699. const std::string &boundary,
  14700. UploadProgress progress) {
  14701. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14702. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14703. }
  14704. const auto &content_type =
  14705. detail::serialize_multipart_formdata_get_content_type(boundary);
  14706. auto content_length = detail::get_multipart_content_length(items, boundary);
  14707. return Patch(path, headers, content_length,
  14708. detail::make_multipart_content_provider(items, boundary),
  14709. content_type, progress);
  14710. }
  14711. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14712. const char *body, size_t content_length,
  14713. const std::string &content_type,
  14714. UploadProgress progress) {
  14715. return send_with_content_provider_and_receiver(
  14716. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14717. content_type, nullptr, progress);
  14718. }
  14719. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14720. const std::string &body,
  14721. const std::string &content_type,
  14722. UploadProgress progress) {
  14723. return send_with_content_provider_and_receiver(
  14724. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14725. content_type, nullptr, progress);
  14726. }
  14727. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14728. size_t content_length,
  14729. ContentProvider content_provider,
  14730. const std::string &content_type,
  14731. UploadProgress progress) {
  14732. return send_with_content_provider_and_receiver(
  14733. "PATCH", path, headers, nullptr, content_length,
  14734. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14735. }
  14736. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14737. size_t content_length,
  14738. ContentProvider content_provider,
  14739. const std::string &content_type,
  14740. ContentReceiver content_receiver,
  14741. UploadProgress progress) {
  14742. return send_with_content_provider_and_receiver(
  14743. "PATCH", path, headers, nullptr, content_length,
  14744. std::move(content_provider), nullptr, content_type,
  14745. std::move(content_receiver), progress);
  14746. }
  14747. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14748. ContentProviderWithoutLength content_provider,
  14749. const std::string &content_type,
  14750. UploadProgress progress) {
  14751. return send_with_content_provider_and_receiver(
  14752. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14753. content_type, nullptr, progress);
  14754. }
  14755. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14756. ContentProviderWithoutLength content_provider,
  14757. const std::string &content_type,
  14758. ContentReceiver content_receiver,
  14759. UploadProgress progress) {
  14760. return send_with_content_provider_and_receiver(
  14761. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14762. content_type, std::move(content_receiver), progress);
  14763. }
  14764. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14765. const UploadFormDataItems &items,
  14766. const FormDataProviderItems &provider_items,
  14767. UploadProgress progress) {
  14768. const auto &boundary = detail::make_multipart_data_boundary();
  14769. const auto &content_type =
  14770. detail::serialize_multipart_formdata_get_content_type(boundary);
  14771. return send_with_content_provider_and_receiver(
  14772. "PATCH", path, headers, nullptr, 0, nullptr,
  14773. get_multipart_content_provider(boundary, items, provider_items),
  14774. content_type, nullptr, progress);
  14775. }
  14776. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14777. const std::string &body,
  14778. const std::string &content_type,
  14779. ContentReceiver content_receiver,
  14780. DownloadProgress progress) {
  14781. Request req;
  14782. req.method = "PATCH";
  14783. req.path = path;
  14784. req.headers = headers;
  14785. req.body = body;
  14786. req.content_receiver =
  14787. [content_receiver](const char *data, size_t data_length,
  14788. size_t /*offset*/, size_t /*total_length*/) {
  14789. return content_receiver(data, data_length);
  14790. };
  14791. req.download_progress = std::move(progress);
  14792. if (max_timeout_msec_ > 0) {
  14793. req.start_time_ = std::chrono::steady_clock::now();
  14794. }
  14795. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14796. return send_(std::move(req));
  14797. }
  14798. inline Result ClientImpl::Delete(const std::string &path,
  14799. DownloadProgress progress) {
  14800. return Delete(path, Headers(), std::string(), std::string(), progress);
  14801. }
  14802. inline Result ClientImpl::Delete(const std::string &path,
  14803. const Headers &headers,
  14804. DownloadProgress progress) {
  14805. return Delete(path, headers, std::string(), std::string(), progress);
  14806. }
  14807. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14808. size_t content_length,
  14809. const std::string &content_type,
  14810. DownloadProgress progress) {
  14811. return Delete(path, Headers(), body, content_length, content_type, progress);
  14812. }
  14813. inline Result ClientImpl::Delete(const std::string &path,
  14814. const std::string &body,
  14815. const std::string &content_type,
  14816. DownloadProgress progress) {
  14817. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14818. progress);
  14819. }
  14820. inline Result ClientImpl::Delete(const std::string &path,
  14821. const Headers &headers,
  14822. const std::string &body,
  14823. const std::string &content_type,
  14824. DownloadProgress progress) {
  14825. return Delete(path, headers, body.data(), body.size(), content_type,
  14826. progress);
  14827. }
  14828. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14829. DownloadProgress progress) {
  14830. return Delete(path, Headers(), params, progress);
  14831. }
  14832. inline Result ClientImpl::Delete(const std::string &path,
  14833. const Headers &headers, const Params &params,
  14834. DownloadProgress progress) {
  14835. auto query = detail::params_to_query_str(params);
  14836. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14837. progress);
  14838. }
  14839. inline Result ClientImpl::Delete(const std::string &path,
  14840. const Headers &headers, const char *body,
  14841. size_t content_length,
  14842. const std::string &content_type,
  14843. DownloadProgress progress) {
  14844. Request req;
  14845. req.method = "DELETE";
  14846. req.headers = headers;
  14847. req.path = path;
  14848. req.download_progress = std::move(progress);
  14849. if (max_timeout_msec_ > 0) {
  14850. req.start_time_ = std::chrono::steady_clock::now();
  14851. }
  14852. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14853. req.body.assign(body, content_length);
  14854. return send_(std::move(req));
  14855. }
  14856. inline Result ClientImpl::Options(const std::string &path) {
  14857. return Options(path, Headers());
  14858. }
  14859. inline Result ClientImpl::Options(const std::string &path,
  14860. const Headers &headers) {
  14861. Request req;
  14862. req.method = "OPTIONS";
  14863. req.headers = headers;
  14864. req.path = path;
  14865. if (max_timeout_msec_ > 0) {
  14866. req.start_time_ = std::chrono::steady_clock::now();
  14867. }
  14868. return send_(std::move(req));
  14869. }
  14870. inline void ClientImpl::stop() {
  14871. std::lock_guard<std::mutex> guard(socket_mutex_);
  14872. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14873. // do is to shutdown_socket, so that threads using this socket suddenly
  14874. // discover they can't read/write any more and error out. Everything else
  14875. // (closing the socket, shutting ssl down) is unsafe because these actions
  14876. // are not thread-safe.
  14877. if (socket_requests_in_flight_ > 0) {
  14878. shutdown_socket(socket_);
  14879. // Aside from that, we set a flag for the socket to be closed when we're
  14880. // done.
  14881. socket_should_be_closed_when_request_is_done_ = true;
  14882. return;
  14883. }
  14884. disconnect(/*gracefully=*/true);
  14885. }
  14886. inline std::string ClientImpl::host() const { return host_; }
  14887. inline int ClientImpl::port() const { return port_; }
  14888. inline size_t ClientImpl::is_socket_open() const {
  14889. std::lock_guard<std::mutex> guard(socket_mutex_);
  14890. return socket_.is_open();
  14891. }
  14892. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14893. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14894. connection_timeout_sec_ = sec;
  14895. connection_timeout_usec_ = usec;
  14896. }
  14897. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14898. read_timeout_sec_ = sec;
  14899. read_timeout_usec_ = usec;
  14900. }
  14901. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14902. write_timeout_sec_ = sec;
  14903. write_timeout_usec_ = usec;
  14904. }
  14905. inline void ClientImpl::set_max_timeout(time_t msec) {
  14906. max_timeout_msec_ = msec;
  14907. }
  14908. inline void ClientImpl::set_basic_auth(const std::string &username,
  14909. const std::string &password) {
  14910. basic_auth_username_ = username;
  14911. basic_auth_password_ = password;
  14912. }
  14913. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14914. bearer_token_auth_token_ = token;
  14915. }
  14916. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14917. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14918. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14919. inline void
  14920. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14921. addr_map_ = std::move(addr_map);
  14922. }
  14923. inline void ClientImpl::set_default_headers(Headers headers) {
  14924. default_headers_ = std::move(headers);
  14925. }
  14926. inline void ClientImpl::set_header_writer(
  14927. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14928. header_writer_ = writer;
  14929. }
  14930. inline void ClientImpl::set_address_family(int family) {
  14931. address_family_ = family;
  14932. }
  14933. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14934. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14935. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14936. socket_options_ = std::move(socket_options);
  14937. }
  14938. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14939. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14940. inline void ClientImpl::set_payload_max_length(size_t length) {
  14941. payload_max_length_ = length;
  14942. has_payload_max_length_ = true;
  14943. }
  14944. inline void ClientImpl::set_interface(const std::string &intf) {
  14945. interface_ = intf;
  14946. }
  14947. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14948. proxy_host_ = host;
  14949. proxy_port_ = port;
  14950. std::lock_guard<std::mutex> guard(socket_mutex_);
  14951. disconnect(/*gracefully=*/true);
  14952. }
  14953. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14954. const std::string &password) {
  14955. proxy_basic_auth_username_ = username;
  14956. proxy_basic_auth_password_ = password;
  14957. }
  14958. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14959. proxy_bearer_token_auth_token_ = token;
  14960. }
  14961. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14962. std::vector<detail::NoProxyEntry> parsed;
  14963. parsed.reserve(patterns.size());
  14964. for (const auto &p : patterns) {
  14965. auto trimmed = detail::trim_copy(p);
  14966. if (trimmed.empty()) { continue; }
  14967. detail::NoProxyEntry entry;
  14968. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14969. parsed.push_back(std::move(entry));
  14970. }
  14971. }
  14972. no_proxy_entries_ = std::move(parsed);
  14973. std::lock_guard<std::mutex> guard(socket_mutex_);
  14974. disconnect(/*gracefully=*/true);
  14975. }
  14976. #ifdef CPPHTTPLIB_SSL_ENABLED
  14977. inline void ClientImpl::set_digest_auth(const std::string &username,
  14978. const std::string &password) {
  14979. digest_auth_username_ = username;
  14980. digest_auth_password_ = password;
  14981. }
  14982. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14983. const std::string &ca_cert_dir_path) {
  14984. ca_cert_file_path_ = ca_cert_file_path;
  14985. ca_cert_dir_path_ = ca_cert_dir_path;
  14986. }
  14987. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14988. const std::string &password) {
  14989. proxy_digest_auth_username_ = username;
  14990. proxy_digest_auth_password_ = password;
  14991. }
  14992. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14993. server_certificate_verification_ = enabled;
  14994. }
  14995. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14996. server_hostname_verification_ = enabled;
  14997. }
  14998. inline void ClientImpl::enable_system_ca(bool enabled) {
  14999. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15000. }
  15001. #endif
  15002. inline void ClientImpl::set_logger(Logger logger) {
  15003. logger_ = std::move(logger);
  15004. }
  15005. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15006. error_logger_ = std::move(error_logger);
  15007. }
  15008. /*
  15009. * SSL/TLS Common Implementation
  15010. */
  15011. inline ClientConnection::~ClientConnection() {
  15012. #ifdef CPPHTTPLIB_SSL_ENABLED
  15013. if (session) {
  15014. tls::shutdown(session, true);
  15015. tls::free_session(session);
  15016. session = nullptr;
  15017. }
  15018. #endif
  15019. if (sock != INVALID_SOCKET) {
  15020. detail::close_socket(sock);
  15021. sock = INVALID_SOCKET;
  15022. }
  15023. }
  15024. // Universal client implementation
  15025. inline Client::Client(const std::string &scheme_host_port)
  15026. : Client(scheme_host_port, std::string(), std::string()) {}
  15027. inline Client::Client(const std::string &scheme_host_port,
  15028. const std::string &client_cert_path,
  15029. const std::string &client_key_path) {
  15030. detail::UrlComponents uc;
  15031. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15032. auto &scheme = uc.scheme;
  15033. #ifdef CPPHTTPLIB_SSL_ENABLED
  15034. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15035. #else
  15036. if (!scheme.empty() && scheme != "http") {
  15037. #endif
  15038. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15039. std::string msg = "'" + scheme + "' scheme is not supported.";
  15040. throw std::invalid_argument(msg);
  15041. #endif
  15042. return;
  15043. }
  15044. auto is_ssl = scheme == "https";
  15045. auto host = std::move(uc.host);
  15046. auto port = is_ssl ? 443 : 80;
  15047. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  15048. if (is_ssl) {
  15049. #ifdef CPPHTTPLIB_SSL_ENABLED
  15050. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15051. client_key_path);
  15052. is_ssl_ = is_ssl;
  15053. #endif
  15054. } else {
  15055. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15056. client_key_path);
  15057. }
  15058. } else {
  15059. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15060. // if port param below changes.
  15061. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15062. client_cert_path, client_key_path);
  15063. }
  15064. }
  15065. inline Client::Client(const std::string &host, int port)
  15066. : Client(host, port, std::string(), std::string()) {}
  15067. inline Client::Client(const std::string &host, int port,
  15068. const std::string &client_cert_path,
  15069. const std::string &client_key_path)
  15070. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15071. client_key_path)) {}
  15072. inline Client::~Client() = default;
  15073. inline bool Client::is_valid() const {
  15074. return cli_ != nullptr && cli_->is_valid();
  15075. }
  15076. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15077. return cli_->Get(path, std::move(progress));
  15078. }
  15079. inline Result Client::Get(const std::string &path, const Headers &headers,
  15080. DownloadProgress progress) {
  15081. return cli_->Get(path, headers, std::move(progress));
  15082. }
  15083. inline Result Client::Get(const std::string &path,
  15084. ContentReceiver content_receiver,
  15085. DownloadProgress progress) {
  15086. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15087. }
  15088. inline Result Client::Get(const std::string &path, const Headers &headers,
  15089. ContentReceiver content_receiver,
  15090. DownloadProgress progress) {
  15091. return cli_->Get(path, headers, std::move(content_receiver),
  15092. std::move(progress));
  15093. }
  15094. inline Result Client::Get(const std::string &path,
  15095. ResponseHandler response_handler,
  15096. ContentReceiver content_receiver,
  15097. DownloadProgress progress) {
  15098. return cli_->Get(path, std::move(response_handler),
  15099. std::move(content_receiver), std::move(progress));
  15100. }
  15101. inline Result Client::Get(const std::string &path, const Headers &headers,
  15102. ResponseHandler response_handler,
  15103. ContentReceiver content_receiver,
  15104. DownloadProgress progress) {
  15105. return cli_->Get(path, headers, std::move(response_handler),
  15106. std::move(content_receiver), std::move(progress));
  15107. }
  15108. inline Result Client::Get(const std::string &path, const Params &params,
  15109. DownloadProgress progress) {
  15110. return cli_->Get(path, params, std::move(progress));
  15111. }
  15112. inline Result Client::Get(const std::string &path, const Params &params,
  15113. const Headers &headers, DownloadProgress progress) {
  15114. return cli_->Get(path, params, headers, std::move(progress));
  15115. }
  15116. inline Result Client::Get(const std::string &path, const Params &params,
  15117. const Headers &headers,
  15118. ContentReceiver content_receiver,
  15119. DownloadProgress progress) {
  15120. return cli_->Get(path, params, headers, std::move(content_receiver),
  15121. std::move(progress));
  15122. }
  15123. inline Result Client::Get(const std::string &path, const Params &params,
  15124. const Headers &headers,
  15125. ResponseHandler response_handler,
  15126. ContentReceiver content_receiver,
  15127. DownloadProgress progress) {
  15128. return cli_->Get(path, params, headers, std::move(response_handler),
  15129. std::move(content_receiver), std::move(progress));
  15130. }
  15131. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15132. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15133. return cli_->Head(path, headers);
  15134. }
  15135. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15136. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15137. return cli_->Post(path, headers);
  15138. }
  15139. inline Result Client::Post(const std::string &path, const char *body,
  15140. size_t content_length,
  15141. const std::string &content_type,
  15142. UploadProgress progress) {
  15143. return cli_->Post(path, body, content_length, content_type, progress);
  15144. }
  15145. inline Result Client::Post(const std::string &path, const Headers &headers,
  15146. const char *body, size_t content_length,
  15147. const std::string &content_type,
  15148. UploadProgress progress) {
  15149. return cli_->Post(path, headers, body, content_length, content_type,
  15150. progress);
  15151. }
  15152. inline Result Client::Post(const std::string &path, const std::string &body,
  15153. const std::string &content_type,
  15154. UploadProgress progress) {
  15155. return cli_->Post(path, body, content_type, progress);
  15156. }
  15157. inline Result Client::Post(const std::string &path, const Headers &headers,
  15158. const std::string &body,
  15159. const std::string &content_type,
  15160. UploadProgress progress) {
  15161. return cli_->Post(path, headers, body, content_type, progress);
  15162. }
  15163. inline Result Client::Post(const std::string &path, size_t content_length,
  15164. ContentProvider content_provider,
  15165. const std::string &content_type,
  15166. UploadProgress progress) {
  15167. return cli_->Post(path, content_length, std::move(content_provider),
  15168. content_type, progress);
  15169. }
  15170. inline Result Client::Post(const std::string &path, size_t content_length,
  15171. ContentProvider content_provider,
  15172. const std::string &content_type,
  15173. ContentReceiver content_receiver,
  15174. UploadProgress progress) {
  15175. return cli_->Post(path, content_length, std::move(content_provider),
  15176. content_type, std::move(content_receiver), progress);
  15177. }
  15178. inline Result Client::Post(const std::string &path,
  15179. ContentProviderWithoutLength content_provider,
  15180. const std::string &content_type,
  15181. UploadProgress progress) {
  15182. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15183. }
  15184. inline Result Client::Post(const std::string &path,
  15185. ContentProviderWithoutLength content_provider,
  15186. const std::string &content_type,
  15187. ContentReceiver content_receiver,
  15188. UploadProgress progress) {
  15189. return cli_->Post(path, std::move(content_provider), content_type,
  15190. std::move(content_receiver), progress);
  15191. }
  15192. inline Result Client::Post(const std::string &path, const Headers &headers,
  15193. size_t content_length,
  15194. ContentProvider content_provider,
  15195. const std::string &content_type,
  15196. UploadProgress progress) {
  15197. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15198. content_type, progress);
  15199. }
  15200. inline Result Client::Post(const std::string &path, const Headers &headers,
  15201. size_t content_length,
  15202. ContentProvider content_provider,
  15203. const std::string &content_type,
  15204. ContentReceiver content_receiver,
  15205. DownloadProgress progress) {
  15206. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15207. content_type, std::move(content_receiver), progress);
  15208. }
  15209. inline Result Client::Post(const std::string &path, const Headers &headers,
  15210. ContentProviderWithoutLength content_provider,
  15211. const std::string &content_type,
  15212. UploadProgress progress) {
  15213. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15214. progress);
  15215. }
  15216. inline Result Client::Post(const std::string &path, const Headers &headers,
  15217. ContentProviderWithoutLength content_provider,
  15218. const std::string &content_type,
  15219. ContentReceiver content_receiver,
  15220. DownloadProgress progress) {
  15221. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15222. std::move(content_receiver), progress);
  15223. }
  15224. inline Result Client::Post(const std::string &path, const Params &params) {
  15225. return cli_->Post(path, params);
  15226. }
  15227. inline Result Client::Post(const std::string &path, const Headers &headers,
  15228. const Params &params) {
  15229. return cli_->Post(path, headers, params);
  15230. }
  15231. inline Result Client::Post(const std::string &path,
  15232. const UploadFormDataItems &items,
  15233. UploadProgress progress) {
  15234. return cli_->Post(path, items, progress);
  15235. }
  15236. inline Result Client::Post(const std::string &path, const Headers &headers,
  15237. const UploadFormDataItems &items,
  15238. UploadProgress progress) {
  15239. return cli_->Post(path, headers, items, progress);
  15240. }
  15241. inline Result Client::Post(const std::string &path, const Headers &headers,
  15242. const UploadFormDataItems &items,
  15243. const std::string &boundary,
  15244. UploadProgress progress) {
  15245. return cli_->Post(path, headers, items, boundary, progress);
  15246. }
  15247. inline Result Client::Post(const std::string &path, const Headers &headers,
  15248. const UploadFormDataItems &items,
  15249. const FormDataProviderItems &provider_items,
  15250. UploadProgress progress) {
  15251. return cli_->Post(path, headers, items, provider_items, progress);
  15252. }
  15253. inline Result Client::Post(const std::string &path, const Headers &headers,
  15254. const std::string &body,
  15255. const std::string &content_type,
  15256. ContentReceiver content_receiver,
  15257. DownloadProgress progress) {
  15258. return cli_->Post(path, headers, body, content_type,
  15259. std::move(content_receiver), progress);
  15260. }
  15261. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15262. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15263. return cli_->Put(path, headers);
  15264. }
  15265. inline Result Client::Put(const std::string &path, const char *body,
  15266. size_t content_length,
  15267. const std::string &content_type,
  15268. UploadProgress progress) {
  15269. return cli_->Put(path, body, content_length, content_type, progress);
  15270. }
  15271. inline Result Client::Put(const std::string &path, const Headers &headers,
  15272. const char *body, size_t content_length,
  15273. const std::string &content_type,
  15274. UploadProgress progress) {
  15275. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15276. }
  15277. inline Result Client::Put(const std::string &path, const std::string &body,
  15278. const std::string &content_type,
  15279. UploadProgress progress) {
  15280. return cli_->Put(path, body, content_type, progress);
  15281. }
  15282. inline Result Client::Put(const std::string &path, const Headers &headers,
  15283. const std::string &body,
  15284. const std::string &content_type,
  15285. UploadProgress progress) {
  15286. return cli_->Put(path, headers, body, content_type, progress);
  15287. }
  15288. inline Result Client::Put(const std::string &path, size_t content_length,
  15289. ContentProvider content_provider,
  15290. const std::string &content_type,
  15291. UploadProgress progress) {
  15292. return cli_->Put(path, content_length, std::move(content_provider),
  15293. content_type, progress);
  15294. }
  15295. inline Result Client::Put(const std::string &path, size_t content_length,
  15296. ContentProvider content_provider,
  15297. const std::string &content_type,
  15298. ContentReceiver content_receiver,
  15299. UploadProgress progress) {
  15300. return cli_->Put(path, content_length, std::move(content_provider),
  15301. content_type, std::move(content_receiver), progress);
  15302. }
  15303. inline Result Client::Put(const std::string &path,
  15304. ContentProviderWithoutLength content_provider,
  15305. const std::string &content_type,
  15306. UploadProgress progress) {
  15307. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15308. }
  15309. inline Result Client::Put(const std::string &path,
  15310. ContentProviderWithoutLength content_provider,
  15311. const std::string &content_type,
  15312. ContentReceiver content_receiver,
  15313. UploadProgress progress) {
  15314. return cli_->Put(path, std::move(content_provider), content_type,
  15315. std::move(content_receiver), progress);
  15316. }
  15317. inline Result Client::Put(const std::string &path, const Headers &headers,
  15318. size_t content_length,
  15319. ContentProvider content_provider,
  15320. const std::string &content_type,
  15321. UploadProgress progress) {
  15322. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15323. content_type, progress);
  15324. }
  15325. inline Result Client::Put(const std::string &path, const Headers &headers,
  15326. size_t content_length,
  15327. ContentProvider content_provider,
  15328. const std::string &content_type,
  15329. ContentReceiver content_receiver,
  15330. UploadProgress progress) {
  15331. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15332. content_type, std::move(content_receiver), progress);
  15333. }
  15334. inline Result Client::Put(const std::string &path, const Headers &headers,
  15335. ContentProviderWithoutLength content_provider,
  15336. const std::string &content_type,
  15337. UploadProgress progress) {
  15338. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15339. progress);
  15340. }
  15341. inline Result Client::Put(const std::string &path, const Headers &headers,
  15342. ContentProviderWithoutLength content_provider,
  15343. const std::string &content_type,
  15344. ContentReceiver content_receiver,
  15345. UploadProgress progress) {
  15346. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15347. std::move(content_receiver), progress);
  15348. }
  15349. inline Result Client::Put(const std::string &path, const Params &params) {
  15350. return cli_->Put(path, params);
  15351. }
  15352. inline Result Client::Put(const std::string &path, const Headers &headers,
  15353. const Params &params) {
  15354. return cli_->Put(path, headers, params);
  15355. }
  15356. inline Result Client::Put(const std::string &path,
  15357. const UploadFormDataItems &items,
  15358. UploadProgress progress) {
  15359. return cli_->Put(path, items, progress);
  15360. }
  15361. inline Result Client::Put(const std::string &path, const Headers &headers,
  15362. const UploadFormDataItems &items,
  15363. UploadProgress progress) {
  15364. return cli_->Put(path, headers, items, progress);
  15365. }
  15366. inline Result Client::Put(const std::string &path, const Headers &headers,
  15367. const UploadFormDataItems &items,
  15368. const std::string &boundary,
  15369. UploadProgress progress) {
  15370. return cli_->Put(path, headers, items, boundary, progress);
  15371. }
  15372. inline Result Client::Put(const std::string &path, const Headers &headers,
  15373. const UploadFormDataItems &items,
  15374. const FormDataProviderItems &provider_items,
  15375. UploadProgress progress) {
  15376. return cli_->Put(path, headers, items, provider_items, progress);
  15377. }
  15378. inline Result Client::Put(const std::string &path, const Headers &headers,
  15379. const std::string &body,
  15380. const std::string &content_type,
  15381. ContentReceiver content_receiver,
  15382. DownloadProgress progress) {
  15383. return cli_->Put(path, headers, body, content_type, content_receiver,
  15384. progress);
  15385. }
  15386. inline Result Client::Patch(const std::string &path) {
  15387. return cli_->Patch(path);
  15388. }
  15389. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15390. return cli_->Patch(path, headers);
  15391. }
  15392. inline Result Client::Patch(const std::string &path, const char *body,
  15393. size_t content_length,
  15394. const std::string &content_type,
  15395. UploadProgress progress) {
  15396. return cli_->Patch(path, body, content_length, content_type, progress);
  15397. }
  15398. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15399. const char *body, size_t content_length,
  15400. const std::string &content_type,
  15401. UploadProgress progress) {
  15402. return cli_->Patch(path, headers, body, content_length, content_type,
  15403. progress);
  15404. }
  15405. inline Result Client::Patch(const std::string &path, const std::string &body,
  15406. const std::string &content_type,
  15407. UploadProgress progress) {
  15408. return cli_->Patch(path, body, content_type, progress);
  15409. }
  15410. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15411. const std::string &body,
  15412. const std::string &content_type,
  15413. UploadProgress progress) {
  15414. return cli_->Patch(path, headers, body, content_type, progress);
  15415. }
  15416. inline Result Client::Patch(const std::string &path, size_t content_length,
  15417. ContentProvider content_provider,
  15418. const std::string &content_type,
  15419. UploadProgress progress) {
  15420. return cli_->Patch(path, content_length, std::move(content_provider),
  15421. content_type, progress);
  15422. }
  15423. inline Result Client::Patch(const std::string &path, size_t content_length,
  15424. ContentProvider content_provider,
  15425. const std::string &content_type,
  15426. ContentReceiver content_receiver,
  15427. UploadProgress progress) {
  15428. return cli_->Patch(path, content_length, std::move(content_provider),
  15429. content_type, std::move(content_receiver), progress);
  15430. }
  15431. inline Result Client::Patch(const std::string &path,
  15432. ContentProviderWithoutLength content_provider,
  15433. const std::string &content_type,
  15434. UploadProgress progress) {
  15435. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15436. }
  15437. inline Result Client::Patch(const std::string &path,
  15438. ContentProviderWithoutLength content_provider,
  15439. const std::string &content_type,
  15440. ContentReceiver content_receiver,
  15441. UploadProgress progress) {
  15442. return cli_->Patch(path, std::move(content_provider), content_type,
  15443. std::move(content_receiver), progress);
  15444. }
  15445. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15446. size_t content_length,
  15447. ContentProvider content_provider,
  15448. const std::string &content_type,
  15449. UploadProgress progress) {
  15450. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15451. content_type, progress);
  15452. }
  15453. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15454. size_t content_length,
  15455. ContentProvider content_provider,
  15456. const std::string &content_type,
  15457. ContentReceiver content_receiver,
  15458. UploadProgress progress) {
  15459. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15460. content_type, std::move(content_receiver), progress);
  15461. }
  15462. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15463. ContentProviderWithoutLength content_provider,
  15464. const std::string &content_type,
  15465. UploadProgress progress) {
  15466. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15467. progress);
  15468. }
  15469. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15470. ContentProviderWithoutLength content_provider,
  15471. const std::string &content_type,
  15472. ContentReceiver content_receiver,
  15473. UploadProgress progress) {
  15474. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15475. std::move(content_receiver), progress);
  15476. }
  15477. inline Result Client::Patch(const std::string &path, const Params &params) {
  15478. return cli_->Patch(path, params);
  15479. }
  15480. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15481. const Params &params) {
  15482. return cli_->Patch(path, headers, params);
  15483. }
  15484. inline Result Client::Patch(const std::string &path,
  15485. const UploadFormDataItems &items,
  15486. UploadProgress progress) {
  15487. return cli_->Patch(path, items, progress);
  15488. }
  15489. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15490. const UploadFormDataItems &items,
  15491. UploadProgress progress) {
  15492. return cli_->Patch(path, headers, items, progress);
  15493. }
  15494. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15495. const UploadFormDataItems &items,
  15496. const std::string &boundary,
  15497. UploadProgress progress) {
  15498. return cli_->Patch(path, headers, items, boundary, progress);
  15499. }
  15500. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15501. const UploadFormDataItems &items,
  15502. const FormDataProviderItems &provider_items,
  15503. UploadProgress progress) {
  15504. return cli_->Patch(path, headers, items, provider_items, progress);
  15505. }
  15506. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15507. const std::string &body,
  15508. const std::string &content_type,
  15509. ContentReceiver content_receiver,
  15510. DownloadProgress progress) {
  15511. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15512. progress);
  15513. }
  15514. inline Result Client::Delete(const std::string &path,
  15515. DownloadProgress progress) {
  15516. return cli_->Delete(path, progress);
  15517. }
  15518. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15519. DownloadProgress progress) {
  15520. return cli_->Delete(path, headers, progress);
  15521. }
  15522. inline Result Client::Delete(const std::string &path, const char *body,
  15523. size_t content_length,
  15524. const std::string &content_type,
  15525. DownloadProgress progress) {
  15526. return cli_->Delete(path, body, content_length, content_type, progress);
  15527. }
  15528. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15529. const char *body, size_t content_length,
  15530. const std::string &content_type,
  15531. DownloadProgress progress) {
  15532. return cli_->Delete(path, headers, body, content_length, content_type,
  15533. progress);
  15534. }
  15535. inline Result Client::Delete(const std::string &path, const std::string &body,
  15536. const std::string &content_type,
  15537. DownloadProgress progress) {
  15538. return cli_->Delete(path, body, content_type, progress);
  15539. }
  15540. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15541. const std::string &body,
  15542. const std::string &content_type,
  15543. DownloadProgress progress) {
  15544. return cli_->Delete(path, headers, body, content_type, progress);
  15545. }
  15546. inline Result Client::Delete(const std::string &path, const Params &params,
  15547. DownloadProgress progress) {
  15548. return cli_->Delete(path, params, progress);
  15549. }
  15550. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15551. const Params &params, DownloadProgress progress) {
  15552. return cli_->Delete(path, headers, params, progress);
  15553. }
  15554. inline Result Client::Options(const std::string &path) {
  15555. return cli_->Options(path);
  15556. }
  15557. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15558. return cli_->Options(path, headers);
  15559. }
  15560. inline ClientImpl::StreamHandle
  15561. Client::open_stream(const std::string &method, const std::string &path,
  15562. const Params &params, const Headers &headers,
  15563. const std::string &body, const std::string &content_type) {
  15564. return cli_->open_stream(method, path, params, headers, body, content_type);
  15565. }
  15566. inline bool Client::send(Request &req, Response &res, Error &error) {
  15567. return cli_->send(req, res, error);
  15568. }
  15569. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15570. inline void Client::stop() { cli_->stop(); }
  15571. inline std::string Client::host() const { return cli_->host(); }
  15572. inline int Client::port() const { return cli_->port(); }
  15573. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15574. inline socket_t Client::socket() const { return cli_->socket(); }
  15575. inline void
  15576. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15577. cli_->set_hostname_addr_map(std::move(addr_map));
  15578. }
  15579. inline void Client::set_default_headers(Headers headers) {
  15580. cli_->set_default_headers(std::move(headers));
  15581. }
  15582. inline void Client::set_header_writer(
  15583. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15584. cli_->set_header_writer(writer);
  15585. }
  15586. inline void Client::set_address_family(int family) {
  15587. cli_->set_address_family(family);
  15588. }
  15589. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15590. inline void Client::set_socket_options(SocketOptions socket_options) {
  15591. cli_->set_socket_options(std::move(socket_options));
  15592. }
  15593. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15594. cli_->set_connection_timeout(sec, usec);
  15595. }
  15596. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15597. cli_->set_read_timeout(sec, usec);
  15598. }
  15599. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15600. cli_->set_write_timeout(sec, usec);
  15601. }
  15602. inline void Client::set_basic_auth(const std::string &username,
  15603. const std::string &password) {
  15604. cli_->set_basic_auth(username, password);
  15605. }
  15606. inline void Client::set_bearer_token_auth(const std::string &token) {
  15607. cli_->set_bearer_token_auth(token);
  15608. }
  15609. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15610. inline void Client::set_follow_location(bool on) {
  15611. cli_->set_follow_location(on);
  15612. }
  15613. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15614. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15615. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15616. inline void Client::set_payload_max_length(size_t length) {
  15617. cli_->set_payload_max_length(length);
  15618. }
  15619. inline void Client::set_interface(const std::string &intf) {
  15620. cli_->set_interface(intf);
  15621. }
  15622. inline void Client::set_proxy(const std::string &host, int port) {
  15623. cli_->set_proxy(host, port);
  15624. }
  15625. inline void Client::set_proxy_basic_auth(const std::string &username,
  15626. const std::string &password) {
  15627. cli_->set_proxy_basic_auth(username, password);
  15628. }
  15629. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15630. cli_->set_proxy_bearer_token_auth(token);
  15631. }
  15632. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15633. cli_->set_no_proxy(patterns);
  15634. }
  15635. inline void Client::set_logger(Logger logger) {
  15636. cli_->set_logger(std::move(logger));
  15637. }
  15638. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15639. cli_->set_error_logger(std::move(error_logger));
  15640. }
  15641. /*
  15642. * Group 6: SSL Server and Client implementation
  15643. */
  15644. #ifdef CPPHTTPLIB_SSL_ENABLED
  15645. // SSL HTTP server implementation
  15646. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15647. const char *client_ca_cert_file_path,
  15648. const char *client_ca_cert_dir_path,
  15649. const char *private_key_password) {
  15650. using namespace tls;
  15651. ctx_ = create_server_context();
  15652. if (!ctx_) { return; }
  15653. // Load server certificate and private key
  15654. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15655. private_key_password)) {
  15656. last_ssl_error_ = static_cast<int>(get_error());
  15657. free_context(ctx_);
  15658. ctx_ = nullptr;
  15659. return;
  15660. }
  15661. // Load client CA certificates for client authentication
  15662. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15663. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15664. client_ca_cert_dir_path)) {
  15665. last_ssl_error_ = static_cast<int>(get_error());
  15666. free_context(ctx_);
  15667. ctx_ = nullptr;
  15668. return;
  15669. }
  15670. // Enable client certificate verification
  15671. set_verify_client(ctx_, true);
  15672. }
  15673. }
  15674. inline SSLServer::SSLServer(const PemMemory &pem) {
  15675. using namespace tls;
  15676. ctx_ = create_server_context();
  15677. if (ctx_) {
  15678. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15679. pem.private_key_password)) {
  15680. last_ssl_error_ = static_cast<int>(get_error());
  15681. free_context(ctx_);
  15682. ctx_ = nullptr;
  15683. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15684. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15685. last_ssl_error_ = static_cast<int>(get_error());
  15686. free_context(ctx_);
  15687. ctx_ = nullptr;
  15688. } else {
  15689. set_verify_client(ctx_, true);
  15690. }
  15691. }
  15692. }
  15693. }
  15694. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15695. using namespace tls;
  15696. ctx_ = create_server_context();
  15697. if (ctx_) {
  15698. if (!setup_callback(ctx_)) {
  15699. free_context(ctx_);
  15700. ctx_ = nullptr;
  15701. }
  15702. }
  15703. }
  15704. inline SSLServer::~SSLServer() {
  15705. if (ctx_) { tls::free_context(ctx_); }
  15706. }
  15707. inline bool SSLServer::is_valid() const {
  15708. return ctx_ != nullptr && Server::is_valid();
  15709. }
  15710. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15711. using namespace tls;
  15712. // Create TLS session with mutex protection
  15713. session_t session = nullptr;
  15714. {
  15715. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15716. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15717. }
  15718. if (!session) {
  15719. last_ssl_error_ = static_cast<int>(get_error());
  15720. detail::shutdown_socket(sock);
  15721. detail::close_socket(sock);
  15722. return false;
  15723. }
  15724. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15725. bool handshake_done = false;
  15726. bool ret = false;
  15727. bool websocket_upgraded = false;
  15728. auto cleanup = detail::scope_exit([&] {
  15729. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15730. free_session(session);
  15731. detail::shutdown_socket(sock);
  15732. detail::close_socket(sock);
  15733. });
  15734. // Perform TLS accept handshake with timeout
  15735. TlsError tls_err;
  15736. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15737. &tls_err)) {
  15738. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15739. // Map TlsError to legacy ssl_error for backward compatibility
  15740. if (tls_err.code == ErrorCode::WantRead) {
  15741. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15742. } else if (tls_err.code == ErrorCode::WantWrite) {
  15743. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15744. } else {
  15745. last_ssl_error_ = SSL_ERROR_SSL;
  15746. }
  15747. #else
  15748. last_ssl_error_ = static_cast<int>(get_error());
  15749. #endif
  15750. return false;
  15751. }
  15752. handshake_done = true;
  15753. std::string remote_addr;
  15754. int remote_port = 0;
  15755. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15756. std::string local_addr;
  15757. int local_port = 0;
  15758. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15759. ret = serve_guarded([&]() {
  15760. return detail::process_server_socket_ssl(
  15761. svr_sock_, session, sock, keep_alive_max_count_,
  15762. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15763. write_timeout_sec_, write_timeout_usec_,
  15764. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15765. return process_request(
  15766. strm, remote_addr, remote_port, local_addr, local_port,
  15767. close_connection, connection_closed,
  15768. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15769. });
  15770. });
  15771. return ret;
  15772. }
  15773. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15774. const char *key_pem,
  15775. const char *client_ca_pem,
  15776. const char *password) {
  15777. if (!ctx_) { return false; }
  15778. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15779. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15780. return false;
  15781. }
  15782. if (client_ca_pem) {
  15783. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15784. }
  15785. return true;
  15786. }
  15787. // SSL HTTP client implementation
  15788. inline SSLClient::~SSLClient() {
  15789. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15790. // base function rather than the derived function once we get to the
  15791. // base class destructor, and won't free the SSL (causing a leak).
  15792. // This must happen before the context is freed below: some backends
  15793. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15794. // context, so freeing the context first leaves close_notify reading
  15795. // freed memory.
  15796. shutdown_ssl_impl(socket_, true);
  15797. if (ctx_) {
  15798. tls::free_context(ctx_);
  15799. ctx_ = nullptr;
  15800. }
  15801. }
  15802. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15803. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15804. shutdown_ssl_impl(socket, shutdown_gracefully);
  15805. }
  15806. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15807. bool shutdown_gracefully) {
  15808. if (socket.sock == INVALID_SOCKET) {
  15809. assert(socket.ssl == nullptr);
  15810. return;
  15811. }
  15812. if (socket.ssl) {
  15813. tls::shutdown(socket.ssl, shutdown_gracefully);
  15814. {
  15815. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15816. tls::free_session(socket.ssl);
  15817. }
  15818. socket.ssl = nullptr;
  15819. }
  15820. assert(socket.ssl == nullptr);
  15821. }
  15822. inline bool SSLClient::process_socket(
  15823. const Socket &socket,
  15824. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15825. std::function<bool(Stream &strm)> callback) {
  15826. assert(socket.ssl);
  15827. return detail::process_client_socket_ssl(
  15828. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15829. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15830. std::move(callback));
  15831. }
  15832. inline bool SSLClient::is_ssl() const { return true; }
  15833. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15834. if (!is_valid()) {
  15835. error = Error::SSLConnection;
  15836. return false;
  15837. }
  15838. return ClientImpl::create_and_connect_socket(socket, error);
  15839. }
  15840. inline bool SSLClient::setup_proxy_connection(
  15841. Socket &socket,
  15842. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15843. Response &res, bool &success, Error &error) {
  15844. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15845. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15846. return false;
  15847. }
  15848. if (!initialize_ssl(socket, error)) {
  15849. success = false;
  15850. return false;
  15851. }
  15852. return true;
  15853. }
  15854. // Assumes that socket_mutex_ is locked and that there are no requests in
  15855. // flight
  15856. inline bool SSLClient::connect_with_proxy(
  15857. Socket &socket,
  15858. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15859. Response &res, bool &success, Error &error) {
  15860. success = true;
  15861. Response proxy_res;
  15862. if (!detail::process_client_socket(
  15863. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15864. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15865. start_time, [&](Stream &strm) {
  15866. Request req2;
  15867. req2.method = "CONNECT";
  15868. req2.path =
  15869. detail::make_host_and_port_string_always_port(host_, port_);
  15870. if (max_timeout_msec_ > 0) {
  15871. req2.start_time_ = std::chrono::steady_clock::now();
  15872. }
  15873. return process_request(strm, req2, proxy_res, false, error);
  15874. })) {
  15875. // Thread-safe to close everything because we are assuming there are no
  15876. // requests in flight
  15877. shutdown_ssl(socket, true);
  15878. shutdown_socket(socket);
  15879. close_socket(socket);
  15880. success = false;
  15881. return false;
  15882. }
  15883. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15884. if (!proxy_digest_auth_username_.empty() &&
  15885. !proxy_digest_auth_password_.empty()) {
  15886. std::map<std::string, std::string> auth;
  15887. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15888. // Close the current socket and create a new one for the authenticated
  15889. // request
  15890. shutdown_ssl(socket, true);
  15891. shutdown_socket(socket);
  15892. close_socket(socket);
  15893. // Create a new socket for the authenticated CONNECT request
  15894. if (!ensure_socket_connection(socket, error)) {
  15895. success = false;
  15896. output_error_log(error, nullptr);
  15897. return false;
  15898. }
  15899. proxy_res = Response();
  15900. if (!detail::process_client_socket(
  15901. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15902. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15903. start_time, [&](Stream &strm) {
  15904. Request req3;
  15905. req3.method = "CONNECT";
  15906. req3.path = detail::make_host_and_port_string_always_port(
  15907. host_, port_);
  15908. req3.headers.insert(detail::make_digest_authentication_header(
  15909. req3, auth, 1, detail::random_string(10),
  15910. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15911. true));
  15912. if (max_timeout_msec_ > 0) {
  15913. req3.start_time_ = std::chrono::steady_clock::now();
  15914. }
  15915. return process_request(strm, req3, proxy_res, false, error);
  15916. })) {
  15917. // Thread-safe to close everything because we are assuming there are
  15918. // no requests in flight
  15919. shutdown_ssl(socket, true);
  15920. shutdown_socket(socket);
  15921. close_socket(socket);
  15922. success = false;
  15923. return false;
  15924. }
  15925. }
  15926. }
  15927. }
  15928. // If status code is not 200, proxy request is failed.
  15929. // Set error to ProxyConnection and return proxy response
  15930. // as the response of the request
  15931. if (proxy_res.status != StatusCode::OK_200) {
  15932. error = Error::ProxyConnection;
  15933. output_error_log(error, nullptr);
  15934. res = std::move(proxy_res);
  15935. // Thread-safe to close everything because we are assuming there are
  15936. // no requests in flight
  15937. shutdown_ssl(socket, true);
  15938. shutdown_socket(socket);
  15939. close_socket(socket);
  15940. return false;
  15941. }
  15942. return true;
  15943. }
  15944. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15945. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15946. if (is_proxy_enabled_for_host(host_)) { return true; }
  15947. if (!initialize_ssl(socket, error)) {
  15948. shutdown_socket(socket);
  15949. close_socket(socket);
  15950. return false;
  15951. }
  15952. return true;
  15953. }
  15954. // SSL HTTP client implementation
  15955. inline SSLClient::SSLClient(const std::string &host)
  15956. : SSLClient(host, 443, std::string(), std::string()) {}
  15957. inline SSLClient::SSLClient(const std::string &host, int port)
  15958. : SSLClient(host, port, std::string(), std::string()) {}
  15959. inline void SSLClient::init_ctx() {
  15960. ctx_ = tls::create_client_context();
  15961. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15962. }
  15963. inline void SSLClient::reset_ctx_on_error() {
  15964. last_backend_error_ = tls::get_error();
  15965. tls::free_context(ctx_);
  15966. ctx_ = nullptr;
  15967. }
  15968. inline SSLClient::SSLClient(const std::string &host, int port,
  15969. const std::string &client_cert_path,
  15970. const std::string &client_key_path,
  15971. const std::string &private_key_password)
  15972. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15973. init_ctx();
  15974. if (!ctx_) { return; }
  15975. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15976. const char *password =
  15977. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15978. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15979. client_key_path.c_str(), password)) {
  15980. reset_ctx_on_error();
  15981. }
  15982. }
  15983. }
  15984. inline SSLClient::SSLClient(const std::string &host, int port,
  15985. const PemMemory &pem)
  15986. : ClientImpl(host, port) {
  15987. init_ctx();
  15988. if (!ctx_) { return; }
  15989. if (pem.cert_pem && pem.key_pem) {
  15990. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15991. pem.private_key_password)) {
  15992. reset_ctx_on_error();
  15993. }
  15994. }
  15995. }
  15996. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15997. if (ca_cert_store && ctx_) {
  15998. // set_ca_store takes ownership of ca_cert_store
  15999. tls::set_ca_store(ctx_, ca_cert_store);
  16000. ca_cert_store_set_ = true;
  16001. } else if (ca_cert_store) {
  16002. tls::free_ca_store(ca_cert_store);
  16003. }
  16004. }
  16005. inline void
  16006. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16007. if (!ctx_) { return; }
  16008. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16009. server_certificate_verifier_set_ = static_cast<bool>(verifier);
  16010. #endif
  16011. tls::set_verify_callback(ctx_, verifier);
  16012. }
  16013. inline void SSLClient::set_session_verifier(
  16014. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16015. session_verifier_ = std::move(verifier);
  16016. }
  16017. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16018. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16019. enable_windows_cert_verification_ = enabled;
  16020. }
  16021. #endif
  16022. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16023. std::size_t size) {
  16024. if (ctx_ && ca_cert && size > 0) {
  16025. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16026. tls::load_ca_pem(ctx_, ca_cert, size);
  16027. }
  16028. }
  16029. inline bool SSLClient::load_certs() {
  16030. auto ret = true;
  16031. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16032. // one client is shared across concurrent requests here.
  16033. std::call_once(initialize_cert_, [&]() {
  16034. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16035. ret = detail::load_client_ca_config(
  16036. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16037. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16038. last_backend_error_);
  16039. });
  16040. return ret;
  16041. }
  16042. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16043. // Load CA certificates if server verification is enabled
  16044. if (server_certificate_verification_) {
  16045. if (!load_certs()) {
  16046. error = Error::SSLLoadingCerts;
  16047. output_error_log(error, nullptr);
  16048. return false;
  16049. }
  16050. }
  16051. detail::ClientTlsSessionOptions options;
  16052. options.server_hostname_verification = server_hostname_verification_;
  16053. options.session_verifier = session_verifier_;
  16054. options.ctx_mutex = &ctx_mutex_;
  16055. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16056. // Skip Schannel when a custom CA cert is specified, as the Windows
  16057. // certificate store would not know about user-provided CA certificates.
  16058. // Also skip when system CA trust is explicitly disabled.
  16059. options.windows_cert_verification =
  16060. enable_windows_cert_verification_ &&
  16061. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16062. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16063. // Only a verifier set through set_server_certificate_verifier() is seen
  16064. // here, not one installed with tls::set_verify_callback() directly.
  16065. options.server_certificate_verifier_set = server_certificate_verifier_set_;
  16066. #endif
  16067. tls::session_t session = nullptr;
  16068. // Use scope_exit to ensure session is freed on error paths
  16069. bool success = false;
  16070. auto session_guard = detail::scope_exit([&] {
  16071. if (!success) { tls::free_session(session); }
  16072. });
  16073. detail::ClientTlsSessionError tls_error;
  16074. if (!detail::setup_client_tls_session(
  16075. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16076. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16077. options)) {
  16078. error = tls_error.error;
  16079. last_ssl_error_ = tls_error.ssl_error;
  16080. last_backend_error_ = tls_error.backend_error;
  16081. output_error_log(error, nullptr);
  16082. return false;
  16083. }
  16084. success = true;
  16085. socket.ssl = session;
  16086. return true;
  16087. }
  16088. inline void Client::set_digest_auth(const std::string &username,
  16089. const std::string &password) {
  16090. cli_->set_digest_auth(username, password);
  16091. }
  16092. inline void Client::set_proxy_digest_auth(const std::string &username,
  16093. const std::string &password) {
  16094. cli_->set_proxy_digest_auth(username, password);
  16095. }
  16096. inline void Client::enable_server_certificate_verification(bool enabled) {
  16097. cli_->enable_server_certificate_verification(enabled);
  16098. }
  16099. inline void Client::enable_server_hostname_verification(bool enabled) {
  16100. cli_->enable_server_hostname_verification(enabled);
  16101. }
  16102. inline void Client::enable_system_ca(bool enabled) {
  16103. cli_->enable_system_ca(enabled);
  16104. }
  16105. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16106. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16107. if (is_ssl_) {
  16108. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16109. enabled);
  16110. }
  16111. }
  16112. #endif
  16113. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16114. const std::string &ca_cert_dir_path) {
  16115. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16116. }
  16117. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16118. if (is_ssl_) {
  16119. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16120. } else if (ca_cert_store) {
  16121. tls::free_ca_store(ca_cert_store);
  16122. }
  16123. }
  16124. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16125. if (is_ssl_) {
  16126. // Use the PEM-based path so the CA data is retained for redirect transfer
  16127. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16128. }
  16129. }
  16130. inline void
  16131. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16132. if (is_ssl_) {
  16133. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16134. std::move(verifier));
  16135. }
  16136. }
  16137. inline void Client::set_session_verifier(
  16138. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16139. if (is_ssl_) {
  16140. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16141. }
  16142. }
  16143. inline tls::ctx_t Client::tls_context() const {
  16144. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16145. return nullptr;
  16146. }
  16147. #endif // CPPHTTPLIB_SSL_ENABLED
  16148. /*
  16149. * Group 7: TLS abstraction layer - Common API
  16150. */
  16151. #ifdef CPPHTTPLIB_SSL_ENABLED
  16152. namespace tls {
  16153. // Helper for PeerCert construction
  16154. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16155. return PeerCert(get_peer_cert(session));
  16156. }
  16157. namespace impl {
  16158. // Check if a string is an IPv4 address
  16159. inline bool is_ipv4_address(const std::string &str) {
  16160. int dots = 0;
  16161. for (char c : str) {
  16162. if (c == '.') {
  16163. dots++;
  16164. } else if (!detail::is_ascii_digit(c)) {
  16165. return false;
  16166. }
  16167. }
  16168. return dots == 3;
  16169. }
  16170. // Parse IPv4 address string to bytes
  16171. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16172. const char *p = str.c_str();
  16173. for (int i = 0; i < 4; i++) {
  16174. if (i > 0) {
  16175. if (*p != '.') { return false; }
  16176. p++;
  16177. }
  16178. int val = 0;
  16179. int digits = 0;
  16180. while (detail::is_ascii_digit(*p)) {
  16181. val = val * 10 + (*p - '0');
  16182. if (val > 255) { return false; }
  16183. p++;
  16184. digits++;
  16185. }
  16186. if (digits == 0) { return false; }
  16187. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16188. if (digits > 1 && *(p - digits) == '0') { return false; }
  16189. out[i] = static_cast<unsigned char>(val);
  16190. }
  16191. return *p == '\0';
  16192. }
  16193. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16194. // `out` must have room for at least 16 bytes. Returns the address length
  16195. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16196. // literal. Used to match a host against iPAddress SANs the same way the
  16197. // OpenSSL backend does via X509_check_ip.
  16198. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16199. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16200. struct in6_addr addr6 = {};
  16201. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16202. memcpy(out, &addr6, 16);
  16203. return 16;
  16204. }
  16205. return 0;
  16206. }
  16207. #ifdef _WIN32
  16208. // Enumerate Windows system certificates and call callback with DER data
  16209. template <typename Callback>
  16210. inline bool enumerate_windows_system_certs(Callback cb) {
  16211. bool loaded = false;
  16212. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16213. for (auto store_name : store_names) {
  16214. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16215. if (hStore) {
  16216. PCCERT_CONTEXT pContext = nullptr;
  16217. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16218. nullptr) {
  16219. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16220. loaded = true;
  16221. }
  16222. }
  16223. CertCloseStore(hStore, 0);
  16224. }
  16225. }
  16226. return loaded;
  16227. }
  16228. #endif
  16229. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16230. // Enumerate macOS Keychain certificates and call callback with DER data
  16231. template <typename Callback>
  16232. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16233. bool loaded = false;
  16234. const SecTrustSettingsDomain domains[] = {
  16235. kSecTrustSettingsDomainSystem,
  16236. kSecTrustSettingsDomainAdmin,
  16237. kSecTrustSettingsDomainUser,
  16238. };
  16239. for (auto domain : domains) {
  16240. CFArrayRef certs = nullptr;
  16241. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16242. if (status != errSecSuccess || !certs) {
  16243. if (certs) CFRelease(certs);
  16244. continue;
  16245. }
  16246. CFIndex count = CFArrayGetCount(certs);
  16247. for (CFIndex i = 0; i < count; i++) {
  16248. SecCertificateRef cert =
  16249. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16250. CFDataRef data = SecCertificateCopyData(cert);
  16251. if (data) {
  16252. if (cb(CFDataGetBytePtr(data),
  16253. static_cast<size_t>(CFDataGetLength(data)))) {
  16254. loaded = true;
  16255. }
  16256. CFRelease(data);
  16257. }
  16258. }
  16259. CFRelease(certs);
  16260. }
  16261. return loaded;
  16262. }
  16263. #endif
  16264. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16265. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16266. // Common CA certificate file paths on Linux/Unix
  16267. inline const char **system_ca_paths() {
  16268. static const char *paths[] = {
  16269. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16270. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16271. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16272. "/etc/pki/tls/cacert.pem", // OpenELEC
  16273. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16274. nullptr};
  16275. return paths;
  16276. }
  16277. // Common CA certificate directory paths on Linux/Unix
  16278. inline const char **system_ca_dirs() {
  16279. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16280. "/etc/pki/tls/certs", // RHEL/CentOS
  16281. "/usr/share/ca-certificates", // Other
  16282. nullptr};
  16283. return dirs;
  16284. }
  16285. #endif
  16286. } // namespace impl
  16287. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16288. const char *ca_dir) {
  16289. if (!ctx) { return false; }
  16290. bool success = true;
  16291. if (ca_file && *ca_file) {
  16292. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16293. }
  16294. if (ca_dir && *ca_dir) {
  16295. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16296. }
  16297. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16298. // Set CA list for client certificate request (CertificateRequest message)
  16299. if (ca_file && *ca_file) {
  16300. auto list = SSL_load_client_CA_file(ca_file);
  16301. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16302. }
  16303. #endif
  16304. return success;
  16305. }
  16306. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16307. const char *password) {
  16308. return set_client_cert_pem(ctx, cert, key, password);
  16309. }
  16310. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16311. const char *key_path, const char *password) {
  16312. return set_client_cert_file(ctx, cert_path, key_path, password);
  16313. }
  16314. // PeerCert implementation
  16315. inline PeerCert::PeerCert() = default;
  16316. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16317. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16318. other.cert_ = nullptr;
  16319. }
  16320. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16321. if (this != &other) {
  16322. if (cert_) { free_cert(cert_); }
  16323. cert_ = other.cert_;
  16324. other.cert_ = nullptr;
  16325. }
  16326. return *this;
  16327. }
  16328. inline PeerCert::~PeerCert() {
  16329. if (cert_) { free_cert(cert_); }
  16330. }
  16331. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16332. inline std::string PeerCert::subject_cn() const {
  16333. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16334. }
  16335. inline std::string PeerCert::issuer_name() const {
  16336. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16337. }
  16338. inline bool PeerCert::check_hostname(const char *hostname) const {
  16339. return cert_ ? verify_hostname(cert_, hostname) : false;
  16340. }
  16341. inline std::vector<SanEntry> PeerCert::sans() const {
  16342. std::vector<SanEntry> result;
  16343. if (cert_) { get_cert_sans(cert_, result); }
  16344. return result;
  16345. }
  16346. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16347. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16348. }
  16349. inline std::string PeerCert::serial() const {
  16350. return cert_ ? get_cert_serial(cert_) : std::string();
  16351. }
  16352. // VerifyContext method implementations
  16353. inline std::string VerifyContext::subject_cn() const {
  16354. return cert ? get_cert_subject_cn(cert) : std::string();
  16355. }
  16356. inline std::string VerifyContext::issuer_name() const {
  16357. return cert ? get_cert_issuer_name(cert) : std::string();
  16358. }
  16359. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16360. return cert ? verify_hostname(cert, hostname) : false;
  16361. }
  16362. inline std::vector<SanEntry> VerifyContext::sans() const {
  16363. std::vector<SanEntry> result;
  16364. if (cert) { get_cert_sans(cert, result); }
  16365. return result;
  16366. }
  16367. inline bool VerifyContext::validity(time_t &not_before,
  16368. time_t &not_after) const {
  16369. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16370. }
  16371. inline std::string VerifyContext::serial() const {
  16372. return cert ? get_cert_serial(cert) : std::string();
  16373. }
  16374. // TlsError static method implementation
  16375. inline std::string TlsError::verify_error_to_string(long error_code) {
  16376. return verify_error_string(error_code);
  16377. }
  16378. } // namespace tls
  16379. // Request::peer_cert() implementation
  16380. inline tls::PeerCert Request::peer_cert() const {
  16381. return tls::get_peer_cert_from_session(ssl);
  16382. }
  16383. // Request::sni() implementation
  16384. inline std::string Request::sni() const {
  16385. if (!ssl) { return std::string(); }
  16386. const char *s = tls::get_sni(ssl);
  16387. return s ? std::string(s) : std::string();
  16388. }
  16389. #endif // CPPHTTPLIB_SSL_ENABLED
  16390. /*
  16391. * Group 8: TLS abstraction layer - OpenSSL backend
  16392. */
  16393. /*
  16394. * OpenSSL Backend Implementation
  16395. */
  16396. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16397. namespace tls {
  16398. namespace impl {
  16399. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16400. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16401. switch (ssl_error) {
  16402. case SSL_ERROR_NONE: return ErrorCode::Success;
  16403. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16404. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16405. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16406. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16407. case SSL_ERROR_SSL:
  16408. default: return ErrorCode::Fatal;
  16409. }
  16410. }
  16411. // Helper: Create client CA list from PEM string
  16412. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16413. // Caller takes ownership of returned list
  16414. inline STACK_OF(X509_NAME) *
  16415. create_client_ca_list_from_pem(const char *ca_pem) {
  16416. if (!ca_pem) { return nullptr; }
  16417. auto ca_list = sk_X509_NAME_new_null();
  16418. if (!ca_list) { return nullptr; }
  16419. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16420. if (!bio) {
  16421. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16422. return nullptr;
  16423. }
  16424. X509 *cert = nullptr;
  16425. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16426. nullptr) {
  16427. const X509_NAME *name = X509_get_subject_name(cert);
  16428. if (name) {
  16429. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16430. }
  16431. X509_free(cert);
  16432. }
  16433. BIO_free(bio);
  16434. return ca_list;
  16435. }
  16436. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16437. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16438. long /*argl*/, void * /*argp*/) {
  16439. delete static_cast<VerifyCallback *>(ptr);
  16440. }
  16441. // The SSL_CTX owns its verify callback, so each client or server sees only
  16442. // its own, on whichever thread runs the handshake.
  16443. inline int verify_callback_index() {
  16444. static const auto index = SSL_CTX_get_ex_new_index(
  16445. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16446. return index;
  16447. }
  16448. // OpenSSL verify callback wrapper
  16449. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16450. // Get SSL object from X509_STORE_CTX
  16451. auto ssl = static_cast<SSL *>(
  16452. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16453. if (!ssl) { return preverify_ok; }
  16454. auto callback = static_cast<VerifyCallback *>(
  16455. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16456. if (!callback) { return preverify_ok; }
  16457. // Get current certificate and depth
  16458. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16459. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16460. int error = X509_STORE_CTX_get_error(ctx);
  16461. // Build context
  16462. VerifyContext verify_ctx;
  16463. verify_ctx.session = static_cast<session_t>(ssl);
  16464. verify_ctx.cert = static_cast<cert_t>(cert);
  16465. verify_ctx.depth = depth;
  16466. verify_ctx.preverify_ok = (preverify_ok != 0);
  16467. verify_ctx.error_code = error;
  16468. verify_ctx.error_string =
  16469. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16470. return (*callback)(verify_ctx) ? 1 : 0;
  16471. }
  16472. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16473. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16474. // that must be released with release_store_objects
  16475. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16476. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16477. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16478. #endif
  16479. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16480. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16481. return X509_STORE_get1_objects(store);
  16482. #else
  16483. return X509_STORE_get0_objects(store);
  16484. #endif
  16485. }
  16486. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16487. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16488. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16489. #else
  16490. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16491. #endif
  16492. }
  16493. } // namespace impl
  16494. inline ctx_t create_client_context() {
  16495. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16496. if (ctx) {
  16497. // Disable auto-retry to properly handle non-blocking I/O
  16498. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16499. // Set minimum TLS version
  16500. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16501. }
  16502. return static_cast<ctx_t>(ctx);
  16503. }
  16504. inline void free_context(ctx_t ctx) {
  16505. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16506. }
  16507. inline bool set_min_version(ctx_t ctx, Version version) {
  16508. if (!ctx) return false;
  16509. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16510. static_cast<int>(version)) == 1;
  16511. }
  16512. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16513. if (!ctx || !pem || len == 0) return false;
  16514. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16515. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16516. if (!store) return false;
  16517. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16518. if (!bio) return false;
  16519. bool ok = true;
  16520. X509 *cert = nullptr;
  16521. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16522. nullptr) {
  16523. if (X509_STORE_add_cert(store, cert) != 1) {
  16524. // Ignore duplicate errors
  16525. auto err = ERR_peek_last_error();
  16526. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16527. ok = false;
  16528. }
  16529. }
  16530. X509_free(cert);
  16531. if (!ok) break;
  16532. }
  16533. BIO_free(bio);
  16534. // Clear any "no more certificates" errors
  16535. ERR_clear_error();
  16536. return ok;
  16537. }
  16538. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16539. if (!ctx || !file_path) return false;
  16540. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16541. nullptr) == 1;
  16542. }
  16543. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16544. if (!ctx || !dir_path) return false;
  16545. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16546. dir_path) == 1;
  16547. }
  16548. inline bool load_system_certs(ctx_t ctx) {
  16549. if (!ctx) return false;
  16550. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16551. #ifdef _WIN32
  16552. // Windows: Load from system certificate store (ROOT and CA)
  16553. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16554. if (!store) return false;
  16555. bool loaded_any = false;
  16556. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16557. for (auto store_name : store_names) {
  16558. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16559. if (!hStore) continue;
  16560. PCCERT_CONTEXT pContext = nullptr;
  16561. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16562. nullptr) {
  16563. const unsigned char *data = pContext->pbCertEncoded;
  16564. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16565. if (x509) {
  16566. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16567. X509_free(x509);
  16568. }
  16569. }
  16570. CertCloseStore(hStore, 0);
  16571. }
  16572. return loaded_any;
  16573. #elif defined(__APPLE__)
  16574. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16575. // macOS: Load from Keychain
  16576. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16577. if (!store) return false;
  16578. bool loaded_any = false;
  16579. const SecTrustSettingsDomain domains[] = {
  16580. kSecTrustSettingsDomainSystem,
  16581. kSecTrustSettingsDomainAdmin,
  16582. kSecTrustSettingsDomainUser,
  16583. };
  16584. for (auto domain : domains) {
  16585. CFArrayRef certs = nullptr;
  16586. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16587. !certs) {
  16588. if (certs) CFRelease(certs);
  16589. continue;
  16590. }
  16591. auto count = CFArrayGetCount(certs);
  16592. for (CFIndex i = 0; i < count; i++) {
  16593. auto cert = reinterpret_cast<SecCertificateRef>(
  16594. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16595. CFDataRef der = SecCertificateCopyData(cert);
  16596. if (der) {
  16597. const unsigned char *data = CFDataGetBytePtr(der);
  16598. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16599. if (x509) {
  16600. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16601. X509_free(x509);
  16602. }
  16603. CFRelease(der);
  16604. }
  16605. }
  16606. CFRelease(certs);
  16607. }
  16608. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16609. #else
  16610. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16611. #endif
  16612. #else
  16613. // Other Unix: use default verify paths
  16614. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16615. #endif
  16616. }
  16617. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16618. const char *password) {
  16619. if (!ctx || !cert || !key) return false;
  16620. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16621. // Load certificate
  16622. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16623. if (!cert_bio) return false;
  16624. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16625. BIO_free(cert_bio);
  16626. if (!x509) return false;
  16627. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16628. X509_free(x509);
  16629. if (!cert_ok) return false;
  16630. // Load private key
  16631. auto key_bio = BIO_new_mem_buf(key, -1);
  16632. if (!key_bio) return false;
  16633. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16634. password ? const_cast<char *>(password)
  16635. : nullptr);
  16636. BIO_free(key_bio);
  16637. if (!pkey) return false;
  16638. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16639. EVP_PKEY_free(pkey);
  16640. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16641. }
  16642. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16643. const char *key_path, const char *password) {
  16644. if (!ctx || !cert_path || !key_path) return false;
  16645. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16646. if (password && password[0] != '\0') {
  16647. SSL_CTX_set_default_passwd_cb_userdata(
  16648. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16649. }
  16650. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16651. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16652. }
  16653. inline ctx_t create_server_context() {
  16654. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16655. if (ctx) {
  16656. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16657. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16658. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16659. }
  16660. return static_cast<ctx_t>(ctx);
  16661. }
  16662. inline void set_verify_client(ctx_t ctx, bool require) {
  16663. if (!ctx) return;
  16664. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16665. require
  16666. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16667. : SSL_VERIFY_NONE,
  16668. nullptr);
  16669. }
  16670. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16671. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16672. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16673. SSL *ssl = SSL_new(ssl_ctx);
  16674. if (!ssl) return nullptr;
  16675. // Disable auto-retry for proper non-blocking I/O handling
  16676. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16677. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16678. if (!bio) {
  16679. SSL_free(ssl);
  16680. return nullptr;
  16681. }
  16682. SSL_set_bio(ssl, bio, bio);
  16683. return static_cast<session_t>(ssl);
  16684. }
  16685. inline void free_session(session_t session) {
  16686. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16687. }
  16688. inline bool set_sni(session_t session, const char *hostname,
  16689. bool /*verify_hostname*/) {
  16690. if (!session || !hostname) return false;
  16691. auto ssl = static_cast<SSL *>(session);
  16692. // Set SNI (Server Name Indication) only - does not enable verification.
  16693. // OpenSSL never binds identity checking to SNI (that happens post-
  16694. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16695. #if defined(OPENSSL_IS_BORINGSSL)
  16696. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16697. #else
  16698. // Direct call instead of macro to suppress -Wold-style-cast warning
  16699. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16700. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16701. #endif
  16702. }
  16703. inline TlsError connect(session_t session) {
  16704. if (!session) { return TlsError(); }
  16705. auto ssl = static_cast<SSL *>(session);
  16706. auto ret = SSL_connect(ssl);
  16707. TlsError err;
  16708. if (ret == 1) {
  16709. err.code = ErrorCode::Success;
  16710. } else {
  16711. auto ssl_err = SSL_get_error(ssl, ret);
  16712. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16713. err.backend_code = ERR_get_error();
  16714. }
  16715. return err;
  16716. }
  16717. inline TlsError accept(session_t session) {
  16718. if (!session) { return TlsError(); }
  16719. auto ssl = static_cast<SSL *>(session);
  16720. auto ret = SSL_accept(ssl);
  16721. TlsError err;
  16722. if (ret == 1) {
  16723. err.code = ErrorCode::Success;
  16724. } else {
  16725. auto ssl_err = SSL_get_error(ssl, ret);
  16726. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16727. err.backend_code = ERR_get_error();
  16728. }
  16729. return err;
  16730. }
  16731. inline bool connect_nonblocking(session_t session, socket_t sock,
  16732. time_t timeout_sec, time_t timeout_usec,
  16733. TlsError *err) {
  16734. if (!session) {
  16735. if (err) { err->code = ErrorCode::Fatal; }
  16736. return false;
  16737. }
  16738. auto ssl = static_cast<SSL *>(session);
  16739. auto bio = SSL_get_rbio(ssl);
  16740. // Set non-blocking mode for handshake
  16741. detail::set_nonblocking(sock, true);
  16742. if (bio) { BIO_set_nbio(bio, 1); }
  16743. auto cleanup = detail::scope_exit([&]() {
  16744. // Restore blocking mode after handshake
  16745. if (bio) { BIO_set_nbio(bio, 0); }
  16746. detail::set_nonblocking(sock, false);
  16747. });
  16748. auto res = 0;
  16749. while ((res = SSL_connect(ssl)) != 1) {
  16750. auto ssl_err = SSL_get_error(ssl, res);
  16751. switch (ssl_err) {
  16752. case SSL_ERROR_WANT_READ:
  16753. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16754. continue;
  16755. }
  16756. break;
  16757. case SSL_ERROR_WANT_WRITE:
  16758. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16759. continue;
  16760. }
  16761. break;
  16762. default: break;
  16763. }
  16764. if (err) {
  16765. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16766. err->backend_code = ERR_get_error();
  16767. }
  16768. return false;
  16769. }
  16770. if (err) { err->code = ErrorCode::Success; }
  16771. return true;
  16772. }
  16773. inline bool accept_nonblocking(session_t session, socket_t sock,
  16774. time_t timeout_sec, time_t timeout_usec,
  16775. TlsError *err) {
  16776. if (!session) {
  16777. if (err) { err->code = ErrorCode::Fatal; }
  16778. return false;
  16779. }
  16780. auto ssl = static_cast<SSL *>(session);
  16781. auto bio = SSL_get_rbio(ssl);
  16782. // Set non-blocking mode for handshake
  16783. detail::set_nonblocking(sock, true);
  16784. if (bio) { BIO_set_nbio(bio, 1); }
  16785. auto cleanup = detail::scope_exit([&]() {
  16786. // Restore blocking mode after handshake
  16787. if (bio) { BIO_set_nbio(bio, 0); }
  16788. detail::set_nonblocking(sock, false);
  16789. });
  16790. auto res = 0;
  16791. while ((res = SSL_accept(ssl)) != 1) {
  16792. auto ssl_err = SSL_get_error(ssl, res);
  16793. switch (ssl_err) {
  16794. case SSL_ERROR_WANT_READ:
  16795. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16796. continue;
  16797. }
  16798. break;
  16799. case SSL_ERROR_WANT_WRITE:
  16800. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16801. continue;
  16802. }
  16803. break;
  16804. default: break;
  16805. }
  16806. if (err) {
  16807. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16808. err->backend_code = ERR_get_error();
  16809. }
  16810. return false;
  16811. }
  16812. if (err) { err->code = ErrorCode::Success; }
  16813. return true;
  16814. }
  16815. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16816. if (!session || !buf) {
  16817. err.code = ErrorCode::Fatal;
  16818. return -1;
  16819. }
  16820. auto ssl = static_cast<SSL *>(session);
  16821. constexpr auto max_len =
  16822. static_cast<size_t>((std::numeric_limits<int>::max)());
  16823. if (len > max_len) { len = max_len; }
  16824. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16825. if (ret > 0) {
  16826. err.code = ErrorCode::Success;
  16827. return ret;
  16828. }
  16829. auto ssl_err = SSL_get_error(ssl, ret);
  16830. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16831. if (err.code == ErrorCode::PeerClosed) {
  16832. return 0;
  16833. } // Gracefully handle the peer closed state.
  16834. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16835. return -1;
  16836. }
  16837. inline ssize_t write(session_t session, const void *buf, size_t len,
  16838. TlsError &err) {
  16839. if (!session || !buf) {
  16840. err.code = ErrorCode::Fatal;
  16841. return -1;
  16842. }
  16843. auto ssl = static_cast<SSL *>(session);
  16844. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16845. if (ret > 0) {
  16846. err.code = ErrorCode::Success;
  16847. return ret;
  16848. }
  16849. auto ssl_err = SSL_get_error(ssl, ret);
  16850. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16851. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16852. return -1;
  16853. }
  16854. inline int pending(const_session_t session) {
  16855. if (!session) return 0;
  16856. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16857. }
  16858. inline void shutdown(session_t session, bool graceful) {
  16859. if (!session) return;
  16860. auto ssl = static_cast<SSL *>(session);
  16861. if (graceful) {
  16862. // Send close_notify without waiting for the peer's. The connection is
  16863. // closed right after this, so a unidirectional shutdown is enough, and an
  16864. // idle peer that never answers would otherwise hold this thread until the
  16865. // read timeout. The other backends do not wait either.
  16866. SSL_shutdown(ssl);
  16867. }
  16868. }
  16869. inline bool is_peer_closed(session_t session, socket_t sock) {
  16870. if (!session) return true;
  16871. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16872. detail::set_nonblocking(sock, true);
  16873. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16874. auto ssl = static_cast<SSL *>(session);
  16875. char buf;
  16876. auto ret = SSL_peek(ssl, &buf, 1);
  16877. if (ret > 0) return false;
  16878. auto err = SSL_get_error(ssl, ret);
  16879. return err == SSL_ERROR_ZERO_RETURN;
  16880. }
  16881. inline cert_t get_peer_cert(const_session_t session) {
  16882. if (!session) return nullptr;
  16883. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16884. static_cast<SSL *>(const_cast<void *>(session))));
  16885. }
  16886. inline size_t get_peer_certs(const_session_t session,
  16887. std::vector<cert_t> &certs) {
  16888. certs.clear();
  16889. if (!session) { return 0; }
  16890. auto ssl = static_cast<const SSL *>(session);
  16891. // On the server side, the chain leaves out the peer's own certificate
  16892. if (SSL_is_server(ssl)) {
  16893. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  16894. }
  16895. auto sk = SSL_get_peer_cert_chain(ssl);
  16896. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  16897. auto x509 = sk_X509_value(sk, i);
  16898. X509_up_ref(x509);
  16899. certs.push_back(static_cast<cert_t>(x509));
  16900. }
  16901. return certs.size();
  16902. }
  16903. inline void free_cert(cert_t cert) {
  16904. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16905. }
  16906. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16907. if (!cert || !hostname) return false;
  16908. auto x509 = static_cast<X509 *>(cert);
  16909. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16910. if (detail::is_ip_address(hostname)) {
  16911. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16912. }
  16913. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16914. }
  16915. inline uint64_t hostname_mismatch_code() {
  16916. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16917. }
  16918. inline long get_verify_result(const_session_t session) {
  16919. if (!session) return X509_V_ERR_UNSPECIFIED;
  16920. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16921. }
  16922. inline std::string get_cert_subject_cn(cert_t cert) {
  16923. if (!cert) return "";
  16924. auto x509 = static_cast<X509 *>(cert);
  16925. auto subject_name = X509_get_subject_name(x509);
  16926. if (!subject_name) return "";
  16927. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16928. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16929. if (idx < 0) return "";
  16930. auto entry = X509_NAME_get_entry(subject_name, idx);
  16931. if (!entry) return "";
  16932. auto data = X509_NAME_ENTRY_get_data(entry);
  16933. if (!data) return "";
  16934. return std::string(
  16935. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16936. static_cast<size_t>(ASN1_STRING_length(data)));
  16937. }
  16938. inline std::string get_cert_issuer_name(cert_t cert) {
  16939. if (!cert) return "";
  16940. auto x509 = static_cast<X509 *>(cert);
  16941. auto issuer_name = X509_get_issuer_name(x509);
  16942. if (!issuer_name) return "";
  16943. char buf[256];
  16944. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16945. return std::string(buf);
  16946. }
  16947. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16948. sans.clear();
  16949. if (!cert) return false;
  16950. auto x509 = static_cast<X509 *>(cert);
  16951. auto names = static_cast<GENERAL_NAMES *>(
  16952. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16953. if (!names) return true; // No SANs is valid
  16954. auto count = sk_GENERAL_NAME_num(names);
  16955. for (decltype(count) i = 0; i < count; i++) {
  16956. auto gen = sk_GENERAL_NAME_value(names, i);
  16957. if (!gen) continue;
  16958. SanEntry entry;
  16959. switch (gen->type) {
  16960. case GEN_DNS:
  16961. entry.type = SanType::DNS;
  16962. if (gen->d.dNSName) {
  16963. entry.value = std::string(
  16964. reinterpret_cast<const char *>(
  16965. ASN1_STRING_get0_data(gen->d.dNSName)),
  16966. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16967. }
  16968. break;
  16969. case GEN_IPADD:
  16970. entry.type = SanType::IP;
  16971. if (gen->d.iPAddress) {
  16972. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16973. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16974. if (len == 4) {
  16975. // IPv4
  16976. char buf[INET_ADDRSTRLEN];
  16977. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16978. entry.value = buf;
  16979. } else if (len == 16) {
  16980. // IPv6
  16981. char buf[INET6_ADDRSTRLEN];
  16982. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16983. entry.value = buf;
  16984. }
  16985. }
  16986. break;
  16987. case GEN_EMAIL:
  16988. entry.type = SanType::EMAIL;
  16989. if (gen->d.rfc822Name) {
  16990. entry.value = std::string(
  16991. reinterpret_cast<const char *>(
  16992. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16993. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16994. }
  16995. break;
  16996. case GEN_URI:
  16997. entry.type = SanType::URI;
  16998. if (gen->d.uniformResourceIdentifier) {
  16999. entry.value = std::string(
  17000. reinterpret_cast<const char *>(
  17001. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17002. static_cast<size_t>(
  17003. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17004. }
  17005. break;
  17006. default: entry.type = SanType::OTHER; break;
  17007. }
  17008. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17009. }
  17010. GENERAL_NAMES_free(names);
  17011. return true;
  17012. }
  17013. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17014. time_t &not_after) {
  17015. if (!cert) return false;
  17016. auto x509 = static_cast<X509 *>(cert);
  17017. auto nb = X509_get0_notBefore(x509);
  17018. auto na = X509_get0_notAfter(x509);
  17019. if (!nb || !na) return false;
  17020. ASN1_TIME *epoch = ASN1_TIME_new();
  17021. if (!epoch) return false;
  17022. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17023. if (!ASN1_TIME_set(epoch, 0)) return false;
  17024. int pday, psec;
  17025. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17026. not_before = 86400 * (time_t)pday + psec;
  17027. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17028. not_after = 86400 * (time_t)pday + psec;
  17029. return true;
  17030. }
  17031. inline std::string get_cert_serial(cert_t cert) {
  17032. if (!cert) return "";
  17033. auto x509 = static_cast<X509 *>(cert);
  17034. auto serial = X509_get_serialNumber(x509);
  17035. if (!serial) return "";
  17036. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17037. if (!bn) return "";
  17038. auto hex = BN_bn2hex(bn);
  17039. BN_free(bn);
  17040. if (!hex) return "";
  17041. std::string result(hex);
  17042. OPENSSL_free(hex);
  17043. return result;
  17044. }
  17045. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17046. if (!cert) return false;
  17047. auto x509 = static_cast<X509 *>(cert);
  17048. auto len = i2d_X509(x509, nullptr);
  17049. if (len < 0) return false;
  17050. der.resize(static_cast<size_t>(len));
  17051. auto p = der.data();
  17052. i2d_X509(x509, &p);
  17053. return true;
  17054. }
  17055. inline const char *get_sni(const_session_t session) {
  17056. if (!session) return nullptr;
  17057. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17058. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17059. }
  17060. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17061. inline uint64_t get_error() { return ERR_get_error(); }
  17062. inline std::string error_string(uint64_t code) {
  17063. char buf[256];
  17064. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17065. return std::string(buf);
  17066. }
  17067. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17068. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17069. if (!mem) { return nullptr; }
  17070. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17071. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17072. if (!inf) { return nullptr; }
  17073. auto store = X509_STORE_new();
  17074. if (store) {
  17075. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17076. auto itmp = sk_X509_INFO_value(inf, i);
  17077. if (!itmp) { continue; }
  17078. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17079. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17080. }
  17081. }
  17082. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17083. return static_cast<ca_store_t>(store);
  17084. }
  17085. inline void free_ca_store(ca_store_t store) {
  17086. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17087. }
  17088. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17089. if (!ctx || !store) { return false; }
  17090. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17091. auto x509_store = static_cast<X509_STORE *>(store);
  17092. // Check if same store is already set
  17093. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17094. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17095. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17096. return true;
  17097. }
  17098. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17099. certs.clear();
  17100. if (!ctx) { return 0; }
  17101. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17102. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17103. if (!store) { return 0; }
  17104. auto objs = impl::get_store_objects(store);
  17105. if (!objs) { return 0; }
  17106. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17107. auto count = sk_X509_OBJECT_num(objs);
  17108. for (decltype(count) i = 0; i < count; i++) {
  17109. auto obj = sk_X509_OBJECT_value(objs, i);
  17110. if (!obj) { continue; }
  17111. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17112. auto x509 = X509_OBJECT_get0_X509(obj);
  17113. if (x509) {
  17114. // Increment reference count so caller can free it
  17115. X509_up_ref(x509);
  17116. certs.push_back(static_cast<cert_t>(x509));
  17117. }
  17118. }
  17119. }
  17120. return certs.size();
  17121. }
  17122. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17123. std::vector<std::string> names;
  17124. if (!ctx) { return names; }
  17125. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17126. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17127. if (!store) { return names; }
  17128. auto objs = impl::get_store_objects(store);
  17129. if (!objs) { return names; }
  17130. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17131. auto count = sk_X509_OBJECT_num(objs);
  17132. for (decltype(count) i = 0; i < count; i++) {
  17133. auto obj = sk_X509_OBJECT_value(objs, i);
  17134. if (!obj) { continue; }
  17135. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17136. auto x509 = X509_OBJECT_get0_X509(obj);
  17137. if (x509) {
  17138. auto subject = X509_get_subject_name(x509);
  17139. if (subject) {
  17140. char buf[512];
  17141. X509_NAME_oneline(subject, buf, sizeof(buf));
  17142. names.push_back(buf);
  17143. }
  17144. }
  17145. }
  17146. }
  17147. return names;
  17148. }
  17149. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17150. const char *key_pem, const char *password) {
  17151. if (!ctx || !cert_pem || !key_pem) { return false; }
  17152. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17153. // Load certificate from PEM
  17154. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17155. if (!cert_bio) { return false; }
  17156. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17157. BIO_free(cert_bio);
  17158. if (!cert) { return false; }
  17159. // Load private key from PEM
  17160. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17161. if (!key_bio) {
  17162. X509_free(cert);
  17163. return false;
  17164. }
  17165. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17166. password ? const_cast<char *>(password)
  17167. : nullptr);
  17168. BIO_free(key_bio);
  17169. if (!key) {
  17170. X509_free(cert);
  17171. return false;
  17172. }
  17173. // Update certificate and key
  17174. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17175. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17176. X509_free(cert);
  17177. EVP_PKEY_free(key);
  17178. return ret;
  17179. }
  17180. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17181. if (!ctx || !ca_pem) { return false; }
  17182. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17183. // Create new X509_STORE from PEM
  17184. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17185. if (!store) { return false; }
  17186. // SSL_CTX_set_cert_store takes ownership
  17187. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17188. // Set client CA list for client certificate request
  17189. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17190. if (ca_list) {
  17191. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17192. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17193. }
  17194. return true;
  17195. }
  17196. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17197. if (!ctx) { return false; }
  17198. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17199. auto index = impl::verify_callback_index();
  17200. if (index < 0) { return false; }
  17201. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17202. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17203. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17204. if (stored) {
  17205. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17206. } else {
  17207. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17208. }
  17209. return true;
  17210. }
  17211. inline long get_verify_error(const_session_t session) {
  17212. if (!session) { return -1; }
  17213. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17214. return SSL_get_verify_result(ssl);
  17215. }
  17216. inline std::string verify_error_string(long error_code) {
  17217. if (error_code == X509_V_OK) { return ""; }
  17218. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17219. return str ? str : "unknown error";
  17220. }
  17221. } // namespace tls
  17222. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17223. /*
  17224. * Group 9: TLS abstraction layer - Mbed TLS backend
  17225. */
  17226. /*
  17227. * Mbed TLS Backend Implementation
  17228. */
  17229. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17230. namespace tls {
  17231. namespace impl {
  17232. // Mbed TLS session wrapper
  17233. struct MbedTlsSession {
  17234. mbedtls_ssl_context ssl;
  17235. socket_t sock = INVALID_SOCKET;
  17236. std::string hostname; // For client: set via set_sni
  17237. std::string sni_hostname; // For server: received from client via SNI callback
  17238. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17239. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17240. // (e.g. a response that arrived while this side was still in its post-write
  17241. // check), the byte is pushed back here and served by the next read().
  17242. unsigned char peeked_byte = 0;
  17243. bool has_peeked_byte = false;
  17244. // Set by set_sni() when the caller disabled hostname verification, so the
  17245. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17246. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17247. // OpenSSL and wolfSSL keep them independent).
  17248. bool suppress_hostname_mismatch = false;
  17249. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17250. // ever runs the callback of its own context.
  17251. VerifyCallback verify_callback;
  17252. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17253. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17254. MbedTlsSession(const MbedTlsSession &) = delete;
  17255. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17256. };
  17257. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17258. // queue)
  17259. inline int &mbedtls_last_error() {
  17260. static thread_local int err = 0;
  17261. return err;
  17262. }
  17263. // Helper to map Mbed TLS error to ErrorCode
  17264. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17265. uint32_t verify_flags) {
  17266. if (ret == 0) { return ErrorCode::Success; }
  17267. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17268. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17269. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17270. return ErrorCode::PeerClosed;
  17271. }
  17272. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17273. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17274. out_errno = errno;
  17275. return ErrorCode::SyscallError;
  17276. }
  17277. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17278. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17279. // the handshake's chain verification (see set_sni()); a mismatch there
  17280. // is reported the same way as any other verify_flags bit. Report it as
  17281. // HostnameMismatch, matching the other backends and the post-handshake
  17282. // identity check below, but only when naming is the sole problem -
  17283. // if the chain itself is also untrusted/expired/etc., that takes
  17284. // priority over the naming detail.
  17285. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17286. return ErrorCode::HostnameMismatch;
  17287. }
  17288. return ErrorCode::CertVerifyFailed;
  17289. }
  17290. return ErrorCode::Fatal;
  17291. }
  17292. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17293. // return value, including the verify-flags-dependent HostnameMismatch
  17294. // mapping; shared by connect() and connect_nonblocking() so the
  17295. // backend_code policy for that mapping only lives in one place.
  17296. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17297. int ret) {
  17298. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17299. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17300. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17301. ? static_cast<uint64_t>(verify_flags)
  17302. : static_cast<uint64_t>(-ret);
  17303. }
  17304. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17305. // non-fatal notification delivered between records, not an error and not
  17306. // application data, so I/O calls that see it should just be retried. Kept in
  17307. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17308. // splitting the closing brace across an #if.
  17309. inline bool mbedtls_is_session_ticket(int ret) {
  17310. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17311. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17312. #else
  17313. (void)ret;
  17314. return false;
  17315. #endif
  17316. }
  17317. // BIO-like send callback for Mbed TLS
  17318. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17319. size_t len) {
  17320. auto sock = *static_cast<socket_t *>(ctx);
  17321. #ifdef _WIN32
  17322. auto ret =
  17323. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17324. if (ret == SOCKET_ERROR) {
  17325. int err = WSAGetLastError();
  17326. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17327. return MBEDTLS_ERR_NET_SEND_FAILED;
  17328. }
  17329. #else
  17330. auto ret = send(sock, buf, len, 0);
  17331. if (ret < 0) {
  17332. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17333. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17334. }
  17335. return MBEDTLS_ERR_NET_SEND_FAILED;
  17336. }
  17337. #endif
  17338. return static_cast<int>(ret);
  17339. }
  17340. // BIO-like recv callback for Mbed TLS
  17341. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17342. auto sock = *static_cast<socket_t *>(ctx);
  17343. #ifdef _WIN32
  17344. auto ret =
  17345. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17346. if (ret == SOCKET_ERROR) {
  17347. int err = WSAGetLastError();
  17348. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17349. return MBEDTLS_ERR_NET_RECV_FAILED;
  17350. }
  17351. #else
  17352. auto ret = recv(sock, buf, len, 0);
  17353. if (ret < 0) {
  17354. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17355. return MBEDTLS_ERR_SSL_WANT_READ;
  17356. }
  17357. return MBEDTLS_ERR_NET_RECV_FAILED;
  17358. }
  17359. #endif
  17360. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17361. return static_cast<int>(ret);
  17362. }
  17363. // MbedTlsContext constructor/destructor implementations
  17364. inline MbedTlsContext::MbedTlsContext() {
  17365. mbedtls_ssl_config_init(&conf);
  17366. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17367. mbedtls_entropy_init(&entropy);
  17368. mbedtls_ctr_drbg_init(&ctr_drbg);
  17369. #endif
  17370. mbedtls_x509_crt_init(&ca_chain);
  17371. mbedtls_x509_crt_init(&own_cert);
  17372. mbedtls_pk_init(&own_key);
  17373. }
  17374. inline MbedTlsContext::~MbedTlsContext() {
  17375. mbedtls_pk_free(&own_key);
  17376. mbedtls_x509_crt_free(&own_cert);
  17377. mbedtls_x509_crt_free(&ca_chain);
  17378. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17379. mbedtls_ctr_drbg_free(&ctr_drbg);
  17380. mbedtls_entropy_free(&entropy);
  17381. #endif
  17382. mbedtls_ssl_config_free(&conf);
  17383. }
  17384. // Thread-local storage for SNI captured during handshake
  17385. // This is needed because the SNI callback doesn't have a way to pass
  17386. // session-specific data before the session is fully set up
  17387. inline std::string &mbedpending_sni() {
  17388. static thread_local std::string sni;
  17389. return sni;
  17390. }
  17391. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17392. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17393. const unsigned char *name, size_t name_len) {
  17394. (void)p_ctx;
  17395. (void)ssl;
  17396. // Store SNI name in thread-local storage
  17397. // It will be retrieved and stored in the session after handshake
  17398. if (name && name_len > 0) {
  17399. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17400. } else {
  17401. mbedpending_sni().clear();
  17402. }
  17403. return 0; // Accept any SNI
  17404. }
  17405. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17406. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17407. }
  17408. // Verify callback used when hostname verification is disabled for a session
  17409. // that has no user-supplied verify callback of its own.
  17410. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17411. mbedtls_x509_crt *, int,
  17412. uint32_t *flags) {
  17413. (void)data;
  17414. mbedtls_clear_cn_mismatch(flags);
  17415. return 0;
  17416. }
  17417. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17418. int cert_depth, uint32_t *flags);
  17419. // MbedTLS verify callback wrapper
  17420. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17421. int cert_depth, uint32_t *flags) {
  17422. // data points to the MbedTlsSession
  17423. auto *session = static_cast<MbedTlsSession *>(data);
  17424. // set_sni() disabled hostname verification for this session: drop the
  17425. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17426. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17427. // SNI. The final pass/fail decision still comes from the remaining flags
  17428. // (or, below, from the user's own verify callback).
  17429. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17430. // Build context
  17431. VerifyContext verify_ctx;
  17432. verify_ctx.session = static_cast<session_t>(session);
  17433. verify_ctx.cert = static_cast<cert_t>(crt);
  17434. verify_ctx.depth = cert_depth;
  17435. verify_ctx.preverify_ok = (*flags == 0);
  17436. verify_ctx.error_code = static_cast<long>(*flags);
  17437. // Convert Mbed TLS flags to error string
  17438. static thread_local char error_buf[256];
  17439. if (*flags != 0) {
  17440. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17441. verify_ctx.error_string = error_buf;
  17442. } else {
  17443. verify_ctx.error_string = nullptr;
  17444. }
  17445. bool accepted = session->verify_callback(verify_ctx);
  17446. if (accepted) {
  17447. *flags = 0; // Clear all error flags
  17448. return 0;
  17449. }
  17450. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17451. }
  17452. } // namespace impl
  17453. inline ctx_t create_client_context() {
  17454. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17455. if (!ctx) { return nullptr; }
  17456. ctx->is_server = false;
  17457. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17458. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17459. if (!detail::ensure_mbedtls_psa_crypto()) {
  17460. delete ctx;
  17461. return nullptr;
  17462. }
  17463. int ret;
  17464. #else
  17465. // Seed the random number generator
  17466. const char *pers = "httplib_client";
  17467. int ret = mbedtls_ctr_drbg_seed(
  17468. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17469. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17470. if (ret != 0) {
  17471. impl::mbedtls_last_error() = ret;
  17472. delete ctx;
  17473. return nullptr;
  17474. }
  17475. #endif
  17476. // Set up SSL config for client
  17477. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17478. MBEDTLS_SSL_TRANSPORT_STREAM,
  17479. MBEDTLS_SSL_PRESET_DEFAULT);
  17480. if (ret != 0) {
  17481. impl::mbedtls_last_error() = ret;
  17482. delete ctx;
  17483. return nullptr;
  17484. }
  17485. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17486. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17487. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17488. #endif
  17489. // Default: verify peer certificate
  17490. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17491. // Set minimum TLS version to 1.2
  17492. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17493. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17494. #else
  17495. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17496. MBEDTLS_SSL_MINOR_VERSION_3);
  17497. #endif
  17498. return static_cast<ctx_t>(ctx);
  17499. }
  17500. inline ctx_t create_server_context() {
  17501. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17502. if (!ctx) { return nullptr; }
  17503. ctx->is_server = true;
  17504. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17505. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17506. if (!detail::ensure_mbedtls_psa_crypto()) {
  17507. delete ctx;
  17508. return nullptr;
  17509. }
  17510. int ret;
  17511. #else
  17512. // Seed the random number generator
  17513. const char *pers = "httplib_server";
  17514. int ret = mbedtls_ctr_drbg_seed(
  17515. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17516. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17517. if (ret != 0) {
  17518. impl::mbedtls_last_error() = ret;
  17519. delete ctx;
  17520. return nullptr;
  17521. }
  17522. #endif
  17523. // Set up SSL config for server
  17524. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17525. MBEDTLS_SSL_TRANSPORT_STREAM,
  17526. MBEDTLS_SSL_PRESET_DEFAULT);
  17527. if (ret != 0) {
  17528. impl::mbedtls_last_error() = ret;
  17529. delete ctx;
  17530. return nullptr;
  17531. }
  17532. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17533. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17534. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17535. #endif
  17536. // Default: don't verify client
  17537. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17538. // Set minimum TLS version to 1.2
  17539. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17540. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17541. #else
  17542. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17543. MBEDTLS_SSL_MINOR_VERSION_3);
  17544. #endif
  17545. // Set SNI callback to capture client's SNI hostname
  17546. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17547. return static_cast<ctx_t>(ctx);
  17548. }
  17549. inline void free_context(ctx_t ctx) {
  17550. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17551. }
  17552. inline bool set_min_version(ctx_t ctx, Version version) {
  17553. if (!ctx) { return false; }
  17554. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17555. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17556. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17557. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17558. if (version >= Version::TLS1_3) {
  17559. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17560. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17561. #endif
  17562. }
  17563. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17564. #else
  17565. // Mbed TLS 2.x uses major/minor version numbers
  17566. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17567. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17568. if (version >= Version::TLS1_3) {
  17569. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17570. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17571. #else
  17572. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17573. #endif
  17574. }
  17575. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17576. #endif
  17577. return true;
  17578. }
  17579. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17580. if (!ctx || !pem) { return false; }
  17581. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17582. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17583. // Add null terminator if not present
  17584. std::string pem_str(pem, len);
  17585. int ret = mbedtls_x509_crt_parse(
  17586. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17587. pem_str.size() + 1);
  17588. if (ret != 0) {
  17589. impl::mbedtls_last_error() = ret;
  17590. return false;
  17591. }
  17592. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17593. return true;
  17594. }
  17595. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17596. if (!ctx || !file_path) { return false; }
  17597. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17598. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17599. if (ret != 0) {
  17600. impl::mbedtls_last_error() = ret;
  17601. return false;
  17602. }
  17603. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17604. return true;
  17605. }
  17606. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17607. if (!ctx || !dir_path) { return false; }
  17608. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17609. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17610. if (ret < 0) { // Returns number of certs on success, negative on error
  17611. impl::mbedtls_last_error() = ret;
  17612. return false;
  17613. }
  17614. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17615. return true;
  17616. }
  17617. inline bool load_system_certs(ctx_t ctx) {
  17618. if (!ctx) { return false; }
  17619. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17620. bool loaded = false;
  17621. #ifdef _WIN32
  17622. loaded = impl::enumerate_windows_system_certs(
  17623. [&](const unsigned char *data, size_t len) {
  17624. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17625. });
  17626. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17627. loaded = impl::enumerate_macos_keychain_certs(
  17628. [&](const unsigned char *data, size_t len) {
  17629. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17630. });
  17631. #else
  17632. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17633. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17634. loaded = true;
  17635. break;
  17636. }
  17637. }
  17638. if (!loaded) {
  17639. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17640. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17641. loaded = true;
  17642. break;
  17643. }
  17644. }
  17645. }
  17646. #endif
  17647. if (loaded) {
  17648. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17649. }
  17650. return loaded;
  17651. }
  17652. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17653. const char *password) {
  17654. if (!ctx || !cert || !key) { return false; }
  17655. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17656. // Parse certificate
  17657. std::string cert_str(cert);
  17658. int ret = mbedtls_x509_crt_parse(
  17659. &mctx->own_cert,
  17660. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17661. cert_str.size() + 1);
  17662. if (ret != 0) {
  17663. impl::mbedtls_last_error() = ret;
  17664. return false;
  17665. }
  17666. // Parse private key
  17667. std::string key_str(key);
  17668. const unsigned char *pwd =
  17669. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17670. size_t pwd_len = password ? strlen(password) : 0;
  17671. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17672. ret = mbedtls_pk_parse_key(
  17673. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17674. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17675. &mctx->ctr_drbg);
  17676. #else
  17677. ret = mbedtls_pk_parse_key(
  17678. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17679. key_str.size() + 1, pwd, pwd_len);
  17680. #endif
  17681. if (ret != 0) {
  17682. impl::mbedtls_last_error() = ret;
  17683. return false;
  17684. }
  17685. // Verify that the certificate and private key match.
  17686. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17687. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17688. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17689. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17690. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17691. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17692. #else
  17693. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17694. #endif
  17695. if (ret != 0) {
  17696. impl::mbedtls_last_error() = ret;
  17697. return false;
  17698. }
  17699. #endif
  17700. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17701. if (ret != 0) {
  17702. impl::mbedtls_last_error() = ret;
  17703. return false;
  17704. }
  17705. return true;
  17706. }
  17707. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17708. const char *key_path, const char *password) {
  17709. if (!ctx || !cert_path || !key_path) { return false; }
  17710. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17711. // Parse certificate file
  17712. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17713. if (ret != 0) {
  17714. impl::mbedtls_last_error() = ret;
  17715. return false;
  17716. }
  17717. // Parse private key file
  17718. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17719. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17720. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17721. #else
  17722. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17723. #endif
  17724. if (ret != 0) {
  17725. impl::mbedtls_last_error() = ret;
  17726. return false;
  17727. }
  17728. // Verify that the certificate and private key match.
  17729. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17730. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17731. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17732. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17733. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17734. #else
  17735. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17736. #endif
  17737. if (ret != 0) {
  17738. impl::mbedtls_last_error() = ret;
  17739. return false;
  17740. }
  17741. #endif
  17742. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17743. if (ret != 0) {
  17744. impl::mbedtls_last_error() = ret;
  17745. return false;
  17746. }
  17747. return true;
  17748. }
  17749. inline void set_verify_client(ctx_t ctx, bool require) {
  17750. if (!ctx) { return; }
  17751. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17752. mctx->verify_client = require;
  17753. if (require) {
  17754. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17755. } else {
  17756. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17757. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17758. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  17759. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17760. : MBEDTLS_SSL_VERIFY_NONE);
  17761. }
  17762. }
  17763. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17764. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17765. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17766. auto session = new (std::nothrow) impl::MbedTlsSession();
  17767. if (!session) { return nullptr; }
  17768. session->sock = sock;
  17769. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17770. if (ret != 0) {
  17771. impl::mbedtls_last_error() = ret;
  17772. delete session;
  17773. return nullptr;
  17774. }
  17775. // Explicitly opt out of in-handshake hostname verification by default;
  17776. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17777. // fails outright when no hostname was set. set_sni() installs the real
  17778. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17779. // caller verifies the certificate identity post-handshake via
  17780. // verify_hostname().
  17781. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17782. // Set BIO callbacks
  17783. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17784. impl::mbedtls_net_recv_cb, nullptr);
  17785. // Set per-session verify callback with session pointer if callback is
  17786. // registered
  17787. session->verify_callback = mctx->verify_callback;
  17788. if (session->verify_callback) {
  17789. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17790. session);
  17791. }
  17792. return static_cast<session_t>(session);
  17793. }
  17794. inline void free_session(session_t session) {
  17795. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17796. }
  17797. inline bool set_sni(session_t session, const char *hostname,
  17798. bool verify_hostname) {
  17799. if (!session || !hostname) { return false; }
  17800. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17801. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17802. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17803. // independently, so a disabled hostname check is handled below by masking
  17804. // the resulting mismatch flag instead of skipping this call.
  17805. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17806. if (ret != 0) {
  17807. impl::mbedtls_last_error() = ret;
  17808. return false;
  17809. }
  17810. msession->hostname = hostname;
  17811. if (!verify_hostname) {
  17812. msession->suppress_hostname_mismatch = true;
  17813. // If a user verify callback is already wired for this session,
  17814. // mbedtls_verify_callback() masks the mismatch flag itself before
  17815. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17816. // here would be redundant. Otherwise install the masking callback alone.
  17817. if (!msession->verify_callback) {
  17818. mbedtls_ssl_set_verify(&msession->ssl,
  17819. impl::mbedtls_mask_hostname_mismatch_callback,
  17820. msession);
  17821. }
  17822. }
  17823. return true;
  17824. }
  17825. inline TlsError connect(session_t session) {
  17826. TlsError err;
  17827. if (!session) {
  17828. err.code = ErrorCode::Fatal;
  17829. return err;
  17830. }
  17831. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17832. int ret;
  17833. do {
  17834. ret = mbedtls_ssl_handshake(&msession->ssl);
  17835. } while (impl::mbedtls_is_session_ticket(ret));
  17836. if (ret == 0) {
  17837. err.code = ErrorCode::Success;
  17838. } else {
  17839. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17840. impl::mbedtls_last_error() = ret;
  17841. }
  17842. return err;
  17843. }
  17844. inline TlsError accept(session_t session) {
  17845. // Same as connect for Mbed TLS - handshake works for both client and server
  17846. auto result = connect(session);
  17847. // After successful handshake, capture SNI from thread-local storage
  17848. if (result.code == ErrorCode::Success && session) {
  17849. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17850. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17851. impl::mbedpending_sni().clear();
  17852. }
  17853. return result;
  17854. }
  17855. inline bool connect_nonblocking(session_t session, socket_t sock,
  17856. time_t timeout_sec, time_t timeout_usec,
  17857. TlsError *err) {
  17858. if (!session) {
  17859. if (err) { err->code = ErrorCode::Fatal; }
  17860. return false;
  17861. }
  17862. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17863. // Set socket to non-blocking mode
  17864. detail::set_nonblocking(sock, true);
  17865. auto cleanup =
  17866. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17867. int ret;
  17868. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17869. // Non-fatal TLS 1.3 ticket; retry immediately.
  17870. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17871. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17872. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17873. continue;
  17874. }
  17875. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17876. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17877. continue;
  17878. }
  17879. }
  17880. // TlsError or timeout
  17881. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17882. impl::mbedtls_last_error() = ret;
  17883. return false;
  17884. }
  17885. if (err) { err->code = ErrorCode::Success; }
  17886. return true;
  17887. }
  17888. inline bool accept_nonblocking(session_t session, socket_t sock,
  17889. time_t timeout_sec, time_t timeout_usec,
  17890. TlsError *err) {
  17891. // Same implementation as connect for Mbed TLS
  17892. bool result =
  17893. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17894. // After successful handshake, capture SNI from thread-local storage
  17895. if (result && session) {
  17896. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17897. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17898. impl::mbedpending_sni().clear();
  17899. }
  17900. return result;
  17901. }
  17902. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17903. if (!session || !buf) {
  17904. err.code = ErrorCode::Fatal;
  17905. return -1;
  17906. }
  17907. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17908. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17909. if (msession->has_peeked_byte) {
  17910. if (len == 0) { return 0; }
  17911. auto p = static_cast<unsigned char *>(buf);
  17912. p[0] = msession->peeked_byte;
  17913. msession->has_peeked_byte = false;
  17914. size_t n = 1;
  17915. // Top up with any already-decrypted bytes without risking a block.
  17916. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17917. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17918. if (extra > 0) { n += static_cast<size_t>(extra); }
  17919. }
  17920. err.code = ErrorCode::Success;
  17921. return static_cast<ssize_t>(n);
  17922. }
  17923. int ret;
  17924. do {
  17925. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17926. len);
  17927. } while (impl::mbedtls_is_session_ticket(ret));
  17928. if (ret > 0) {
  17929. err.code = ErrorCode::Success;
  17930. return static_cast<ssize_t>(ret);
  17931. }
  17932. if (ret == 0) {
  17933. err.code = ErrorCode::PeerClosed;
  17934. return 0;
  17935. }
  17936. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17937. err.backend_code = static_cast<uint64_t>(-ret);
  17938. impl::mbedtls_last_error() = ret;
  17939. // mbedTLS signals a clean close_notify via a negative error code rather
  17940. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17941. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17942. return -1;
  17943. }
  17944. inline ssize_t write(session_t session, const void *buf, size_t len,
  17945. TlsError &err) {
  17946. if (!session || !buf) {
  17947. err.code = ErrorCode::Fatal;
  17948. return -1;
  17949. }
  17950. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17951. int ret;
  17952. do {
  17953. ret = mbedtls_ssl_write(&msession->ssl,
  17954. static_cast<const unsigned char *>(buf), len);
  17955. } while (impl::mbedtls_is_session_ticket(ret));
  17956. if (ret > 0) {
  17957. err.code = ErrorCode::Success;
  17958. return static_cast<ssize_t>(ret);
  17959. }
  17960. if (ret == 0) {
  17961. err.code = ErrorCode::PeerClosed;
  17962. return 0;
  17963. }
  17964. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17965. err.backend_code = static_cast<uint64_t>(-ret);
  17966. impl::mbedtls_last_error() = ret;
  17967. return -1;
  17968. }
  17969. inline int pending(const_session_t session) {
  17970. if (!session) { return 0; }
  17971. auto msession =
  17972. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17973. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17974. (msession->has_peeked_byte ? 1 : 0);
  17975. }
  17976. inline void shutdown(session_t session, bool graceful) {
  17977. if (!session) { return; }
  17978. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17979. if (graceful) {
  17980. // Try to send close_notify, but don't block forever
  17981. int ret;
  17982. int attempts = 0;
  17983. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17984. attempts < 3) {
  17985. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17986. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17987. break;
  17988. }
  17989. attempts++;
  17990. }
  17991. }
  17992. }
  17993. inline bool is_peer_closed(session_t session, socket_t sock) {
  17994. if (!session || sock == INVALID_SOCKET) { return true; }
  17995. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17996. // Check if there's already decrypted or pushed-back data available.
  17997. // If so, the connection is definitely alive.
  17998. if (msession->has_peeked_byte ||
  17999. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18000. return false;
  18001. }
  18002. // Set socket to non-blocking to avoid blocking on read
  18003. detail::set_nonblocking(sock, true);
  18004. auto cleanup =
  18005. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18006. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18007. // on application data — e.g. a response that already arrived — push the
  18008. // byte back so the next read() delivers it instead of losing it.
  18009. unsigned char buf;
  18010. int ret;
  18011. do {
  18012. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18013. } while (impl::mbedtls_is_session_ticket(ret));
  18014. // If we got data or WANT_READ (would block), connection is alive
  18015. if (ret > 0) {
  18016. msession->peeked_byte = buf;
  18017. msession->has_peeked_byte = true;
  18018. return false;
  18019. }
  18020. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18021. // If we get a peer close notify or a connection reset, the peer is closed
  18022. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18023. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18024. }
  18025. inline cert_t get_peer_cert(const_session_t session) {
  18026. if (!session) { return nullptr; }
  18027. auto msession =
  18028. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18029. // Mbed TLS returns a pointer to the internal peer cert chain.
  18030. // WARNING: This pointer is only valid while the session is active.
  18031. // Do not use the certificate after calling free_session().
  18032. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18033. return const_cast<mbedtls_x509_crt *>(cert);
  18034. }
  18035. inline size_t get_peer_certs(const_session_t session,
  18036. std::vector<cert_t> &certs) {
  18037. certs.clear();
  18038. // Mbed TLS parses the whole received chain into a list headed by the peer
  18039. // certificate, owned by the session like get_peer_cert()'s result
  18040. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18041. crt && crt->raw.len > 0; crt = crt->next) {
  18042. certs.push_back(static_cast<cert_t>(crt));
  18043. }
  18044. return certs.size();
  18045. }
  18046. inline void free_cert(cert_t cert) {
  18047. // Mbed TLS: peer certificate is owned by the SSL context.
  18048. // No-op here, but callers should still call this for cross-backend
  18049. // portability.
  18050. (void)cert;
  18051. }
  18052. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18053. if (!cert || !hostname) { return false; }
  18054. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18055. std::string host_str(hostname);
  18056. // Check if hostname is an IP address (IPv4 or IPv6)
  18057. unsigned char ip_bytes[16];
  18058. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18059. auto is_ip = ip_len > 0;
  18060. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18061. // in buf.tag and the raw value in buf.p / buf.len.
  18062. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18063. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18064. const unsigned char *p = san->buf.p;
  18065. size_t len = san->buf.len;
  18066. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18067. if (is_ip) {
  18068. // For an IP host, only a matching iPAddress SAN of the same family
  18069. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18070. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18071. memcmp(p, ip_bytes, ip_len) == 0) {
  18072. return true;
  18073. }
  18074. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18075. std::string san_name(reinterpret_cast<const char *>(p), len);
  18076. if (detail::match_hostname(san_name, host_str)) { return true; }
  18077. }
  18078. san = san->next;
  18079. }
  18080. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18081. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18082. // the OpenSSL backend's X509_check_ip behaves the same way).
  18083. if (!is_ip) {
  18084. char cn[256];
  18085. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18086. if (ret > 0) {
  18087. std::string cn_str(cn);
  18088. // Look for "CN=" in the DN string
  18089. size_t cn_pos = cn_str.find("CN=");
  18090. if (cn_pos != std::string::npos) {
  18091. size_t start = cn_pos + 3;
  18092. size_t end = cn_str.find(',', start);
  18093. std::string cn_value =
  18094. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18095. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18096. }
  18097. }
  18098. }
  18099. return false;
  18100. }
  18101. inline uint64_t hostname_mismatch_code() {
  18102. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18103. }
  18104. inline long get_verify_result(const_session_t session) {
  18105. if (!session) { return -1; }
  18106. auto msession =
  18107. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18108. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18109. // Return 0 (X509_V_OK equivalent) if verification passed
  18110. return flags == 0 ? 0 : static_cast<long>(flags);
  18111. }
  18112. inline std::string get_cert_subject_cn(cert_t cert) {
  18113. if (!cert) return "";
  18114. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18115. // Find the CN in the subject
  18116. const mbedtls_x509_name *name = &x509->subject;
  18117. while (name != nullptr) {
  18118. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18119. return std::string(reinterpret_cast<const char *>(name->val.p),
  18120. name->val.len);
  18121. }
  18122. name = name->next;
  18123. }
  18124. return "";
  18125. }
  18126. inline std::string get_cert_issuer_name(cert_t cert) {
  18127. if (!cert) return "";
  18128. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18129. // Build a human-readable issuer name string
  18130. char buf[512];
  18131. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18132. if (ret < 0) return "";
  18133. return std::string(buf);
  18134. }
  18135. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18136. sans.clear();
  18137. if (!cert) return false;
  18138. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18139. // Parse the Subject Alternative Name extension
  18140. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18141. while (cur != nullptr) {
  18142. if (cur->buf.len > 0) {
  18143. const unsigned char *p = cur->buf.p;
  18144. size_t value_len = cur->buf.len;
  18145. SanEntry entry;
  18146. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18147. case MBEDTLS_X509_SAN_DNS_NAME:
  18148. entry.type = SanType::DNS;
  18149. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18150. break;
  18151. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18152. entry.type = SanType::IP;
  18153. if (value_len == 4) {
  18154. // IPv4
  18155. char buf[16];
  18156. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18157. entry.value = buf;
  18158. } else if (value_len == 16) {
  18159. // IPv6
  18160. char buf[64];
  18161. snprintf(buf, sizeof(buf),
  18162. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18163. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18164. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18165. p[10], p[11], p[12], p[13], p[14], p[15]);
  18166. entry.value = buf;
  18167. }
  18168. break;
  18169. case MBEDTLS_X509_SAN_RFC822_NAME:
  18170. entry.type = SanType::EMAIL;
  18171. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18172. break;
  18173. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18174. entry.type = SanType::URI;
  18175. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18176. break;
  18177. default: entry.type = SanType::OTHER; break;
  18178. }
  18179. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18180. }
  18181. cur = cur->next;
  18182. }
  18183. return true;
  18184. }
  18185. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18186. time_t &not_after) {
  18187. if (!cert) return false;
  18188. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18189. // Convert mbedtls_x509_time to time_t
  18190. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18191. struct tm tm_time = {};
  18192. tm_time.tm_year = t.year - 1900;
  18193. tm_time.tm_mon = t.mon - 1;
  18194. tm_time.tm_mday = t.day;
  18195. tm_time.tm_hour = t.hour;
  18196. tm_time.tm_min = t.min;
  18197. tm_time.tm_sec = t.sec;
  18198. #ifdef _WIN32
  18199. return _mkgmtime(&tm_time);
  18200. #else
  18201. return timegm(&tm_time);
  18202. #endif
  18203. };
  18204. not_before = to_time_t(x509->valid_from);
  18205. not_after = to_time_t(x509->valid_to);
  18206. return true;
  18207. }
  18208. inline std::string get_cert_serial(cert_t cert) {
  18209. if (!cert) return "";
  18210. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18211. // Convert serial number to hex string
  18212. std::string result;
  18213. result.reserve(x509->serial.len * 2);
  18214. for (size_t i = 0; i < x509->serial.len; i++) {
  18215. char hex[3];
  18216. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18217. result += hex;
  18218. }
  18219. return result;
  18220. }
  18221. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18222. if (!cert) return false;
  18223. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18224. if (!crt->raw.p || crt->raw.len == 0) return false;
  18225. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18226. return true;
  18227. }
  18228. inline const char *get_sni(const_session_t session) {
  18229. if (!session) return nullptr;
  18230. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18231. // For server: return SNI received from client during handshake
  18232. if (!msession->sni_hostname.empty()) {
  18233. return msession->sni_hostname.c_str();
  18234. }
  18235. // For client: return the hostname set via set_sni
  18236. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18237. return nullptr;
  18238. }
  18239. inline uint64_t peek_error() {
  18240. // Mbed TLS doesn't have an error queue, return the last error
  18241. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18242. }
  18243. inline uint64_t get_error() {
  18244. // Mbed TLS doesn't have an error queue, return and clear the last error
  18245. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18246. impl::mbedtls_last_error() = 0;
  18247. return err;
  18248. }
  18249. inline std::string error_string(uint64_t code) {
  18250. char buf[256];
  18251. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18252. return std::string(buf);
  18253. }
  18254. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18255. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18256. if (!ca_chain) { return nullptr; }
  18257. mbedtls_x509_crt_init(ca_chain);
  18258. // mbedtls_x509_crt_parse expects null-terminated PEM
  18259. int ret = mbedtls_x509_crt_parse(ca_chain,
  18260. reinterpret_cast<const unsigned char *>(pem),
  18261. len + 1); // +1 for null terminator
  18262. if (ret != 0) {
  18263. // Try without +1 in case PEM is already null-terminated
  18264. ret = mbedtls_x509_crt_parse(
  18265. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18266. if (ret != 0) {
  18267. mbedtls_x509_crt_free(ca_chain);
  18268. delete ca_chain;
  18269. return nullptr;
  18270. }
  18271. }
  18272. return static_cast<ca_store_t>(ca_chain);
  18273. }
  18274. inline void free_ca_store(ca_store_t store) {
  18275. if (store) {
  18276. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18277. mbedtls_x509_crt_free(ca_chain);
  18278. delete ca_chain;
  18279. }
  18280. }
  18281. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18282. if (!ctx || !store) { return false; }
  18283. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18284. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18285. // Free existing CA chain
  18286. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18287. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18288. // Copy the CA chain (deep copy)
  18289. // Parse from the raw data of the source cert
  18290. mbedtls_x509_crt *src = ca_chain;
  18291. while (src != nullptr) {
  18292. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18293. src->raw.len);
  18294. if (ret != 0) {
  18295. free_ca_store(store);
  18296. return false;
  18297. }
  18298. src = src->next;
  18299. }
  18300. // This function takes ownership of the store; the chain was deep-copied
  18301. // above, so release the source
  18302. free_ca_store(store);
  18303. // Update the SSL config to use the new CA chain
  18304. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18305. return true;
  18306. }
  18307. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18308. certs.clear();
  18309. if (!ctx) { return 0; }
  18310. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18311. // Iterate through the CA chain
  18312. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18313. while (cert != nullptr && cert->raw.len > 0) {
  18314. // Create a copy of the certificate for the caller
  18315. auto *copy = new mbedtls_x509_crt;
  18316. mbedtls_x509_crt_init(copy);
  18317. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18318. if (ret == 0) {
  18319. certs.push_back(static_cast<cert_t>(copy));
  18320. } else {
  18321. mbedtls_x509_crt_free(copy);
  18322. delete copy;
  18323. }
  18324. cert = cert->next;
  18325. }
  18326. return certs.size();
  18327. }
  18328. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18329. std::vector<std::string> names;
  18330. if (!ctx) { return names; }
  18331. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18332. // Iterate through the CA chain
  18333. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18334. while (cert != nullptr && cert->raw.len > 0) {
  18335. char buf[512];
  18336. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18337. if (ret > 0) { names.push_back(buf); }
  18338. cert = cert->next;
  18339. }
  18340. return names;
  18341. }
  18342. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18343. const char *key_pem, const char *password) {
  18344. if (!ctx || !cert_pem || !key_pem) { return false; }
  18345. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18346. // Free existing certificate and key
  18347. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18348. mbedtls_pk_free(&mbed_ctx->own_key);
  18349. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18350. mbedtls_pk_init(&mbed_ctx->own_key);
  18351. // Parse certificate PEM
  18352. int ret = mbedtls_x509_crt_parse(
  18353. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18354. strlen(cert_pem) + 1);
  18355. if (ret != 0) {
  18356. impl::mbedtls_last_error() = ret;
  18357. return false;
  18358. }
  18359. // Parse private key PEM
  18360. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18361. ret = mbedtls_pk_parse_key(
  18362. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18363. strlen(key_pem) + 1,
  18364. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18365. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18366. &mbed_ctx->ctr_drbg);
  18367. #else
  18368. ret = mbedtls_pk_parse_key(
  18369. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18370. strlen(key_pem) + 1,
  18371. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18372. password ? strlen(password) : 0);
  18373. #endif
  18374. if (ret != 0) {
  18375. impl::mbedtls_last_error() = ret;
  18376. return false;
  18377. }
  18378. // Configure SSL to use the new certificate and key
  18379. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18380. &mbed_ctx->own_key);
  18381. if (ret != 0) {
  18382. impl::mbedtls_last_error() = ret;
  18383. return false;
  18384. }
  18385. return true;
  18386. }
  18387. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18388. if (!ctx || !ca_pem) { return false; }
  18389. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18390. // Free existing CA chain
  18391. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18392. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18393. // Parse CA PEM
  18394. int ret = mbedtls_x509_crt_parse(
  18395. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18396. strlen(ca_pem) + 1);
  18397. if (ret != 0) {
  18398. impl::mbedtls_last_error() = ret;
  18399. return false;
  18400. }
  18401. // Update SSL config to use new CA chain
  18402. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18403. return true;
  18404. }
  18405. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18406. if (!ctx) { return false; }
  18407. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18408. // create_session() hands each session its own copy to run.
  18409. mbed_ctx->verify_callback = std::move(callback);
  18410. if (mbed_ctx->verify_callback) {
  18411. // Set OPTIONAL mode to ensure callback is called even when verification
  18412. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18413. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18414. }
  18415. return true;
  18416. }
  18417. inline long get_verify_error(const_session_t session) {
  18418. if (!session) { return -1; }
  18419. auto *msession =
  18420. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18421. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18422. }
  18423. inline std::string verify_error_string(long error_code) {
  18424. if (error_code == 0) { return ""; }
  18425. char buf[256];
  18426. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18427. static_cast<uint32_t>(error_code));
  18428. // Remove trailing newline if present
  18429. std::string result(buf);
  18430. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18431. result.pop_back();
  18432. }
  18433. return result;
  18434. }
  18435. } // namespace tls
  18436. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18437. /*
  18438. * Group 10: TLS abstraction layer - wolfSSL backend
  18439. */
  18440. /*
  18441. * wolfSSL Backend Implementation
  18442. */
  18443. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18444. namespace tls {
  18445. namespace impl {
  18446. // wolfSSL session wrapper
  18447. struct WolfSSLSession {
  18448. WOLFSSL *ssl = nullptr;
  18449. socket_t sock = INVALID_SOCKET;
  18450. std::string hostname; // For client: set via set_sni
  18451. std::string sni_hostname; // For server: received from client via SNI callback
  18452. WolfSSLSession() = default;
  18453. ~WolfSSLSession() {
  18454. if (ssl) { wolfSSL_free(ssl); }
  18455. }
  18456. WolfSSLSession(const WolfSSLSession &) = delete;
  18457. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18458. };
  18459. // Thread-local error code accessor for wolfSSL
  18460. inline uint64_t &wolfssl_last_error() {
  18461. static thread_local uint64_t err = 0;
  18462. return err;
  18463. }
  18464. // Helper to map wolfSSL error to ErrorCode.
  18465. // ssl_error is the value from wolfSSL_get_error().
  18466. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18467. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18468. int &out_errno) {
  18469. switch (ssl_error) {
  18470. case SSL_ERROR_NONE: return ErrorCode::Success;
  18471. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18472. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18473. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18474. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18475. default:
  18476. if (ssl) {
  18477. // wolfSSL stores the low-level error code as a negative value.
  18478. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18479. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18480. if (low_err == DOMAIN_NAME_MISMATCH) {
  18481. return ErrorCode::HostnameMismatch;
  18482. }
  18483. // Check verify result to distinguish cert verification from generic SSL
  18484. // errors.
  18485. long vr = wolfSSL_get_verify_result(ssl);
  18486. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18487. }
  18488. return ErrorCode::Fatal;
  18489. }
  18490. }
  18491. // WolfSSLContext constructor/destructor implementations
  18492. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18493. inline WolfSSLContext::~WolfSSLContext() {
  18494. if (ctx) { wolfSSL_CTX_free(ctx); }
  18495. }
  18496. // Thread-local storage for SNI captured during handshake
  18497. inline std::string &wolfssl_pending_sni() {
  18498. static thread_local std::string sni;
  18499. return sni;
  18500. }
  18501. // SNI callback for wolfSSL server to capture client's SNI hostname
  18502. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18503. (void)ret;
  18504. (void)exArg;
  18505. void *name_data = nullptr;
  18506. unsigned short name_len =
  18507. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18508. if (name_data && name_len > 0) {
  18509. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18510. name_len);
  18511. } else {
  18512. wolfssl_pending_sni().clear();
  18513. }
  18514. return 0; // Continue regardless
  18515. }
  18516. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18517. // runs the verify callback of its own context.
  18518. inline int context_ex_data_index() {
  18519. static const auto index =
  18520. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18521. return index;
  18522. }
  18523. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18524. // other tls:: function takes.
  18525. inline int session_ex_data_index() {
  18526. static const auto index =
  18527. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18528. return index;
  18529. }
  18530. // wolfSSL verify callback wrapper
  18531. inline int wolfssl_verify_callback(int preverify_ok,
  18532. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18533. // Get the WOLFSSL object from the X509_STORE_CTX
  18534. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18535. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18536. if (!ssl) { return preverify_ok; }
  18537. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18538. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18539. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18540. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18541. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18542. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18543. VerifyContext verify_ctx;
  18544. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18545. verify_ctx.cert = static_cast<cert_t>(cert);
  18546. verify_ctx.depth = depth;
  18547. verify_ctx.preverify_ok = (preverify_ok != 0);
  18548. verify_ctx.error_code = static_cast<long>(err);
  18549. if (err != 0) {
  18550. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18551. } else {
  18552. verify_ctx.error_string = nullptr;
  18553. }
  18554. bool accepted = wctx->verify_callback(verify_ctx);
  18555. return accepted ? 1 : 0;
  18556. }
  18557. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18558. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18559. wolfSSL_CTX_set_default_passwd_cb(
  18560. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18561. auto *pwd = static_cast<const char *>(userdata);
  18562. if (!pwd) return 0;
  18563. auto len = static_cast<int>(strlen(pwd));
  18564. if (len > size) len = size;
  18565. memcpy(buf, pwd, static_cast<size_t>(len));
  18566. return len;
  18567. });
  18568. }
  18569. } // namespace impl
  18570. inline ctx_t create_client_context() {
  18571. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18572. if (!ctx) { return nullptr; }
  18573. ctx->is_server = false;
  18574. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18575. if (!method) {
  18576. delete ctx;
  18577. return nullptr;
  18578. }
  18579. ctx->ctx = wolfSSL_CTX_new(method);
  18580. if (!ctx->ctx ||
  18581. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18582. WOLFSSL_SUCCESS) {
  18583. delete ctx;
  18584. return nullptr;
  18585. }
  18586. // Default: verify peer certificate
  18587. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18588. return static_cast<ctx_t>(ctx);
  18589. }
  18590. inline ctx_t create_server_context() {
  18591. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18592. if (!ctx) { return nullptr; }
  18593. ctx->is_server = true;
  18594. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18595. if (!method) {
  18596. delete ctx;
  18597. return nullptr;
  18598. }
  18599. ctx->ctx = wolfSSL_CTX_new(method);
  18600. if (!ctx->ctx ||
  18601. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18602. WOLFSSL_SUCCESS) {
  18603. delete ctx;
  18604. return nullptr;
  18605. }
  18606. // Default: don't verify client
  18607. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18608. // Enable SNI on server
  18609. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18610. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18611. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18612. return static_cast<ctx_t>(ctx);
  18613. }
  18614. inline void free_context(ctx_t ctx) {
  18615. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18616. }
  18617. inline bool set_min_version(ctx_t ctx, Version version) {
  18618. if (!ctx) { return false; }
  18619. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18620. int min_ver = WOLFSSL_TLSV1_2;
  18621. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18622. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18623. }
  18624. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18625. if (!ctx || !pem) { return false; }
  18626. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18627. int ret = wolfSSL_CTX_load_verify_buffer(
  18628. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18629. static_cast<long>(len), SSL_FILETYPE_PEM);
  18630. if (ret != SSL_SUCCESS) {
  18631. impl::wolfssl_last_error() =
  18632. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18633. return false;
  18634. }
  18635. wctx->ca_pem_data_.append(pem, len);
  18636. return true;
  18637. }
  18638. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18639. if (!ctx || !file_path) { return false; }
  18640. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18641. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18642. if (ret != SSL_SUCCESS) {
  18643. impl::wolfssl_last_error() =
  18644. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18645. return false;
  18646. }
  18647. return true;
  18648. }
  18649. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18650. if (!ctx || !dir_path) { return false; }
  18651. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18652. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18653. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18654. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18655. // immediately. Return true even on failure since the CA file may have
  18656. // already been loaded, matching OpenSSL's lenient behavior.
  18657. (void)ret;
  18658. return true;
  18659. }
  18660. inline bool load_system_certs(ctx_t ctx) {
  18661. if (!ctx) { return false; }
  18662. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18663. bool loaded = false;
  18664. #ifdef _WIN32
  18665. loaded = impl::enumerate_windows_system_certs(
  18666. [&](const unsigned char *data, size_t len) {
  18667. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18668. static_cast<long>(len),
  18669. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18670. });
  18671. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18672. loaded = impl::enumerate_macos_keychain_certs(
  18673. [&](const unsigned char *data, size_t len) {
  18674. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18675. static_cast<long>(len),
  18676. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18677. });
  18678. #else
  18679. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18680. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18681. SSL_SUCCESS) {
  18682. loaded = true;
  18683. break;
  18684. }
  18685. }
  18686. if (!loaded) {
  18687. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18688. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18689. SSL_SUCCESS) {
  18690. loaded = true;
  18691. break;
  18692. }
  18693. }
  18694. }
  18695. #endif
  18696. return loaded;
  18697. }
  18698. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18699. const char *password) {
  18700. if (!ctx || !cert || !key) { return false; }
  18701. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18702. // Load certificate
  18703. int ret = wolfSSL_CTX_use_certificate_buffer(
  18704. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18705. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18706. if (ret != SSL_SUCCESS) {
  18707. impl::wolfssl_last_error() =
  18708. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18709. return false;
  18710. }
  18711. // Set password callback if password is provided
  18712. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18713. // Load private key
  18714. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18715. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18716. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18717. if (ret != SSL_SUCCESS) {
  18718. impl::wolfssl_last_error() =
  18719. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18720. return false;
  18721. }
  18722. // Verify that the certificate and private key match
  18723. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18724. }
  18725. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18726. const char *key_path, const char *password) {
  18727. if (!ctx || !cert_path || !key_path) { return false; }
  18728. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18729. // Load certificate file
  18730. int ret =
  18731. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18732. if (ret != SSL_SUCCESS) {
  18733. impl::wolfssl_last_error() =
  18734. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18735. return false;
  18736. }
  18737. // Set password callback if password is provided
  18738. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18739. // Load private key file
  18740. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18741. if (ret != SSL_SUCCESS) {
  18742. impl::wolfssl_last_error() =
  18743. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18744. return false;
  18745. }
  18746. // Verify that the certificate and private key match
  18747. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18748. }
  18749. inline void set_verify_client(ctx_t ctx, bool require) {
  18750. if (!ctx) { return; }
  18751. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18752. wctx->verify_client = require;
  18753. if (require) {
  18754. wolfSSL_CTX_set_verify(
  18755. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18756. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18757. } else {
  18758. if (wctx->verify_callback) {
  18759. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18760. impl::wolfssl_verify_callback);
  18761. } else {
  18762. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18763. }
  18764. }
  18765. }
  18766. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18767. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18768. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18769. auto session = new (std::nothrow) impl::WolfSSLSession();
  18770. if (!session) { return nullptr; }
  18771. session->sock = sock;
  18772. session->ssl = wolfSSL_new(wctx->ctx);
  18773. if (!session->ssl) {
  18774. impl::wolfssl_last_error() =
  18775. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18776. delete session;
  18777. return nullptr;
  18778. }
  18779. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  18780. session) != WOLFSSL_SUCCESS) {
  18781. delete session;
  18782. return nullptr;
  18783. }
  18784. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18785. return static_cast<session_t>(session);
  18786. }
  18787. inline void free_session(session_t session) {
  18788. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18789. }
  18790. inline bool set_sni(session_t session, const char *hostname,
  18791. bool verify_hostname) {
  18792. if (!session || !hostname) { return false; }
  18793. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18794. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18795. static_cast<word16>(strlen(hostname)));
  18796. if (ret != WOLFSSL_SUCCESS) {
  18797. impl::wolfssl_last_error() =
  18798. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18799. return false;
  18800. }
  18801. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18802. // separately from the SNI extension sent above; skip it when hostname
  18803. // verification is disabled so only the chain is checked, matching OpenSSL.
  18804. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18805. wsession->hostname = hostname;
  18806. return true;
  18807. }
  18808. inline TlsError connect(session_t session) {
  18809. TlsError err;
  18810. if (!session) {
  18811. err.code = ErrorCode::Fatal;
  18812. return err;
  18813. }
  18814. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18815. int ret = wolfSSL_connect(wsession->ssl);
  18816. if (ret == SSL_SUCCESS) {
  18817. err.code = ErrorCode::Success;
  18818. } else {
  18819. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18820. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18821. err.backend_code = static_cast<uint64_t>(ssl_error);
  18822. impl::wolfssl_last_error() = err.backend_code;
  18823. }
  18824. return err;
  18825. }
  18826. inline TlsError accept(session_t session) {
  18827. TlsError err;
  18828. if (!session) {
  18829. err.code = ErrorCode::Fatal;
  18830. return err;
  18831. }
  18832. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18833. int ret = wolfSSL_accept(wsession->ssl);
  18834. if (ret == SSL_SUCCESS) {
  18835. err.code = ErrorCode::Success;
  18836. // Capture SNI from thread-local storage after successful handshake
  18837. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18838. impl::wolfssl_pending_sni().clear();
  18839. } else {
  18840. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18841. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18842. err.backend_code = static_cast<uint64_t>(ssl_error);
  18843. impl::wolfssl_last_error() = err.backend_code;
  18844. }
  18845. return err;
  18846. }
  18847. inline bool connect_nonblocking(session_t session, socket_t sock,
  18848. time_t timeout_sec, time_t timeout_usec,
  18849. TlsError *err) {
  18850. if (!session) {
  18851. if (err) { err->code = ErrorCode::Fatal; }
  18852. return false;
  18853. }
  18854. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18855. // Set socket to non-blocking mode
  18856. detail::set_nonblocking(sock, true);
  18857. auto cleanup =
  18858. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18859. int ret;
  18860. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18861. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18862. if (ssl_error == SSL_ERROR_WANT_READ) {
  18863. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18864. continue;
  18865. }
  18866. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18867. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18868. continue;
  18869. }
  18870. }
  18871. // Error or timeout
  18872. if (err) {
  18873. err->code =
  18874. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18875. err->backend_code = static_cast<uint64_t>(ssl_error);
  18876. }
  18877. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18878. return false;
  18879. }
  18880. if (err) { err->code = ErrorCode::Success; }
  18881. return true;
  18882. }
  18883. inline bool accept_nonblocking(session_t session, socket_t sock,
  18884. time_t timeout_sec, time_t timeout_usec,
  18885. TlsError *err) {
  18886. if (!session) {
  18887. if (err) { err->code = ErrorCode::Fatal; }
  18888. return false;
  18889. }
  18890. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18891. // Set socket to non-blocking mode
  18892. detail::set_nonblocking(sock, true);
  18893. auto cleanup =
  18894. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18895. int ret;
  18896. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18897. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18898. if (ssl_error == SSL_ERROR_WANT_READ) {
  18899. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18900. continue;
  18901. }
  18902. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18903. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18904. continue;
  18905. }
  18906. }
  18907. // Error or timeout
  18908. if (err) {
  18909. err->code =
  18910. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18911. err->backend_code = static_cast<uint64_t>(ssl_error);
  18912. }
  18913. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18914. return false;
  18915. }
  18916. if (err) { err->code = ErrorCode::Success; }
  18917. // Capture SNI from thread-local storage after successful handshake
  18918. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18919. impl::wolfssl_pending_sni().clear();
  18920. return true;
  18921. }
  18922. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18923. if (!session || !buf) {
  18924. err.code = ErrorCode::Fatal;
  18925. return -1;
  18926. }
  18927. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18928. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18929. if (ret > 0) {
  18930. err.code = ErrorCode::Success;
  18931. return static_cast<ssize_t>(ret);
  18932. }
  18933. if (ret == 0) {
  18934. err.code = ErrorCode::PeerClosed;
  18935. return 0;
  18936. }
  18937. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18938. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18939. err.backend_code = static_cast<uint64_t>(ssl_error);
  18940. impl::wolfssl_last_error() = err.backend_code;
  18941. return -1;
  18942. }
  18943. inline ssize_t write(session_t session, const void *buf, size_t len,
  18944. TlsError &err) {
  18945. if (!session || !buf) {
  18946. err.code = ErrorCode::Fatal;
  18947. return -1;
  18948. }
  18949. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18950. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18951. if (ret > 0) {
  18952. err.code = ErrorCode::Success;
  18953. return static_cast<ssize_t>(ret);
  18954. }
  18955. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18956. // Treat this as an error (return -1) so callers don't spin in a
  18957. // write loop adding zero to the offset.
  18958. if (ret == 0) {
  18959. err.code = ErrorCode::PeerClosed;
  18960. return -1;
  18961. }
  18962. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18963. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18964. err.backend_code = static_cast<uint64_t>(ssl_error);
  18965. impl::wolfssl_last_error() = err.backend_code;
  18966. return -1;
  18967. }
  18968. inline int pending(const_session_t session) {
  18969. if (!session) { return 0; }
  18970. auto wsession =
  18971. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18972. return wolfSSL_pending(wsession->ssl);
  18973. }
  18974. inline void shutdown(session_t session, bool graceful) {
  18975. if (!session) { return; }
  18976. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18977. if (graceful) {
  18978. int ret;
  18979. int attempts = 0;
  18980. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18981. attempts < 3) {
  18982. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18983. if (ssl_error != SSL_ERROR_WANT_READ &&
  18984. ssl_error != SSL_ERROR_WANT_WRITE) {
  18985. break;
  18986. }
  18987. attempts++;
  18988. }
  18989. } else {
  18990. wolfSSL_shutdown(wsession->ssl);
  18991. }
  18992. }
  18993. inline bool is_peer_closed(session_t session, socket_t sock) {
  18994. if (!session || sock == INVALID_SOCKET) { return true; }
  18995. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18996. // Check if there's already decrypted data available
  18997. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18998. // Set socket to non-blocking to avoid blocking on read
  18999. detail::set_nonblocking(sock, true);
  19000. auto cleanup =
  19001. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19002. // Peek 1 byte to check connection status without consuming data
  19003. unsigned char buf;
  19004. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19005. // If we got data or WANT_READ (would block), connection is alive
  19006. if (ret > 0) { return false; }
  19007. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19008. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19009. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19010. ret == 0;
  19011. }
  19012. inline cert_t get_peer_cert(const_session_t session) {
  19013. if (!session) { return nullptr; }
  19014. auto wsession =
  19015. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19016. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19017. return static_cast<cert_t>(cert);
  19018. }
  19019. inline size_t get_peer_certs(const_session_t session,
  19020. std::vector<cert_t> &certs) {
  19021. certs.clear();
  19022. if (!session) { return 0; }
  19023. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19024. #ifdef SESSION_CERTS
  19025. auto wsession =
  19026. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19027. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19028. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19029. for (int i = 0; i < count; i++) {
  19030. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19031. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19032. }
  19033. #endif
  19034. return certs.size();
  19035. }
  19036. inline void free_cert(cert_t cert) {
  19037. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19038. }
  19039. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19040. if (!cert || !hostname) { return false; }
  19041. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19042. std::string host_str(hostname);
  19043. // Check if hostname is an IP address (IPv4 or IPv6)
  19044. unsigned char ip_bytes[16];
  19045. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19046. auto is_ip = ip_len > 0;
  19047. // Check Subject Alternative Names
  19048. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19049. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19050. if (san_names) {
  19051. int san_count = wolfSSL_sk_num(san_names);
  19052. for (int i = 0; i < san_count; i++) {
  19053. auto *names =
  19054. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19055. if (!names) continue;
  19056. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19057. // DNS name
  19058. unsigned char *dns_name = nullptr;
  19059. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19060. if (dns_name && dns_len > 0) {
  19061. std::string san_name(reinterpret_cast<char *>(dns_name),
  19062. static_cast<size_t>(dns_len));
  19063. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19064. if (detail::match_hostname(san_name, host_str)) {
  19065. wolfSSL_sk_free(san_names);
  19066. return true;
  19067. }
  19068. }
  19069. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19070. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19071. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19072. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19073. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19074. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19075. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19076. wolfSSL_sk_free(san_names);
  19077. return true;
  19078. }
  19079. }
  19080. }
  19081. wolfSSL_sk_free(san_names);
  19082. }
  19083. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19084. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19085. // the OpenSSL backend's X509_check_ip behaves the same way).
  19086. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19087. if (subject) {
  19088. char cn[256] = {};
  19089. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19090. sizeof(cn));
  19091. if (cn_len > 0) {
  19092. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19093. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19094. }
  19095. }
  19096. return false;
  19097. }
  19098. inline uint64_t hostname_mismatch_code() {
  19099. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19100. }
  19101. inline long get_verify_result(const_session_t session) {
  19102. if (!session) { return -1; }
  19103. auto wsession =
  19104. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19105. long result = wolfSSL_get_verify_result(wsession->ssl);
  19106. return result;
  19107. }
  19108. inline std::string get_cert_subject_cn(cert_t cert) {
  19109. if (!cert) return "";
  19110. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19111. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19112. if (!subject) return "";
  19113. char cn[256] = {};
  19114. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19115. sizeof(cn));
  19116. if (cn_len <= 0) return "";
  19117. return std::string(cn, static_cast<size_t>(cn_len));
  19118. }
  19119. inline std::string get_cert_issuer_name(cert_t cert) {
  19120. if (!cert) return "";
  19121. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19122. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19123. if (!issuer) return "";
  19124. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19125. if (!name_str) return "";
  19126. std::string result(name_str);
  19127. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19128. return result;
  19129. }
  19130. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19131. sans.clear();
  19132. if (!cert) return false;
  19133. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19134. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19135. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19136. if (!san_names) return true; // No SANs is not an error
  19137. int count = wolfSSL_sk_num(san_names);
  19138. for (int i = 0; i < count; i++) {
  19139. auto *name =
  19140. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19141. if (!name) continue;
  19142. SanEntry entry;
  19143. switch (name->type) {
  19144. case WOLFSSL_GEN_DNS: {
  19145. entry.type = SanType::DNS;
  19146. unsigned char *dns_name = nullptr;
  19147. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19148. if (dns_name && dns_len > 0) {
  19149. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19150. static_cast<size_t>(dns_len));
  19151. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19152. }
  19153. break;
  19154. }
  19155. case WOLFSSL_GEN_IPADD: {
  19156. entry.type = SanType::IP;
  19157. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19158. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19159. if (ip_data && ip_len == 4) {
  19160. char buf[16];
  19161. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19162. ip_data[2], ip_data[3]);
  19163. entry.value = buf;
  19164. } else if (ip_data && ip_len == 16) {
  19165. char buf[64];
  19166. snprintf(buf, sizeof(buf),
  19167. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19168. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19169. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19170. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19171. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19172. ip_data[14], ip_data[15]);
  19173. entry.value = buf;
  19174. }
  19175. break;
  19176. }
  19177. case WOLFSSL_GEN_EMAIL:
  19178. entry.type = SanType::EMAIL;
  19179. {
  19180. unsigned char *email = nullptr;
  19181. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19182. if (email && email_len > 0) {
  19183. entry.value = std::string(reinterpret_cast<char *>(email),
  19184. static_cast<size_t>(email_len));
  19185. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19186. }
  19187. }
  19188. break;
  19189. case WOLFSSL_GEN_URI:
  19190. entry.type = SanType::URI;
  19191. {
  19192. unsigned char *uri = nullptr;
  19193. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19194. &uri, name->d.uniformResourceIdentifier);
  19195. if (uri && uri_len > 0) {
  19196. entry.value = std::string(reinterpret_cast<char *>(uri),
  19197. static_cast<size_t>(uri_len));
  19198. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19199. }
  19200. }
  19201. break;
  19202. default: entry.type = SanType::OTHER; break;
  19203. }
  19204. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19205. }
  19206. wolfSSL_sk_free(san_names);
  19207. return true;
  19208. }
  19209. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19210. time_t &not_after) {
  19211. if (!cert) return false;
  19212. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19213. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19214. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19215. if (!nb || !na) return false;
  19216. // wolfSSL_ASN1_TIME_to_tm is available
  19217. struct tm tm_nb = {}, tm_na = {};
  19218. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19219. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19220. #ifdef _WIN32
  19221. not_before = _mkgmtime(&tm_nb);
  19222. not_after = _mkgmtime(&tm_na);
  19223. #else
  19224. not_before = timegm(&tm_nb);
  19225. not_after = timegm(&tm_na);
  19226. #endif
  19227. return true;
  19228. }
  19229. inline std::string get_cert_serial(cert_t cert) {
  19230. if (!cert) return "";
  19231. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19232. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19233. if (!serial_asn1) return "";
  19234. // Get the serial number data
  19235. int len = serial_asn1->length;
  19236. unsigned char *data = serial_asn1->data;
  19237. if (!data || len <= 0) return "";
  19238. std::string result;
  19239. result.reserve(static_cast<size_t>(len) * 2);
  19240. for (int i = 0; i < len; i++) {
  19241. char hex[3];
  19242. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19243. result += hex;
  19244. }
  19245. return result;
  19246. }
  19247. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19248. if (!cert) return false;
  19249. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19250. int der_len = 0;
  19251. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19252. if (!der_data || der_len <= 0) return false;
  19253. der.assign(der_data, der_data + der_len);
  19254. return true;
  19255. }
  19256. inline const char *get_sni(const_session_t session) {
  19257. if (!session) return nullptr;
  19258. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19259. // For server: return SNI received from client during handshake
  19260. if (!wsession->sni_hostname.empty()) {
  19261. return wsession->sni_hostname.c_str();
  19262. }
  19263. // For client: return the hostname set via set_sni
  19264. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19265. return nullptr;
  19266. }
  19267. inline uint64_t peek_error() {
  19268. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19269. }
  19270. inline uint64_t get_error() {
  19271. uint64_t err = impl::wolfssl_last_error();
  19272. impl::wolfssl_last_error() = 0;
  19273. return err;
  19274. }
  19275. inline std::string error_string(uint64_t code) {
  19276. char buf[256];
  19277. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19278. return std::string(buf);
  19279. }
  19280. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19281. if (!pem || len == 0) { return nullptr; }
  19282. // Validate by attempting to load into a temporary ctx
  19283. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19284. if (!tmp_ctx) { return nullptr; }
  19285. int ret = wolfSSL_CTX_load_verify_buffer(
  19286. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19287. static_cast<long>(len), SSL_FILETYPE_PEM);
  19288. wolfSSL_CTX_free(tmp_ctx);
  19289. if (ret != SSL_SUCCESS) { return nullptr; }
  19290. return static_cast<ca_store_t>(
  19291. new impl::WolfSSLCAStore{std::string(pem, len)});
  19292. }
  19293. inline void free_ca_store(ca_store_t store) {
  19294. delete static_cast<impl::WolfSSLCAStore *>(store);
  19295. }
  19296. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19297. if (!ctx || !store) { return false; }
  19298. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19299. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19300. int ret = wolfSSL_CTX_load_verify_buffer(
  19301. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19302. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19303. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19304. // This function takes ownership of the store; the PEM data was copied into
  19305. // the context, so release the source
  19306. free_ca_store(store);
  19307. return ret == SSL_SUCCESS;
  19308. }
  19309. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19310. certs.clear();
  19311. if (!ctx) { return 0; }
  19312. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19313. if (wctx->ca_pem_data_.empty()) { return 0; }
  19314. const std::string &pem = wctx->ca_pem_data_;
  19315. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19316. const std::string end_marker = "-----END CERTIFICATE-----";
  19317. size_t pos = 0;
  19318. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19319. size_t end_pos = pem.find(end_marker, pos);
  19320. if (end_pos == std::string::npos) { break; }
  19321. end_pos += end_marker.size();
  19322. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19323. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19324. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19325. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19326. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19327. pos = end_pos;
  19328. }
  19329. return certs.size();
  19330. }
  19331. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19332. std::vector<std::string> names;
  19333. if (!ctx) { return names; }
  19334. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19335. if (wctx->ca_pem_data_.empty()) { return names; }
  19336. const std::string &pem = wctx->ca_pem_data_;
  19337. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19338. const std::string end_marker = "-----END CERTIFICATE-----";
  19339. size_t pos = 0;
  19340. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19341. size_t end_pos = pem.find(end_marker, pos);
  19342. if (end_pos == std::string::npos) { break; }
  19343. end_pos += end_marker.size();
  19344. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19345. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19346. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19347. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19348. if (x509) {
  19349. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19350. if (subject) {
  19351. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19352. if (name_str) {
  19353. names.push_back(name_str);
  19354. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19355. }
  19356. }
  19357. wolfSSL_X509_free(x509);
  19358. }
  19359. pos = end_pos;
  19360. }
  19361. return names;
  19362. }
  19363. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19364. const char *key_pem, const char *password) {
  19365. if (!ctx || !cert_pem || !key_pem) { return false; }
  19366. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19367. // Load new certificate
  19368. int ret = wolfSSL_CTX_use_certificate_buffer(
  19369. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19370. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19371. if (ret != SSL_SUCCESS) {
  19372. impl::wolfssl_last_error() =
  19373. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19374. return false;
  19375. }
  19376. // Set password if provided
  19377. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19378. // Load new private key
  19379. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19380. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19381. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19382. if (ret != SSL_SUCCESS) {
  19383. impl::wolfssl_last_error() =
  19384. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19385. return false;
  19386. }
  19387. return true;
  19388. }
  19389. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19390. if (!ctx || !ca_pem) { return false; }
  19391. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19392. int ret = wolfSSL_CTX_load_verify_buffer(
  19393. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19394. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19395. if (ret != SSL_SUCCESS) {
  19396. impl::wolfssl_last_error() =
  19397. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19398. return false;
  19399. }
  19400. return true;
  19401. }
  19402. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19403. if (!ctx) { return false; }
  19404. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19405. wctx->verify_callback = std::move(callback);
  19406. if (wctx->verify_callback) {
  19407. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19408. impl::wolfssl_verify_callback);
  19409. } else {
  19410. wolfSSL_CTX_set_verify(
  19411. wctx->ctx,
  19412. wctx->verify_client
  19413. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19414. : SSL_VERIFY_NONE,
  19415. nullptr);
  19416. }
  19417. return true;
  19418. }
  19419. inline long get_verify_error(const_session_t session) {
  19420. if (!session) { return -1; }
  19421. auto *wsession =
  19422. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19423. return wolfSSL_get_verify_result(wsession->ssl);
  19424. }
  19425. inline std::string verify_error_string(long error_code) {
  19426. if (error_code == 0) { return ""; }
  19427. const char *str =
  19428. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19429. return str ? std::string(str) : std::string();
  19430. }
  19431. } // namespace tls
  19432. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19433. // WebSocket implementation
  19434. namespace ws {
  19435. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19436. bool fin) {
  19437. std::lock_guard<std::mutex> lock(write_mutex_);
  19438. if (closed_) { return false; }
  19439. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19440. }
  19441. inline ReadResult WebSocket::read(std::string &msg) {
  19442. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19443. while (!closed_) {
  19444. Opcode opcode;
  19445. std::string payload;
  19446. bool fin;
  19447. impl::FrameRead r =
  19448. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19449. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19450. // A timeout landed on a frame boundary: the connection is untouched and
  19451. // still usable, so hand control back without closing it. That is only
  19452. // useful to a caller who asked for the timeout; the compile-time default
  19453. // is a backstop against a peer gone quiet, and elapsing it closes the
  19454. // connection so a plain `while (ws.read(msg))` loop ends.
  19455. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19456. if (r != impl::FrameRead::Ok) {
  19457. closed_ = true;
  19458. return Fail;
  19459. }
  19460. switch (opcode) {
  19461. case Opcode::Ping: {
  19462. std::lock_guard<std::mutex> lock(write_mutex_);
  19463. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19464. payload.size(), true, !is_server_);
  19465. continue;
  19466. }
  19467. case Opcode::Pong: {
  19468. std::lock_guard<std::mutex> lock(ping_mutex_);
  19469. unacked_pings_ = 0;
  19470. continue;
  19471. }
  19472. case Opcode::Close: {
  19473. if (!closed_.exchange(true)) {
  19474. // Echo close frame back
  19475. std::lock_guard<std::mutex> lock(write_mutex_);
  19476. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19477. payload.size(), true, !is_server_);
  19478. }
  19479. return Fail;
  19480. }
  19481. case Opcode::Text:
  19482. case Opcode::Binary: {
  19483. auto result = opcode == Opcode::Text ? Text : Binary;
  19484. msg = std::move(payload);
  19485. // Handle fragmentation
  19486. if (!fin) {
  19487. while (true) {
  19488. Opcode cont_opcode;
  19489. std::string cont_payload;
  19490. bool cont_fin;
  19491. // A timeout is not reportable here: half of a fragmented message is
  19492. // already in `msg` and read() has no way to resume it, so it is a
  19493. // failure like any other. Timeouts are only ever seen on a message
  19494. // boundary.
  19495. if (impl::read_websocket_frame(
  19496. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19497. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19498. impl::FrameRead::Ok) {
  19499. closed_ = true;
  19500. return Fail;
  19501. }
  19502. if (cont_opcode == Opcode::Ping) {
  19503. std::lock_guard<std::mutex> lock(write_mutex_);
  19504. detail::write_websocket_frame(
  19505. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19506. true, !is_server_);
  19507. continue;
  19508. }
  19509. if (cont_opcode == Opcode::Pong) {
  19510. std::lock_guard<std::mutex> lock(ping_mutex_);
  19511. unacked_pings_ = 0;
  19512. continue;
  19513. }
  19514. if (cont_opcode == Opcode::Close) {
  19515. if (!closed_.exchange(true)) {
  19516. std::lock_guard<std::mutex> lock(write_mutex_);
  19517. detail::write_websocket_frame(
  19518. strm_, Opcode::Close, cont_payload.data(),
  19519. cont_payload.size(), true, !is_server_);
  19520. }
  19521. return Fail;
  19522. }
  19523. // RFC 6455: continuation frames must use opcode 0x0
  19524. if (cont_opcode != Opcode::Continuation) {
  19525. closed_ = true;
  19526. return Fail;
  19527. }
  19528. msg += cont_payload;
  19529. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19530. closed_ = true;
  19531. return Fail;
  19532. }
  19533. if (cont_fin) { break; }
  19534. }
  19535. }
  19536. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19537. if (result == Text && !impl::is_valid_utf8(msg)) {
  19538. // close() takes the read lock to wait for the peer's Close reply, so
  19539. // it must not run while this thread still holds it.
  19540. read_lock.unlock();
  19541. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19542. return Fail;
  19543. }
  19544. return result;
  19545. }
  19546. default: closed_ = true; return Fail;
  19547. }
  19548. }
  19549. return Fail;
  19550. }
  19551. inline bool WebSocket::send(const std::string &data) {
  19552. return send_frame(Opcode::Text, data.data(), data.size());
  19553. }
  19554. inline bool WebSocket::send(const char *data, size_t len) {
  19555. return send_frame(Opcode::Binary, data, len);
  19556. }
  19557. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19558. if (closed_.exchange(true)) { return; }
  19559. ping_cv_.notify_all();
  19560. std::string payload;
  19561. auto code = static_cast<uint16_t>(status);
  19562. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19563. payload.push_back(static_cast<char>(code & 0xFF));
  19564. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19565. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19566. payload += reason.substr(0, 123);
  19567. {
  19568. std::lock_guard<std::mutex> lock(write_mutex_);
  19569. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19570. payload.size(), true, !is_server_);
  19571. }
  19572. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19573. // Close response before closing the TCP connection.
  19574. //
  19575. // Wait only when no other thread is parsing frames. When one is, it is the
  19576. // thread positioned to see the peer's reply, and reading here would take
  19577. // bytes out of the message it is assembling. Bailing out also leaves the
  19578. // stream, including its read timeout, entirely to that thread.
  19579. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19580. if (!read_lock.owns_lock()) { return; }
  19581. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19582. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19583. Opcode op;
  19584. std::string resp;
  19585. bool fin;
  19586. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19587. impl::FrameRead::Ok) {
  19588. if (op == Opcode::Close) { break; }
  19589. }
  19590. }
  19591. inline WebSocket::~WebSocket() {
  19592. {
  19593. std::lock_guard<std::mutex> lock(ping_mutex_);
  19594. closed_ = true;
  19595. }
  19596. ping_cv_.notify_all();
  19597. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19598. }
  19599. inline void WebSocket::start_heartbeat() {
  19600. if (ping_interval_sec_ == 0) { return; }
  19601. ping_thread_ = std::thread([this]() {
  19602. std::unique_lock<std::mutex> lock(ping_mutex_);
  19603. // The predicate keeps a spurious wakeup from sending a ping early
  19604. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19605. [this]() { return closed_.load(); })) {
  19606. // If the peer has failed to respond to the previous pings, give up.
  19607. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19608. // opt-in liveness check controlled by max_missed_pongs_.
  19609. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19610. lock.unlock();
  19611. close(CloseStatus::GoingAway, "pong timeout");
  19612. // Wake a read() blocked on the unresponsive peer. Only the read side
  19613. // is shut down: a TLS backend answers the EOF with an alert, and
  19614. // writing it to a socket closed for writing raises SIGPIPE.
  19615. #ifdef _WIN32
  19616. shutdown(strm_.socket(), SD_RECEIVE);
  19617. #else
  19618. shutdown(strm_.socket(), SHUT_RD);
  19619. #endif
  19620. return;
  19621. }
  19622. lock.unlock();
  19623. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19624. lock.lock();
  19625. closed_ = true;
  19626. break;
  19627. }
  19628. lock.lock();
  19629. unacked_pings_++;
  19630. }
  19631. });
  19632. }
  19633. inline const Request &WebSocket::request() const { return req_; }
  19634. inline bool WebSocket::is_open() const { return !closed_; }
  19635. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19636. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19637. // poll(), where 0 would instead mean "return immediately", so hand it the
  19638. // negative poll uses for an unbounded wait.
  19639. if (sec == 0 && usec == 0) { sec = -1; }
  19640. strm_.set_read_timeout(sec, usec);
  19641. read_timeout_set_ = true;
  19642. }
  19643. // WebSocketClient implementation
  19644. inline WebSocketClient::WebSocketClient(
  19645. const std::string &scheme_host_port_path, const Headers &headers)
  19646. : headers_(headers) {
  19647. detail::UrlComponents uc;
  19648. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19649. !uc.host.empty() && !uc.path.empty()) {
  19650. auto &scheme = uc.scheme;
  19651. #ifdef CPPHTTPLIB_SSL_ENABLED
  19652. if (scheme != "ws" && scheme != "wss") {
  19653. #else
  19654. if (scheme != "ws") {
  19655. #endif
  19656. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19657. std::string msg = "'" + scheme + "' scheme is not supported.";
  19658. throw std::invalid_argument(msg);
  19659. #endif
  19660. return;
  19661. }
  19662. auto is_ssl = scheme == "wss";
  19663. host_ = std::move(uc.host);
  19664. port_ = is_ssl ? 443 : 80;
  19665. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19666. path_ = std::move(uc.path);
  19667. if (!uc.query.empty()) { path_ += uc.query; }
  19668. #ifdef CPPHTTPLIB_SSL_ENABLED
  19669. is_ssl_ = is_ssl;
  19670. if (is_ssl_) {
  19671. // The context lives as long as the client so that CA configuration
  19672. // survives reconnects; sessions are created per connection.
  19673. tls_ctx_ = tls::create_client_context();
  19674. if (!tls_ctx_) { return; }
  19675. }
  19676. #else
  19677. if (is_ssl) { return; }
  19678. #endif
  19679. is_valid_ = true;
  19680. }
  19681. }
  19682. #ifdef CPPHTTPLIB_SSL_ENABLED
  19683. inline WebSocketClient::WebSocketClient(
  19684. const std::string &scheme_host_port_path, const PemMemory &pem,
  19685. const Headers &headers)
  19686. : WebSocketClient(scheme_host_port_path, headers) {
  19687. // For ws:// URLs the client certificate is silently ignored, consistent
  19688. // with the TLS-only setters such as set_ca_cert_path().
  19689. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19690. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19691. pem.private_key_password)) {
  19692. tls::free_context(tls_ctx_);
  19693. tls_ctx_ = nullptr;
  19694. is_valid_ = false;
  19695. }
  19696. }
  19697. }
  19698. #endif
  19699. inline WebSocketClient::~WebSocketClient() {
  19700. shutdown_and_close();
  19701. #ifdef CPPHTTPLIB_SSL_ENABLED
  19702. if (tls_ctx_) {
  19703. tls::free_context(tls_ctx_);
  19704. tls_ctx_ = nullptr;
  19705. }
  19706. #endif
  19707. }
  19708. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19709. inline void WebSocketClient::shutdown_and_close() {
  19710. // Send the close frame while the TLS session is still alive: ws_ holds an
  19711. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19712. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19713. if (ws_ && ws_->is_open()) { ws_->close(); }
  19714. ws_.reset();
  19715. #ifdef CPPHTTPLIB_SSL_ENABLED
  19716. if (is_ssl_) {
  19717. if (tls_session_) {
  19718. tls::shutdown(tls_session_, true);
  19719. tls::free_session(tls_session_);
  19720. tls_session_ = nullptr;
  19721. }
  19722. }
  19723. #endif
  19724. if (sock_ != INVALID_SOCKET) {
  19725. detail::shutdown_socket(sock_);
  19726. detail::close_socket(sock_);
  19727. sock_ = INVALID_SOCKET;
  19728. }
  19729. }
  19730. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19731. Error &error, int &ssl_error,
  19732. uint64_t &ssl_backend_error) {
  19733. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19734. // The streams wait with poll(), where 0 instead means "return immediately",
  19735. // so they are given the negative poll uses for an unbounded wait.
  19736. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19737. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19738. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19739. // The handshake belongs to establishing the connection, so an unset read
  19740. // timeout leaves it bounded by the connection timeout instead of forever.
  19741. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19742. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19743. #ifdef CPPHTTPLIB_SSL_ENABLED
  19744. if (is_ssl_) {
  19745. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19746. // is not safe to call concurrently on one client to begin with, since
  19747. // nothing else here is guarded either.
  19748. if (server_certificate_verification_ && !certs_loaded_) {
  19749. uint64_t backend_error = 0;
  19750. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19751. ca_cert_dir_path_, custom_ca_loaded_,
  19752. system_ca_mode_, backend_error);
  19753. certs_loaded_ = true;
  19754. }
  19755. detail::ClientTlsSessionOptions options;
  19756. options.server_hostname_verification = server_hostname_verification_;
  19757. detail::ClientTlsSessionError tls_error;
  19758. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19759. server_certificate_verification_,
  19760. hs_sec, hs_usec, &tls_error,
  19761. options)) {
  19762. error = tls_error.error;
  19763. ssl_error = tls_error.ssl_error;
  19764. ssl_backend_error = tls_error.backend_error;
  19765. return false;
  19766. }
  19767. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19768. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19769. write_timeout_usec_));
  19770. return true;
  19771. }
  19772. #else
  19773. (void)error;
  19774. (void)ssl_error;
  19775. (void)ssl_backend_error;
  19776. (void)hs_sec;
  19777. (void)hs_usec;
  19778. #endif
  19779. strm = std::unique_ptr<Stream>(
  19780. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19781. write_timeout_sec_, write_timeout_usec_));
  19782. return true;
  19783. }
  19784. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19785. #ifdef CPPHTTPLIB_SSL_ENABLED
  19786. auto is_ssl = is_ssl_;
  19787. #else
  19788. auto is_ssl = false;
  19789. #endif
  19790. if (!req.has_header("Host")) {
  19791. req.headers.emplace("Host", detail::make_default_host_header_value(
  19792. host_, port_, is_ssl, address_family_));
  19793. }
  19794. detail::add_default_user_agent_header(req);
  19795. }
  19796. inline Result WebSocketClient::connect() {
  19797. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19798. shutdown_and_close();
  19799. // Check is custom IP or hostname specified for host_
  19800. std::string connect_host;
  19801. std::string ip;
  19802. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19803. auto error = Error::Success;
  19804. sock_ = detail::create_client_socket(
  19805. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19806. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19807. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19808. write_timeout_usec_, interface_, error);
  19809. if (sock_ == INVALID_SOCKET) {
  19810. if (error == Error::Success) { error = Error::Connection; }
  19811. return Result{error, -1, Headers{}};
  19812. }
  19813. std::unique_ptr<Stream> strm;
  19814. auto stream_error = Error::SSLConnection;
  19815. int ssl_error = 0;
  19816. uint64_t ssl_backend_error = 0;
  19817. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19818. shutdown_and_close();
  19819. #ifdef CPPHTTPLIB_SSL_ENABLED
  19820. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19821. #else
  19822. return Result{stream_error, -1, Headers{}};
  19823. #endif
  19824. }
  19825. Request req;
  19826. req.method = "GET";
  19827. req.path = path_;
  19828. req.headers = headers_;
  19829. prepare_default_headers(req);
  19830. detail::WebSocketUpgradeResponse upgrade;
  19831. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19832. shutdown_and_close();
  19833. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19834. }
  19835. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19836. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19837. websocket_ping_interval_sec_,
  19838. websocket_max_missed_pongs_));
  19839. // The stream was created with the timeout already; tell the WebSocket
  19840. // whether it came from the caller, so read() knows to report it as Timeout.
  19841. ws_->read_timeout_set_ = read_timeout_set_;
  19842. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19843. }
  19844. inline ReadResult WebSocketClient::read(std::string &msg) {
  19845. if (!ws_) { return Fail; }
  19846. return ws_->read(msg);
  19847. }
  19848. inline bool WebSocketClient::send(const std::string &data) {
  19849. if (!ws_) { return false; }
  19850. return ws_->send(data);
  19851. }
  19852. inline bool WebSocketClient::send(const char *data, size_t len) {
  19853. if (!ws_) { return false; }
  19854. return ws_->send(data, len);
  19855. }
  19856. inline void WebSocketClient::close(CloseStatus status,
  19857. const std::string &reason) {
  19858. if (ws_) { ws_->close(status, reason); }
  19859. }
  19860. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19861. inline const std::string &WebSocketClient::subprotocol() const {
  19862. return subprotocol_;
  19863. }
  19864. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19865. read_timeout_sec_ = sec;
  19866. read_timeout_usec_ = usec;
  19867. read_timeout_set_ = true;
  19868. // The members above only seed the next connect(); read() consults the
  19869. // stream, so an already-open connection has to be told directly.
  19870. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19871. }
  19872. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19873. write_timeout_sec_ = sec;
  19874. write_timeout_usec_ = usec;
  19875. }
  19876. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19877. websocket_ping_interval_sec_ = sec;
  19878. }
  19879. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19880. websocket_max_missed_pongs_ = count;
  19881. }
  19882. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19883. inline void WebSocketClient::set_address_family(int family) {
  19884. address_family_ = family;
  19885. }
  19886. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19887. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19888. socket_options_ = std::move(socket_options);
  19889. }
  19890. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19891. connection_timeout_sec_ = sec;
  19892. connection_timeout_usec_ = usec;
  19893. }
  19894. inline void WebSocketClient::set_interface(const std::string &intf) {
  19895. interface_ = intf;
  19896. }
  19897. inline void WebSocketClient::set_hostname_addr_map(
  19898. std::map<std::string, std::string> addr_map) {
  19899. addr_map_ = std::move(addr_map);
  19900. }
  19901. #ifdef CPPHTTPLIB_SSL_ENABLED
  19902. inline void
  19903. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19904. const std::string &ca_cert_dir_path) {
  19905. ca_cert_file_path_ = ca_cert_file_path;
  19906. ca_cert_dir_path_ = ca_cert_dir_path;
  19907. }
  19908. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19909. if (store && tls_ctx_) {
  19910. // set_ca_store takes ownership of store
  19911. tls::set_ca_store(tls_ctx_, store);
  19912. custom_ca_loaded_ = true;
  19913. } else if (store) {
  19914. tls::free_ca_store(store);
  19915. }
  19916. }
  19917. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19918. std::size_t size) {
  19919. if (tls_ctx_ && ca_cert && size > 0) {
  19920. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19921. custom_ca_loaded_ = true;
  19922. }
  19923. }
  19924. inline void
  19925. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19926. server_certificate_verification_ = enabled;
  19927. }
  19928. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19929. server_hostname_verification_ = enabled;
  19930. }
  19931. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19932. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19933. }
  19934. #endif // CPPHTTPLIB_SSL_ENABLED
  19935. } // namespace ws
  19936. // ----------------------------------------------------------------------------
  19937. } // namespace httplib
  19938. #endif // CPPHTTPLIB_HTTPLIB_H