httplib.h 774 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813
  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.54.1"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003601"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. /*
  18. * Configuration
  19. */
  20. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  21. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  22. #endif
  23. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  24. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  25. #endif
  26. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  27. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  28. #endif
  29. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  30. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  31. #endif
  32. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  33. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  34. #endif
  35. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  36. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  37. #endif
  38. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  39. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  40. #endif
  41. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  42. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  43. #endif
  44. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  45. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  46. #endif
  47. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  48. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  49. #endif
  50. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  51. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  52. #endif
  53. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  54. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  55. #endif
  56. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  57. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  58. #endif
  59. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  60. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  61. #endif
  62. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  63. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  64. #endif
  65. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  66. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  67. #endif
  68. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  69. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  70. #endif
  71. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  72. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  73. #endif
  74. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  75. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  76. #endif
  77. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  78. #ifdef _WIN32
  79. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  80. #else
  81. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  82. #endif
  83. #endif
  84. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  85. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  86. #endif
  87. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  88. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  89. #endif
  90. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  91. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  92. #endif
  93. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  94. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  95. #endif
  96. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  97. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  98. #endif
  99. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  100. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  101. #endif
  102. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  103. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  104. #endif
  105. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  106. // 1400 rather than a round number: a body that already fits in one 1500-byte
  107. // MTU gains nothing from being made smaller.
  108. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  109. #endif
  110. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  111. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  112. #endif
  113. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  114. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  115. #endif
  116. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  117. // recurses roughly once per matched character for quantified patterns such
  118. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  119. // a default ~8MB thread stack that has been observed to take on the order of
  120. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  121. // margin below that (well under the 8192-byte request URI limit) while still
  122. // fitting any realistic route segment; raise it if a route legitimately needs
  123. // longer paths. Regex routes are never applied to paths longer than this.
  124. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  125. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  126. #endif
  127. #ifndef CPPHTTPLIB_TCP_NODELAY
  128. #define CPPHTTPLIB_TCP_NODELAY false
  129. #endif
  130. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  131. #define CPPHTTPLIB_IPV6_V6ONLY false
  132. #endif
  133. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  134. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  135. #endif
  136. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  137. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  138. #endif
  139. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  140. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  141. #endif
  142. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  143. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  144. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  145. ? std::thread::hardware_concurrency() - 1 \
  146. : 0))
  147. #endif
  148. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  149. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  150. #endif
  151. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  152. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  153. #endif
  154. #ifndef CPPHTTPLIB_RECV_FLAGS
  155. #define CPPHTTPLIB_RECV_FLAGS 0
  156. #endif
  157. #ifndef CPPHTTPLIB_SEND_FLAGS
  158. #define CPPHTTPLIB_SEND_FLAGS 0
  159. #endif
  160. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  161. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  162. #endif
  163. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  164. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  165. #endif
  166. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  167. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  168. #endif
  169. // One macro used to set the read timeout for both sides. They want different
  170. // defaults: a client's read timeout is the caller's own tool (it waits forever
  171. // until asked not to), while a server keeps a ceiling that reclaims a worker
  172. // from a peer that has gone quiet. The old name still works and sets both.
  173. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  174. #pragma message( \
  175. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  176. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  177. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  178. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  179. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  180. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #endif
  182. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  183. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  184. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  185. #endif
  186. #endif
  187. // 0 waits forever. A read timeout is how a caller gets control back to send on
  188. // the same connection; it is not a liveness check (that is ping/pong).
  189. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  190. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  191. #endif
  192. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  202. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  203. #endif
  204. /*
  205. * Headers
  206. */
  207. #ifdef _WIN32
  208. #ifndef _CRT_SECURE_NO_WARNINGS
  209. #define _CRT_SECURE_NO_WARNINGS
  210. #endif //_CRT_SECURE_NO_WARNINGS
  211. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  212. #define _CRT_NONSTDC_NO_DEPRECATE
  213. #endif //_CRT_NONSTDC_NO_DEPRECATE
  214. #if defined(_MSC_VER)
  215. #if _MSC_VER < 1900
  216. #error Sorry, Visual Studio versions prior to 2015 are not supported
  217. #endif
  218. #pragma comment(lib, "ws2_32.lib")
  219. #ifndef _SSIZE_T_DEFINED
  220. using ssize_t = __int64;
  221. #define _SSIZE_T_DEFINED
  222. #endif
  223. #endif // _MSC_VER
  224. #ifndef S_ISREG
  225. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  226. #endif // S_ISREG
  227. #ifndef S_ISDIR
  228. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  229. #endif // S_ISDIR
  230. #ifndef NOMINMAX
  231. #define NOMINMAX
  232. #endif // NOMINMAX
  233. #include <io.h>
  234. #include <winsock2.h>
  235. #include <ws2tcpip.h>
  236. #if defined(__has_include)
  237. #if __has_include(<afunix.h>)
  238. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  239. #include <afunix.h>
  240. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  241. #endif
  242. #endif
  243. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  244. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  245. #endif
  246. using nfds_t = unsigned long;
  247. using socket_t = SOCKET;
  248. using socklen_t = int;
  249. #else // not _WIN32
  250. #include <arpa/inet.h>
  251. #if !defined(_AIX) && !defined(__MVS__)
  252. #include <ifaddrs.h>
  253. #endif
  254. #ifdef __MVS__
  255. #include <strings.h>
  256. #ifndef NI_MAXHOST
  257. #define NI_MAXHOST 1025
  258. #endif
  259. #endif
  260. #include <net/if.h>
  261. #include <netdb.h>
  262. #include <netinet/in.h>
  263. #ifdef __linux__
  264. #include <resolv.h>
  265. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  266. #endif
  267. #include <csignal>
  268. #include <netinet/tcp.h>
  269. #include <poll.h>
  270. #include <pthread.h>
  271. #include <sys/mman.h>
  272. #include <sys/socket.h>
  273. #include <sys/un.h>
  274. #include <unistd.h>
  275. using socket_t = int;
  276. #ifndef INVALID_SOCKET
  277. #define INVALID_SOCKET (-1)
  278. #endif
  279. #endif //_WIN32
  280. #if defined(__APPLE__)
  281. #include <TargetConditionals.h>
  282. #endif
  283. #include <algorithm>
  284. #include <array>
  285. #include <atomic>
  286. #include <cassert>
  287. #include <chrono>
  288. #include <climits>
  289. #include <condition_variable>
  290. #include <cstdlib>
  291. #include <cstring>
  292. #include <errno.h>
  293. #include <exception>
  294. #include <fcntl.h>
  295. #include <fstream>
  296. #include <functional>
  297. #include <iomanip>
  298. #include <iostream>
  299. #include <iterator>
  300. #include <list>
  301. #include <map>
  302. #include <memory>
  303. #include <mutex>
  304. #include <random>
  305. #include <regex>
  306. #include <set>
  307. #include <sstream>
  308. #include <string>
  309. #include <sys/stat.h>
  310. #include <system_error>
  311. #include <thread>
  312. #include <type_traits>
  313. #include <unordered_map>
  314. #include <unordered_set>
  315. #include <utility>
  316. #include <vector>
  317. // On macOS with a TLS backend, enable Keychain root certificates by default
  318. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  319. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  320. // only; on those platforms the user must provide a CA bundle explicitly.
  321. #if defined(__APPLE__) && defined(__clang__) && \
  322. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  323. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  324. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  325. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  326. #if TARGET_OS_OSX
  327. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  328. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  329. #endif
  330. #endif
  331. #endif
  332. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  333. defined(__APPLE__) && !TARGET_OS_OSX
  334. #error \
  335. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  336. #endif
  337. // On Windows, enable Schannel certificate verification by default
  338. // unless the user explicitly opts out.
  339. #if defined(_WIN32) && \
  340. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  341. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  342. #endif
  343. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  344. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  345. #if TARGET_OS_MAC && defined(__clang__)
  346. #include <CFNetwork/CFHost.h>
  347. #include <CoreFoundation/CoreFoundation.h>
  348. #endif
  349. #endif
  350. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  351. #ifdef _WIN32
  352. #include <wincrypt.h>
  353. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  354. // used
  355. #undef X509_NAME
  356. #undef X509_CERT_PAIR
  357. #undef X509_EXTENSIONS
  358. #undef PKCS7_SIGNER_INFO
  359. #ifdef _MSC_VER
  360. #pragma comment(lib, "crypt32.lib")
  361. #endif
  362. #endif // _WIN32
  363. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  364. #if TARGET_OS_OSX
  365. #include <Security/Security.h>
  366. #endif
  367. #endif
  368. #include <openssl/err.h>
  369. #include <openssl/evp.h>
  370. #include <openssl/ssl.h>
  371. #include <openssl/x509v3.h>
  372. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  373. #include <openssl/applink.c>
  374. #endif
  375. #include <iostream>
  376. #include <sstream>
  377. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  378. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  379. #error Please use OpenSSL or a current version of BoringSSL
  380. #endif
  381. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  382. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  383. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  384. #endif
  385. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  386. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  387. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  388. // in with this first include group so the version gating below can use it.
  389. #include <mbedtls/error.h>
  390. #include <mbedtls/net_sockets.h>
  391. #include <mbedtls/oid.h>
  392. #include <mbedtls/pk.h>
  393. #include <mbedtls/ssl.h>
  394. #include <mbedtls/version.h>
  395. #include <mbedtls/x509_crt.h>
  396. #if MBEDTLS_VERSION_MAJOR >= 4
  397. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  398. #include <psa/crypto.h>
  399. #else
  400. #include <mbedtls/ctr_drbg.h>
  401. #include <mbedtls/entropy.h>
  402. #include <mbedtls/md5.h>
  403. #include <mbedtls/sha1.h>
  404. #include <mbedtls/sha256.h>
  405. #include <mbedtls/sha512.h>
  406. #endif
  407. #ifdef _WIN32
  408. #include <wincrypt.h>
  409. #ifdef _MSC_VER
  410. #pragma comment(lib, "crypt32.lib")
  411. #endif
  412. #endif // _WIN32
  413. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  414. #if TARGET_OS_OSX
  415. #include <Security/Security.h>
  416. #endif
  417. #endif
  418. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  419. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  420. #if MBEDTLS_VERSION_MAJOR >= 4
  421. #define CPPHTTPLIB_MBEDTLS_V4
  422. #endif
  423. #if MBEDTLS_VERSION_MAJOR >= 3
  424. #define CPPHTTPLIB_MBEDTLS_V3
  425. #endif
  426. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  427. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  428. #include <wolfssl/options.h>
  429. #include <wolfssl/openssl/x509v3.h>
  430. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  431. #ifndef WOLFSSL_GEN_EMAIL
  432. #define WOLFSSL_GEN_EMAIL 1
  433. #endif
  434. #ifndef WOLFSSL_GEN_DNS
  435. #define WOLFSSL_GEN_DNS 2
  436. #endif
  437. #ifndef WOLFSSL_GEN_URI
  438. #define WOLFSSL_GEN_URI 6
  439. #endif
  440. #ifndef WOLFSSL_GEN_IPADD
  441. #define WOLFSSL_GEN_IPADD 7
  442. #endif
  443. #include <wolfssl/ssl.h>
  444. #include <wolfssl/wolfcrypt/hash.h>
  445. #include <wolfssl/wolfcrypt/md5.h>
  446. #include <wolfssl/wolfcrypt/sha256.h>
  447. #include <wolfssl/wolfcrypt/sha512.h>
  448. #ifdef _WIN32
  449. #include <wincrypt.h>
  450. #ifdef _MSC_VER
  451. #pragma comment(lib, "crypt32.lib")
  452. #endif
  453. #endif // _WIN32
  454. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  455. #if TARGET_OS_OSX
  456. #include <Security/Security.h>
  457. #endif
  458. #endif
  459. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  460. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  461. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  462. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  463. #define CPPHTTPLIB_SSL_ENABLED
  464. #endif
  465. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  466. #include <zlib.h>
  467. #endif
  468. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  469. #include <brotli/decode.h>
  470. #include <brotli/encode.h>
  471. #endif
  472. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  473. #include <zstd.h>
  474. #endif
  475. /*
  476. * Declaration
  477. */
  478. namespace httplib {
  479. namespace ws {
  480. class WebSocket;
  481. } // namespace ws
  482. namespace detail {
  483. /*
  484. * Backport std::make_unique from C++14.
  485. *
  486. * NOTE: This code came up with the following stackoverflow post:
  487. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  488. *
  489. */
  490. template <class T, class... Args>
  491. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  492. make_unique(Args &&...args) {
  493. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  494. }
  495. template <class T>
  496. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  497. make_unique(std::size_t n) {
  498. typedef typename std::remove_extent<T>::type RT;
  499. return std::unique_ptr<T>(new RT[n]);
  500. }
  501. // Locale-independent ASCII character classification. The <cctype>
  502. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  503. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  504. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  505. // classified without regard to the locale.
  506. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  507. inline bool is_ascii_alpha(char c) {
  508. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  509. }
  510. inline bool is_ascii_alnum(char c) {
  511. return is_ascii_digit(c) || is_ascii_alpha(c);
  512. }
  513. namespace case_ignore {
  514. inline unsigned char to_lower(int c) {
  515. const static unsigned char table[256] = {
  516. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  517. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  518. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  519. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  520. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  521. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  522. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  523. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  524. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  525. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  526. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  527. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  528. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  529. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  530. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  531. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  532. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  533. 255,
  534. };
  535. return table[(unsigned char)(char)c];
  536. }
  537. inline std::string to_lower(const std::string &s) {
  538. std::string result = s;
  539. std::transform(
  540. result.begin(), result.end(), result.begin(),
  541. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  542. return result;
  543. }
  544. inline bool equal(const std::string &a, const std::string &b) {
  545. return a.size() == b.size() &&
  546. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  547. return to_lower(ca) == to_lower(cb);
  548. });
  549. }
  550. struct equal_to {
  551. bool operator()(const std::string &a, const std::string &b) const {
  552. return equal(a, b);
  553. }
  554. };
  555. struct hash {
  556. size_t operator()(const std::string &key) const {
  557. return hash_core(key.data(), key.size(), 0);
  558. }
  559. size_t hash_core(const char *s, size_t l, size_t h) const {
  560. return (l == 0) ? h
  561. : hash_core(s + 1, l - 1,
  562. // Unsets the 6 high bits of h, therefore no
  563. // overflow happens
  564. (((std::numeric_limits<size_t>::max)() >> 6) &
  565. h * 33) ^
  566. static_cast<unsigned char>(to_lower(*s)));
  567. }
  568. };
  569. template <typename T>
  570. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  571. detail::case_ignore::equal_to>;
  572. } // namespace case_ignore
  573. // This is based on
  574. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  575. struct scope_exit {
  576. explicit scope_exit(std::function<void(void)> &&f)
  577. : exit_function(std::move(f)), execute_on_destruction{true} {}
  578. scope_exit(scope_exit &&rhs) noexcept
  579. : exit_function(std::move(rhs.exit_function)),
  580. execute_on_destruction{rhs.execute_on_destruction} {
  581. rhs.release();
  582. }
  583. ~scope_exit() {
  584. if (execute_on_destruction) { this->exit_function(); }
  585. }
  586. void release() { this->execute_on_destruction = false; }
  587. private:
  588. scope_exit(const scope_exit &) = delete;
  589. void operator=(const scope_exit &) = delete;
  590. scope_exit &operator=(scope_exit &&) = delete;
  591. std::function<void(void)> exit_function;
  592. bool execute_on_destruction;
  593. };
  594. // Simple from_chars implementation for integer and double types (C++17
  595. // substitute)
  596. template <typename T> struct from_chars_result {
  597. const char *ptr;
  598. std::errc ec;
  599. };
  600. template <typename T>
  601. inline from_chars_result<T> from_chars(const char *first, const char *last,
  602. T &value, int base = 10) {
  603. value = 0;
  604. const char *p = first;
  605. bool negative = false;
  606. if (p != last && *p == '-') {
  607. negative = true;
  608. ++p;
  609. }
  610. if (p == last) { return {first, std::errc::invalid_argument}; }
  611. T result = 0;
  612. for (; p != last; ++p) {
  613. char c = *p;
  614. int digit = -1;
  615. if (is_ascii_digit(c)) {
  616. digit = c - '0';
  617. } else if ('a' <= c && c <= 'z') {
  618. digit = c - 'a' + 10;
  619. } else if ('A' <= c && c <= 'Z') {
  620. digit = c - 'A' + 10;
  621. } else {
  622. break;
  623. }
  624. if (digit < 0 || digit >= base) { break; }
  625. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  626. return {p, std::errc::result_out_of_range};
  627. }
  628. result = result * base + digit;
  629. }
  630. if (p == first || (negative && p == first + 1)) {
  631. return {first, std::errc::invalid_argument};
  632. }
  633. value = negative ? T(0) - result : result;
  634. return {p, std::errc{}};
  635. }
  636. // from_chars for double (hand-written, locale-independent)
  637. //
  638. // The only double consumed by this library is the HTTP quality value, whose
  639. // grammar is (RFC 9110 12.4.2):
  640. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  641. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  642. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  643. // '.' always the decimal separator (std::strtod would instead read it from the
  644. // global C locale, mis-parsing q-values once an embedder calls
  645. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  646. // the result to [0, 1], so inputs outside that range need not be distinguished
  647. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  648. // cases that exponent and wide-range handling would introduce.
  649. inline from_chars_result<double> from_chars(const char *first, const char *last,
  650. double &value) {
  651. value = 0.0;
  652. const char *p = first;
  653. // Each 1eN is exactly representable, so a single final division by the
  654. // matching entry yields a correctly-rounded result.
  655. static const double powers_of_ten[] = {
  656. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  657. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  658. const int max_frac_digits =
  659. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  660. // Accumulate digits into a 64-bit integer and remember how many were
  661. // fractional. Two independent caps keep this bounded and safe:
  662. // * accumulation saturates before mantissa could overflow uint64_t, and
  663. // * frac_digits is capped at max_frac_digits so it is always a valid index
  664. // into powers_of_ten (without this an input like "0.000...0" would never
  665. // grow mantissa, so the saturation cap alone would not bound it).
  666. // Both caps only drop digits far beyond the precision a q-value needs; any
  667. // value they would change is well outside [0, 1] and rejected by the caller.
  668. uint64_t mantissa = 0;
  669. int frac_digits = 0;
  670. bool seen_digit = false;
  671. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  672. auto accumulate = [&](char c) {
  673. if (mantissa <= limit) {
  674. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  675. return true;
  676. }
  677. return false;
  678. };
  679. for (; p != last && is_ascii_digit(*p); ++p) {
  680. seen_digit = true;
  681. accumulate(*p);
  682. }
  683. if (p != last && *p == '.') {
  684. ++p;
  685. for (; p != last && is_ascii_digit(*p); ++p) {
  686. seen_digit = true;
  687. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  688. }
  689. }
  690. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  691. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  692. return {p, std::errc{}};
  693. }
  694. inline bool parse_port(const char *s, size_t len, int &port) {
  695. int val = 0;
  696. auto r = from_chars(s, s + len, val);
  697. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  698. port = val;
  699. return true;
  700. }
  701. inline bool parse_port(const std::string &s, int &port) {
  702. return parse_port(s.data(), s.size(), port);
  703. }
  704. struct UrlComponents {
  705. std::string scheme;
  706. std::string host;
  707. std::string port;
  708. std::string path;
  709. std::string query;
  710. };
  711. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  712. uc = {};
  713. size_t pos = 0;
  714. auto sep = url.find("://");
  715. if (sep != std::string::npos) {
  716. uc.scheme = url.substr(0, sep);
  717. // Scheme must be [a-z]+ only
  718. if (uc.scheme.empty()) { return false; }
  719. for (auto c : uc.scheme) {
  720. if (c < 'a' || c > 'z') { return false; }
  721. }
  722. pos = sep + 3;
  723. } else if (url.compare(0, 2, "//") == 0) {
  724. pos = 2;
  725. }
  726. auto has_authority_prefix = pos > 0;
  727. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  728. url[0] != '?' && url[0] != '#');
  729. if (has_authority) {
  730. if (pos < url.size() && url[pos] == '[') {
  731. auto close = url.find(']', pos);
  732. if (close == std::string::npos) { return false; }
  733. uc.host = url.substr(pos + 1, close - pos - 1);
  734. // IPv6 host must be [a-fA-F0-9:]+ only
  735. if (uc.host.empty()) { return false; }
  736. for (auto c : uc.host) {
  737. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  738. (c >= 'A' && c <= 'F') || c == ':')) {
  739. return false;
  740. }
  741. }
  742. pos = close + 1;
  743. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  744. // path, query or fragment delimiter (or the end of input). Otherwise the
  745. // trailing bytes would be folded into the path while the connection
  746. // still targets the bracketed address.
  747. if (pos < url.size()) {
  748. auto c = url[pos];
  749. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  750. }
  751. } else {
  752. auto end = url.find_first_of(":/?#", pos);
  753. if (end == std::string::npos) { end = url.size(); }
  754. uc.host = url.substr(pos, end - pos);
  755. pos = end;
  756. }
  757. if (pos < url.size() && url[pos] == ':') {
  758. ++pos;
  759. auto end = url.find_first_of("/?#", pos);
  760. if (end == std::string::npos) { end = url.size(); }
  761. uc.port = url.substr(pos, end - pos);
  762. pos = end;
  763. }
  764. // Without :// or //, the entire input must be consumed as host[:port].
  765. // If there is leftover (path, query, etc.), this is not a valid
  766. // host[:port] string — clear and reparse as a plain path.
  767. if (!has_authority_prefix && pos < url.size()) {
  768. uc.host.clear();
  769. uc.port.clear();
  770. pos = 0;
  771. }
  772. }
  773. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  774. auto end = url.find_first_of("?#", pos);
  775. if (end == std::string::npos) { end = url.size(); }
  776. uc.path = url.substr(pos, end - pos);
  777. pos = end;
  778. }
  779. if (pos < url.size() && url[pos] == '?') {
  780. auto end = url.find('#', pos);
  781. if (end == std::string::npos) { end = url.size(); }
  782. uc.query = url.substr(pos, end - pos);
  783. }
  784. return true;
  785. }
  786. } // namespace detail
  787. enum class SSLVerifierResponse {
  788. // no decision has been made, use the built-in certificate verifier
  789. NoDecisionMade,
  790. // connection certificate is verified and accepted
  791. CertificateAccepted,
  792. // connection certificate was processed but is rejected
  793. CertificateRejected
  794. };
  795. // System CA loading policy for SSL clients. Auto (the default) loads system
  796. // CA certs only when no custom CA is configured; enable_system_ca() switches
  797. // to an explicit policy.
  798. enum class SystemCAMode { Auto, Enabled, Disabled };
  799. enum StatusCode {
  800. // Information responses
  801. Continue_100 = 100,
  802. SwitchingProtocol_101 = 101,
  803. Processing_102 = 102,
  804. EarlyHints_103 = 103,
  805. // Successful responses
  806. OK_200 = 200,
  807. Created_201 = 201,
  808. Accepted_202 = 202,
  809. NonAuthoritativeInformation_203 = 203,
  810. NoContent_204 = 204,
  811. ResetContent_205 = 205,
  812. PartialContent_206 = 206,
  813. MultiStatus_207 = 207,
  814. AlreadyReported_208 = 208,
  815. IMUsed_226 = 226,
  816. // Redirection messages
  817. MultipleChoices_300 = 300,
  818. MovedPermanently_301 = 301,
  819. Found_302 = 302,
  820. SeeOther_303 = 303,
  821. NotModified_304 = 304,
  822. UseProxy_305 = 305,
  823. unused_306 = 306,
  824. TemporaryRedirect_307 = 307,
  825. PermanentRedirect_308 = 308,
  826. // Client error responses
  827. BadRequest_400 = 400,
  828. Unauthorized_401 = 401,
  829. PaymentRequired_402 = 402,
  830. Forbidden_403 = 403,
  831. NotFound_404 = 404,
  832. MethodNotAllowed_405 = 405,
  833. NotAcceptable_406 = 406,
  834. ProxyAuthenticationRequired_407 = 407,
  835. RequestTimeout_408 = 408,
  836. Conflict_409 = 409,
  837. Gone_410 = 410,
  838. LengthRequired_411 = 411,
  839. PreconditionFailed_412 = 412,
  840. PayloadTooLarge_413 = 413,
  841. UriTooLong_414 = 414,
  842. UnsupportedMediaType_415 = 415,
  843. RangeNotSatisfiable_416 = 416,
  844. ExpectationFailed_417 = 417,
  845. ImATeapot_418 = 418,
  846. MisdirectedRequest_421 = 421,
  847. UnprocessableContent_422 = 422,
  848. Locked_423 = 423,
  849. FailedDependency_424 = 424,
  850. TooEarly_425 = 425,
  851. UpgradeRequired_426 = 426,
  852. PreconditionRequired_428 = 428,
  853. TooManyRequests_429 = 429,
  854. RequestHeaderFieldsTooLarge_431 = 431,
  855. UnavailableForLegalReasons_451 = 451,
  856. // Server error responses
  857. InternalServerError_500 = 500,
  858. NotImplemented_501 = 501,
  859. BadGateway_502 = 502,
  860. ServiceUnavailable_503 = 503,
  861. GatewayTimeout_504 = 504,
  862. HttpVersionNotSupported_505 = 505,
  863. VariantAlsoNegotiates_506 = 506,
  864. InsufficientStorage_507 = 507,
  865. LoopDetected_508 = 508,
  866. NotExtended_510 = 510,
  867. NetworkAuthenticationRequired_511 = 511,
  868. };
  869. namespace detail {
  870. // A multimap that keeps its entries in the order they were inserted.
  871. //
  872. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  873. // fields sharing a field name significant and forbids a proxy from reordering
  874. // them, and a query string's parameters are meaningful in the order the caller
  875. // wrote them. Neither standard container expresses it: std::unordered_multimap
  876. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  877. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  878. // key, which would drop control data such as Host behind whatever else the
  879. // message carries and alphabetise a query string.
  880. //
  881. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  882. // scan, which beats hashing for the handful of entries a message carries
  883. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  884. //
  885. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  886. // Params, whose parameter names are case-sensitive, not.
  887. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  888. public:
  889. using key_type = std::string;
  890. using mapped_type = Mapped;
  891. using value_type = std::pair<std::string, Mapped>;
  892. using size_type = std::size_t;
  893. using difference_type = std::ptrdiff_t;
  894. using reference = value_type &;
  895. using const_reference = const value_type &;
  896. private:
  897. static size_type npos() { return static_cast<size_type>(-1); }
  898. static bool keys_equal(const std::string &a, const std::string &b) {
  899. return KeyEqual()(a, b);
  900. }
  901. // Iterating yields every entry in insertion order, but equal_range() and
  902. // find() have to walk only the entries sharing one key, which are not
  903. // adjacent. Both are the same iterator type: key_idx_ selects between the
  904. // two traversals, and since equality compares only the position, an iterator
  905. // restricted to one key still compares equal to end().
  906. template <typename V> class iterator_t {
  907. public:
  908. using iterator_category = std::bidirectional_iterator_tag;
  909. using value_type = insertion_ordered_multimap::value_type;
  910. using difference_type = insertion_ordered_multimap::difference_type;
  911. using pointer = V *;
  912. using reference = V &;
  913. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  914. template <typename U,
  915. typename std::enable_if<std::is_convertible<U *, V *>::value,
  916. int>::type = 0>
  917. iterator_t(const iterator_t<U> &rhs)
  918. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  919. key_idx_(rhs.key_idx_) {}
  920. reference operator*() const { return data_[idx_]; }
  921. pointer operator->() const { return data_ + idx_; }
  922. iterator_t &operator++() {
  923. // Saturating, so that advancing past the last entry of a key (which
  924. // get_multimap_value() does when asked for an out-of-range id) stays at
  925. // end() instead of running off the container.
  926. if (idx_ >= size_) { return *this; }
  927. ++idx_;
  928. if (key_idx_ != npos()) {
  929. while (idx_ < size_ && !matches(idx_)) {
  930. ++idx_;
  931. }
  932. }
  933. return *this;
  934. }
  935. iterator_t operator++(int) {
  936. auto tmp = *this;
  937. ++*this;
  938. return tmp;
  939. }
  940. iterator_t &operator--() {
  941. if (idx_ == 0) { return *this; }
  942. --idx_;
  943. if (key_idx_ != npos()) {
  944. while (idx_ > 0 && !matches(idx_)) {
  945. --idx_;
  946. }
  947. }
  948. return *this;
  949. }
  950. iterator_t operator--(int) {
  951. auto tmp = *this;
  952. --*this;
  953. return tmp;
  954. }
  955. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  956. return idx_ == rhs.idx_;
  957. }
  958. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  959. return idx_ != rhs.idx_;
  960. }
  961. private:
  962. friend class insertion_ordered_multimap;
  963. template <typename> friend class iterator_t;
  964. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  965. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  966. bool matches(size_type i) const {
  967. return keys_equal(data_[i].first, data_[key_idx_].first);
  968. }
  969. V *data_;
  970. size_type idx_;
  971. size_type size_;
  972. size_type key_idx_;
  973. };
  974. public:
  975. using iterator = iterator_t<value_type>;
  976. using const_iterator = iterator_t<const value_type>;
  977. insertion_ordered_multimap() = default;
  978. insertion_ordered_multimap(std::initializer_list<value_type> il)
  979. : entries_(il) {}
  980. template <typename InputIt>
  981. insertion_ordered_multimap(InputIt first, InputIt last)
  982. : entries_(first, last) {}
  983. iterator begin() { return make_iter(0, npos()); }
  984. iterator end() { return make_iter(entries_.size(), npos()); }
  985. const_iterator begin() const { return make_citer(0, npos()); }
  986. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  987. const_iterator cbegin() const { return begin(); }
  988. const_iterator cend() const { return end(); }
  989. bool empty() const { return entries_.empty(); }
  990. size_type size() const { return entries_.size(); }
  991. void clear() { entries_.clear(); }
  992. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  993. iterator insert(const value_type &val) {
  994. entries_.push_back(val);
  995. return make_iter(entries_.size() - 1, npos());
  996. }
  997. iterator insert(value_type &&val) {
  998. entries_.push_back(std::move(val));
  999. return make_iter(entries_.size() - 1, npos());
  1000. }
  1001. template <typename... Args> iterator emplace(Args &&...args) {
  1002. entries_.emplace_back(std::forward<Args>(args)...);
  1003. return make_iter(entries_.size() - 1, npos());
  1004. }
  1005. // For entries that have to lead the message, such as the Host header field
  1006. // (RFC 9110 5.3 recommends sending control data first).
  1007. template <typename... Args> iterator emplace_front(Args &&...args) {
  1008. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1009. return make_iter(0, npos());
  1010. }
  1011. iterator find(const std::string &key) {
  1012. auto i = index_of(key);
  1013. return i == npos() ? end() : make_iter(i, i);
  1014. }
  1015. const_iterator find(const std::string &key) const {
  1016. auto i = index_of(key);
  1017. return i == npos() ? end() : make_citer(i, i);
  1018. }
  1019. size_type count(const std::string &key) const {
  1020. size_type n = 0;
  1021. for (const auto &entry : entries_) {
  1022. if (keys_equal(entry.first, key)) { n++; }
  1023. }
  1024. return n;
  1025. }
  1026. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1027. auto i = index_of(key);
  1028. return i == npos() ? std::make_pair(end(), end())
  1029. : std::make_pair(make_iter(i, i), end());
  1030. }
  1031. std::pair<const_iterator, const_iterator>
  1032. equal_range(const std::string &key) const {
  1033. auto i = index_of(key);
  1034. return i == npos() ? std::make_pair(end(), end())
  1035. : std::make_pair(make_citer(i, i), end());
  1036. }
  1037. size_type erase(const std::string &key) {
  1038. auto before = entries_.size();
  1039. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1040. [&](const value_type &entry) {
  1041. return keys_equal(entry.first, key);
  1042. }),
  1043. entries_.end());
  1044. return before - entries_.size();
  1045. }
  1046. iterator erase(const_iterator pos) {
  1047. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1048. return make_iter(pos.idx_, npos());
  1049. }
  1050. // Erases what iterating [first, last) would actually visit, so erasing an
  1051. // equal_range() removes only the entries with that key, not everything
  1052. // positioned between them.
  1053. iterator erase(const_iterator first, const_iterator last) {
  1054. auto from = first.idx_;
  1055. auto to = last.idx_;
  1056. if (from >= to) { return make_iter(from, npos()); }
  1057. auto begin_it = entries_.begin();
  1058. auto from_it = begin_it + static_cast<difference_type>(from);
  1059. auto to_it = begin_it + static_cast<difference_type>(to);
  1060. if (first.key_idx_ == npos()) {
  1061. entries_.erase(from_it, to_it);
  1062. } else {
  1063. auto key = entries_[first.key_idx_].first;
  1064. auto keep = from_it;
  1065. for (auto it = from_it; it != to_it; ++it) {
  1066. if (!keys_equal(it->first, key)) {
  1067. if (keep != it) { *keep = std::move(*it); }
  1068. ++keep;
  1069. }
  1070. }
  1071. if (keep != to_it) {
  1072. keep = std::move(to_it, entries_.end(), keep);
  1073. } else {
  1074. keep = entries_.end();
  1075. }
  1076. entries_.erase(keep, entries_.end());
  1077. }
  1078. return make_iter(from, npos());
  1079. }
  1080. friend bool operator==(const insertion_ordered_multimap &lhs,
  1081. const insertion_ordered_multimap &rhs) {
  1082. return lhs.entries_ == rhs.entries_;
  1083. }
  1084. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1085. const insertion_ordered_multimap &rhs) {
  1086. return !(lhs == rhs);
  1087. }
  1088. private:
  1089. size_type index_of(const std::string &key) const {
  1090. for (size_type i = 0; i < entries_.size(); i++) {
  1091. if (keys_equal(entries_[i].first, key)) { return i; }
  1092. }
  1093. return npos();
  1094. }
  1095. iterator make_iter(size_type idx, size_type key_idx) {
  1096. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1097. }
  1098. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1099. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1100. }
  1101. std::vector<value_type> entries_;
  1102. };
  1103. } // namespace detail
  1104. using Headers =
  1105. detail::insertion_ordered_multimap<std::string,
  1106. detail::case_ignore::equal_to>;
  1107. // Query parameter names are case-sensitive, unlike header field names.
  1108. using Params =
  1109. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1110. using Match = std::smatch;
  1111. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1112. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1113. /*
  1114. * detail: type-erased storage used by UserData.
  1115. * ABI-stable regardless of C++ standard — always uses this custom
  1116. * implementation instead of std::any.
  1117. */
  1118. namespace detail {
  1119. using any_type_id = const void *;
  1120. template <typename T> any_type_id any_typeid() noexcept {
  1121. static const char id = 0;
  1122. return &id;
  1123. }
  1124. struct any_storage {
  1125. virtual ~any_storage() = default;
  1126. virtual std::unique_ptr<any_storage> clone() const = 0;
  1127. virtual any_type_id type_id() const noexcept = 0;
  1128. };
  1129. template <typename T> struct any_value final : any_storage {
  1130. T value;
  1131. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1132. std::unique_ptr<any_storage> clone() const override {
  1133. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1134. }
  1135. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1136. };
  1137. } // namespace detail
  1138. class UserData {
  1139. public:
  1140. UserData() = default;
  1141. UserData(UserData &&) noexcept = default;
  1142. UserData &operator=(UserData &&) noexcept = default;
  1143. UserData(const UserData &o) {
  1144. for (const auto &e : o.entries_) {
  1145. if (e.second) { entries_[e.first] = e.second->clone(); }
  1146. }
  1147. }
  1148. UserData &operator=(const UserData &o) {
  1149. if (this != &o) {
  1150. entries_.clear();
  1151. for (const auto &e : o.entries_) {
  1152. if (e.second) { entries_[e.first] = e.second->clone(); }
  1153. }
  1154. }
  1155. return *this;
  1156. }
  1157. template <typename T> void set(const std::string &key, T &&value) {
  1158. using D = typename std::decay<T>::type;
  1159. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1160. }
  1161. template <typename T> T *get(const std::string &key) noexcept {
  1162. auto it = entries_.find(key);
  1163. if (it == entries_.end() || !it->second) { return nullptr; }
  1164. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1165. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1166. }
  1167. template <typename T> const T *get(const std::string &key) const noexcept {
  1168. auto it = entries_.find(key);
  1169. if (it == entries_.end() || !it->second) { return nullptr; }
  1170. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1171. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1172. }
  1173. bool has(const std::string &key) const noexcept {
  1174. return entries_.find(key) != entries_.end();
  1175. }
  1176. void erase(const std::string &key) { entries_.erase(key); }
  1177. void clear() noexcept { entries_.clear(); }
  1178. private:
  1179. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1180. entries_;
  1181. };
  1182. struct Response;
  1183. using ResponseHandler = std::function<bool(const Response &response)>;
  1184. struct FormData {
  1185. std::string name;
  1186. std::string content;
  1187. std::string filename;
  1188. std::string content_type;
  1189. Headers headers;
  1190. };
  1191. struct FormField {
  1192. std::string name;
  1193. std::string content;
  1194. Headers headers;
  1195. };
  1196. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1197. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1198. // should see the parts as they were sent. A std::multimap sorts by field name
  1199. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1200. // than the case-insensitive predicate Headers uses.
  1201. using FormFields =
  1202. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1203. using FormFiles =
  1204. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1205. struct MultipartFormData {
  1206. FormFields fields; // Text fields from multipart
  1207. FormFiles files; // Files from multipart
  1208. // Text field access
  1209. std::string get_field(const std::string &key, size_t id = 0) const;
  1210. std::vector<std::string> get_fields(const std::string &key) const;
  1211. bool has_field(const std::string &key) const;
  1212. size_t get_field_count(const std::string &key) const;
  1213. // File access
  1214. FormData get_file(const std::string &key, size_t id = 0) const;
  1215. std::vector<FormData> get_files(const std::string &key) const;
  1216. bool has_file(const std::string &key) const;
  1217. size_t get_file_count(const std::string &key) const;
  1218. };
  1219. struct UploadFormData {
  1220. std::string name;
  1221. std::string content;
  1222. std::string filename;
  1223. std::string content_type;
  1224. };
  1225. using UploadFormDataItems = std::vector<UploadFormData>;
  1226. class DataSink {
  1227. public:
  1228. DataSink() : os(&sb_), sb_(*this) {}
  1229. DataSink(const DataSink &) = delete;
  1230. DataSink &operator=(const DataSink &) = delete;
  1231. DataSink(DataSink &&) = delete;
  1232. DataSink &operator=(DataSink &&) = delete;
  1233. std::function<bool(const char *data, size_t data_len)> write;
  1234. // Only `write` is mandatory. The rest are defaulted so that a provider
  1235. // calling one on a writer that does not set it gets sensible behaviour
  1236. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1237. // `this` is safe: DataSink is neither copyable nor movable.
  1238. std::function<bool()> is_writable = []() { return true; };
  1239. std::function<void()> done = []() {};
  1240. std::function<void(const Headers &trailer)> done_with_trailer =
  1241. [this](const Headers & /*trailer*/) { done(); };
  1242. std::ostream os;
  1243. private:
  1244. class data_sink_streambuf final : public std::streambuf {
  1245. public:
  1246. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1247. protected:
  1248. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1249. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1250. return 0;
  1251. }
  1252. private:
  1253. DataSink &sink_;
  1254. };
  1255. data_sink_streambuf sb_;
  1256. };
  1257. using ContentProvider =
  1258. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1259. using ContentProviderWithoutLength =
  1260. std::function<bool(size_t offset, DataSink &sink)>;
  1261. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1262. struct FormDataProvider {
  1263. std::string name;
  1264. ContentProviderWithoutLength provider;
  1265. std::string filename;
  1266. std::string content_type;
  1267. };
  1268. using FormDataProviderItems = std::vector<FormDataProvider>;
  1269. inline FormDataProvider
  1270. make_file_provider(const std::string &name, const std::string &filepath,
  1271. const std::string &filename = std::string(),
  1272. const std::string &content_type = std::string()) {
  1273. FormDataProvider fdp;
  1274. fdp.name = name;
  1275. fdp.filename = filename.empty() ? filepath : filename;
  1276. fdp.content_type = content_type;
  1277. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1278. std::ifstream f(filepath, std::ios::binary);
  1279. if (!f) { return false; }
  1280. if (offset > 0) {
  1281. f.seekg(static_cast<std::streamoff>(offset));
  1282. if (!f.good()) {
  1283. sink.done();
  1284. return true;
  1285. }
  1286. }
  1287. char buf[8192];
  1288. f.read(buf, sizeof(buf));
  1289. auto n = static_cast<size_t>(f.gcount());
  1290. if (n > 0) { return sink.write(buf, n); }
  1291. sink.done(); // EOF
  1292. return true;
  1293. };
  1294. return fdp;
  1295. }
  1296. inline std::pair<size_t, ContentProvider>
  1297. make_file_body(const std::string &filepath) {
  1298. size_t size = 0;
  1299. {
  1300. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1301. if (!f) { return {0, ContentProvider{}}; }
  1302. size = static_cast<size_t>(f.tellg());
  1303. }
  1304. ContentProvider provider = [filepath](size_t offset, size_t length,
  1305. DataSink &sink) -> bool {
  1306. std::ifstream f(filepath, std::ios::binary);
  1307. if (!f) { return false; }
  1308. f.seekg(static_cast<std::streamoff>(offset));
  1309. if (!f.good()) { return false; }
  1310. char buf[8192];
  1311. while (length > 0) {
  1312. auto to_read = (std::min)(sizeof(buf), length);
  1313. f.read(buf, static_cast<std::streamsize>(to_read));
  1314. auto n = static_cast<size_t>(f.gcount());
  1315. // The file is shorter than the size make_file_body() measured, which the
  1316. // caller has already committed to as Content-Length. The body cannot be
  1317. // completed, so fail as every other error here does.
  1318. if (n == 0) { return false; }
  1319. if (!sink.write(buf, n)) { return false; }
  1320. length -= n;
  1321. }
  1322. return true;
  1323. };
  1324. return {size, std::move(provider)};
  1325. }
  1326. using ContentReceiverWithProgress = std::function<bool(
  1327. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1328. using ContentReceiver =
  1329. std::function<bool(const char *data, size_t data_length)>;
  1330. using FormDataHeader = std::function<bool(const FormData &file)>;
  1331. class ContentReader {
  1332. public:
  1333. using Reader = std::function<bool(ContentReceiver receiver)>;
  1334. using FormDataReader =
  1335. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1336. ContentReader(Reader reader, FormDataReader multipart_reader)
  1337. : reader_(std::move(reader)),
  1338. formdata_reader_(std::move(multipart_reader)) {}
  1339. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1340. return formdata_reader_(std::move(header), std::move(receiver));
  1341. }
  1342. bool operator()(ContentReceiver receiver) const {
  1343. return reader_(std::move(receiver));
  1344. }
  1345. Reader reader_;
  1346. FormDataReader formdata_reader_;
  1347. };
  1348. using Range = std::pair<ssize_t, ssize_t>;
  1349. using Ranges = std::vector<Range>;
  1350. #ifdef CPPHTTPLIB_SSL_ENABLED
  1351. // TLS abstraction layer - public type definitions and API
  1352. namespace tls {
  1353. // Opaque handles (defined as void* for abstraction)
  1354. using ctx_t = void *;
  1355. using session_t = void *;
  1356. using const_session_t = const void *; // For read-only session access
  1357. using cert_t = void *;
  1358. using ca_store_t = void *;
  1359. // TLS versions
  1360. enum class Version {
  1361. TLS1_2 = 0x0303,
  1362. TLS1_3 = 0x0304,
  1363. };
  1364. // Subject Alternative Names (SAN) entry types
  1365. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1366. // SAN entry structure
  1367. struct SanEntry {
  1368. SanType type;
  1369. std::string value;
  1370. };
  1371. // Verification context for certificate verification callback
  1372. struct VerifyContext {
  1373. session_t session; // TLS session handle
  1374. cert_t cert; // Current certificate being verified
  1375. int depth; // Certificate chain depth (0 = leaf)
  1376. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1377. long error_code; // Backend-specific error code (0 = no error)
  1378. const char *error_string; // Human-readable error description
  1379. // Certificate introspection methods
  1380. std::string subject_cn() const;
  1381. std::string issuer_name() const;
  1382. bool check_hostname(const char *hostname) const;
  1383. std::vector<SanEntry> sans() const;
  1384. bool validity(time_t &not_before, time_t &not_after) const;
  1385. std::string serial() const;
  1386. };
  1387. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1388. // TlsError codes for TLS operations (backend-independent)
  1389. enum class ErrorCode : int {
  1390. Success = 0,
  1391. WantRead, // Non-blocking: need to wait for read
  1392. WantWrite, // Non-blocking: need to wait for write
  1393. PeerClosed, // Peer closed the connection
  1394. Fatal, // Unrecoverable error
  1395. SyscallError, // System call error (check sys_errno)
  1396. CertVerifyFailed, // Certificate verification failed
  1397. HostnameMismatch, // Hostname verification failed
  1398. };
  1399. // TLS error information
  1400. struct TlsError {
  1401. ErrorCode code = ErrorCode::Fatal;
  1402. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1403. int sys_errno = 0; // errno when SyscallError
  1404. // Convert verification error code to human-readable string
  1405. static std::string verify_error_to_string(long error_code);
  1406. };
  1407. // RAII wrapper for peer certificate
  1408. class PeerCert {
  1409. public:
  1410. PeerCert();
  1411. PeerCert(PeerCert &&other) noexcept;
  1412. PeerCert &operator=(PeerCert &&other) noexcept;
  1413. ~PeerCert();
  1414. PeerCert(const PeerCert &) = delete;
  1415. PeerCert &operator=(const PeerCert &) = delete;
  1416. explicit operator bool() const;
  1417. std::string subject_cn() const;
  1418. std::string issuer_name() const;
  1419. bool check_hostname(const char *hostname) const;
  1420. std::vector<SanEntry> sans() const;
  1421. bool validity(time_t &not_before, time_t &not_after) const;
  1422. std::string serial() const;
  1423. private:
  1424. explicit PeerCert(cert_t cert);
  1425. cert_t cert_ = nullptr;
  1426. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1427. };
  1428. // Callback for TLS context setup (used by SSLServer constructor)
  1429. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1430. } // namespace tls
  1431. #endif
  1432. struct Request {
  1433. std::string method;
  1434. std::string path;
  1435. std::string matched_route;
  1436. Params params;
  1437. Headers headers;
  1438. Headers trailers;
  1439. std::string body;
  1440. std::string remote_addr;
  1441. int remote_port = -1;
  1442. std::string local_addr;
  1443. int local_port = -1;
  1444. // for server
  1445. std::string version;
  1446. std::string target;
  1447. MultipartFormData form;
  1448. Ranges ranges;
  1449. Match matches;
  1450. std::unordered_map<std::string, std::string> path_params;
  1451. std::function<bool()> is_connection_closed = []() { return true; };
  1452. // for client
  1453. std::vector<std::string> accept_content_types;
  1454. ResponseHandler response_handler;
  1455. ContentReceiverWithProgress content_receiver;
  1456. DownloadProgress download_progress;
  1457. UploadProgress upload_progress;
  1458. bool has_header(const std::string &key) const;
  1459. std::string get_header_value(const std::string &key, const char *def = "",
  1460. size_t id = 0) const;
  1461. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1462. size_t id = 0) const;
  1463. size_t get_header_value_count(const std::string &key) const;
  1464. void set_header(const std::string &key, const std::string &val);
  1465. bool has_trailer(const std::string &key) const;
  1466. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1467. size_t get_trailer_value_count(const std::string &key) const;
  1468. bool has_param(const std::string &key) const;
  1469. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1470. std::vector<std::string> get_param_values(const std::string &key) const;
  1471. size_t get_param_value_count(const std::string &key) const;
  1472. bool is_multipart_form_data() const;
  1473. // private members...
  1474. bool body_consumed_ = false;
  1475. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1476. size_t content_length_ = 0;
  1477. ContentProvider content_provider_;
  1478. bool is_chunked_content_provider_ = false;
  1479. size_t authorization_count_ = 0;
  1480. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1481. (std::chrono::steady_clock::time_point::min)();
  1482. #ifdef CPPHTTPLIB_SSL_ENABLED
  1483. tls::const_session_t ssl = nullptr;
  1484. tls::PeerCert peer_cert() const;
  1485. std::string sni() const;
  1486. #endif
  1487. };
  1488. namespace detail {
  1489. // Declared up here, away from the rest of the compression helpers, because
  1490. // `Response` stores one.
  1491. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1492. } // namespace detail
  1493. struct Response {
  1494. std::string version;
  1495. int status = -1;
  1496. std::string reason;
  1497. Headers headers;
  1498. Headers trailers;
  1499. std::string body;
  1500. std::string location; // Redirect location
  1501. // User-defined context — set by pre-routing/pre-request handlers and read
  1502. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1503. UserData user_data;
  1504. bool has_header(const std::string &key) const;
  1505. std::string get_header_value(const std::string &key, const char *def = "",
  1506. size_t id = 0) const;
  1507. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1508. size_t id = 0) const;
  1509. size_t get_header_value_count(const std::string &key) const;
  1510. void set_header(const std::string &key, const std::string &val);
  1511. bool has_trailer(const std::string &key) const;
  1512. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1513. size_t get_trailer_value_count(const std::string &key) const;
  1514. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1515. void set_content(const char *s, size_t n, const std::string &content_type);
  1516. void set_content(const std::string &s, const std::string &content_type);
  1517. void set_content(std::string &&s, const std::string &content_type);
  1518. void set_content_provider(
  1519. size_t length, const std::string &content_type, ContentProvider provider,
  1520. ContentProviderResourceReleaser resource_releaser = nullptr);
  1521. void set_content_provider(
  1522. const std::string &content_type, ContentProviderWithoutLength provider,
  1523. ContentProviderResourceReleaser resource_releaser = nullptr);
  1524. void set_chunked_content_provider(
  1525. const std::string &content_type, ContentProviderWithoutLength provider,
  1526. ContentProviderResourceReleaser resource_releaser = nullptr);
  1527. void set_file_content(const std::string &path,
  1528. const std::string &content_type);
  1529. void set_file_content(const std::string &path);
  1530. Response() = default;
  1531. Response(const Response &) = default;
  1532. Response &operator=(const Response &) = default;
  1533. Response(Response &&) = default;
  1534. Response &operator=(Response &&) = default;
  1535. ~Response() {
  1536. if (content_provider_resource_releaser_) {
  1537. content_provider_resource_releaser_(content_provider_success_);
  1538. }
  1539. }
  1540. // private members...
  1541. size_t content_length_ = 0;
  1542. ContentProvider content_provider_;
  1543. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1544. bool is_chunked_content_provider_ = false;
  1545. bool content_provider_success_ = false;
  1546. std::string file_content_path_;
  1547. std::string file_content_content_type_;
  1548. // Content coding chosen for the response body, decided once so that the
  1549. // headers and the body cannot disagree: where the file is opened for a
  1550. // file-backed content provider (keeping the ETag honest), and in
  1551. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1552. // for every other kind of response.
  1553. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1554. };
  1555. enum class Error {
  1556. Success = 0,
  1557. Unknown,
  1558. Connection,
  1559. BindIPAddress,
  1560. Read,
  1561. Write,
  1562. ExceedRedirectCount,
  1563. Canceled,
  1564. SSLConnection,
  1565. SSLLoadingCerts,
  1566. SSLServerVerification,
  1567. SSLServerHostnameVerification,
  1568. UnsupportedMultipartBoundaryChars,
  1569. Compression,
  1570. ConnectionTimeout,
  1571. ProxyConnection,
  1572. ConnectionClosed,
  1573. Timeout,
  1574. ResourceExhaustion,
  1575. TooManyFormDataFiles,
  1576. ExceedMaxPayloadSize,
  1577. ExceedUriMaxLength,
  1578. ExceedMaxSocketDescriptorCount,
  1579. InvalidRequestLine,
  1580. InvalidHTTPMethod,
  1581. InvalidHTTPVersion,
  1582. InvalidHeaders,
  1583. MultipartParsing,
  1584. OpenFile,
  1585. Listen,
  1586. GetSockName,
  1587. UnsupportedAddressFamily,
  1588. HTTPParsing,
  1589. InvalidRangeHeader,
  1590. UnsupportedContentEncoding,
  1591. WebSocketHandshake,
  1592. UserCallbackException,
  1593. // For internal use only
  1594. SSLPeerCouldBeClosed_,
  1595. };
  1596. std::string to_string(Error error);
  1597. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1598. class Stream {
  1599. public:
  1600. virtual ~Stream() = default;
  1601. virtual bool is_readable() const = 0;
  1602. virtual bool wait_readable() const = 0;
  1603. virtual bool wait_writable() const = 0;
  1604. virtual bool is_peer_alive() const { return wait_writable(); }
  1605. virtual ssize_t read(char *ptr, size_t size) = 0;
  1606. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1607. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1608. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1609. virtual socket_t socket() const = 0;
  1610. virtual time_t duration() const = 0;
  1611. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1612. (void)sec;
  1613. (void)usec;
  1614. }
  1615. // Bytes already pulled off the socket and sitting in this stream's own
  1616. // buffer. Exposing them lets a line reader scan for a terminator in one
  1617. // pass instead of asking for a byte at a time. A stream that does no
  1618. // buffering of its own reports none, and readers fall back to read().
  1619. virtual const char *buffered_data(size_t &size) const {
  1620. size = 0;
  1621. return nullptr;
  1622. }
  1623. // Discards `size` bytes previously returned by buffered_data().
  1624. virtual void consume_buffered(size_t size) { (void)size; }
  1625. ssize_t write(const char *ptr);
  1626. ssize_t write(const std::string &s);
  1627. Error get_error() const { return error_; }
  1628. protected:
  1629. Error error_ = Error::Success;
  1630. };
  1631. class TaskQueue {
  1632. public:
  1633. TaskQueue() = default;
  1634. virtual ~TaskQueue() = default;
  1635. virtual bool enqueue(std::function<void()> fn) = 0;
  1636. virtual void shutdown() = 0;
  1637. virtual void on_idle() {}
  1638. };
  1639. class ThreadPool final : public TaskQueue {
  1640. public:
  1641. explicit ThreadPool(
  1642. size_t n, size_t max_n = 0, size_t mqr = 0,
  1643. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1644. ThreadPool(const ThreadPool &) = delete;
  1645. ~ThreadPool() override = default;
  1646. bool enqueue(std::function<void()> fn) override;
  1647. void shutdown() override;
  1648. private:
  1649. void worker(bool is_dynamic);
  1650. void move_to_finished(std::thread::id id);
  1651. void cleanup_finished_threads();
  1652. size_t base_thread_count_;
  1653. size_t max_thread_count_;
  1654. size_t max_queued_requests_;
  1655. time_t idle_timeout_sec_;
  1656. size_t idle_thread_count_;
  1657. bool shutdown_;
  1658. std::list<std::function<void()>> jobs_;
  1659. std::vector<std::thread> threads_; // base threads
  1660. std::list<std::thread> dynamic_threads_; // dynamic threads
  1661. std::vector<std::thread>
  1662. finished_threads_; // exited dynamic threads awaiting join
  1663. std::condition_variable cond_;
  1664. std::mutex mutex_;
  1665. };
  1666. using Logger = std::function<void(const Request &, const Response &)>;
  1667. // Forward declaration for Error type
  1668. enum class Error;
  1669. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1670. using SocketOptions = std::function<void(socket_t sock)>;
  1671. void default_socket_options(socket_t sock);
  1672. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1673. const char *status_message(int status);
  1674. std::string to_string(Error error);
  1675. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1676. std::string get_bearer_token_auth(const Request &req);
  1677. namespace detail {
  1678. class MatcherBase {
  1679. public:
  1680. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1681. virtual ~MatcherBase() = default;
  1682. const std::string &pattern() const { return pattern_; }
  1683. // Match request path and populate its matches and
  1684. virtual bool match(Request &request) const = 0;
  1685. private:
  1686. std::string pattern_;
  1687. };
  1688. /**
  1689. * Captures parameters in request path and stores them in Request::path_params
  1690. *
  1691. * Capture name is a substring of a pattern from : to /.
  1692. * The rest of the pattern is matched against the request path directly
  1693. * Parameters are captured starting from the next character after
  1694. * the end of the last matched static pattern fragment until the next /.
  1695. *
  1696. * Example pattern:
  1697. * "/path/fragments/:capture/more/fragments/:second_capture"
  1698. * Static fragments:
  1699. * "/path/fragments/", "more/fragments/"
  1700. *
  1701. * Given the following request path:
  1702. * "/path/fragments/:1/more/fragments/:2"
  1703. * the resulting capture will be
  1704. * {{"capture", "1"}, {"second_capture", "2"}}
  1705. */
  1706. class PathParamsMatcher final : public MatcherBase {
  1707. public:
  1708. PathParamsMatcher(const std::string &pattern);
  1709. bool match(Request &request) const override;
  1710. private:
  1711. // Treat segment separators as the end of path parameter capture
  1712. // Does not need to handle query parameters as they are parsed before path
  1713. // matching
  1714. static constexpr char separator = '/';
  1715. // Contains static path fragments to match against, excluding the '/' after
  1716. // path params
  1717. // Fragments are separated by path params
  1718. std::vector<std::string> static_fragments_;
  1719. // Stores the names of the path parameters to be used as keys in the
  1720. // Request::path_params map
  1721. std::vector<std::string> param_names_;
  1722. };
  1723. /**
  1724. * Performs std::regex_match on request path
  1725. * and stores the result in Request::matches
  1726. *
  1727. * Note that regex match is performed directly on the whole request.
  1728. * This means that wildcard patterns may match multiple path segments with /:
  1729. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1730. */
  1731. class RegexMatcher final : public MatcherBase {
  1732. public:
  1733. RegexMatcher(const std::string &pattern)
  1734. : MatcherBase(pattern), regex_(pattern) {}
  1735. bool match(Request &request) const override;
  1736. private:
  1737. std::regex regex_;
  1738. };
  1739. int close_socket(socket_t sock) noexcept;
  1740. bool is_accept_resource_error();
  1741. bool is_accept_transient_error();
  1742. ssize_t write_headers(Stream &strm, const Headers &headers);
  1743. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1744. time_t usec);
  1745. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1746. const std::string &boundary);
  1747. ContentProvider
  1748. make_multipart_content_provider(const UploadFormDataItems &items,
  1749. const std::string &boundary);
  1750. } // namespace detail
  1751. bool is_valid_multipart_boundary(const std::string &boundary);
  1752. // Serializer for multipart/form-data request bodies. The boundary is owned
  1753. // by the writer so that per-part framing and the final terminator always
  1754. // agree. Field names and filenames are escaped following the WHATWG HTML
  1755. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1756. // in content types.
  1757. class MultipartFormDataWriter {
  1758. public:
  1759. MultipartFormDataWriter();
  1760. // precondition: is_valid_multipart_boundary(boundary)
  1761. explicit MultipartFormDataWriter(std::string boundary);
  1762. const std::string &boundary() const;
  1763. std::string content_type() const;
  1764. // In-memory items -> whole body (known length)
  1765. std::string serialize(const UploadFormDataItems &items) const;
  1766. size_t content_length(const UploadFormDataItems &items) const;
  1767. // Per-part framing for streaming via a content provider
  1768. std::string item_begin(const UploadFormData &item) const;
  1769. static std::string item_end();
  1770. std::string finish() const;
  1771. private:
  1772. std::string boundary_;
  1773. };
  1774. class Server {
  1775. public:
  1776. using Handler = std::function<void(const Request &, Response &)>;
  1777. using ExceptionHandler =
  1778. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1779. enum class HandlerResponse {
  1780. Handled,
  1781. Unhandled,
  1782. };
  1783. using HandlerWithResponse =
  1784. std::function<HandlerResponse(const Request &, Response &)>;
  1785. using HandlerWithContentReader = std::function<void(
  1786. const Request &, Response &, const ContentReader &content_reader)>;
  1787. using Expect100ContinueHandler =
  1788. std::function<int(const Request &, Response &)>;
  1789. using StartHandler = std::function<void()>;
  1790. using WebSocketHandler =
  1791. std::function<void(const Request &, ws::WebSocket &)>;
  1792. using SubProtocolSelector =
  1793. std::function<std::string(const std::vector<std::string> &protocols)>;
  1794. Server();
  1795. virtual ~Server();
  1796. virtual bool is_valid() const;
  1797. Server &Get(const std::string &pattern, Handler handler);
  1798. Server &Post(const std::string &pattern, Handler handler);
  1799. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1800. Server &Put(const std::string &pattern, Handler handler);
  1801. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1802. Server &Patch(const std::string &pattern, Handler handler);
  1803. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1804. Server &Delete(const std::string &pattern, Handler handler);
  1805. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1806. Server &Options(const std::string &pattern, Handler handler);
  1807. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1808. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1809. // server accept it; an unregistered method is still rejected with 400.
  1810. // `method` must be a valid HTTP method token and must not be one of the
  1811. // built-in methods, which have their own registration functions above. A
  1812. // rejected registration makes is_valid() return false, so listen() fails.
  1813. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1814. Handler handler);
  1815. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1816. HandlerWithContentReader handler);
  1817. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1818. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1819. SubProtocolSelector sub_protocol_selector);
  1820. bool set_base_dir(const std::string &dir,
  1821. const std::string &mount_point = std::string());
  1822. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1823. Headers headers = Headers());
  1824. bool remove_mount_point(const std::string &mount_point);
  1825. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1826. const std::string &mime);
  1827. Server &set_default_file_mimetype(const std::string &mime);
  1828. Server &set_file_request_handler(Handler handler);
  1829. template <class ErrorHandlerFunc>
  1830. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1831. return set_error_handler_core(
  1832. std::forward<ErrorHandlerFunc>(handler),
  1833. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1834. }
  1835. Server &set_exception_handler(ExceptionHandler handler);
  1836. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1837. Server &set_post_routing_handler(Handler handler);
  1838. Server &set_pre_request_handler(HandlerWithResponse handler);
  1839. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1840. Server &set_start_handler(StartHandler handler);
  1841. Server &set_logger(Logger logger);
  1842. Server &set_pre_compression_logger(Logger logger);
  1843. Server &set_error_logger(ErrorLogger error_logger);
  1844. Server &set_address_family(int family);
  1845. Server &set_tcp_nodelay(bool on);
  1846. Server &set_ipv6_v6only(bool on);
  1847. Server &set_socket_options(SocketOptions socket_options);
  1848. Server &set_default_headers(Headers headers);
  1849. Server &
  1850. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1851. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1852. Server &set_keep_alive_max_count(size_t count);
  1853. Server &set_keep_alive_timeout(time_t sec);
  1854. template <class Rep, class Period>
  1855. Server &
  1856. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1857. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1858. template <class Rep, class Period>
  1859. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1860. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1861. template <class Rep, class Period>
  1862. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1863. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1864. template <class Rep, class Period>
  1865. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1866. Server &set_payload_max_length(size_t length);
  1867. Server &set_static_file_compression(bool on);
  1868. Server &set_static_file_compression_min_length(size_t length);
  1869. Server &set_static_file_compression_max_length(size_t length);
  1870. Server &set_websocket_ping_interval(time_t sec);
  1871. template <class Rep, class Period>
  1872. Server &set_websocket_ping_interval(
  1873. const std::chrono::duration<Rep, Period> &duration);
  1874. Server &set_websocket_max_missed_pongs(int count);
  1875. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1876. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1877. bool listen_after_bind();
  1878. bool listen(const std::string &host, int port, int socket_flags = 0);
  1879. bool is_running() const;
  1880. void wait_until_ready() const;
  1881. void stop() noexcept;
  1882. void decommission();
  1883. std::function<TaskQueue *(void)> new_task_queue;
  1884. protected:
  1885. bool process_request(Stream &strm, const std::string &remote_addr,
  1886. int remote_port, const std::string &local_addr,
  1887. int local_port, bool close_connection,
  1888. bool &connection_closed,
  1889. const std::function<void(Request &)> &setup_request,
  1890. bool *websocket_upgraded = nullptr);
  1891. // Runs the per-connection serving loop and stops an exception thrown by a
  1892. // user callback from escaping the worker thread.
  1893. //
  1894. // process_request() wraps only routing() in a try/catch. Content providers,
  1895. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1896. // handlers all run outside it, and the task queue calls the job without a
  1897. // catch, so an exception from any of those would terminate the process.
  1898. //
  1899. // No 500 is possible here: by the time a content provider runs, the status
  1900. // line and headers are already on the wire. Report it through the error
  1901. // logger and drop the connection, which is what the peer observes either
  1902. // way. Other connections are unaffected.
  1903. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1904. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1905. return serve();
  1906. #else
  1907. try {
  1908. return serve();
  1909. } catch (...) {
  1910. // The error logger is a user callback too, so it must not be able to
  1911. // throw the guard back open.
  1912. try {
  1913. output_error_log(Error::UserCallbackException, nullptr);
  1914. } catch (...) {}
  1915. return false;
  1916. }
  1917. #endif
  1918. }
  1919. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1920. std::vector<std::string> trusted_proxies_;
  1921. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1922. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1923. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1924. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1925. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1926. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1927. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1928. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1929. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1930. bool static_file_compression_ = false;
  1931. size_t static_file_compression_min_length_ =
  1932. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1933. size_t static_file_compression_max_length_ =
  1934. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1935. time_t websocket_ping_interval_sec_ =
  1936. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1937. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1938. private:
  1939. using Handlers =
  1940. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1941. using HandlersForContentReader =
  1942. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1943. HandlerWithContentReader>>;
  1944. // Both handler tables for one custom method live in a single entry, so that
  1945. // routing() needs only one map lookup per request to reach either of them.
  1946. struct CustomHandlerEntry {
  1947. Handlers handlers;
  1948. HandlersForContentReader handlers_for_content_reader;
  1949. };
  1950. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1951. static std::unique_ptr<detail::MatcherBase>
  1952. make_matcher(const std::string &pattern);
  1953. static const std::set<std::string> &builtin_methods();
  1954. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1955. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1956. template <typename H>
  1957. Server &add_handler(
  1958. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1959. const std::string &pattern, H handler) {
  1960. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  1961. return *this;
  1962. }
  1963. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  1964. Server &set_error_handler_core(Handler handler, std::false_type);
  1965. socket_t create_server_socket(const std::string &host, int port,
  1966. int socket_flags,
  1967. SocketOptions socket_options) const;
  1968. int bind_internal(const std::string &host, int port, int socket_flags);
  1969. bool listen_internal();
  1970. bool routing(Request &req, Response &res, Stream &strm);
  1971. bool handle_file_request(Request &req, Response &res);
  1972. bool check_if_not_modified(const Request &req, Response &res,
  1973. const std::string &etag, time_t mtime) const;
  1974. bool check_if_range(Request &req, const std::string &etag,
  1975. time_t mtime) const;
  1976. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  1977. Stream &strm);
  1978. bool dispatch_request_for_content_reader(
  1979. Request &req, Response &res, ContentReader content_reader,
  1980. const HandlersForContentReader &handlers) const;
  1981. bool parse_request_line(const char *s, Request &req) const;
  1982. detail::EncodingType static_file_encoding(const Request &req,
  1983. const Response &res,
  1984. const std::string &content_type,
  1985. size_t length) const;
  1986. bool apply_static_file_compression(const Request &req, Response &res) const;
  1987. void apply_ranges(const Request &req, Response &res,
  1988. std::string &content_type, std::string &boundary) const;
  1989. bool write_response(Stream &strm, bool close_connection, Request &req,
  1990. Response &res);
  1991. bool write_response_with_content(Stream &strm, bool close_connection,
  1992. const Request &req, Response &res);
  1993. bool write_response_core(Stream &strm, bool close_connection,
  1994. const Request &req, Response &res,
  1995. bool need_apply_ranges);
  1996. bool write_content_with_provider(Stream &strm, const Request &req,
  1997. Response &res, const std::string &boundary,
  1998. const std::string &content_type);
  1999. bool read_content(Stream &strm, Request &req, Response &res);
  2000. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2001. Response &res,
  2002. ContentReceiver receiver,
  2003. FormDataHeader multipart_header,
  2004. ContentReceiver multipart_receiver);
  2005. bool read_content_core(Stream &strm, Request &req, Response &res,
  2006. ContentReceiver receiver,
  2007. FormDataHeader multipart_header,
  2008. ContentReceiver multipart_receiver) const;
  2009. virtual bool process_and_close_socket(socket_t sock);
  2010. void output_log(const Request &req, const Response &res) const;
  2011. void output_pre_compression_log(const Request &req,
  2012. const Response &res) const;
  2013. void output_error_log(const Error &err, const Request *req) const;
  2014. std::atomic<bool> is_running_{false};
  2015. std::atomic<bool> is_decommissioned{false};
  2016. // Set when CustomRoute() refuses a registration. Written before listen(),
  2017. // read by is_valid() on the same thread, so it needs no synchronization.
  2018. bool has_invalid_registration_ = false;
  2019. struct MountPointEntry {
  2020. std::string mount_point;
  2021. std::string base_dir;
  2022. std::string resolved_base_dir;
  2023. Headers headers;
  2024. };
  2025. std::vector<MountPointEntry> base_dirs_;
  2026. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2027. std::string default_file_mimetype_ = "application/octet-stream";
  2028. Handler file_request_handler_;
  2029. Handlers get_handlers_;
  2030. Handlers post_handlers_;
  2031. HandlersForContentReader post_handlers_for_content_reader_;
  2032. Handlers put_handlers_;
  2033. HandlersForContentReader put_handlers_for_content_reader_;
  2034. Handlers patch_handlers_;
  2035. HandlersForContentReader patch_handlers_for_content_reader_;
  2036. Handlers delete_handlers_;
  2037. HandlersForContentReader delete_handlers_for_content_reader_;
  2038. Handlers options_handlers_;
  2039. CustomHandlers custom_handlers_;
  2040. struct WebSocketHandlerEntry {
  2041. std::unique_ptr<detail::MatcherBase> matcher;
  2042. WebSocketHandler handler;
  2043. SubProtocolSelector sub_protocol_selector;
  2044. };
  2045. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2046. WebSocketHandlers websocket_handlers_;
  2047. HandlerWithResponse error_handler_;
  2048. ExceptionHandler exception_handler_;
  2049. HandlerWithResponse pre_routing_handler_;
  2050. Handler post_routing_handler_;
  2051. HandlerWithResponse pre_request_handler_;
  2052. Expect100ContinueHandler expect_100_continue_handler_;
  2053. StartHandler start_handler_;
  2054. mutable std::mutex logger_mutex_;
  2055. Logger logger_;
  2056. Logger pre_compression_logger_;
  2057. ErrorLogger error_logger_;
  2058. int address_family_ = AF_UNSPEC;
  2059. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2060. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2061. SocketOptions socket_options_ = default_socket_options;
  2062. Headers default_headers_;
  2063. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2064. detail::write_headers;
  2065. };
  2066. class Result {
  2067. public:
  2068. Result() = default;
  2069. Result(std::unique_ptr<Response> &&res, Error err,
  2070. Headers &&request_headers = Headers{})
  2071. : res_(std::move(res)), err_(err),
  2072. request_headers_(std::move(request_headers)) {}
  2073. // Response
  2074. operator bool() const { return res_ != nullptr; }
  2075. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2076. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2077. const Response &value() const { return *res_; }
  2078. Response &value() { return *res_; }
  2079. const Response &operator*() const { return *res_; }
  2080. Response &operator*() { return *res_; }
  2081. const Response *operator->() const { return res_.get(); }
  2082. Response *operator->() { return res_.get(); }
  2083. // Error
  2084. Error error() const { return err_; }
  2085. // Request Headers
  2086. bool has_request_header(const std::string &key) const;
  2087. std::string get_request_header_value(const std::string &key,
  2088. const char *def = "",
  2089. size_t id = 0) const;
  2090. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2091. size_t id = 0) const;
  2092. size_t get_request_header_value_count(const std::string &key) const;
  2093. private:
  2094. std::unique_ptr<Response> res_;
  2095. Error err_ = Error::Unknown;
  2096. Headers request_headers_;
  2097. #ifdef CPPHTTPLIB_SSL_ENABLED
  2098. public:
  2099. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2100. int ssl_error)
  2101. : res_(std::move(res)), err_(err),
  2102. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2103. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2104. int ssl_error, uint64_t ssl_backend_error)
  2105. : res_(std::move(res)), err_(err),
  2106. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2107. ssl_backend_error_(ssl_backend_error) {}
  2108. int ssl_error() const { return ssl_error_; }
  2109. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2110. private:
  2111. int ssl_error_ = 0;
  2112. uint64_t ssl_backend_error_ = 0;
  2113. #endif
  2114. };
  2115. struct ClientConnection {
  2116. socket_t sock = INVALID_SOCKET;
  2117. bool is_open() const { return sock != INVALID_SOCKET; }
  2118. ClientConnection() = default;
  2119. ~ClientConnection();
  2120. ClientConnection(const ClientConnection &) = delete;
  2121. ClientConnection &operator=(const ClientConnection &) = delete;
  2122. ClientConnection(ClientConnection &&other) noexcept
  2123. : sock(other.sock)
  2124. #ifdef CPPHTTPLIB_SSL_ENABLED
  2125. ,
  2126. session(other.session)
  2127. #endif
  2128. {
  2129. other.sock = INVALID_SOCKET;
  2130. #ifdef CPPHTTPLIB_SSL_ENABLED
  2131. other.session = nullptr;
  2132. #endif
  2133. }
  2134. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2135. if (this != &other) {
  2136. sock = other.sock;
  2137. other.sock = INVALID_SOCKET;
  2138. #ifdef CPPHTTPLIB_SSL_ENABLED
  2139. session = other.session;
  2140. other.session = nullptr;
  2141. #endif
  2142. }
  2143. return *this;
  2144. }
  2145. #ifdef CPPHTTPLIB_SSL_ENABLED
  2146. tls::session_t session = nullptr;
  2147. #endif
  2148. };
  2149. namespace detail {
  2150. struct ChunkedDecoder;
  2151. struct BodyReader {
  2152. Stream *stream = nullptr;
  2153. bool has_content_length = false;
  2154. size_t content_length = 0;
  2155. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2156. size_t bytes_read = 0;
  2157. bool chunked = false;
  2158. bool eof = false;
  2159. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2160. Error last_error = Error::Success;
  2161. ssize_t read(char *buf, size_t len);
  2162. bool has_error() const { return last_error != Error::Success; }
  2163. };
  2164. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2165. size_t len) {
  2166. (void)stream;
  2167. return br.read(buf, len);
  2168. }
  2169. class decompressor;
  2170. enum class NoProxyKind {
  2171. Wildcard, // "*"
  2172. HostnameSuffix, // "example.com" or ".example.com"
  2173. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2174. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2175. };
  2176. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2177. // Lets one CIDR matcher cover both families.
  2178. using IPBytes = std::array<uint8_t, 16>;
  2179. struct NoProxyEntry {
  2180. NoProxyKind kind = NoProxyKind::Wildcard;
  2181. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2182. IPBytes net{};
  2183. int prefix_bits = 0;
  2184. };
  2185. struct NormalizedTarget {
  2186. std::string hostname; // lowercase; brackets and trailing dot removed
  2187. bool is_ipv4 = false;
  2188. bool is_ipv6 = false;
  2189. IPBytes ip{};
  2190. };
  2191. } // namespace detail
  2192. class ClientImpl {
  2193. public:
  2194. explicit ClientImpl(const std::string &host);
  2195. explicit ClientImpl(const std::string &host, int port);
  2196. explicit ClientImpl(const std::string &host, int port,
  2197. const std::string &client_cert_path,
  2198. const std::string &client_key_path);
  2199. virtual ~ClientImpl();
  2200. virtual bool is_valid() const;
  2201. struct StreamHandle {
  2202. std::unique_ptr<Response> response;
  2203. Error error = Error::Success;
  2204. StreamHandle() = default;
  2205. StreamHandle(const StreamHandle &) = delete;
  2206. StreamHandle &operator=(const StreamHandle &) = delete;
  2207. StreamHandle(StreamHandle &&) = default;
  2208. StreamHandle &operator=(StreamHandle &&) = default;
  2209. ~StreamHandle() = default;
  2210. bool is_valid() const {
  2211. return response != nullptr && error == Error::Success;
  2212. }
  2213. ssize_t read(char *buf, size_t len);
  2214. void parse_trailers_if_needed();
  2215. Error get_read_error() const { return body_reader_.last_error; }
  2216. bool has_read_error() const { return body_reader_.has_error(); }
  2217. bool trailers_parsed_ = false;
  2218. private:
  2219. friend class ClientImpl;
  2220. ssize_t read_with_decompression(char *buf, size_t len);
  2221. std::unique_ptr<ClientConnection> connection_;
  2222. std::unique_ptr<Stream> socket_stream_;
  2223. Stream *stream_ = nullptr;
  2224. detail::BodyReader body_reader_;
  2225. std::unique_ptr<detail::decompressor> decompressor_;
  2226. std::string decompress_buffer_;
  2227. size_t decompress_offset_ = 0;
  2228. size_t decompressed_bytes_read_ = 0;
  2229. };
  2230. // clang-format off
  2231. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2232. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2233. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2234. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2235. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2236. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2237. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2238. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2239. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2240. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2241. Result Head(const std::string &path);
  2242. Result Head(const std::string &path, const Headers &headers);
  2243. Result Post(const std::string &path);
  2244. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2245. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2246. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2247. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2248. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2249. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2250. Result Post(const std::string &path, const Params &params);
  2251. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2252. Result Post(const std::string &path, const Headers &headers);
  2253. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2254. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2255. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2256. 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);
  2257. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2258. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2259. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2260. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2261. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2262. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2263. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2264. Result Put(const std::string &path);
  2265. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2266. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2267. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2268. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2269. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2270. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2271. Result Put(const std::string &path, const Params &params);
  2272. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2273. Result Put(const std::string &path, const Headers &headers);
  2274. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2275. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2276. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2277. 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);
  2278. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2279. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2280. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2281. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2282. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2283. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2284. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2285. Result Patch(const std::string &path);
  2286. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2287. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2288. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2289. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2290. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2291. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2292. Result Patch(const std::string &path, const Params &params);
  2293. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2294. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2295. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2296. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2297. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2298. 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);
  2299. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2301. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2302. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2303. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2304. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2305. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2306. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2307. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2308. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2309. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2310. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2311. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2312. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2313. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2314. Result Options(const std::string &path);
  2315. Result Options(const std::string &path, const Headers &headers);
  2316. // clang-format on
  2317. // Streaming API: Open a stream for reading response body incrementally
  2318. // Socket ownership is transferred to StreamHandle for true streaming
  2319. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2320. StreamHandle open_stream(const std::string &method, const std::string &path,
  2321. const Params &params = {},
  2322. const Headers &headers = {},
  2323. const std::string &body = {},
  2324. const std::string &content_type = {});
  2325. bool send(Request &req, Response &res, Error &error);
  2326. Result send(const Request &req);
  2327. void stop();
  2328. std::string host() const;
  2329. int port() const;
  2330. size_t is_socket_open() const;
  2331. socket_t socket() const;
  2332. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2333. void set_default_headers(Headers headers);
  2334. void
  2335. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2336. void set_address_family(int family);
  2337. void set_tcp_nodelay(bool on);
  2338. void set_ipv6_v6only(bool on);
  2339. void set_socket_options(SocketOptions socket_options);
  2340. void set_connection_timeout(time_t sec, time_t usec = 0);
  2341. template <class Rep, class Period>
  2342. void
  2343. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2344. void set_read_timeout(time_t sec, time_t usec = 0);
  2345. template <class Rep, class Period>
  2346. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2347. void set_write_timeout(time_t sec, time_t usec = 0);
  2348. template <class Rep, class Period>
  2349. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2350. void set_max_timeout(time_t msec);
  2351. template <class Rep, class Period>
  2352. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2353. void set_basic_auth(const std::string &username, const std::string &password);
  2354. void set_bearer_token_auth(const std::string &token);
  2355. void set_keep_alive(bool on);
  2356. void set_follow_location(bool on);
  2357. void set_path_encode(bool on);
  2358. void set_compress(bool on);
  2359. void set_decompress(bool on);
  2360. void set_payload_max_length(size_t length);
  2361. void set_interface(const std::string &intf);
  2362. void set_proxy(const std::string &host, int port);
  2363. void set_proxy_basic_auth(const std::string &username,
  2364. const std::string &password);
  2365. void set_proxy_bearer_token_auth(const std::string &token);
  2366. void set_no_proxy(const std::vector<std::string> &patterns);
  2367. void set_logger(Logger logger);
  2368. void set_error_logger(ErrorLogger error_logger);
  2369. protected:
  2370. struct Socket {
  2371. socket_t sock = INVALID_SOCKET;
  2372. // For Mbed TLS compatibility: start_time for request timeout tracking
  2373. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2374. bool is_open() const { return sock != INVALID_SOCKET; }
  2375. #ifdef CPPHTTPLIB_SSL_ENABLED
  2376. tls::session_t ssl = nullptr;
  2377. #endif
  2378. };
  2379. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2380. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2381. virtual bool setup_proxy_connection(
  2382. Socket &socket,
  2383. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2384. Response &res, bool &success, Error &error);
  2385. bool is_proxy_enabled_for_host(const std::string &host) const;
  2386. // All of:
  2387. // shutdown_ssl
  2388. // shutdown_socket
  2389. // close_socket
  2390. // disconnect
  2391. // should ONLY be called when socket_mutex_ is locked, and only when
  2392. // no other thread is using the socket.
  2393. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2394. void shutdown_socket(Socket &socket) const;
  2395. void close_socket(Socket &socket);
  2396. void disconnect(bool gracefully);
  2397. bool process_request(Stream &strm, Request &req, Response &res,
  2398. bool close_connection, Error &error);
  2399. bool write_content_with_provider(Stream &strm, const Request &req,
  2400. Error &error) const;
  2401. void copy_settings(const ClientImpl &rhs);
  2402. void output_log(const Request &req, const Response &res) const;
  2403. void output_error_log(const Error &err, const Request *req) const;
  2404. // Socket endpoint information
  2405. const std::string host_;
  2406. const int port_;
  2407. // Current open socket
  2408. Socket socket_;
  2409. mutable std::mutex socket_mutex_;
  2410. std::recursive_mutex request_mutex_;
  2411. // These are all protected under socket_mutex
  2412. size_t socket_requests_in_flight_ = 0;
  2413. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2414. bool socket_should_be_closed_when_request_is_done_ = false;
  2415. // Hostname to connection target map. The value is an IP literal or another
  2416. // hostname; only the connection target changes, never the identity.
  2417. std::map<std::string, std::string> addr_map_;
  2418. // Default headers
  2419. Headers default_headers_;
  2420. // Header writer
  2421. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2422. detail::write_headers;
  2423. // Settings
  2424. std::string client_cert_path_;
  2425. std::string client_key_path_;
  2426. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2427. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2428. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2429. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2430. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2431. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2432. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2433. std::string basic_auth_username_;
  2434. std::string basic_auth_password_;
  2435. std::string bearer_token_auth_token_;
  2436. bool keep_alive_ = false;
  2437. bool follow_location_ = false;
  2438. bool path_encode_ = true;
  2439. int address_family_ = AF_UNSPEC;
  2440. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2441. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2442. SocketOptions socket_options_ = nullptr;
  2443. bool compress_ = false;
  2444. bool decompress_ = true;
  2445. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2446. bool has_payload_max_length_ = false;
  2447. std::string interface_;
  2448. std::string proxy_host_;
  2449. int proxy_port_ = -1;
  2450. std::string proxy_basic_auth_username_;
  2451. std::string proxy_basic_auth_password_;
  2452. std::string proxy_bearer_token_auth_token_;
  2453. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2454. mutable detail::NormalizedTarget host_normalized_;
  2455. mutable bool host_normalized_valid_ = false;
  2456. mutable std::mutex logger_mutex_;
  2457. Logger logger_;
  2458. ErrorLogger error_logger_;
  2459. private:
  2460. bool send_(Request &req, Response &res, Error &error);
  2461. Result send_(Request &&req);
  2462. socket_t create_client_socket(Error &error) const;
  2463. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2464. bool skip_100_continue = true) const;
  2465. bool write_request(Stream &strm, Request &req, bool close_connection,
  2466. Error &error, bool skip_body = false);
  2467. bool write_request_body(Stream &strm, Request &req, Error &error);
  2468. void prepare_default_headers(Request &r, bool for_stream,
  2469. const std::string &ct);
  2470. bool redirect(Request &req, Response &res, Error &error);
  2471. bool create_redirect_client(const std::string &scheme,
  2472. const std::string &host, int port, Request &req,
  2473. Response &res, const std::string &path,
  2474. const std::string &location, Error &error);
  2475. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2476. bool handle_request(Stream &strm, Request &req, Response &res,
  2477. bool close_connection, Error &error);
  2478. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2479. Request &req, const char *body, size_t content_length,
  2480. ContentProvider content_provider,
  2481. ContentProviderWithoutLength content_provider_without_length,
  2482. const std::string &content_type, ContentReceiver content_receiver,
  2483. Error &error);
  2484. Result send_with_content_provider_and_receiver(
  2485. const std::string &method, const std::string &path,
  2486. const Headers &headers, const char *body, size_t content_length,
  2487. ContentProvider content_provider,
  2488. ContentProviderWithoutLength content_provider_without_length,
  2489. const std::string &content_type, ContentReceiver content_receiver,
  2490. UploadProgress progress);
  2491. ContentProviderWithoutLength get_multipart_content_provider(
  2492. const std::string &boundary, const UploadFormDataItems &items,
  2493. const FormDataProviderItems &provider_items) const;
  2494. virtual bool
  2495. process_socket(const Socket &socket,
  2496. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2497. std::function<bool(Stream &strm)> callback);
  2498. virtual bool is_ssl() const;
  2499. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2500. #ifdef CPPHTTPLIB_SSL_ENABLED
  2501. public:
  2502. void set_digest_auth(const std::string &username,
  2503. const std::string &password);
  2504. void set_proxy_digest_auth(const std::string &username,
  2505. const std::string &password);
  2506. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2507. const std::string &ca_cert_dir_path = std::string());
  2508. void enable_server_certificate_verification(bool enabled);
  2509. void enable_server_hostname_verification(bool enabled);
  2510. void enable_system_ca(bool enabled);
  2511. protected:
  2512. std::string digest_auth_username_;
  2513. std::string digest_auth_password_;
  2514. std::string proxy_digest_auth_username_;
  2515. std::string proxy_digest_auth_password_;
  2516. std::string ca_cert_file_path_;
  2517. std::string ca_cert_dir_path_;
  2518. bool server_certificate_verification_ = true;
  2519. bool server_hostname_verification_ = true;
  2520. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2521. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2522. int last_ssl_error_ = 0;
  2523. uint64_t last_backend_error_ = 0;
  2524. #endif
  2525. };
  2526. class Client {
  2527. public:
  2528. // Universal interface
  2529. explicit Client(const std::string &scheme_host_port);
  2530. explicit Client(const std::string &scheme_host_port,
  2531. const std::string &client_cert_path,
  2532. const std::string &client_key_path);
  2533. // HTTP only interface
  2534. explicit Client(const std::string &host, int port);
  2535. explicit Client(const std::string &host, int port,
  2536. const std::string &client_cert_path,
  2537. const std::string &client_key_path);
  2538. Client(Client &&) = default;
  2539. Client &operator=(Client &&) = default;
  2540. ~Client();
  2541. bool is_valid() const;
  2542. // clang-format off
  2543. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2544. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2545. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2546. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2547. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2548. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2549. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2550. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2551. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2552. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2553. Result Head(const std::string &path);
  2554. Result Head(const std::string &path, const Headers &headers);
  2555. Result Post(const std::string &path);
  2556. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2557. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2558. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2559. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2560. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2561. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2562. Result Post(const std::string &path, const Params &params);
  2563. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2564. Result Post(const std::string &path, const Headers &headers);
  2565. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2566. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2567. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2568. 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);
  2569. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2570. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2571. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2572. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2573. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2574. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2575. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2576. Result Put(const std::string &path);
  2577. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2578. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2579. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2580. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2581. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2582. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2583. Result Put(const std::string &path, const Params &params);
  2584. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2585. Result Put(const std::string &path, const Headers &headers);
  2586. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2587. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2588. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2589. 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);
  2590. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2591. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2592. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2593. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2594. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2595. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2596. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2597. Result Patch(const std::string &path);
  2598. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2599. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2600. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2601. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2602. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2603. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2604. Result Patch(const std::string &path, const Params &params);
  2605. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2606. Result Patch(const std::string &path, const Headers &headers);
  2607. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2608. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2609. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2610. 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);
  2611. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2613. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2614. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2615. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2616. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2617. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2618. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2619. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2620. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2621. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2622. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2623. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2624. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2625. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2626. Result Options(const std::string &path);
  2627. Result Options(const std::string &path, const Headers &headers);
  2628. // clang-format on
  2629. // Streaming API: Open a stream for reading response body incrementally
  2630. // Socket ownership is transferred to StreamHandle for true streaming
  2631. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2632. ClientImpl::StreamHandle open_stream(const std::string &method,
  2633. const std::string &path,
  2634. const Params &params = {},
  2635. const Headers &headers = {},
  2636. const std::string &body = {},
  2637. const std::string &content_type = {});
  2638. bool send(Request &req, Response &res, Error &error);
  2639. Result send(const Request &req);
  2640. void stop();
  2641. std::string host() const;
  2642. int port() const;
  2643. size_t is_socket_open() const;
  2644. socket_t socket() const;
  2645. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2646. void set_default_headers(Headers headers);
  2647. void
  2648. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2649. void set_address_family(int family);
  2650. void set_tcp_nodelay(bool on);
  2651. void set_socket_options(SocketOptions socket_options);
  2652. void set_connection_timeout(time_t sec, time_t usec = 0);
  2653. template <class Rep, class Period>
  2654. void
  2655. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2656. void set_read_timeout(time_t sec, time_t usec = 0);
  2657. template <class Rep, class Period>
  2658. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2659. void set_write_timeout(time_t sec, time_t usec = 0);
  2660. template <class Rep, class Period>
  2661. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2662. void set_max_timeout(time_t msec);
  2663. template <class Rep, class Period>
  2664. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2665. void set_basic_auth(const std::string &username, const std::string &password);
  2666. void set_bearer_token_auth(const std::string &token);
  2667. void set_keep_alive(bool on);
  2668. void set_follow_location(bool on);
  2669. void set_path_encode(bool on);
  2670. void set_compress(bool on);
  2671. void set_decompress(bool on);
  2672. void set_payload_max_length(size_t length);
  2673. void set_interface(const std::string &intf);
  2674. void set_proxy(const std::string &host, int port);
  2675. void set_proxy_basic_auth(const std::string &username,
  2676. const std::string &password);
  2677. void set_proxy_bearer_token_auth(const std::string &token);
  2678. void set_no_proxy(const std::vector<std::string> &patterns);
  2679. void set_logger(Logger logger);
  2680. void set_error_logger(ErrorLogger error_logger);
  2681. private:
  2682. std::unique_ptr<ClientImpl> cli_;
  2683. #ifdef CPPHTTPLIB_SSL_ENABLED
  2684. public:
  2685. void set_digest_auth(const std::string &username,
  2686. const std::string &password);
  2687. void set_proxy_digest_auth(const std::string &username,
  2688. const std::string &password);
  2689. void enable_server_certificate_verification(bool enabled);
  2690. void enable_server_hostname_verification(bool enabled);
  2691. void enable_system_ca(bool enabled);
  2692. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2693. const std::string &ca_cert_dir_path = std::string());
  2694. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2695. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2696. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2697. void set_session_verifier(
  2698. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2699. tls::ctx_t tls_context() const;
  2700. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2701. void enable_windows_certificate_verification(bool enabled);
  2702. #endif
  2703. private:
  2704. bool is_ssl_ = false;
  2705. #endif
  2706. };
  2707. #ifdef CPPHTTPLIB_SSL_ENABLED
  2708. class SSLServer : public Server {
  2709. public:
  2710. SSLServer(const char *cert_path, const char *private_key_path,
  2711. const char *client_ca_cert_file_path = nullptr,
  2712. const char *client_ca_cert_dir_path = nullptr,
  2713. const char *private_key_password = nullptr);
  2714. struct PemMemory {
  2715. const char *cert_pem;
  2716. size_t cert_pem_len;
  2717. const char *key_pem;
  2718. size_t key_pem_len;
  2719. const char *client_ca_pem;
  2720. size_t client_ca_pem_len;
  2721. const char *private_key_password;
  2722. };
  2723. explicit SSLServer(const PemMemory &pem);
  2724. // The callback receives the ctx_t handle which can be cast to the
  2725. // appropriate backend type (SSL_CTX* for OpenSSL,
  2726. // tls::impl::MbedTlsContext* for Mbed TLS)
  2727. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2728. ~SSLServer() override;
  2729. bool is_valid() const override;
  2730. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2731. const char *client_ca_pem = nullptr,
  2732. const char *password = nullptr);
  2733. tls::ctx_t tls_context() const { return ctx_; }
  2734. int ssl_last_error() const { return last_ssl_error_; }
  2735. private:
  2736. bool process_and_close_socket(socket_t sock) override;
  2737. tls::ctx_t ctx_ = nullptr;
  2738. std::mutex ctx_mutex_;
  2739. int last_ssl_error_ = 0;
  2740. };
  2741. class SSLClient final : public ClientImpl {
  2742. public:
  2743. explicit SSLClient(const std::string &host);
  2744. explicit SSLClient(const std::string &host, int port);
  2745. explicit SSLClient(const std::string &host, int port,
  2746. const std::string &client_cert_path,
  2747. const std::string &client_key_path,
  2748. const std::string &private_key_password = std::string());
  2749. struct PemMemory {
  2750. const char *cert_pem;
  2751. size_t cert_pem_len;
  2752. const char *key_pem;
  2753. size_t key_pem_len;
  2754. const char *private_key_password;
  2755. };
  2756. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2757. ~SSLClient() override;
  2758. bool is_valid() const override;
  2759. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2760. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2761. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2762. // Post-handshake session verifier (backend-independent)
  2763. void set_session_verifier(
  2764. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2765. tls::ctx_t tls_context() const { return ctx_; }
  2766. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2767. void enable_windows_certificate_verification(bool enabled);
  2768. #endif
  2769. private:
  2770. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2771. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2772. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2773. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2774. bool
  2775. process_socket(const Socket &socket,
  2776. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2777. std::function<bool(Stream &strm)> callback) override;
  2778. bool is_ssl() const override;
  2779. bool setup_proxy_connection(
  2780. Socket &socket,
  2781. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2782. Response &res, bool &success, Error &error) override;
  2783. bool connect_with_proxy(
  2784. Socket &sock,
  2785. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2786. Response &res, bool &success, Error &error);
  2787. bool initialize_ssl(Socket &socket, Error &error);
  2788. void init_ctx();
  2789. void reset_ctx_on_error();
  2790. bool load_certs();
  2791. tls::ctx_t ctx_ = nullptr;
  2792. std::mutex ctx_mutex_;
  2793. std::once_flag initialize_cert_;
  2794. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2795. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2796. // Used to keep custom CA configuration exclusive with system CA loading.
  2797. bool ca_cert_store_set_ = false;
  2798. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2799. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2800. bool enable_windows_cert_verification_ = true;
  2801. #endif
  2802. friend class ClientImpl;
  2803. };
  2804. #endif // CPPHTTPLIB_SSL_ENABLED
  2805. namespace detail {
  2806. template <typename T, typename U>
  2807. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2808. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2809. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2810. duration - std::chrono::seconds(sec))
  2811. .count();
  2812. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2813. }
  2814. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2815. return N - 1;
  2816. }
  2817. inline bool is_numeric(const std::string &str) {
  2818. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2819. }
  2820. inline size_t get_header_value_u64(const Headers &headers,
  2821. const std::string &key, size_t def,
  2822. size_t id, bool &is_invalid_value) {
  2823. is_invalid_value = false;
  2824. auto rng = headers.equal_range(key);
  2825. auto it = rng.first;
  2826. std::advance(it, static_cast<ssize_t>(id));
  2827. if (it != rng.second) {
  2828. if (is_numeric(it->second)) {
  2829. // Parse at size_t width so an out-of-range Content-Length is reported
  2830. // rather than silently saturated/truncated (a value above 2^32 would
  2831. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2832. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2833. size_t val = 0;
  2834. const auto &s = it->second;
  2835. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2836. if (r.ec == std::errc::result_out_of_range) {
  2837. is_invalid_value = true;
  2838. return (std::numeric_limits<size_t>::max)();
  2839. }
  2840. return val;
  2841. } else {
  2842. is_invalid_value = true;
  2843. }
  2844. }
  2845. return def;
  2846. }
  2847. inline size_t get_header_value_u64(const Headers &headers,
  2848. const std::string &key, size_t def,
  2849. size_t id) {
  2850. auto dummy = false;
  2851. return get_header_value_u64(headers, key, def, id, dummy);
  2852. }
  2853. } // namespace detail
  2854. template <class Rep, class Period>
  2855. inline Server &
  2856. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2857. detail::duration_to_sec_and_usec(
  2858. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2859. return *this;
  2860. }
  2861. template <class Rep, class Period>
  2862. inline Server &
  2863. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2864. detail::duration_to_sec_and_usec(
  2865. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2866. return *this;
  2867. }
  2868. template <class Rep, class Period>
  2869. inline Server &
  2870. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2871. detail::duration_to_sec_and_usec(
  2872. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2873. return *this;
  2874. }
  2875. template <class Rep, class Period>
  2876. inline void ClientImpl::set_connection_timeout(
  2877. const std::chrono::duration<Rep, Period> &duration) {
  2878. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2879. set_connection_timeout(sec, usec);
  2880. });
  2881. }
  2882. template <class Rep, class Period>
  2883. inline void ClientImpl::set_read_timeout(
  2884. const std::chrono::duration<Rep, Period> &duration) {
  2885. detail::duration_to_sec_and_usec(
  2886. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2887. }
  2888. template <class Rep, class Period>
  2889. inline void ClientImpl::set_write_timeout(
  2890. const std::chrono::duration<Rep, Period> &duration) {
  2891. detail::duration_to_sec_and_usec(
  2892. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2893. }
  2894. template <class Rep, class Period>
  2895. inline void ClientImpl::set_max_timeout(
  2896. const std::chrono::duration<Rep, Period> &duration) {
  2897. auto msec =
  2898. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2899. set_max_timeout(msec);
  2900. }
  2901. template <class Rep, class Period>
  2902. inline void Client::set_connection_timeout(
  2903. const std::chrono::duration<Rep, Period> &duration) {
  2904. cli_->set_connection_timeout(duration);
  2905. }
  2906. template <class Rep, class Period>
  2907. inline void
  2908. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2909. cli_->set_read_timeout(duration);
  2910. }
  2911. template <class Rep, class Period>
  2912. inline void
  2913. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2914. cli_->set_write_timeout(duration);
  2915. }
  2916. inline void Client::set_max_timeout(time_t msec) {
  2917. cli_->set_max_timeout(msec);
  2918. }
  2919. template <class Rep, class Period>
  2920. inline void
  2921. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2922. cli_->set_max_timeout(duration);
  2923. }
  2924. /*
  2925. * Forward declarations and types that will be part of the .h file if split into
  2926. * .h + .cc.
  2927. */
  2928. std::string hosted_at(const std::string &hostname);
  2929. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2930. // JavaScript-style URL encoding/decoding functions
  2931. std::string encode_uri_component(const std::string &value);
  2932. std::string encode_uri(const std::string &value);
  2933. std::string decode_uri_component(const std::string &value);
  2934. std::string decode_uri(const std::string &value);
  2935. // RFC 3986 compliant URL component encoding/decoding functions
  2936. std::string encode_path_component(const std::string &component);
  2937. std::string decode_path_component(const std::string &component);
  2938. std::string encode_query_component(const std::string &component,
  2939. bool space_as_plus = true);
  2940. std::string decode_query_component(const std::string &component,
  2941. bool plus_as_space = true);
  2942. std::string sanitize_filename(const std::string &filename);
  2943. std::string append_query_params(const std::string &path, const Params &params);
  2944. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2945. std::pair<std::string, std::string>
  2946. make_basic_authentication_header(const std::string &username,
  2947. const std::string &password,
  2948. bool is_proxy = false);
  2949. namespace detail {
  2950. #if defined(_WIN32)
  2951. inline std::wstring u8string_to_wstring(const char *s) {
  2952. if (!s) { return std::wstring(); }
  2953. auto len = static_cast<int>(strlen(s));
  2954. if (!len) { return std::wstring(); }
  2955. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2956. if (!wlen) { return std::wstring(); }
  2957. std::wstring ws;
  2958. ws.resize(wlen);
  2959. wlen = ::MultiByteToWideChar(
  2960. CP_UTF8, 0, s, len,
  2961. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  2962. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  2963. return ws;
  2964. }
  2965. #endif
  2966. struct FileStat {
  2967. FileStat(const std::string &path);
  2968. bool is_file() const;
  2969. bool is_dir() const;
  2970. time_t mtime() const;
  2971. size_t size() const;
  2972. private:
  2973. #if defined(_WIN32)
  2974. struct _stat st_;
  2975. #else
  2976. struct stat st_;
  2977. #endif
  2978. int ret_ = -1;
  2979. };
  2980. std::string make_host_and_port_string(const std::string &host, int port,
  2981. bool is_ssl);
  2982. template <typename T>
  2983. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  2984. Error &error);
  2985. std::string trim_copy(const std::string &s);
  2986. void divide(
  2987. const char *data, std::size_t size, char d,
  2988. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2989. fn);
  2990. void divide(
  2991. const std::string &str, char d,
  2992. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2993. fn);
  2994. void split(const char *b, const char *e, char d,
  2995. std::function<void(const char *, const char *)> fn);
  2996. void split(const char *b, const char *e, char d, size_t m,
  2997. std::function<void(const char *, const char *)> fn);
  2998. bool split_find(const char *b, const char *e, char d,
  2999. std::function<bool(const char *, const char *)> fn);
  3000. bool has_header_token(const Headers &headers, const std::string &key,
  3001. const std::string &token);
  3002. std::string websocket_accept_key(const std::string &client_key);
  3003. bool is_websocket_upgrade(const Request &req);
  3004. bool process_client_socket(
  3005. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3006. time_t write_timeout_sec, time_t write_timeout_usec,
  3007. time_t max_timeout_msec,
  3008. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3009. std::function<bool(Stream &)> callback);
  3010. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3011. int port, int address_family, bool tcp_nodelay,
  3012. bool ipv6_v6only, SocketOptions socket_options,
  3013. time_t connection_timeout_sec,
  3014. time_t connection_timeout_usec,
  3015. time_t read_timeout_sec, time_t read_timeout_usec,
  3016. time_t write_timeout_sec,
  3017. time_t write_timeout_usec,
  3018. const std::string &intf, Error &error);
  3019. const char *get_header_value(const Headers &headers, const std::string &key,
  3020. const char *def, size_t id);
  3021. std::string get_combined_header_value(const Headers &headers,
  3022. const std::string &key);
  3023. std::string params_to_query_str(const Params &params);
  3024. void parse_query_text(const char *data, std::size_t size, Params &params);
  3025. void parse_query_text(const std::string &s, Params &params);
  3026. bool parse_multipart_boundary(const std::string &content_type,
  3027. std::string &boundary);
  3028. bool parse_range_header(const std::string &s, Ranges &ranges);
  3029. bool parse_accept_header(const std::string &s,
  3030. std::vector<std::string> &content_types);
  3031. void parse_disposition_params(const std::string &s, Params &params);
  3032. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3033. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3034. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3035. EncodingType encoding_type(const Request &req, const Response &res,
  3036. const std::string &content_type);
  3037. EncodingType encoding_type(const Request &req, const Response &res);
  3038. class BufferStream final : public Stream {
  3039. public:
  3040. BufferStream() = default;
  3041. ~BufferStream() override = default;
  3042. bool is_readable() const override;
  3043. bool wait_readable() const override;
  3044. bool wait_writable() const override;
  3045. ssize_t read(char *ptr, size_t size) override;
  3046. ssize_t write(const char *ptr, size_t size) override;
  3047. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3048. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3049. socket_t socket() const override;
  3050. time_t duration() const override;
  3051. const std::string &get_buffer() const;
  3052. private:
  3053. std::string buffer;
  3054. size_t position = 0;
  3055. };
  3056. class compressor {
  3057. public:
  3058. virtual ~compressor() = default;
  3059. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3060. virtual bool compress(const char *data, size_t data_length, bool last,
  3061. Callback callback) = 0;
  3062. };
  3063. class decompressor {
  3064. public:
  3065. virtual ~decompressor() = default;
  3066. virtual bool is_valid() const = 0;
  3067. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3068. virtual bool decompress(const char *data, size_t data_length,
  3069. Callback callback) = 0;
  3070. };
  3071. class nocompressor final : public compressor {
  3072. public:
  3073. ~nocompressor() override = default;
  3074. bool compress(const char *data, size_t data_length, bool /*last*/,
  3075. Callback callback) override;
  3076. };
  3077. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3078. class gzip_compressor final : public compressor {
  3079. public:
  3080. gzip_compressor();
  3081. ~gzip_compressor() override;
  3082. bool compress(const char *data, size_t data_length, bool last,
  3083. Callback callback) override;
  3084. private:
  3085. bool is_valid_ = false;
  3086. z_stream strm_;
  3087. };
  3088. class gzip_decompressor final : public decompressor {
  3089. public:
  3090. gzip_decompressor();
  3091. ~gzip_decompressor() override;
  3092. bool is_valid() const override;
  3093. bool decompress(const char *data, size_t data_length,
  3094. Callback callback) override;
  3095. private:
  3096. bool is_valid_ = false;
  3097. z_stream strm_;
  3098. };
  3099. #endif
  3100. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3101. class brotli_compressor final : public compressor {
  3102. public:
  3103. brotli_compressor();
  3104. ~brotli_compressor();
  3105. bool compress(const char *data, size_t data_length, bool last,
  3106. Callback callback) override;
  3107. private:
  3108. BrotliEncoderState *state_ = nullptr;
  3109. };
  3110. class brotli_decompressor final : public decompressor {
  3111. public:
  3112. brotli_decompressor();
  3113. ~brotli_decompressor();
  3114. bool is_valid() const override;
  3115. bool decompress(const char *data, size_t data_length,
  3116. Callback callback) override;
  3117. private:
  3118. BrotliDecoderResult decoder_r;
  3119. BrotliDecoderState *decoder_s = nullptr;
  3120. };
  3121. #endif
  3122. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3123. class zstd_compressor : public compressor {
  3124. public:
  3125. zstd_compressor();
  3126. ~zstd_compressor();
  3127. bool compress(const char *data, size_t data_length, bool last,
  3128. Callback callback) override;
  3129. private:
  3130. ZSTD_CCtx *ctx_ = nullptr;
  3131. };
  3132. class zstd_decompressor : public decompressor {
  3133. public:
  3134. zstd_decompressor();
  3135. ~zstd_decompressor();
  3136. bool is_valid() const override;
  3137. bool decompress(const char *data, size_t data_length,
  3138. Callback callback) override;
  3139. private:
  3140. ZSTD_DCtx *ctx_ = nullptr;
  3141. };
  3142. #endif
  3143. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3144. // to store data. The call can set memory on stack for performance.
  3145. class stream_line_reader {
  3146. public:
  3147. stream_line_reader(Stream &strm, char *fixed_buffer,
  3148. size_t fixed_buffer_size);
  3149. const char *ptr() const;
  3150. size_t size() const;
  3151. bool end_with_crlf() const;
  3152. bool getline();
  3153. private:
  3154. void append(char c);
  3155. void append(const char *data, size_t size);
  3156. Stream &strm_;
  3157. char *fixed_buffer_;
  3158. const size_t fixed_buffer_size_;
  3159. size_t fixed_buffer_used_size_ = 0;
  3160. std::string growable_buffer_;
  3161. };
  3162. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3163. const Headers &src_headers);
  3164. struct ChunkedDecoder {
  3165. Stream &strm;
  3166. size_t chunk_remaining = 0;
  3167. bool finished = false;
  3168. char line_buf[64];
  3169. size_t last_chunk_total = 0;
  3170. size_t last_chunk_offset = 0;
  3171. explicit ChunkedDecoder(Stream &s);
  3172. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3173. size_t &out_chunk_total);
  3174. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3175. };
  3176. class mmap {
  3177. public:
  3178. mmap(const char *path);
  3179. ~mmap();
  3180. bool open(const char *path);
  3181. void close();
  3182. bool is_open() const;
  3183. size_t size() const;
  3184. const char *data() const;
  3185. private:
  3186. #if defined(_WIN32)
  3187. HANDLE hFile_ = NULL;
  3188. HANDLE hMapping_ = NULL;
  3189. #else
  3190. int fd_ = -1;
  3191. #endif
  3192. size_t size_ = 0;
  3193. void *addr_ = nullptr;
  3194. bool is_open_empty_file = false;
  3195. };
  3196. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3197. namespace fields {
  3198. bool is_token_char(char c);
  3199. bool is_token(const std::string &s);
  3200. bool is_field_name(const std::string &s);
  3201. bool is_vchar(char c);
  3202. bool is_obs_text(char c);
  3203. bool is_field_vchar(char c);
  3204. bool is_field_content(const std::string &s);
  3205. bool is_field_value(const std::string &s);
  3206. bool is_field_valid(const std::string &name, const std::string &value);
  3207. } // namespace fields
  3208. } // namespace detail
  3209. /*
  3210. * TLS Abstraction Layer Declarations
  3211. */
  3212. #ifdef CPPHTTPLIB_SSL_ENABLED
  3213. // TLS abstraction layer - backend-specific type declarations
  3214. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3215. namespace tls {
  3216. namespace impl {
  3217. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3218. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3219. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3220. struct MbedTlsContext {
  3221. mbedtls_ssl_config conf;
  3222. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3223. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3224. mbedtls_entropy_context entropy;
  3225. mbedtls_ctr_drbg_context ctr_drbg;
  3226. #endif
  3227. mbedtls_x509_crt ca_chain;
  3228. mbedtls_x509_crt own_cert;
  3229. mbedtls_pk_context own_key;
  3230. bool is_server = false;
  3231. bool verify_client = false;
  3232. bool has_verify_callback = false;
  3233. MbedTlsContext();
  3234. ~MbedTlsContext();
  3235. MbedTlsContext(const MbedTlsContext &) = delete;
  3236. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3237. };
  3238. } // namespace impl
  3239. } // namespace tls
  3240. #endif
  3241. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3242. namespace tls {
  3243. namespace impl {
  3244. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3245. // This struct is accessible via tls::impl for use in SSL context
  3246. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3247. struct WolfSSLContext {
  3248. WOLFSSL_CTX *ctx = nullptr;
  3249. bool is_server = false;
  3250. bool verify_client = false;
  3251. bool has_verify_callback = false;
  3252. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3253. WolfSSLContext();
  3254. ~WolfSSLContext();
  3255. WolfSSLContext(const WolfSSLContext &) = delete;
  3256. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3257. };
  3258. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3259. struct WolfSSLCAStore {
  3260. std::string pem_data;
  3261. };
  3262. } // namespace impl
  3263. } // namespace tls
  3264. #endif
  3265. #endif // CPPHTTPLIB_SSL_ENABLED
  3266. namespace stream {
  3267. class Result {
  3268. public:
  3269. Result();
  3270. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3271. Result(Result &&other) noexcept;
  3272. Result &operator=(Result &&other) noexcept;
  3273. Result(const Result &) = delete;
  3274. Result &operator=(const Result &) = delete;
  3275. // Response info
  3276. bool is_valid() const;
  3277. explicit operator bool() const;
  3278. int status() const;
  3279. const Headers &headers() const;
  3280. std::string get_header_value(const std::string &key,
  3281. const char *def = "") const;
  3282. bool has_header(const std::string &key) const;
  3283. Error error() const;
  3284. Error read_error() const;
  3285. bool has_read_error() const;
  3286. // Stream reading
  3287. bool next();
  3288. const char *data() const;
  3289. size_t size() const;
  3290. std::string read_all();
  3291. private:
  3292. ClientImpl::StreamHandle handle_;
  3293. std::string buffer_;
  3294. size_t current_size_ = 0;
  3295. size_t chunk_size_;
  3296. bool finished_ = false;
  3297. };
  3298. // GET
  3299. template <typename ClientType>
  3300. inline Result Get(ClientType &cli, const std::string &path,
  3301. size_t chunk_size = 8192) {
  3302. return Result{cli.open_stream("GET", path), chunk_size};
  3303. }
  3304. template <typename ClientType>
  3305. inline Result Get(ClientType &cli, const std::string &path,
  3306. const Headers &headers, size_t chunk_size = 8192) {
  3307. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3308. }
  3309. template <typename ClientType>
  3310. inline Result Get(ClientType &cli, const std::string &path,
  3311. const Params &params, size_t chunk_size = 8192) {
  3312. return Result{cli.open_stream("GET", path, params), chunk_size};
  3313. }
  3314. template <typename ClientType>
  3315. inline Result Get(ClientType &cli, const std::string &path,
  3316. const Params &params, const Headers &headers,
  3317. size_t chunk_size = 8192) {
  3318. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3319. }
  3320. // POST
  3321. template <typename ClientType>
  3322. inline Result Post(ClientType &cli, const std::string &path,
  3323. const std::string &body, const std::string &content_type,
  3324. size_t chunk_size = 8192) {
  3325. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3326. chunk_size};
  3327. }
  3328. template <typename ClientType>
  3329. inline Result Post(ClientType &cli, const std::string &path,
  3330. const Headers &headers, const std::string &body,
  3331. const std::string &content_type, size_t chunk_size = 8192) {
  3332. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3333. chunk_size};
  3334. }
  3335. template <typename ClientType>
  3336. inline Result Post(ClientType &cli, const std::string &path,
  3337. const Params &params, const std::string &body,
  3338. const std::string &content_type, size_t chunk_size = 8192) {
  3339. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3340. chunk_size};
  3341. }
  3342. template <typename ClientType>
  3343. inline Result Post(ClientType &cli, const std::string &path,
  3344. const Params &params, const Headers &headers,
  3345. const std::string &body, const std::string &content_type,
  3346. size_t chunk_size = 8192) {
  3347. return Result{
  3348. cli.open_stream("POST", path, params, headers, body, content_type),
  3349. chunk_size};
  3350. }
  3351. // PUT
  3352. template <typename ClientType>
  3353. inline Result Put(ClientType &cli, const std::string &path,
  3354. const std::string &body, const std::string &content_type,
  3355. size_t chunk_size = 8192) {
  3356. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3357. chunk_size};
  3358. }
  3359. template <typename ClientType>
  3360. inline Result Put(ClientType &cli, const std::string &path,
  3361. const Headers &headers, const std::string &body,
  3362. const std::string &content_type, size_t chunk_size = 8192) {
  3363. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3364. chunk_size};
  3365. }
  3366. template <typename ClientType>
  3367. inline Result Put(ClientType &cli, const std::string &path,
  3368. const Params &params, const std::string &body,
  3369. const std::string &content_type, size_t chunk_size = 8192) {
  3370. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3371. chunk_size};
  3372. }
  3373. template <typename ClientType>
  3374. inline Result Put(ClientType &cli, const std::string &path,
  3375. const Params &params, const Headers &headers,
  3376. const std::string &body, const std::string &content_type,
  3377. size_t chunk_size = 8192) {
  3378. return Result{
  3379. cli.open_stream("PUT", path, params, headers, body, content_type),
  3380. chunk_size};
  3381. }
  3382. // PATCH
  3383. template <typename ClientType>
  3384. inline Result Patch(ClientType &cli, const std::string &path,
  3385. const std::string &body, const std::string &content_type,
  3386. size_t chunk_size = 8192) {
  3387. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3388. chunk_size};
  3389. }
  3390. template <typename ClientType>
  3391. inline Result Patch(ClientType &cli, const std::string &path,
  3392. const Headers &headers, const std::string &body,
  3393. const std::string &content_type, size_t chunk_size = 8192) {
  3394. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3395. chunk_size};
  3396. }
  3397. template <typename ClientType>
  3398. inline Result Patch(ClientType &cli, const std::string &path,
  3399. const Params &params, const std::string &body,
  3400. const std::string &content_type, size_t chunk_size = 8192) {
  3401. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3402. chunk_size};
  3403. }
  3404. template <typename ClientType>
  3405. inline Result Patch(ClientType &cli, const std::string &path,
  3406. const Params &params, const Headers &headers,
  3407. const std::string &body, const std::string &content_type,
  3408. size_t chunk_size = 8192) {
  3409. return Result{
  3410. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3411. chunk_size};
  3412. }
  3413. // DELETE
  3414. template <typename ClientType>
  3415. inline Result Delete(ClientType &cli, const std::string &path,
  3416. size_t chunk_size = 8192) {
  3417. return Result{cli.open_stream("DELETE", path), chunk_size};
  3418. }
  3419. template <typename ClientType>
  3420. inline Result Delete(ClientType &cli, const std::string &path,
  3421. const Headers &headers, size_t chunk_size = 8192) {
  3422. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3423. }
  3424. template <typename ClientType>
  3425. inline Result Delete(ClientType &cli, const std::string &path,
  3426. const std::string &body, const std::string &content_type,
  3427. size_t chunk_size = 8192) {
  3428. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3429. chunk_size};
  3430. }
  3431. template <typename ClientType>
  3432. inline Result Delete(ClientType &cli, const std::string &path,
  3433. const Headers &headers, const std::string &body,
  3434. const std::string &content_type,
  3435. size_t chunk_size = 8192) {
  3436. return Result{
  3437. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Delete(ClientType &cli, const std::string &path,
  3442. const Params &params, size_t chunk_size = 8192) {
  3443. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3444. }
  3445. template <typename ClientType>
  3446. inline Result Delete(ClientType &cli, const std::string &path,
  3447. const Params &params, const Headers &headers,
  3448. size_t chunk_size = 8192) {
  3449. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3450. }
  3451. template <typename ClientType>
  3452. inline Result Delete(ClientType &cli, const std::string &path,
  3453. const Params &params, const std::string &body,
  3454. const std::string &content_type,
  3455. size_t chunk_size = 8192) {
  3456. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3457. chunk_size};
  3458. }
  3459. template <typename ClientType>
  3460. inline Result Delete(ClientType &cli, const std::string &path,
  3461. const Params &params, const Headers &headers,
  3462. const std::string &body, const std::string &content_type,
  3463. size_t chunk_size = 8192) {
  3464. return Result{
  3465. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3466. chunk_size};
  3467. }
  3468. // HEAD
  3469. template <typename ClientType>
  3470. inline Result Head(ClientType &cli, const std::string &path,
  3471. size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("HEAD", path), chunk_size};
  3473. }
  3474. template <typename ClientType>
  3475. inline Result Head(ClientType &cli, const std::string &path,
  3476. const Headers &headers, size_t chunk_size = 8192) {
  3477. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3478. }
  3479. template <typename ClientType>
  3480. inline Result Head(ClientType &cli, const std::string &path,
  3481. const Params &params, size_t chunk_size = 8192) {
  3482. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3483. }
  3484. template <typename ClientType>
  3485. inline Result Head(ClientType &cli, const std::string &path,
  3486. const Params &params, const Headers &headers,
  3487. size_t chunk_size = 8192) {
  3488. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3489. }
  3490. // OPTIONS
  3491. template <typename ClientType>
  3492. inline Result Options(ClientType &cli, const std::string &path,
  3493. size_t chunk_size = 8192) {
  3494. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3495. }
  3496. template <typename ClientType>
  3497. inline Result Options(ClientType &cli, const std::string &path,
  3498. const Headers &headers, size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Options(ClientType &cli, const std::string &path,
  3503. const Params &params, size_t chunk_size = 8192) {
  3504. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3505. }
  3506. template <typename ClientType>
  3507. inline Result Options(ClientType &cli, const std::string &path,
  3508. const Params &params, const Headers &headers,
  3509. size_t chunk_size = 8192) {
  3510. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3511. }
  3512. } // namespace stream
  3513. namespace sse {
  3514. struct SSEMessage {
  3515. std::string event; // Event type (default: "message")
  3516. std::string data; // Event payload
  3517. std::string id; // Event ID for Last-Event-ID header
  3518. SSEMessage();
  3519. void clear();
  3520. };
  3521. class SSEClient {
  3522. public:
  3523. using MessageHandler = std::function<void(const SSEMessage &)>;
  3524. using ErrorHandler = std::function<void(Error)>;
  3525. using OpenHandler = std::function<void()>;
  3526. SSEClient(Client &client, const std::string &path);
  3527. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3528. ~SSEClient();
  3529. SSEClient(const SSEClient &) = delete;
  3530. SSEClient &operator=(const SSEClient &) = delete;
  3531. // Event handlers
  3532. SSEClient &on_message(MessageHandler handler);
  3533. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3534. SSEClient &on_open(OpenHandler handler);
  3535. SSEClient &on_error(ErrorHandler handler);
  3536. SSEClient &set_reconnect_interval(int ms);
  3537. SSEClient &set_max_reconnect_attempts(int n);
  3538. // Update headers (thread-safe)
  3539. SSEClient &set_headers(const Headers &headers);
  3540. // State accessors
  3541. bool is_connected() const;
  3542. const std::string &last_event_id() const;
  3543. // Blocking start - runs event loop with auto-reconnect
  3544. void start();
  3545. // Non-blocking start - runs in background thread
  3546. void start_async();
  3547. // Stop the client (thread-safe)
  3548. void stop();
  3549. private:
  3550. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3551. void run_event_loop();
  3552. void dispatch_event(const SSEMessage &msg);
  3553. bool should_reconnect(int count) const;
  3554. void wait_for_reconnect();
  3555. // Client and path
  3556. Client &client_;
  3557. std::string path_;
  3558. Headers headers_;
  3559. mutable std::mutex headers_mutex_;
  3560. // Callbacks
  3561. MessageHandler on_message_;
  3562. std::map<std::string, MessageHandler> event_handlers_;
  3563. OpenHandler on_open_;
  3564. ErrorHandler on_error_;
  3565. // Configuration
  3566. int reconnect_interval_ms_ = 3000;
  3567. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3568. // State
  3569. std::atomic<bool> running_{false};
  3570. std::atomic<bool> connected_{false};
  3571. std::string last_event_id_;
  3572. // Async support
  3573. std::thread async_thread_;
  3574. };
  3575. } // namespace sse
  3576. namespace ws {
  3577. enum class Opcode : uint8_t {
  3578. Continuation = 0x0,
  3579. Text = 0x1,
  3580. Binary = 0x2,
  3581. Close = 0x8,
  3582. Ping = 0x9,
  3583. Pong = 0xA,
  3584. };
  3585. enum class CloseStatus : uint16_t {
  3586. Normal = 1000,
  3587. GoingAway = 1001,
  3588. ProtocolError = 1002,
  3589. UnsupportedData = 1003,
  3590. NoStatus = 1005,
  3591. Abnormal = 1006,
  3592. InvalidPayload = 1007,
  3593. PolicyViolation = 1008,
  3594. MessageTooBig = 1009,
  3595. MandatoryExtension = 1010,
  3596. InternalError = 1011,
  3597. };
  3598. // Timeout is returned only when a read timeout was set and it elapsed before
  3599. // any byte of a frame arrived: nothing was consumed and the connection is
  3600. // still open, so the caller can send on it and read again. `msg` is left
  3601. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3602. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3603. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3604. // upgrade handshake fully succeeded. On failure error() identifies the
  3605. // failing layer; status()/headers() expose the server's upgrade response
  3606. // when one was received (status() is -1 otherwise).
  3607. class Result {
  3608. public:
  3609. Result() = default;
  3610. Result(Error err, int status, Headers &&headers)
  3611. : err_(err), status_(status), headers_(std::move(headers)) {}
  3612. explicit operator bool() const { return err_ == Error::Success; }
  3613. Error error() const { return err_; }
  3614. // Upgrade response info
  3615. int status() const { return status_; }
  3616. const Headers &headers() const { return headers_; }
  3617. std::string get_header_value(const std::string &key,
  3618. const char *def = "") const {
  3619. return detail::get_header_value(headers_, key, def, 0);
  3620. }
  3621. bool has_header(const std::string &key) const {
  3622. return headers_.find(key) != headers_.end();
  3623. }
  3624. #ifdef CPPHTTPLIB_SSL_ENABLED
  3625. Result(Error err, int status, Headers &&headers, int ssl_error,
  3626. uint64_t ssl_backend_error)
  3627. : err_(err), status_(status), headers_(std::move(headers)),
  3628. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3629. int ssl_error() const { return ssl_error_; }
  3630. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3631. #endif
  3632. private:
  3633. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3634. int status_ = -1;
  3635. Headers headers_;
  3636. #ifdef CPPHTTPLIB_SSL_ENABLED
  3637. int ssl_error_ = 0;
  3638. uint64_t ssl_backend_error_ = 0;
  3639. #endif
  3640. };
  3641. class WebSocket {
  3642. public:
  3643. WebSocket(const WebSocket &) = delete;
  3644. WebSocket &operator=(const WebSocket &) = delete;
  3645. ~WebSocket();
  3646. ReadResult read(std::string &msg);
  3647. bool send(const std::string &data);
  3648. bool send(const char *data, size_t len);
  3649. void close(CloseStatus status = CloseStatus::Normal,
  3650. const std::string &reason = "");
  3651. const Request &request() const;
  3652. bool is_open() const;
  3653. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3654. // A server handler owns its connection's timeout this way; a client sets it
  3655. // through WebSocketClient. Safe to call while another thread is in read().
  3656. void set_read_timeout(time_t sec, time_t usec = 0);
  3657. template <class Rep, class Period>
  3658. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3659. private:
  3660. friend class httplib::Server;
  3661. friend class WebSocketClient;
  3662. WebSocket(
  3663. Stream &strm, const Request &req, bool is_server,
  3664. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3665. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3666. : strm_(strm), req_(req), is_server_(is_server),
  3667. ping_interval_sec_(ping_interval_sec),
  3668. max_missed_pongs_(max_missed_pongs) {
  3669. start_heartbeat();
  3670. }
  3671. WebSocket(
  3672. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3673. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3674. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3675. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3676. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3677. max_missed_pongs_(max_missed_pongs) {
  3678. start_heartbeat();
  3679. }
  3680. void start_heartbeat();
  3681. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3682. Stream &strm_;
  3683. std::unique_ptr<Stream> owned_strm_;
  3684. Request req_;
  3685. bool is_server_;
  3686. time_t ping_interval_sec_;
  3687. int max_missed_pongs_;
  3688. int unacked_pings_ = 0;
  3689. std::atomic<bool> closed_{false};
  3690. std::mutex write_mutex_;
  3691. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3692. // may do so: read_websocket_frame() reads a payload until it has the whole
  3693. // declared length, so a second parser stealing bytes silently corrupts the
  3694. // message the first one is assembling.
  3695. std::mutex read_mutex_;
  3696. std::thread ping_thread_;
  3697. std::mutex ping_mutex_;
  3698. std::condition_variable ping_cv_;
  3699. };
  3700. class WebSocketClient {
  3701. public:
  3702. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3703. const Headers &headers = {});
  3704. ~WebSocketClient();
  3705. WebSocketClient(const WebSocketClient &) = delete;
  3706. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3707. bool is_valid() const;
  3708. Result connect();
  3709. ReadResult read(std::string &msg);
  3710. bool send(const std::string &data);
  3711. bool send(const char *data, size_t len);
  3712. void close(CloseStatus status = CloseStatus::Normal,
  3713. const std::string &reason = "");
  3714. bool is_open() const;
  3715. const std::string &subprotocol() const;
  3716. void set_read_timeout(time_t sec, time_t usec = 0);
  3717. template <class Rep, class Period>
  3718. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3719. void set_write_timeout(time_t sec, time_t usec = 0);
  3720. template <class Rep, class Period>
  3721. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3722. void set_websocket_ping_interval(time_t sec);
  3723. void set_websocket_max_missed_pongs(int count);
  3724. void set_tcp_nodelay(bool on);
  3725. void set_address_family(int family);
  3726. void set_ipv6_v6only(bool on);
  3727. void set_socket_options(SocketOptions socket_options);
  3728. void set_connection_timeout(time_t sec, time_t usec = 0);
  3729. template <class Rep, class Period>
  3730. void
  3731. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3732. void set_interface(const std::string &intf);
  3733. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3734. #ifdef CPPHTTPLIB_SSL_ENABLED
  3735. struct PemMemory {
  3736. const char *cert_pem;
  3737. size_t cert_pem_len;
  3738. const char *key_pem;
  3739. size_t key_pem_len;
  3740. const char *private_key_password;
  3741. };
  3742. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3743. const PemMemory &pem, const Headers &headers = {});
  3744. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3745. const std::string &ca_cert_dir_path = std::string());
  3746. void set_ca_cert_store(tls::ca_store_t store);
  3747. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3748. void enable_server_certificate_verification(bool enabled);
  3749. void enable_server_hostname_verification(bool enabled);
  3750. void enable_system_ca(bool enabled);
  3751. #endif
  3752. private:
  3753. void shutdown_and_close();
  3754. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3755. int &ssl_error, uint64_t &ssl_backend_error);
  3756. void prepare_default_headers(Request &req);
  3757. std::string host_;
  3758. int port_;
  3759. std::string path_;
  3760. Headers headers_;
  3761. std::string subprotocol_;
  3762. bool is_valid_ = false;
  3763. socket_t sock_ = INVALID_SOCKET;
  3764. std::unique_ptr<WebSocket> ws_;
  3765. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3766. time_t read_timeout_usec_ = 0;
  3767. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3768. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3769. time_t websocket_ping_interval_sec_ =
  3770. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3771. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3772. int address_family_ = AF_UNSPEC;
  3773. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3774. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3775. SocketOptions socket_options_ = nullptr;
  3776. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3777. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3778. std::string interface_;
  3779. // Hostname to connection target map. The value is an IP literal or another
  3780. // hostname; only the connection target changes, never the identity.
  3781. std::map<std::string, std::string> addr_map_;
  3782. #ifdef CPPHTTPLIB_SSL_ENABLED
  3783. bool is_ssl_ = false;
  3784. tls::ctx_t tls_ctx_ = nullptr;
  3785. tls::session_t tls_session_ = nullptr;
  3786. std::string ca_cert_file_path_;
  3787. std::string ca_cert_dir_path_;
  3788. bool custom_ca_loaded_ = false;
  3789. bool certs_loaded_ = false;
  3790. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3791. bool server_certificate_verification_ = true;
  3792. bool server_hostname_verification_ = true;
  3793. #endif
  3794. };
  3795. template <class Rep, class Period>
  3796. inline void WebSocketClient::set_read_timeout(
  3797. const std::chrono::duration<Rep, Period> &duration) {
  3798. detail::duration_to_sec_and_usec(
  3799. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3800. }
  3801. template <class Rep, class Period>
  3802. inline void WebSocketClient::set_write_timeout(
  3803. const std::chrono::duration<Rep, Period> &duration) {
  3804. detail::duration_to_sec_and_usec(
  3805. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3806. }
  3807. template <class Rep, class Period>
  3808. inline void WebSocketClient::set_connection_timeout(
  3809. const std::chrono::duration<Rep, Period> &duration) {
  3810. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3811. set_connection_timeout(sec, usec);
  3812. });
  3813. }
  3814. namespace impl {
  3815. bool is_valid_utf8(const std::string &s);
  3816. // Three states, because a failure that consumed bytes and one that consumed
  3817. // none are not the same thing: the first has left the stream in the middle of
  3818. // a frame and the connection cannot be reused, the second can just be retried.
  3819. enum class FrameRead { Ok, Fail, Timeout };
  3820. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3821. std::string &payload, bool &fin,
  3822. bool expect_masked, size_t max_len);
  3823. } // namespace impl
  3824. } // namespace ws
  3825. // ----------------------------------------------------------------------------
  3826. /*
  3827. * Implementation that will be part of the .cc file if split into .h + .cc.
  3828. */
  3829. namespace stream {
  3830. // stream::Result implementations
  3831. inline Result::Result() : chunk_size_(8192) {}
  3832. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3833. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3834. inline Result::Result(Result &&other) noexcept
  3835. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3836. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3837. finished_(other.finished_) {
  3838. other.current_size_ = 0;
  3839. other.finished_ = true;
  3840. }
  3841. inline Result &Result::operator=(Result &&other) noexcept {
  3842. if (this != &other) {
  3843. handle_ = std::move(other.handle_);
  3844. buffer_ = std::move(other.buffer_);
  3845. current_size_ = other.current_size_;
  3846. chunk_size_ = other.chunk_size_;
  3847. finished_ = other.finished_;
  3848. other.current_size_ = 0;
  3849. other.finished_ = true;
  3850. }
  3851. return *this;
  3852. }
  3853. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3854. inline Result::operator bool() const { return is_valid(); }
  3855. inline int Result::status() const {
  3856. return handle_.response ? handle_.response->status : -1;
  3857. }
  3858. inline const Headers &Result::headers() const {
  3859. static const Headers empty_headers;
  3860. return handle_.response ? handle_.response->headers : empty_headers;
  3861. }
  3862. inline std::string Result::get_header_value(const std::string &key,
  3863. const char *def) const {
  3864. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3865. }
  3866. inline bool Result::has_header(const std::string &key) const {
  3867. return handle_.response ? handle_.response->has_header(key) : false;
  3868. }
  3869. inline Error Result::error() const { return handle_.error; }
  3870. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3871. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3872. inline bool Result::next() {
  3873. if (!handle_.is_valid() || finished_) { return false; }
  3874. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3875. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3876. if (n > 0) {
  3877. current_size_ = static_cast<size_t>(n);
  3878. return true;
  3879. }
  3880. current_size_ = 0;
  3881. finished_ = true;
  3882. return false;
  3883. }
  3884. inline const char *Result::data() const { return buffer_.data(); }
  3885. inline size_t Result::size() const { return current_size_; }
  3886. inline std::string Result::read_all() {
  3887. std::string result;
  3888. while (next()) {
  3889. result.append(data(), size());
  3890. }
  3891. return result;
  3892. }
  3893. } // namespace stream
  3894. namespace sse {
  3895. // SSEMessage implementations
  3896. inline SSEMessage::SSEMessage() : event("message") {}
  3897. inline void SSEMessage::clear() {
  3898. event = "message";
  3899. data.clear();
  3900. id.clear();
  3901. }
  3902. // SSEClient implementations
  3903. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3904. : client_(client), path_(path) {}
  3905. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3906. const Headers &headers)
  3907. : client_(client), path_(path), headers_(headers) {}
  3908. inline SSEClient::~SSEClient() { stop(); }
  3909. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3910. on_message_ = std::move(handler);
  3911. return *this;
  3912. }
  3913. inline SSEClient &SSEClient::on_event(const std::string &type,
  3914. MessageHandler handler) {
  3915. event_handlers_[type] = std::move(handler);
  3916. return *this;
  3917. }
  3918. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3919. on_open_ = std::move(handler);
  3920. return *this;
  3921. }
  3922. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3923. on_error_ = std::move(handler);
  3924. return *this;
  3925. }
  3926. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3927. reconnect_interval_ms_ = ms;
  3928. return *this;
  3929. }
  3930. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3931. max_reconnect_attempts_ = n;
  3932. return *this;
  3933. }
  3934. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3935. std::lock_guard<std::mutex> lock(headers_mutex_);
  3936. headers_ = headers;
  3937. return *this;
  3938. }
  3939. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3940. inline const std::string &SSEClient::last_event_id() const {
  3941. return last_event_id_;
  3942. }
  3943. inline void SSEClient::start() {
  3944. running_.store(true);
  3945. run_event_loop();
  3946. }
  3947. inline void SSEClient::start_async() {
  3948. running_.store(true);
  3949. async_thread_ = std::thread([this]() { run_event_loop(); });
  3950. }
  3951. inline void SSEClient::stop() {
  3952. running_.store(false);
  3953. client_.stop(); // Cancel any pending operations
  3954. if (async_thread_.joinable()) { async_thread_.join(); }
  3955. }
  3956. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  3957. int &retry_ms) {
  3958. // Blank line signals end of event
  3959. if (line.empty() || line == "\r") { return true; }
  3960. // Lines starting with ':' are comments (ignored)
  3961. if (!line.empty() && line[0] == ':') { return false; }
  3962. // Find the colon separator
  3963. auto colon_pos = line.find(':');
  3964. if (colon_pos == std::string::npos) {
  3965. // Line with no colon is treated as field name with empty value
  3966. return false;
  3967. }
  3968. auto field = line.substr(0, colon_pos);
  3969. std::string value;
  3970. // Value starts after colon, skip optional single space
  3971. if (colon_pos + 1 < line.size()) {
  3972. auto value_start = colon_pos + 1;
  3973. if (line[value_start] == ' ') { value_start++; }
  3974. value = line.substr(value_start);
  3975. // Remove trailing \r if present
  3976. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  3977. }
  3978. // Handle known fields
  3979. if (field == "event") {
  3980. msg.event = value;
  3981. } else if (field == "data") {
  3982. // Multiple data lines are concatenated with newlines
  3983. if (!msg.data.empty()) { msg.data += "\n"; }
  3984. msg.data += value;
  3985. } else if (field == "id") {
  3986. // Empty id is valid (clears the last event ID)
  3987. msg.id = value;
  3988. } else if (field == "retry") {
  3989. // Parse retry interval in milliseconds
  3990. {
  3991. int v = 0;
  3992. auto res =
  3993. detail::from_chars(value.data(), value.data() + value.size(), v);
  3994. if (res.ec == std::errc{}) { retry_ms = v; }
  3995. }
  3996. }
  3997. // Unknown fields are ignored per SSE spec
  3998. return false;
  3999. }
  4000. inline void SSEClient::run_event_loop() {
  4001. auto reconnect_count = 0;
  4002. while (running_.load()) {
  4003. // Build headers, including Last-Event-ID if we have one
  4004. Headers request_headers;
  4005. {
  4006. std::lock_guard<std::mutex> lock(headers_mutex_);
  4007. request_headers = headers_;
  4008. }
  4009. if (!last_event_id_.empty()) {
  4010. request_headers.emplace("Last-Event-ID", last_event_id_);
  4011. }
  4012. // Open streaming connection
  4013. auto result = stream::Get(client_, path_, request_headers);
  4014. // Connection error handling
  4015. if (!result) {
  4016. connected_.store(false);
  4017. if (on_error_) { on_error_(result.error()); }
  4018. if (!should_reconnect(reconnect_count)) { break; }
  4019. wait_for_reconnect();
  4020. reconnect_count++;
  4021. continue;
  4022. }
  4023. if (result.status() != StatusCode::OK_200) {
  4024. connected_.store(false);
  4025. if (on_error_) { on_error_(Error::Connection); }
  4026. // For certain errors, don't reconnect.
  4027. // Note: 401 is intentionally absent so that handlers can refresh
  4028. // credentials via set_headers() and let the client reconnect.
  4029. if (result.status() == StatusCode::NoContent_204 ||
  4030. result.status() == StatusCode::NotFound_404 ||
  4031. result.status() == StatusCode::Forbidden_403) {
  4032. break;
  4033. }
  4034. if (!should_reconnect(reconnect_count)) { break; }
  4035. wait_for_reconnect();
  4036. reconnect_count++;
  4037. continue;
  4038. }
  4039. // Connection successful
  4040. connected_.store(true);
  4041. reconnect_count = 0;
  4042. if (on_open_) { on_open_(); }
  4043. // Event receiving loop
  4044. std::string buffer;
  4045. SSEMessage current_msg;
  4046. while (running_.load() && result.next()) {
  4047. buffer.append(result.data(), result.size());
  4048. // Process complete lines in the buffer
  4049. size_t line_start = 0;
  4050. size_t newline_pos;
  4051. while ((newline_pos = buffer.find('\n', line_start)) !=
  4052. std::string::npos) {
  4053. auto line = buffer.substr(line_start, newline_pos - line_start);
  4054. line_start = newline_pos + 1;
  4055. // Parse the line and check if event is complete
  4056. auto event_complete =
  4057. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4058. if (event_complete && !current_msg.data.empty()) {
  4059. // Update last_event_id for reconnection
  4060. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4061. // Dispatch event to appropriate handler
  4062. dispatch_event(current_msg);
  4063. current_msg.clear();
  4064. }
  4065. }
  4066. // Keep unprocessed data in buffer
  4067. buffer.erase(0, line_start);
  4068. }
  4069. // Connection ended
  4070. connected_.store(false);
  4071. if (!running_.load()) { break; }
  4072. // Check for read errors
  4073. if (result.has_read_error()) {
  4074. if (on_error_) { on_error_(result.read_error()); }
  4075. }
  4076. if (!should_reconnect(reconnect_count)) { break; }
  4077. wait_for_reconnect();
  4078. reconnect_count++;
  4079. }
  4080. connected_.store(false);
  4081. }
  4082. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4083. // Check for specific event type handler first
  4084. auto it = event_handlers_.find(msg.event);
  4085. if (it != event_handlers_.end()) {
  4086. it->second(msg);
  4087. return;
  4088. }
  4089. // Fall back to generic message handler
  4090. if (on_message_) { on_message_(msg); }
  4091. }
  4092. inline bool SSEClient::should_reconnect(int count) const {
  4093. if (!running_.load()) { return false; }
  4094. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4095. return count < max_reconnect_attempts_;
  4096. }
  4097. inline void SSEClient::wait_for_reconnect() {
  4098. // Use small increments to check running_ flag frequently
  4099. auto waited = 0;
  4100. while (running_.load() && waited < reconnect_interval_ms_) {
  4101. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  4102. waited += 100;
  4103. }
  4104. }
  4105. } // namespace sse
  4106. #ifdef CPPHTTPLIB_SSL_ENABLED
  4107. /*
  4108. * TLS abstraction layer - internal function declarations
  4109. * These are implementation details and not part of the public API.
  4110. */
  4111. namespace tls {
  4112. // Client context
  4113. ctx_t create_client_context();
  4114. void free_context(ctx_t ctx);
  4115. bool set_min_version(ctx_t ctx, Version version);
  4116. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4117. bool load_ca_file(ctx_t ctx, const char *file_path);
  4118. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4119. bool load_system_certs(ctx_t ctx);
  4120. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4121. const char *password);
  4122. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4123. const char *key_path, const char *password);
  4124. // Server context
  4125. ctx_t create_server_context();
  4126. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4127. const char *password);
  4128. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4129. const char *key_path, const char *password);
  4130. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4131. void set_verify_client(ctx_t ctx, bool require);
  4132. // Session management
  4133. session_t create_session(ctx_t ctx, socket_t sock);
  4134. void free_session(session_t session);
  4135. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4136. // Handshake (non-blocking capable)
  4137. TlsError connect(session_t session);
  4138. TlsError accept(session_t session);
  4139. // Handshake with timeout (blocking until timeout)
  4140. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4141. time_t timeout_usec, TlsError *err);
  4142. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4143. time_t timeout_usec, TlsError *err);
  4144. // I/O (non-blocking capable)
  4145. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4146. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4147. int pending(const_session_t session);
  4148. void shutdown(session_t session, bool graceful);
  4149. // Connection state
  4150. bool is_peer_closed(session_t session, socket_t sock);
  4151. // Certificate verification
  4152. cert_t get_peer_cert(const_session_t session);
  4153. void free_cert(cert_t cert);
  4154. bool verify_hostname(cert_t cert, const char *hostname);
  4155. uint64_t hostname_mismatch_code();
  4156. long get_verify_result(const_session_t session);
  4157. // Certificate introspection
  4158. std::string get_cert_subject_cn(cert_t cert);
  4159. std::string get_cert_issuer_name(cert_t cert);
  4160. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4161. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4162. std::string get_cert_serial(cert_t cert);
  4163. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4164. const char *get_sni(const_session_t session);
  4165. // CA store management
  4166. ca_store_t create_ca_store(const char *pem, size_t len);
  4167. void free_ca_store(ca_store_t store);
  4168. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4169. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4170. std::vector<std::string> get_ca_names(ctx_t ctx);
  4171. // Dynamic certificate update (for servers)
  4172. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4173. const char *password);
  4174. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4175. // Certificate verification callback
  4176. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4177. long get_verify_error(const_session_t session);
  4178. std::string verify_error_string(long error_code);
  4179. // TlsError information
  4180. uint64_t peek_error();
  4181. uint64_t get_error();
  4182. std::string error_string(uint64_t code);
  4183. } // namespace tls
  4184. #endif // CPPHTTPLIB_SSL_ENABLED
  4185. /*
  4186. * Group 1: detail namespace - Non-SSL utilities
  4187. */
  4188. namespace detail {
  4189. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4190. const void *optval, socklen_t optlen) {
  4191. return setsockopt(sock, level, optname,
  4192. #ifdef _WIN32
  4193. reinterpret_cast<const char *>(optval),
  4194. #else
  4195. optval,
  4196. #endif
  4197. optlen) == 0;
  4198. }
  4199. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4200. time_t sec, time_t usec) {
  4201. #ifdef _WIN32
  4202. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4203. #else
  4204. timeval timeout;
  4205. timeout.tv_sec = static_cast<long>(sec);
  4206. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4207. #endif
  4208. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4209. }
  4210. inline bool is_hex(char c, int &v) {
  4211. if (is_ascii_digit(c)) {
  4212. v = c - '0';
  4213. return true;
  4214. } else if ('A' <= c && c <= 'F') {
  4215. v = c - 'A' + 10;
  4216. return true;
  4217. } else if ('a' <= c && c <= 'f') {
  4218. v = c - 'a' + 10;
  4219. return true;
  4220. }
  4221. return false;
  4222. }
  4223. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4224. int &val) {
  4225. if (i >= s.size()) { return false; }
  4226. val = 0;
  4227. for (; cnt; i++, cnt--) {
  4228. if (!s[i]) { return false; }
  4229. auto v = 0;
  4230. if (is_hex(s[i], v)) {
  4231. val = val * 16 + v;
  4232. } else {
  4233. return false;
  4234. }
  4235. }
  4236. return true;
  4237. }
  4238. inline std::string from_i_to_hex(size_t n) {
  4239. static const auto charset = "0123456789abcdef";
  4240. std::string ret;
  4241. do {
  4242. ret = charset[n & 15] + ret;
  4243. n >>= 4;
  4244. } while (n > 0);
  4245. return ret;
  4246. }
  4247. inline std::string compute_etag(const FileStat &fs,
  4248. const std::string &suffix = std::string()) {
  4249. if (!fs.is_file()) { return std::string(); }
  4250. // If mtime cannot be determined (negative value indicates an error
  4251. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4252. // value like 0 could collide with a real file that legitimately has
  4253. // mtime == 0 (epoch) and lead to misleading validators.
  4254. auto mtime_raw = fs.mtime();
  4255. if (mtime_raw < 0) { return std::string(); }
  4256. auto mtime = static_cast<size_t>(mtime_raw);
  4257. auto size = fs.size();
  4258. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4259. from_i_to_hex(size) + suffix + "\"";
  4260. }
  4261. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4262. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4263. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4264. inline std::string file_mtime_to_http_date(time_t mtime) {
  4265. if (mtime < 0) { return std::string(); }
  4266. struct tm tm_buf;
  4267. #ifdef _WIN32
  4268. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4269. #else
  4270. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4271. #endif
  4272. char buf[64];
  4273. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4274. return std::string();
  4275. }
  4276. return std::string(buf);
  4277. }
  4278. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4279. inline time_t parse_http_date(const std::string &date_str) {
  4280. struct tm tm_buf;
  4281. // Create a classic locale object once for all parsing attempts
  4282. const std::locale classic_locale = std::locale::classic();
  4283. // Try to parse using std::get_time (C++11, cross-platform)
  4284. auto try_parse = [&](const char *fmt) -> bool {
  4285. std::istringstream ss(date_str);
  4286. ss.imbue(classic_locale);
  4287. memset(&tm_buf, 0, sizeof(tm_buf));
  4288. ss >> std::get_time(&tm_buf, fmt);
  4289. return !ss.fail();
  4290. };
  4291. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4292. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4293. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4294. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4295. // asctime format: "Sun Nov 6 08:49:37 1994"
  4296. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4297. return static_cast<time_t>(-1);
  4298. }
  4299. }
  4300. }
  4301. #ifdef _WIN32
  4302. return _mkgmtime(&tm_buf);
  4303. #elif defined _AIX
  4304. return mktime(&tm_buf);
  4305. #else
  4306. return timegm(&tm_buf);
  4307. #endif
  4308. }
  4309. inline bool is_weak_etag(const std::string &s) {
  4310. // Check if the string is a weak ETag (starts with 'W/"')
  4311. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4312. }
  4313. inline bool is_strong_etag(const std::string &s) {
  4314. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4315. // chars)
  4316. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4317. }
  4318. inline size_t to_utf8(int code, char *buff) {
  4319. if (code < 0x0080) {
  4320. buff[0] = static_cast<char>(code & 0x7F);
  4321. return 1;
  4322. } else if (code < 0x0800) {
  4323. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4324. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4325. return 2;
  4326. } else if (code < 0xD800) {
  4327. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4328. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4329. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4330. return 3;
  4331. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4332. return 0;
  4333. } else if (code < 0x10000) {
  4334. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4335. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4336. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4337. return 3;
  4338. } else if (code < 0x110000) {
  4339. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4340. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4341. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4342. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4343. return 4;
  4344. }
  4345. // NOTREACHED
  4346. return 0;
  4347. }
  4348. } // namespace detail
  4349. namespace ws {
  4350. namespace impl {
  4351. inline bool is_valid_utf8(const std::string &s) {
  4352. size_t i = 0;
  4353. auto n = s.size();
  4354. while (i < n) {
  4355. auto c = static_cast<unsigned char>(s[i]);
  4356. size_t len;
  4357. uint32_t cp;
  4358. if (c < 0x80) {
  4359. i++;
  4360. continue;
  4361. } else if ((c & 0xE0) == 0xC0) {
  4362. len = 2;
  4363. cp = c & 0x1F;
  4364. } else if ((c & 0xF0) == 0xE0) {
  4365. len = 3;
  4366. cp = c & 0x0F;
  4367. } else if ((c & 0xF8) == 0xF0) {
  4368. len = 4;
  4369. cp = c & 0x07;
  4370. } else {
  4371. return false;
  4372. }
  4373. if (i + len > n) { return false; }
  4374. for (size_t j = 1; j < len; j++) {
  4375. auto b = static_cast<unsigned char>(s[i + j]);
  4376. if ((b & 0xC0) != 0x80) { return false; }
  4377. cp = (cp << 6) | (b & 0x3F);
  4378. }
  4379. // Overlong encoding check
  4380. if (len == 2 && cp < 0x80) { return false; }
  4381. if (len == 3 && cp < 0x800) { return false; }
  4382. if (len == 4 && cp < 0x10000) { return false; }
  4383. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4384. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4385. if (cp > 0x10FFFF) { return false; }
  4386. i += len;
  4387. }
  4388. return true;
  4389. }
  4390. } // namespace impl
  4391. } // namespace ws
  4392. namespace detail {
  4393. // NOTE: This code came up with the following stackoverflow post:
  4394. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4395. inline std::string base64_encode(const std::string &in) {
  4396. static const auto lookup =
  4397. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4398. std::string out;
  4399. out.reserve(in.size());
  4400. // Unsigned: the accumulator is never masked, so with a signed int the
  4401. // `val << 8` below overflows once enough bytes are folded in (undefined
  4402. // behaviour before C++20). Only the low bits are ever emitted, so the
  4403. // wrap-around of an unsigned accumulator does not affect the output.
  4404. uint32_t val = 0;
  4405. auto valb = -6;
  4406. for (auto c : in) {
  4407. val = (val << 8) + static_cast<uint8_t>(c);
  4408. valb += 8;
  4409. while (valb >= 0) {
  4410. out.push_back(lookup[(val >> valb) & 0x3F]);
  4411. valb -= 6;
  4412. }
  4413. }
  4414. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4415. while (out.size() % 4) {
  4416. out.push_back('=');
  4417. }
  4418. return out;
  4419. }
  4420. inline std::string sha1(const std::string &input) {
  4421. // RFC 3174 SHA-1 implementation
  4422. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4423. return (x << n) | (x >> (32 - n));
  4424. };
  4425. uint32_t h0 = 0x67452301;
  4426. uint32_t h1 = 0xEFCDAB89;
  4427. uint32_t h2 = 0x98BADCFE;
  4428. uint32_t h3 = 0x10325476;
  4429. uint32_t h4 = 0xC3D2E1F0;
  4430. // Pre-processing: adding padding bits
  4431. std::string msg = input;
  4432. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4433. msg.push_back(static_cast<char>(0x80u));
  4434. while (msg.size() % 64 != 56) {
  4435. msg.push_back(0);
  4436. }
  4437. // Append original length in bits as 64-bit big-endian
  4438. for (int i = 56; i >= 0; i -= 8) {
  4439. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4440. }
  4441. // Process each 512-bit chunk
  4442. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4443. uint32_t w[80];
  4444. for (size_t i = 0; i < 16; i++) {
  4445. w[i] =
  4446. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4447. << 24) |
  4448. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4449. << 16) |
  4450. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4451. << 8) |
  4452. (static_cast<uint32_t>(
  4453. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4454. }
  4455. for (int i = 16; i < 80; i++) {
  4456. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4457. }
  4458. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4459. for (int i = 0; i < 80; i++) {
  4460. uint32_t f, k;
  4461. if (i < 20) {
  4462. f = (b & c) | ((~b) & d);
  4463. k = 0x5A827999;
  4464. } else if (i < 40) {
  4465. f = b ^ c ^ d;
  4466. k = 0x6ED9EBA1;
  4467. } else if (i < 60) {
  4468. f = (b & c) | (b & d) | (c & d);
  4469. k = 0x8F1BBCDC;
  4470. } else {
  4471. f = b ^ c ^ d;
  4472. k = 0xCA62C1D6;
  4473. }
  4474. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4475. e = d;
  4476. d = c;
  4477. c = left_rotate(b, 30);
  4478. b = a;
  4479. a = temp;
  4480. }
  4481. h0 += a;
  4482. h1 += b;
  4483. h2 += c;
  4484. h3 += d;
  4485. h4 += e;
  4486. }
  4487. // Produce the final hash as a 20-byte binary string
  4488. std::string hash(20, '\0');
  4489. for (size_t i = 0; i < 4; i++) {
  4490. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4491. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4492. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4493. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4494. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4495. }
  4496. return hash;
  4497. }
  4498. inline std::string websocket_accept_key(const std::string &client_key) {
  4499. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4500. return base64_encode(sha1(client_key + magic));
  4501. }
  4502. inline bool is_websocket_upgrade(const Request &req) {
  4503. if (req.method != "GET") { return false; }
  4504. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4505. // list of protocols and asks recipients to match each name
  4506. // case-insensitively, so look for the token rather than compare the whole
  4507. // field value.
  4508. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4509. // Check Connection: Upgrade
  4510. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4511. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4512. // RFC 6455 Section 4.2.1
  4513. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4514. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4515. return false;
  4516. }
  4517. static const std::string b64chars =
  4518. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4519. for (size_t i = 0; i < 22; i++) {
  4520. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4521. }
  4522. // Check Sec-WebSocket-Version: 13
  4523. auto version = req.get_header_value("Sec-WebSocket-Version");
  4524. if (version != "13") { return false; }
  4525. return true;
  4526. }
  4527. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4528. const char *data, size_t len, bool fin,
  4529. bool mask) {
  4530. // First byte: FIN + opcode
  4531. uint8_t header[2];
  4532. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4533. (static_cast<uint8_t>(opcode) & 0x0F));
  4534. // Second byte: MASK + payload length
  4535. if (len < 126) {
  4536. header[1] = static_cast<uint8_t>(len);
  4537. if (mask) { header[1] |= 0x80; }
  4538. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4539. } else if (len <= 0xFFFF) {
  4540. header[1] = 126;
  4541. if (mask) { header[1] |= 0x80; }
  4542. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4543. uint8_t ext[2];
  4544. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4545. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4546. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4547. } else {
  4548. header[1] = 127;
  4549. if (mask) { header[1] |= 0x80; }
  4550. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4551. uint8_t ext[8];
  4552. for (int i = 7; i >= 0; i--) {
  4553. ext[7 - i] =
  4554. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4555. }
  4556. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4557. }
  4558. if (mask) {
  4559. // Generate random mask key
  4560. thread_local std::mt19937 rng(std::random_device{}());
  4561. uint8_t mask_key[4];
  4562. auto r = rng();
  4563. std::memcpy(mask_key, &r, 4);
  4564. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4565. // Write masked payload in chunks
  4566. const size_t chunk_size = 4096;
  4567. std::vector<char> buf((std::min)(len, chunk_size));
  4568. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4569. size_t n = (std::min)(chunk_size, len - offset);
  4570. for (size_t i = 0; i < n; i++) {
  4571. buf[i] =
  4572. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4573. }
  4574. if (strm.write(buf.data(), n) < 0) { return false; }
  4575. }
  4576. } else {
  4577. if (len > 0) {
  4578. if (strm.write(data, len) < 0) { return false; }
  4579. }
  4580. }
  4581. return true;
  4582. }
  4583. } // namespace detail
  4584. namespace ws {
  4585. namespace impl {
  4586. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4587. // hands back whatever its buffer already holds -- so every multi-byte field has
  4588. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4589. // header straddles the read buffer's boundary.
  4590. //
  4591. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4592. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4593. // there is a failure like any other. (When read() fails it always records why,
  4594. // so the error belongs to this call and not to an earlier one.)
  4595. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4596. auto p = static_cast<char *>(buf);
  4597. size_t total = 0;
  4598. while (total < size) {
  4599. auto n = strm.read(p + total, size - total);
  4600. if (n <= 0) {
  4601. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4602. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4603. }
  4604. total += static_cast<size_t>(n);
  4605. }
  4606. return FrameRead::Ok;
  4607. }
  4608. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4609. std::string &payload, bool &fin,
  4610. bool expect_masked, size_t max_len) {
  4611. // Read first 2 bytes. This is the only read that may report a timeout: it
  4612. // sits on a frame boundary, where nothing has been consumed yet.
  4613. uint8_t header[2];
  4614. FrameRead first = read_exact(strm, header, 2);
  4615. if (first != FrameRead::Ok) { return first; }
  4616. fin = (header[0] & 0x80) != 0;
  4617. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4618. if (header[0] & 0x70) { return FrameRead::Fail; }
  4619. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4620. bool masked = (header[1] & 0x80) != 0;
  4621. uint64_t payload_len = header[1] & 0x7F;
  4622. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4623. // MUST have a payload length of 125 bytes or less
  4624. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4625. if (is_control) {
  4626. if (!fin) { return FrameRead::Fail; }
  4627. if (payload_len > 125) { return FrameRead::Fail; }
  4628. }
  4629. if (masked != expect_masked) { return FrameRead::Fail; }
  4630. // Extended payload length
  4631. if (payload_len == 126) {
  4632. uint8_t ext[2];
  4633. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4634. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4635. } else if (payload_len == 127) {
  4636. uint8_t ext[8];
  4637. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4638. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4639. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4640. payload_len = 0;
  4641. for (int i = 0; i < 8; i++) {
  4642. payload_len = (payload_len << 8) | ext[i];
  4643. }
  4644. }
  4645. if (payload_len > max_len) { return FrameRead::Fail; }
  4646. // Read mask key if present
  4647. uint8_t mask_key[4] = {0};
  4648. if (masked) {
  4649. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4650. return FrameRead::Fail;
  4651. }
  4652. }
  4653. // Read payload
  4654. payload.resize(static_cast<size_t>(payload_len));
  4655. if (payload_len > 0 &&
  4656. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4657. FrameRead::Ok) {
  4658. return FrameRead::Fail;
  4659. }
  4660. // Unmask if needed
  4661. if (masked) {
  4662. for (size_t i = 0; i < payload.size(); i++) {
  4663. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4664. }
  4665. }
  4666. return FrameRead::Ok;
  4667. }
  4668. } // namespace impl
  4669. } // namespace ws
  4670. namespace detail {
  4671. inline bool is_valid_path(const std::string &path) {
  4672. size_t level = 0;
  4673. size_t i = 0;
  4674. // Skip slash
  4675. while (i < path.size() && path[i] == '/') {
  4676. i++;
  4677. }
  4678. while (i < path.size()) {
  4679. // Read component
  4680. auto beg = i;
  4681. while (i < path.size() && path[i] != '/') {
  4682. if (path[i] == '\0') {
  4683. return false;
  4684. } else if (path[i] == '\\') {
  4685. return false;
  4686. }
  4687. i++;
  4688. }
  4689. auto len = i - beg;
  4690. assert(len > 0);
  4691. if (!path.compare(beg, len, ".")) {
  4692. ;
  4693. } else if (!path.compare(beg, len, "..")) {
  4694. if (level == 0) { return false; }
  4695. level--;
  4696. } else {
  4697. level++;
  4698. }
  4699. // Skip slash
  4700. while (i < path.size() && path[i] == '/') {
  4701. i++;
  4702. }
  4703. }
  4704. return true;
  4705. }
  4706. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4707. #if defined(_WIN32)
  4708. char buf[_MAX_PATH];
  4709. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4710. resolved = buf;
  4711. #elif defined(PATH_MAX)
  4712. char buf[PATH_MAX];
  4713. if (realpath(path, buf) == nullptr) { return false; }
  4714. resolved = buf;
  4715. #else
  4716. auto buf = realpath(path, nullptr);
  4717. auto guard = scope_exit([&]() { std::free(buf); });
  4718. if (buf == nullptr) { return false; }
  4719. resolved = buf;
  4720. #endif
  4721. return true;
  4722. }
  4723. inline bool is_path_within_base(const std::string &resolved_path,
  4724. const std::string &resolved_base) {
  4725. #if defined(_WIN32)
  4726. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4727. resolved_base.size()) == 0;
  4728. #else
  4729. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4730. resolved_base.size()) == 0;
  4731. #endif
  4732. }
  4733. inline FileStat::FileStat(const std::string &path) {
  4734. #if defined(_WIN32)
  4735. auto wpath = u8string_to_wstring(path.c_str());
  4736. ret_ = _wstat(wpath.c_str(), &st_);
  4737. #else
  4738. ret_ = stat(path.c_str(), &st_);
  4739. #endif
  4740. }
  4741. inline bool FileStat::is_file() const {
  4742. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4743. }
  4744. inline bool FileStat::is_dir() const {
  4745. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4746. }
  4747. inline time_t FileStat::mtime() const {
  4748. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4749. : static_cast<time_t>(-1);
  4750. }
  4751. inline size_t FileStat::size() const {
  4752. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4753. }
  4754. inline std::string encode_path(const std::string &s) {
  4755. std::string result;
  4756. result.reserve(s.size());
  4757. for (size_t i = 0; s[i]; i++) {
  4758. switch (s[i]) {
  4759. case ' ': result += "%20"; break;
  4760. case '+': result += "%2B"; break;
  4761. case '\r': result += "%0D"; break;
  4762. case '\n': result += "%0A"; break;
  4763. case '\'': result += "%27"; break;
  4764. case ',': result += "%2C"; break;
  4765. // case ':': result += "%3A"; break; // ok? probably...
  4766. case ';': result += "%3B"; break;
  4767. default:
  4768. auto c = static_cast<uint8_t>(s[i]);
  4769. if (c >= 0x80) {
  4770. result += '%';
  4771. char hex[4];
  4772. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4773. assert(len == 2);
  4774. result.append(hex, static_cast<size_t>(len));
  4775. } else {
  4776. result += s[i];
  4777. }
  4778. break;
  4779. }
  4780. }
  4781. return result;
  4782. }
  4783. inline std::string file_extension(const std::string &path) {
  4784. std::smatch m;
  4785. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4786. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4787. return std::string();
  4788. }
  4789. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4790. template <typename T>
  4791. inline bool parse_header(const char *beg, const char *end, T fn);
  4792. template <typename T>
  4793. inline bool parse_header(const char *beg, const char *end, T fn) {
  4794. // Skip trailing spaces and tabs.
  4795. while (beg < end && is_space_or_tab(end[-1])) {
  4796. end--;
  4797. }
  4798. auto p = beg;
  4799. while (p < end && *p != ':') {
  4800. p++;
  4801. }
  4802. auto name = std::string(beg, p);
  4803. if (!detail::fields::is_field_name(name)) { return false; }
  4804. if (p == end) { return false; }
  4805. auto key_end = p;
  4806. if (*p++ != ':') { return false; }
  4807. while (p < end && is_space_or_tab(*p)) {
  4808. p++;
  4809. }
  4810. if (p <= end) {
  4811. auto key_len = key_end - beg;
  4812. if (!key_len) { return false; }
  4813. auto key = std::string(beg, key_end);
  4814. auto val = std::string(p, end);
  4815. if (!detail::fields::is_field_value(val)) { return false; }
  4816. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4817. // percent-decoded by the recipient. Applications that need to interpret a
  4818. // value as a URI component should call httplib::decode_uri_component()
  4819. // (or decode_path_component()) explicitly.
  4820. fn(key, val);
  4821. return true;
  4822. }
  4823. return false;
  4824. }
  4825. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4826. const Headers &src_headers) {
  4827. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4828. // transfer coding is complete when a chunk with a chunk-size of zero is
  4829. // received, possibly followed by a trailer section, and finally terminated by
  4830. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4831. //
  4832. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4833. // doesn't care for the existence of the final CRLF. In other words, it seems
  4834. // to be ok whether the final CRLF exists or not in the chunked data.
  4835. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4836. //
  4837. // According to the reference code in RFC 9112, cpp-httplib now allows
  4838. // chunked transfer coding data without the final CRLF.
  4839. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4840. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4841. "transfer-encoding",
  4842. "content-length",
  4843. "host",
  4844. "authorization",
  4845. "www-authenticate",
  4846. "proxy-authenticate",
  4847. "proxy-authorization",
  4848. "cookie",
  4849. "set-cookie",
  4850. "cache-control",
  4851. "expect",
  4852. "max-forwards",
  4853. "pragma",
  4854. "range",
  4855. "te",
  4856. "age",
  4857. "expires",
  4858. "date",
  4859. "location",
  4860. "retry-after",
  4861. "vary",
  4862. "warning",
  4863. "content-encoding",
  4864. "content-type",
  4865. "content-range",
  4866. "trailer"};
  4867. case_ignore::unordered_set<std::string> declared_trailers;
  4868. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4869. if (!trailer_header.empty()) {
  4870. // split() trims each token and skips empty ones, so the name arrives ready
  4871. // to look up.
  4872. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4873. ',', [&](const char *b, const char *e) {
  4874. std::string key(b, e);
  4875. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4876. declared_trailers.insert(key);
  4877. }
  4878. });
  4879. }
  4880. size_t trailer_header_count = 0;
  4881. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4882. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4883. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4884. constexpr auto line_terminator_len = 2;
  4885. auto line_beg = line_reader.ptr();
  4886. auto line_end =
  4887. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4888. if (!parse_header(line_beg, line_end,
  4889. [&](const std::string &key, const std::string &val) {
  4890. if (declared_trailers.find(key) !=
  4891. declared_trailers.end()) {
  4892. dest.emplace(key, val);
  4893. trailer_header_count++;
  4894. }
  4895. })) {
  4896. return false;
  4897. }
  4898. if (!line_reader.getline()) { return false; }
  4899. }
  4900. return true;
  4901. }
  4902. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4903. size_t right) {
  4904. while (b + left < e && is_space_or_tab(b[left])) {
  4905. left++;
  4906. }
  4907. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4908. right--;
  4909. }
  4910. return std::make_pair(left, right);
  4911. }
  4912. inline std::string trim_copy(const std::string &s) {
  4913. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4914. return s.substr(r.first, r.second - r.first);
  4915. }
  4916. inline std::string trim_double_quotes_copy(const std::string &s) {
  4917. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4918. return s.substr(1, s.size() - 2);
  4919. }
  4920. return s;
  4921. }
  4922. inline void
  4923. divide(const char *data, std::size_t size, char d,
  4924. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4925. fn) {
  4926. const auto it = std::find(data, data + size, d);
  4927. const auto found = static_cast<std::size_t>(it != data + size);
  4928. const auto lhs_data = data;
  4929. const auto lhs_size = static_cast<std::size_t>(it - data);
  4930. const auto rhs_data = it + found;
  4931. const auto rhs_size = size - lhs_size - found;
  4932. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  4933. }
  4934. inline void
  4935. divide(const std::string &str, char d,
  4936. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4937. fn) {
  4938. divide(str.data(), str.size(), d, std::move(fn));
  4939. }
  4940. inline void split(const char *b, const char *e, char d,
  4941. std::function<void(const char *, const char *)> fn) {
  4942. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  4943. }
  4944. inline void split(const char *b, const char *e, char d, size_t m,
  4945. std::function<void(const char *, const char *)> fn) {
  4946. size_t i = 0;
  4947. size_t beg = 0;
  4948. size_t count = 1;
  4949. while (e ? (b + i < e) : (b[i] != '\0')) {
  4950. if (b[i] == d && count < m) {
  4951. auto r = trim(b, e, beg, i);
  4952. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4953. beg = i + 1;
  4954. count++;
  4955. }
  4956. i++;
  4957. }
  4958. if (i) {
  4959. auto r = trim(b, e, beg, i);
  4960. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4961. }
  4962. }
  4963. // Same contract as split(), except that a delimiter inside a quoted-string is
  4964. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  4965. // quoted-string, and ';' and '=' are legal characters inside one.
  4966. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  4967. std::function<void(const char *, const char *)> fn) {
  4968. size_t i = 0;
  4969. size_t beg = 0;
  4970. size_t count = 1;
  4971. auto in_quotes = false;
  4972. while (e ? (b + i < e) : (b[i] != '\0')) {
  4973. if (b[i] == '"') {
  4974. in_quotes = !in_quotes;
  4975. } else if (b[i] == d && !in_quotes && count < m) {
  4976. auto r = trim(b, e, beg, i);
  4977. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4978. beg = i + 1;
  4979. count++;
  4980. }
  4981. i++;
  4982. }
  4983. if (i) {
  4984. auto r = trim(b, e, beg, i);
  4985. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4986. }
  4987. }
  4988. inline void split_unquoted(const char *b, const char *e, char d,
  4989. std::function<void(const char *, const char *)> fn) {
  4990. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  4991. std::move(fn));
  4992. }
  4993. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  4994. // key a token, so the first '=' is the separator even when the value is a
  4995. // quoted-string carrying more of them.
  4996. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  4997. std::string &val) {
  4998. divide(
  4999. b, static_cast<std::size_t>(e - b), '=',
  5000. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5001. const auto kr = trim(kb, kb + klen, 0, klen);
  5002. key.assign(kb + kr.first, kb + kr.second);
  5003. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5004. val.assign(vb + vr.first, vb + vr.second);
  5005. });
  5006. }
  5007. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5008. std::function<bool(const char *, const char *)> fn) {
  5009. size_t i = 0;
  5010. size_t beg = 0;
  5011. size_t count = 1;
  5012. while (e ? (b + i < e) : (b[i] != '\0')) {
  5013. if (b[i] == d && count < m) {
  5014. auto r = trim(b, e, beg, i);
  5015. if (r.first < r.second) {
  5016. auto found = fn(&b[r.first], &b[r.second]);
  5017. if (found) { return true; }
  5018. }
  5019. beg = i + 1;
  5020. count++;
  5021. }
  5022. i++;
  5023. }
  5024. if (i) {
  5025. auto r = trim(b, e, beg, i);
  5026. if (r.first < r.second) {
  5027. auto found = fn(&b[r.first], &b[r.second]);
  5028. if (found) { return true; }
  5029. }
  5030. }
  5031. return false;
  5032. }
  5033. inline bool split_find(const char *b, const char *e, char d,
  5034. std::function<bool(const char *, const char *)> fn) {
  5035. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5036. std::move(fn));
  5037. }
  5038. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5039. size_t fixed_buffer_size)
  5040. : strm_(strm), fixed_buffer_(fixed_buffer),
  5041. fixed_buffer_size_(fixed_buffer_size) {}
  5042. inline const char *stream_line_reader::ptr() const {
  5043. if (growable_buffer_.empty()) {
  5044. return fixed_buffer_;
  5045. } else {
  5046. return growable_buffer_.data();
  5047. }
  5048. }
  5049. inline size_t stream_line_reader::size() const {
  5050. if (growable_buffer_.empty()) {
  5051. return fixed_buffer_used_size_;
  5052. } else {
  5053. return growable_buffer_.size();
  5054. }
  5055. }
  5056. inline bool stream_line_reader::end_with_crlf() const {
  5057. auto end = ptr() + size();
  5058. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5059. }
  5060. inline bool stream_line_reader::getline() {
  5061. fixed_buffer_used_size_ = 0;
  5062. growable_buffer_.clear();
  5063. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5064. char prev_byte = 0;
  5065. #endif
  5066. for (size_t i = 0;; i++) {
  5067. // Fast path: whatever the stream has already buffered can be scanned for
  5068. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5069. // call, a bounds check and a one-byte copy per character of the request.
  5070. size_t buffered_size = 0;
  5071. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5072. auto take = buffered_size;
  5073. auto terminated = false;
  5074. for (size_t at = 0; at < buffered_size;) {
  5075. auto nl = static_cast<const char *>(
  5076. memchr(buffered + at, '\n', buffered_size - at));
  5077. if (!nl) { break; }
  5078. auto pos = static_cast<size_t>(nl - buffered);
  5079. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5080. take = pos + 1;
  5081. terminated = true;
  5082. break;
  5083. #else
  5084. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5085. // be the last byte of an earlier chunk, hence prev_byte.
  5086. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5087. take = pos + 1;
  5088. terminated = true;
  5089. break;
  5090. }
  5091. at = pos + 1;
  5092. #endif
  5093. }
  5094. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5095. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5096. prev_byte = buffered[take - 1];
  5097. #endif
  5098. append(buffered, take);
  5099. strm_.consume_buffered(take);
  5100. i += take;
  5101. if (terminated) { return true; }
  5102. continue;
  5103. }
  5104. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5105. // Treat exceptionally long lines as an error to
  5106. // prevent infinite loops/memory exhaustion
  5107. return false;
  5108. }
  5109. char byte;
  5110. auto n = strm_.read(&byte, 1);
  5111. if (n < 0) {
  5112. return false;
  5113. } else if (n == 0) {
  5114. if (i == 0) {
  5115. return false;
  5116. } else {
  5117. break;
  5118. }
  5119. }
  5120. append(byte);
  5121. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5122. if (byte == '\n') { break; }
  5123. #else
  5124. if (prev_byte == '\r' && byte == '\n') { break; }
  5125. prev_byte = byte;
  5126. #endif
  5127. }
  5128. return true;
  5129. }
  5130. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5131. inline void stream_line_reader::append(const char *data, size_t size) {
  5132. // Once the line has outgrown the fixed buffer everything must keep going to
  5133. // the growable one, even if a later chunk would have fit. Without the
  5134. // emptiness check a short append after a long one would land in the fixed
  5135. // buffer, which ptr() and size() no longer look at, and be lost.
  5136. if (growable_buffer_.empty() &&
  5137. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5138. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5139. fixed_buffer_used_size_ += size;
  5140. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5141. } else {
  5142. // Unlike the per-character overload, this can be the very first append of
  5143. // the line, so the fixed buffer may hold nothing and carry no terminator
  5144. // yet. assign() takes an explicit length and does not need one.
  5145. if (growable_buffer_.empty()) {
  5146. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5147. }
  5148. growable_buffer_.append(data, size);
  5149. }
  5150. }
  5151. inline mmap::mmap(const char *path) { open(path); }
  5152. inline mmap::~mmap() { close(); }
  5153. inline bool mmap::open(const char *path) {
  5154. close();
  5155. #if defined(_WIN32)
  5156. auto wpath = u8string_to_wstring(path);
  5157. if (wpath.empty()) { return false; }
  5158. hFile_ =
  5159. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5160. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5161. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5162. LARGE_INTEGER size{};
  5163. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5164. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5165. // See:
  5166. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5167. if (static_cast<ULONGLONG>(size.QuadPart) >
  5168. (std::numeric_limits<decltype(size_)>::max)()) {
  5169. // `size_t` might be 32-bits, on 32-bits Windows.
  5170. return false;
  5171. }
  5172. size_ = static_cast<size_t>(size.QuadPart);
  5173. hMapping_ =
  5174. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5175. // Special treatment for an empty file...
  5176. if (hMapping_ == NULL && size_ == 0) {
  5177. close();
  5178. is_open_empty_file = true;
  5179. return true;
  5180. }
  5181. if (hMapping_ == NULL) {
  5182. close();
  5183. return false;
  5184. }
  5185. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5186. if (addr_ == nullptr) {
  5187. close();
  5188. return false;
  5189. }
  5190. #else
  5191. fd_ = ::open(path, O_RDONLY);
  5192. if (fd_ == -1) { return false; }
  5193. struct stat sb;
  5194. if (fstat(fd_, &sb) == -1) {
  5195. close();
  5196. return false;
  5197. }
  5198. size_ = static_cast<size_t>(sb.st_size);
  5199. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5200. // Special treatment for an empty file...
  5201. if (addr_ == MAP_FAILED && size_ == 0) {
  5202. close();
  5203. is_open_empty_file = true;
  5204. return false;
  5205. }
  5206. if (addr_ == MAP_FAILED) {
  5207. // Clear the sentinel before `close()`, since `is_open()` only checks
  5208. // `addr_` against nullptr and `munmap()` must not be called with it.
  5209. addr_ = nullptr;
  5210. close();
  5211. return false;
  5212. }
  5213. #endif
  5214. return true;
  5215. }
  5216. inline bool mmap::is_open() const {
  5217. return is_open_empty_file ? true : addr_ != nullptr;
  5218. }
  5219. inline size_t mmap::size() const { return size_; }
  5220. inline const char *mmap::data() const {
  5221. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5222. }
  5223. inline void mmap::close() {
  5224. #if defined(_WIN32)
  5225. if (addr_) {
  5226. ::UnmapViewOfFile(addr_);
  5227. addr_ = nullptr;
  5228. }
  5229. if (hMapping_) {
  5230. ::CloseHandle(hMapping_);
  5231. hMapping_ = NULL;
  5232. }
  5233. if (hFile_ != INVALID_HANDLE_VALUE) {
  5234. ::CloseHandle(hFile_);
  5235. hFile_ = INVALID_HANDLE_VALUE;
  5236. }
  5237. is_open_empty_file = false;
  5238. #else
  5239. if (addr_ != nullptr) {
  5240. munmap(addr_, size_);
  5241. addr_ = nullptr;
  5242. }
  5243. if (fd_ != -1) {
  5244. ::close(fd_);
  5245. fd_ = -1;
  5246. }
  5247. #endif
  5248. size_ = 0;
  5249. }
  5250. inline int close_socket(socket_t sock) noexcept {
  5251. #ifdef _WIN32
  5252. return closesocket(sock);
  5253. #else
  5254. return close(sock);
  5255. #endif
  5256. }
  5257. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5258. ssize_t res = 0;
  5259. while (true) {
  5260. res = fn();
  5261. if (res < 0 && errno == EINTR) {
  5262. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5263. continue;
  5264. }
  5265. break;
  5266. }
  5267. return res;
  5268. }
  5269. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5270. return handle_EINTR([&]() {
  5271. return recv(sock,
  5272. #ifdef _WIN32
  5273. static_cast<char *>(ptr), static_cast<int>(size),
  5274. #else
  5275. ptr, size,
  5276. #endif
  5277. flags);
  5278. });
  5279. }
  5280. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5281. int flags) {
  5282. return handle_EINTR([&]() {
  5283. return send(sock,
  5284. #ifdef _WIN32
  5285. static_cast<const char *>(ptr), static_cast<int>(size),
  5286. #else
  5287. ptr, size,
  5288. #endif
  5289. flags);
  5290. });
  5291. }
  5292. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5293. #ifdef _WIN32
  5294. return ::WSAPoll(fds, nfds, timeout);
  5295. #else
  5296. return ::poll(fds, nfds, timeout);
  5297. #endif
  5298. }
  5299. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5300. time_t usec) {
  5301. struct pollfd pfd;
  5302. pfd.fd = sock;
  5303. pfd.events = events;
  5304. pfd.revents = 0;
  5305. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5306. // "return immediately", which callers here rely on to probe a socket.
  5307. auto timeout =
  5308. sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5309. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5310. }
  5311. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5312. return select_impl(sock, POLLIN, sec, usec);
  5313. }
  5314. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5315. return select_impl(sock, POLLOUT, sec, usec);
  5316. }
  5317. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5318. time_t usec) {
  5319. struct pollfd pfd_read;
  5320. pfd_read.fd = sock;
  5321. pfd_read.events = POLLIN | POLLOUT;
  5322. pfd_read.revents = 0;
  5323. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5324. auto poll_res =
  5325. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5326. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5327. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5328. auto error = 0;
  5329. socklen_t len = sizeof(error);
  5330. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5331. reinterpret_cast<char *>(&error), &len);
  5332. auto successful = res >= 0 && !error;
  5333. return successful ? Error::Success : Error::Connection;
  5334. }
  5335. return Error::Connection;
  5336. }
  5337. inline bool is_socket_alive(socket_t sock) {
  5338. const auto val = detail::select_read(sock, 0, 0);
  5339. if (val == 0) {
  5340. return true;
  5341. } else if (val < 0 && errno == EBADF) {
  5342. return false;
  5343. }
  5344. char buf[1];
  5345. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5346. }
  5347. class SocketStream final : public Stream {
  5348. public:
  5349. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5350. time_t write_timeout_sec, time_t write_timeout_usec,
  5351. time_t max_timeout_msec = 0,
  5352. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5353. (std::chrono::steady_clock::time_point::min)());
  5354. ~SocketStream() override;
  5355. bool is_readable() const override;
  5356. bool wait_readable() const override;
  5357. bool wait_writable() const override;
  5358. bool is_peer_alive() const override;
  5359. ssize_t read(char *ptr, size_t size) override;
  5360. ssize_t write(const char *ptr, size_t size) override;
  5361. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5362. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5363. socket_t socket() const override;
  5364. time_t duration() const override;
  5365. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5366. const char *buffered_data(size_t &size) const override;
  5367. void consume_buffered(size_t size) override;
  5368. // The caller has just seen this socket become readable. Lets the next read
  5369. // skip its own readiness wait, which would otherwise ask the kernel a
  5370. // question that was answered a moment ago. Consumed by that read.
  5371. void set_readable_hint() { readable_hint_ = true; }
  5372. private:
  5373. bool ensure_readable();
  5374. socket_t sock_;
  5375. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5376. // thread while a read is in flight -- that is the point of it, for a caller
  5377. // holding one connection and wanting control back to send on it.
  5378. std::atomic<time_t> read_timeout_sec_;
  5379. std::atomic<time_t> read_timeout_usec_;
  5380. time_t write_timeout_sec_;
  5381. time_t write_timeout_usec_;
  5382. time_t max_timeout_msec_;
  5383. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5384. std::vector<char> read_buff_;
  5385. size_t read_buff_off_ = 0;
  5386. size_t read_buff_content_size_ = 0;
  5387. bool readable_hint_ = false;
  5388. static const size_t read_buff_size_ = 1024l * 4;
  5389. };
  5390. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5391. time_t keep_alive_timeout_sec) {
  5392. using namespace std::chrono;
  5393. const auto interval_usec =
  5394. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5395. // Avoid expensive `steady_clock::now()` call for the first time
  5396. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5397. const auto start = steady_clock::now() - microseconds{interval_usec};
  5398. const auto timeout = seconds{keep_alive_timeout_sec};
  5399. while (true) {
  5400. if (svr_sock == INVALID_SOCKET) {
  5401. break; // Server socket is closed
  5402. }
  5403. auto val = select_read(sock, 0, interval_usec);
  5404. if (val < 0) {
  5405. break; // Ssocket error
  5406. } else if (val == 0) {
  5407. if (steady_clock::now() - start > timeout) {
  5408. break; // Timeout
  5409. }
  5410. } else {
  5411. return true; // Ready for read
  5412. }
  5413. }
  5414. return false;
  5415. }
  5416. template <typename T>
  5417. inline bool
  5418. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5419. size_t keep_alive_max_count,
  5420. time_t keep_alive_timeout_sec, T callback) {
  5421. assert(keep_alive_max_count > 0);
  5422. auto ret = false;
  5423. auto count = keep_alive_max_count;
  5424. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5425. auto close_connection = count == 1;
  5426. auto connection_closed = false;
  5427. ret = callback(close_connection, connection_closed);
  5428. if (!ret || connection_closed) { break; }
  5429. count--;
  5430. }
  5431. return ret;
  5432. }
  5433. template <typename T>
  5434. inline bool
  5435. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5436. size_t keep_alive_max_count,
  5437. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5438. time_t read_timeout_usec, time_t write_timeout_sec,
  5439. time_t write_timeout_usec, T callback) {
  5440. return process_server_socket_core(
  5441. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5442. [&](bool close_connection, bool &connection_closed) {
  5443. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5444. write_timeout_sec, write_timeout_usec);
  5445. // process_server_socket_core() only gets here once keep_alive() has
  5446. // seen the socket go readable.
  5447. strm.set_readable_hint();
  5448. return callback(strm, close_connection, connection_closed);
  5449. });
  5450. }
  5451. inline bool process_client_socket(
  5452. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5453. time_t write_timeout_sec, time_t write_timeout_usec,
  5454. time_t max_timeout_msec,
  5455. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5456. std::function<bool(Stream &)> callback) {
  5457. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5458. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5459. start_time);
  5460. return callback(strm);
  5461. }
  5462. inline int shutdown_socket(socket_t sock) noexcept {
  5463. #ifdef _WIN32
  5464. return shutdown(sock, SD_BOTH);
  5465. #else
  5466. return shutdown(sock, SHUT_RDWR);
  5467. #endif
  5468. }
  5469. // Half-closes the write side and drains any in-flight/queued bytes before
  5470. // the final shutdown+close. Closing with unread data in the receive queue
  5471. // (or bytes arriving after the receive side is closed) makes the stack send
  5472. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5473. // response as a failed read even though it was fully written.
  5474. inline void drain_and_close_socket(socket_t sock) noexcept {
  5475. #ifdef _WIN32
  5476. shutdown(sock, SD_SEND);
  5477. #else
  5478. shutdown(sock, SHUT_WR);
  5479. #endif
  5480. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5481. size_t total = 0;
  5482. const auto deadline = std::chrono::steady_clock::now() +
  5483. std::chrono::milliseconds(100); // bound #1
  5484. while (total < size_t(1024u * 1024u)) { // bound #2
  5485. const auto remaining =
  5486. std::chrono::duration_cast<std::chrono::microseconds>(
  5487. deadline - std::chrono::steady_clock::now())
  5488. .count();
  5489. if (remaining <= 0) { break; }
  5490. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5491. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5492. if (n <= 0) { break; }
  5493. total += static_cast<size_t>(n);
  5494. }
  5495. shutdown_socket(sock);
  5496. close_socket(sock);
  5497. }
  5498. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5499. if (s.size() > 1 && s[0] == '\0') {
  5500. auto ret = s;
  5501. ret[0] = '@';
  5502. return ret;
  5503. }
  5504. return s;
  5505. }
  5506. inline std::string
  5507. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5508. if (s.size() > 1 && s[0] == '@') {
  5509. auto ret = s;
  5510. ret[0] = '\0';
  5511. return ret;
  5512. }
  5513. return s;
  5514. }
  5515. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5516. const struct addrinfo *hints,
  5517. struct addrinfo **res, time_t timeout_sec) {
  5518. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5519. if (timeout_sec <= 0) {
  5520. // No timeout specified, use standard getaddrinfo
  5521. return getaddrinfo(node, service, hints, res);
  5522. }
  5523. #ifdef _WIN32
  5524. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5525. OVERLAPPED overlapped = {};
  5526. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5527. if (!event) { return EAI_FAIL; }
  5528. overlapped.hEvent = event;
  5529. PADDRINFOEXW result_addrinfo = nullptr;
  5530. HANDLE cancel_handle = nullptr;
  5531. ADDRINFOEXW hints_ex = {};
  5532. if (hints) {
  5533. hints_ex.ai_flags = hints->ai_flags;
  5534. hints_ex.ai_family = hints->ai_family;
  5535. hints_ex.ai_socktype = hints->ai_socktype;
  5536. hints_ex.ai_protocol = hints->ai_protocol;
  5537. }
  5538. auto wnode = u8string_to_wstring(node);
  5539. auto wservice = u8string_to_wstring(service);
  5540. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5541. hints ? &hints_ex : nullptr, &result_addrinfo,
  5542. nullptr, &overlapped, nullptr, &cancel_handle);
  5543. if (ret == WSA_IO_PENDING) {
  5544. auto wait_result =
  5545. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5546. if (wait_result == WAIT_TIMEOUT) {
  5547. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5548. ::CloseHandle(event);
  5549. return EAI_AGAIN;
  5550. }
  5551. DWORD bytes_returned;
  5552. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5553. &bytes_returned, FALSE)) {
  5554. ::CloseHandle(event);
  5555. return ::WSAGetLastError();
  5556. }
  5557. }
  5558. ::CloseHandle(event);
  5559. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5560. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5561. return 0;
  5562. }
  5563. return ret;
  5564. #elif TARGET_OS_MAC && defined(__clang__)
  5565. if (!node) { return EAI_NONAME; }
  5566. // macOS implementation using CFHost API for asynchronous DNS resolution
  5567. CFStringRef hostname_ref = CFStringCreateWithCString(
  5568. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5569. if (!hostname_ref) { return EAI_MEMORY; }
  5570. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5571. CFRelease(hostname_ref);
  5572. if (!host_ref) { return EAI_MEMORY; }
  5573. // Set up context for callback
  5574. struct CFHostContext {
  5575. bool completed = false;
  5576. bool success = false;
  5577. CFArrayRef addresses = nullptr;
  5578. std::mutex mutex;
  5579. std::condition_variable cv;
  5580. } context;
  5581. CFHostClientContext client_context;
  5582. memset(&client_context, 0, sizeof(client_context));
  5583. client_context.info = &context;
  5584. // Set callback
  5585. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5586. const CFStreamError *error, void *info) {
  5587. auto ctx = static_cast<CFHostContext *>(info);
  5588. std::lock_guard<std::mutex> lock(ctx->mutex);
  5589. if (error && error->error != 0) {
  5590. ctx->success = false;
  5591. } else {
  5592. Boolean hasBeenResolved;
  5593. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5594. if (ctx->addresses && hasBeenResolved) {
  5595. CFRetain(ctx->addresses);
  5596. ctx->success = true;
  5597. } else {
  5598. ctx->success = false;
  5599. }
  5600. }
  5601. ctx->completed = true;
  5602. ctx->cv.notify_one();
  5603. };
  5604. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5605. CFRelease(host_ref);
  5606. return EAI_SYSTEM;
  5607. }
  5608. // Schedule on run loop
  5609. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5610. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5611. // Start resolution
  5612. CFStreamError stream_error;
  5613. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5614. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5615. CFRelease(host_ref);
  5616. return EAI_FAIL;
  5617. }
  5618. // Wait for completion with timeout
  5619. auto timeout_time =
  5620. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5621. bool timed_out = false;
  5622. {
  5623. std::unique_lock<std::mutex> lock(context.mutex);
  5624. while (!context.completed) {
  5625. auto now = std::chrono::steady_clock::now();
  5626. if (now >= timeout_time) {
  5627. timed_out = true;
  5628. break;
  5629. }
  5630. // Run the runloop for a short time
  5631. lock.unlock();
  5632. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5633. lock.lock();
  5634. }
  5635. }
  5636. // Clean up
  5637. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5638. CFHostSetClient(host_ref, nullptr, nullptr);
  5639. if (timed_out || !context.completed) {
  5640. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5641. CFRelease(host_ref);
  5642. return EAI_AGAIN;
  5643. }
  5644. if (!context.success || !context.addresses) {
  5645. CFRelease(host_ref);
  5646. return EAI_NODATA;
  5647. }
  5648. // Convert CFArray to addrinfo
  5649. CFIndex count = CFArrayGetCount(context.addresses);
  5650. if (count == 0) {
  5651. CFRelease(context.addresses);
  5652. CFRelease(host_ref);
  5653. return EAI_NODATA;
  5654. }
  5655. struct addrinfo *result_addrinfo = nullptr;
  5656. struct addrinfo **current = &result_addrinfo;
  5657. for (CFIndex i = 0; i < count; i++) {
  5658. CFDataRef addr_data =
  5659. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5660. if (!addr_data) continue;
  5661. const struct sockaddr *sockaddr_ptr =
  5662. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5663. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5664. // Allocate addrinfo structure
  5665. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5666. if (!*current) {
  5667. freeaddrinfo(result_addrinfo);
  5668. CFRelease(context.addresses);
  5669. CFRelease(host_ref);
  5670. return EAI_MEMORY;
  5671. }
  5672. memset(*current, 0, sizeof(struct addrinfo));
  5673. // Set up addrinfo fields
  5674. (*current)->ai_family = sockaddr_ptr->sa_family;
  5675. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5676. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5677. (*current)->ai_addrlen = sockaddr_len;
  5678. // Copy sockaddr
  5679. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5680. if (!(*current)->ai_addr) {
  5681. freeaddrinfo(result_addrinfo);
  5682. CFRelease(context.addresses);
  5683. CFRelease(host_ref);
  5684. return EAI_MEMORY;
  5685. }
  5686. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5687. // Set port if service is specified
  5688. if (service && *service) {
  5689. int port = 0;
  5690. if (parse_port(service, strlen(service), port)) {
  5691. if (sockaddr_ptr->sa_family == AF_INET) {
  5692. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5693. ->sin_port = htons(static_cast<uint16_t>(port));
  5694. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5695. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5696. ->sin6_port = htons(static_cast<uint16_t>(port));
  5697. }
  5698. }
  5699. }
  5700. current = &((*current)->ai_next);
  5701. }
  5702. CFRelease(context.addresses);
  5703. CFRelease(host_ref);
  5704. *res = result_addrinfo;
  5705. return 0;
  5706. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5707. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5708. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5709. // the resolver worker still references the stack-local gaicb. The cancel
  5710. // path therefore waits (gai_suspend with no timeout) for the worker to
  5711. // actually finish before letting the stack frame go. The trade-off is that
  5712. // a wedged DNS server can hold this thread for the system resolver timeout
  5713. // (~30s by default) past the caller's connection timeout.
  5714. struct gaicb request {};
  5715. struct gaicb *requests[1] = {&request};
  5716. struct sigevent sevp {};
  5717. struct timespec timeout {
  5718. timeout_sec, 0
  5719. };
  5720. request.ar_name = node;
  5721. request.ar_service = service;
  5722. request.ar_request = hints;
  5723. sevp.sigev_notify = SIGEV_NONE;
  5724. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5725. if (rc != 0) { return rc; }
  5726. auto cleanup = scope_exit([&] {
  5727. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5728. });
  5729. int wait_result = gai_suspend(requests, 1, &timeout);
  5730. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5731. int gai_result = gai_error(&request);
  5732. if (gai_result == 0) {
  5733. *res = request.ar_result;
  5734. request.ar_result = nullptr;
  5735. return 0;
  5736. }
  5737. return gai_result;
  5738. }
  5739. gai_cancel(&request);
  5740. while (gai_error(&request) == EAI_INPROGRESS) {
  5741. gai_suspend(requests, 1, nullptr);
  5742. }
  5743. return wait_result;
  5744. #else
  5745. // Fallback implementation using thread-based timeout for other Unix systems.
  5746. struct GetAddrInfoState {
  5747. ~GetAddrInfoState() {
  5748. if (info) { freeaddrinfo(info); }
  5749. }
  5750. std::mutex mutex;
  5751. std::condition_variable result_cv;
  5752. bool completed = false;
  5753. int result = EAI_SYSTEM;
  5754. std::string node;
  5755. std::string service;
  5756. struct addrinfo hints;
  5757. struct addrinfo *info = nullptr;
  5758. };
  5759. // Allocate on the heap, so the resolver thread can keep using the data.
  5760. auto state = std::make_shared<GetAddrInfoState>();
  5761. if (node) { state->node = node; }
  5762. state->service = service;
  5763. state->hints = *hints;
  5764. std::thread resolve_thread([state]() {
  5765. auto thread_result =
  5766. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5767. &state->info);
  5768. std::lock_guard<std::mutex> lock(state->mutex);
  5769. state->result = thread_result;
  5770. state->completed = true;
  5771. state->result_cv.notify_one();
  5772. });
  5773. // Wait for completion or timeout
  5774. std::unique_lock<std::mutex> lock(state->mutex);
  5775. auto finished =
  5776. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5777. [&] { return state->completed; });
  5778. if (finished) {
  5779. // Operation completed within timeout
  5780. resolve_thread.join();
  5781. *res = state->info;
  5782. state->info = nullptr; // Pass ownership to caller
  5783. return state->result;
  5784. } else {
  5785. // Timeout occurred
  5786. resolve_thread.detach(); // Let the thread finish in background
  5787. return EAI_AGAIN; // Return timeout error
  5788. }
  5789. #endif
  5790. #else
  5791. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5792. return getaddrinfo(node, service, hints, res);
  5793. #endif
  5794. }
  5795. template <typename BindOrConnect>
  5796. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5797. int address_family, int socket_flags, bool tcp_nodelay,
  5798. bool ipv6_v6only, SocketOptions socket_options,
  5799. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5800. // Get address info
  5801. const char *node = nullptr;
  5802. struct addrinfo hints;
  5803. struct addrinfo *result;
  5804. memset(&hints, 0, sizeof(struct addrinfo));
  5805. hints.ai_socktype = SOCK_STREAM;
  5806. hints.ai_protocol = IPPROTO_IP;
  5807. if (!ip.empty()) {
  5808. node = ip.c_str();
  5809. // Ask getaddrinfo to convert IP in c-string to address
  5810. hints.ai_family = AF_UNSPEC;
  5811. hints.ai_flags = AI_NUMERICHOST;
  5812. } else {
  5813. if (!host.empty()) { node = host.c_str(); }
  5814. hints.ai_family = address_family;
  5815. hints.ai_flags = socket_flags;
  5816. }
  5817. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5818. if (hints.ai_family == AF_UNIX) {
  5819. const auto addrlen = host.length();
  5820. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5821. #ifdef SOCK_CLOEXEC
  5822. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5823. hints.ai_protocol);
  5824. #else
  5825. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5826. #endif
  5827. if (sock != INVALID_SOCKET) {
  5828. sockaddr_un addr{};
  5829. addr.sun_family = AF_UNIX;
  5830. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5831. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5832. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5833. hints.ai_addrlen = static_cast<socklen_t>(
  5834. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5835. #ifndef SOCK_CLOEXEC
  5836. #ifndef _WIN32
  5837. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5838. #endif
  5839. #endif
  5840. if (socket_options) { socket_options(sock); }
  5841. #ifdef _WIN32
  5842. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5843. // remove the option.
  5844. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5845. #endif
  5846. bool dummy;
  5847. if (!bind_or_connect(sock, hints, dummy)) {
  5848. close_socket(sock);
  5849. sock = INVALID_SOCKET;
  5850. }
  5851. }
  5852. return sock;
  5853. }
  5854. #endif
  5855. auto service = std::to_string(port);
  5856. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5857. timeout_sec)) {
  5858. #if defined __linux__ && !defined __ANDROID__
  5859. res_init();
  5860. #endif
  5861. return INVALID_SOCKET;
  5862. }
  5863. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5864. for (auto rp = result; rp; rp = rp->ai_next) {
  5865. // Create a socket
  5866. #ifdef _WIN32
  5867. auto sock =
  5868. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5869. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5870. /**
  5871. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5872. * and above the socket creation fails on older Windows Systems.
  5873. *
  5874. * Let's try to create a socket the old way in this case.
  5875. *
  5876. * Reference:
  5877. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5878. *
  5879. * WSA_FLAG_NO_HANDLE_INHERIT:
  5880. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5881. * SP1, and later
  5882. *
  5883. */
  5884. if (sock == INVALID_SOCKET) {
  5885. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5886. }
  5887. #else
  5888. #ifdef SOCK_CLOEXEC
  5889. auto sock =
  5890. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5891. #else
  5892. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5893. #endif
  5894. #endif
  5895. if (sock == INVALID_SOCKET) { continue; }
  5896. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5897. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5898. close_socket(sock);
  5899. continue;
  5900. }
  5901. #endif
  5902. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5903. if (rp->ai_family == AF_INET6) {
  5904. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5905. }
  5906. if (socket_options) { socket_options(sock); }
  5907. // bind or connect
  5908. auto quit = false;
  5909. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5910. close_socket(sock);
  5911. if (quit) { break; }
  5912. }
  5913. return INVALID_SOCKET;
  5914. }
  5915. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5916. #ifdef _WIN32
  5917. auto flags = nonblocking ? 1UL : 0UL;
  5918. ioctlsocket(sock, FIONBIO, &flags);
  5919. #else
  5920. auto flags = fcntl(sock, F_GETFL, 0);
  5921. fcntl(sock, F_SETFL,
  5922. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5923. #endif
  5924. }
  5925. inline bool is_connection_error() {
  5926. #ifdef _WIN32
  5927. return WSAGetLastError() != WSAEWOULDBLOCK;
  5928. #else
  5929. return errno != EINPROGRESS;
  5930. #endif
  5931. }
  5932. // accept() failed because the process or the network stack is temporarily out
  5933. // of resources. The listening socket is still usable, so back off briefly and
  5934. // try again.
  5935. inline bool is_accept_resource_error() {
  5936. #ifdef _WIN32
  5937. auto err = WSAGetLastError();
  5938. return err == WSAEMFILE || err == WSAENOBUFS;
  5939. #else
  5940. auto err = errno;
  5941. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  5942. #endif
  5943. }
  5944. // accept() failed for a reason that says nothing about the listening socket:
  5945. // the pending connection went away before it could be accepted, or the call
  5946. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  5947. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  5948. // connection that way.
  5949. inline bool is_accept_transient_error() {
  5950. #ifdef _WIN32
  5951. auto err = WSAGetLastError();
  5952. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  5953. err == WSAECONNABORTED;
  5954. #else
  5955. auto err = errno;
  5956. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  5957. err == ECONNABORTED;
  5958. #endif
  5959. }
  5960. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  5961. struct addrinfo hints;
  5962. struct addrinfo *result;
  5963. memset(&hints, 0, sizeof(struct addrinfo));
  5964. hints.ai_family = AF_UNSPEC;
  5965. hints.ai_socktype = SOCK_STREAM;
  5966. hints.ai_protocol = 0;
  5967. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  5968. return false;
  5969. }
  5970. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5971. auto ret = false;
  5972. for (auto rp = result; rp; rp = rp->ai_next) {
  5973. const auto &ai = *rp;
  5974. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  5975. ret = true;
  5976. break;
  5977. }
  5978. }
  5979. return ret;
  5980. }
  5981. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  5982. #define USE_IF2IP
  5983. #endif
  5984. #ifdef USE_IF2IP
  5985. inline std::string if2ip(int address_family, const std::string &ifn) {
  5986. struct ifaddrs *ifap;
  5987. getifaddrs(&ifap);
  5988. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  5989. std::string addr_candidate;
  5990. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  5991. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  5992. (AF_UNSPEC == address_family ||
  5993. ifa->ifa_addr->sa_family == address_family)) {
  5994. if (ifa->ifa_addr->sa_family == AF_INET) {
  5995. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  5996. char buf[INET_ADDRSTRLEN];
  5997. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  5998. return std::string(buf, INET_ADDRSTRLEN);
  5999. }
  6000. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6001. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6002. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6003. char buf[INET6_ADDRSTRLEN] = {};
  6004. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6005. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6006. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6007. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6008. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6009. } else {
  6010. return std::string(buf, INET6_ADDRSTRLEN);
  6011. }
  6012. }
  6013. }
  6014. }
  6015. }
  6016. }
  6017. return addr_candidate;
  6018. }
  6019. #endif
  6020. inline socket_t create_client_socket(
  6021. const std::string &host, const std::string &ip, int port,
  6022. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6023. SocketOptions socket_options, time_t connection_timeout_sec,
  6024. time_t connection_timeout_usec, time_t read_timeout_sec,
  6025. time_t read_timeout_usec, time_t write_timeout_sec,
  6026. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6027. auto sock = create_socket(
  6028. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6029. std::move(socket_options),
  6030. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6031. if (!intf.empty()) {
  6032. #ifdef USE_IF2IP
  6033. auto ip_from_if = if2ip(address_family, intf);
  6034. if (ip_from_if.empty()) { ip_from_if = intf; }
  6035. if (!bind_ip_address(sock2, ip_from_if)) {
  6036. error = Error::BindIPAddress;
  6037. return false;
  6038. }
  6039. #endif
  6040. }
  6041. set_nonblocking(sock2, true);
  6042. auto ret =
  6043. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6044. if (ret < 0) {
  6045. if (is_connection_error()) {
  6046. error = Error::Connection;
  6047. return false;
  6048. }
  6049. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6050. connection_timeout_usec);
  6051. if (error != Error::Success) {
  6052. if (error == Error::ConnectionTimeout) { quit = true; }
  6053. return false;
  6054. }
  6055. }
  6056. set_nonblocking(sock2, false);
  6057. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6058. read_timeout_usec);
  6059. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6060. write_timeout_usec);
  6061. error = Error::Success;
  6062. return true;
  6063. },
  6064. connection_timeout_sec); // Pass DNS timeout
  6065. if (sock != INVALID_SOCKET) {
  6066. error = Error::Success;
  6067. } else {
  6068. if (error == Error::Success) { error = Error::Connection; }
  6069. }
  6070. return sock;
  6071. }
  6072. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6073. socklen_t addr_len, std::string &ip, int &port) {
  6074. if (addr.ss_family == AF_INET) {
  6075. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6076. } else if (addr.ss_family == AF_INET6) {
  6077. port =
  6078. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6079. } else {
  6080. return false;
  6081. }
  6082. std::array<char, NI_MAXHOST> ipstr{};
  6083. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6084. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6085. 0, NI_NUMERICHOST)) {
  6086. return false;
  6087. }
  6088. ip = ipstr.data();
  6089. return true;
  6090. }
  6091. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6092. struct sockaddr_storage addr;
  6093. socklen_t addr_len = sizeof(addr);
  6094. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6095. &addr_len)) {
  6096. get_ip_and_port(addr, addr_len, ip, port);
  6097. }
  6098. }
  6099. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6100. struct sockaddr_storage addr;
  6101. socklen_t addr_len = sizeof(addr);
  6102. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6103. &addr_len)) {
  6104. #ifndef _WIN32
  6105. if (addr.ss_family == AF_UNIX) {
  6106. #if defined(__linux__)
  6107. struct ucred ucred;
  6108. socklen_t len = sizeof(ucred);
  6109. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6110. port = ucred.pid;
  6111. }
  6112. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6113. pid_t pid;
  6114. socklen_t len = sizeof(pid);
  6115. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6116. port = pid;
  6117. }
  6118. #endif
  6119. return;
  6120. }
  6121. #endif
  6122. get_ip_and_port(addr, addr_len, ip, port);
  6123. }
  6124. }
  6125. // Recursive form retained so operator""_t below can compute hashes for
  6126. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6127. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6128. // instead, which is iterative and stack-safe.
  6129. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6130. unsigned int h) {
  6131. return (l == 0)
  6132. ? h
  6133. : str2tag_core(
  6134. s + 1, l - 1,
  6135. // Unsets the 6 high bits of h, therefore no overflow happens
  6136. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6137. h * 33) ^
  6138. static_cast<unsigned char>(*s));
  6139. }
  6140. inline unsigned int str2tag(const std::string &s) {
  6141. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6142. // for compile-time UDL evaluation of short string literals, but at runtime
  6143. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6144. // would blow the stack with one frame per character.
  6145. unsigned int h = 0;
  6146. for (auto c : s) {
  6147. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6148. static_cast<unsigned char>(c);
  6149. }
  6150. return h;
  6151. }
  6152. namespace udl {
  6153. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6154. return str2tag_core(s, l, 0);
  6155. }
  6156. } // namespace udl
  6157. inline std::string
  6158. find_content_type(const std::string &path,
  6159. const std::map<std::string, std::string> &user_data,
  6160. const std::string &default_content_type) {
  6161. auto ext = file_extension(path);
  6162. auto it = user_data.find(ext);
  6163. if (it != user_data.end()) { return it->second; }
  6164. using udl::operator""_t;
  6165. switch (str2tag(ext)) {
  6166. default: return default_content_type;
  6167. case "css"_t: return "text/css";
  6168. case "csv"_t: return "text/csv";
  6169. case "htm"_t:
  6170. case "html"_t: return "text/html";
  6171. case "js"_t:
  6172. case "mjs"_t: return "text/javascript";
  6173. case "txt"_t: return "text/plain";
  6174. case "vtt"_t: return "text/vtt";
  6175. case "apng"_t: return "image/apng";
  6176. case "avif"_t: return "image/avif";
  6177. case "bmp"_t: return "image/bmp";
  6178. case "gif"_t: return "image/gif";
  6179. case "png"_t: return "image/png";
  6180. case "svg"_t: return "image/svg+xml";
  6181. case "webp"_t: return "image/webp";
  6182. case "ico"_t: return "image/x-icon";
  6183. case "tif"_t: return "image/tiff";
  6184. case "tiff"_t: return "image/tiff";
  6185. case "jpg"_t:
  6186. case "jpeg"_t: return "image/jpeg";
  6187. case "mp4"_t: return "video/mp4";
  6188. case "mpeg"_t: return "video/mpeg";
  6189. case "webm"_t: return "video/webm";
  6190. case "mp3"_t: return "audio/mp3";
  6191. case "mpga"_t: return "audio/mpeg";
  6192. case "weba"_t: return "audio/webm";
  6193. case "wav"_t: return "audio/wave";
  6194. case "otf"_t: return "font/otf";
  6195. case "ttf"_t: return "font/ttf";
  6196. case "woff"_t: return "font/woff";
  6197. case "woff2"_t: return "font/woff2";
  6198. case "7z"_t: return "application/x-7z-compressed";
  6199. case "atom"_t: return "application/atom+xml";
  6200. case "pdf"_t: return "application/pdf";
  6201. case "json"_t: return "application/json";
  6202. case "rss"_t: return "application/rss+xml";
  6203. case "tar"_t: return "application/x-tar";
  6204. case "xht"_t:
  6205. case "xhtml"_t: return "application/xhtml+xml";
  6206. case "xslt"_t: return "application/xslt+xml";
  6207. case "xml"_t: return "application/xml";
  6208. case "gz"_t: return "application/gzip";
  6209. case "zip"_t: return "application/zip";
  6210. case "wasm"_t: return "application/wasm";
  6211. }
  6212. }
  6213. inline std::string
  6214. extract_media_type(const std::string &content_type,
  6215. std::map<std::string, std::string> *params = nullptr) {
  6216. // Extract type/subtype from Content-Type value (RFC 2045)
  6217. // e.g. "application/json; charset=utf-8" -> "application/json"
  6218. auto media_type = content_type;
  6219. auto semicolon_pos = media_type.find(';');
  6220. if (semicolon_pos != std::string::npos) {
  6221. auto param_str = media_type.substr(semicolon_pos + 1);
  6222. media_type = media_type.substr(0, semicolon_pos);
  6223. if (params) {
  6224. // Parse parameters: key=value pairs separated by ';'
  6225. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6226. [&](const char *b, const char *e) {
  6227. std::string key;
  6228. std::string val;
  6229. divide_param_pair(b, e, key, val);
  6230. if (!key.empty()) {
  6231. params->emplace(trim_copy(key),
  6232. trim_double_quotes_copy(val));
  6233. }
  6234. });
  6235. }
  6236. }
  6237. // Trim whitespace from media type
  6238. return trim_copy(media_type);
  6239. }
  6240. inline bool can_compress_content_type(const std::string &content_type) {
  6241. using udl::operator""_t;
  6242. auto mime_type = extract_media_type(content_type);
  6243. auto tag = str2tag(mime_type);
  6244. switch (tag) {
  6245. case "image/svg+xml"_t:
  6246. case "application/javascript"_t:
  6247. case "application/x-javascript"_t:
  6248. case "application/json"_t:
  6249. case "application/ld+json"_t:
  6250. case "application/xml"_t:
  6251. case "application/xhtml+xml"_t:
  6252. case "application/rss+xml"_t:
  6253. case "application/atom+xml"_t:
  6254. case "application/xslt+xml"_t:
  6255. case "application/protobuf"_t: return true;
  6256. case "text/event-stream"_t: return false;
  6257. default: return !mime_type.rfind("text/", 0);
  6258. }
  6259. }
  6260. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6261. double &quality) {
  6262. quality = 1.0;
  6263. token.clear();
  6264. // Split on first ';': left = token name, right = parameters
  6265. const char *params_b = nullptr;
  6266. std::size_t params_len = 0;
  6267. divide(
  6268. b, static_cast<std::size_t>(e - b), ';',
  6269. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6270. auto r = trim(lb, lb + llen, 0, llen);
  6271. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6272. params_b = rb;
  6273. params_len = rlen;
  6274. });
  6275. if (token.empty()) { return false; }
  6276. if (params_len == 0) { return true; }
  6277. // Scan parameters for q= (stops on first match)
  6278. bool invalid = false;
  6279. split_find(params_b, params_b + params_len, ';',
  6280. (std::numeric_limits<size_t>::max)(),
  6281. [&](const char *pb, const char *pe) -> bool {
  6282. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6283. auto len = static_cast<size_t>(pe - pb);
  6284. if (len < 2) { return false; }
  6285. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6286. return false;
  6287. }
  6288. // Trim the value portion
  6289. auto r = trim(pb, pe, 2, len);
  6290. if (r.first >= r.second) {
  6291. invalid = true;
  6292. return true;
  6293. }
  6294. double v = 0.0;
  6295. auto res = from_chars(pb + r.first, pb + r.second, v);
  6296. if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
  6297. invalid = true;
  6298. return true;
  6299. }
  6300. quality = v;
  6301. return true;
  6302. });
  6303. return !invalid;
  6304. }
  6305. inline EncodingType encoding_type(const Request &req,
  6306. const std::string &content_type) {
  6307. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6308. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6309. if (s.empty()) { return EncodingType::None; }
  6310. // Single-pass: iterate tokens and track the best supported encoding.
  6311. // Server preference breaks ties (br > gzip > zstd).
  6312. EncodingType best = EncodingType::None;
  6313. double best_q = 0.0; // q=0 means "not acceptable"
  6314. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6315. auto priority = [](EncodingType t) -> int {
  6316. switch (t) {
  6317. case EncodingType::Brotli: return 0;
  6318. case EncodingType::Gzip: return 1;
  6319. case EncodingType::Zstd: return 2;
  6320. default: return 3;
  6321. }
  6322. };
  6323. std::string name;
  6324. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6325. double quality = 1.0;
  6326. if (!parse_quality(b, e, name, quality)) { return; }
  6327. if (quality <= 0.0) { return; }
  6328. EncodingType type = EncodingType::None;
  6329. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6330. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6331. #endif
  6332. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6333. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6334. type = EncodingType::Gzip;
  6335. }
  6336. #endif
  6337. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6338. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6339. type = EncodingType::Zstd;
  6340. }
  6341. #endif
  6342. if (type == EncodingType::None) { return; }
  6343. // Higher q-value wins; for equal q, server preference breaks ties
  6344. if (quality > best_q ||
  6345. (quality == best_q && priority(type) < priority(best))) {
  6346. best_q = quality;
  6347. best = type;
  6348. }
  6349. });
  6350. return best;
  6351. }
  6352. // `content_type` is taken separately because a file-backed response has not
  6353. // been given one yet when its coding has to be decided.
  6354. inline EncodingType encoding_type(const Request &req, const Response &res,
  6355. const std::string &content_type) {
  6356. // The response already names a content coding of its own: a handler serving
  6357. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6358. // point whose headers name the coding its files are stored in. Applying one
  6359. // on top of that would double-encode the body and append a second
  6360. // `Content-Encoding` field line.
  6361. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6362. return encoding_type(req, content_type);
  6363. }
  6364. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6365. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6366. }
  6367. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6368. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6369. if (type == EncodingType::Gzip) {
  6370. return detail::make_unique<gzip_compressor>();
  6371. }
  6372. #endif
  6373. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6374. if (type == EncodingType::Brotli) {
  6375. return detail::make_unique<brotli_compressor>();
  6376. }
  6377. #endif
  6378. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6379. if (type == EncodingType::Zstd) {
  6380. return detail::make_unique<zstd_compressor>();
  6381. }
  6382. #endif
  6383. (void)type;
  6384. return nullptr;
  6385. }
  6386. inline const char *encoding_name(EncodingType type) {
  6387. switch (type) {
  6388. case EncodingType::Gzip: return "gzip";
  6389. case EncodingType::Brotli: return "br";
  6390. case EncodingType::Zstd: return "zstd";
  6391. default: return "";
  6392. }
  6393. }
  6394. inline bool nocompressor::compress(const char *data, size_t data_length,
  6395. bool /*last*/, Callback callback) {
  6396. if (!data_length) { return true; }
  6397. return callback(data, data_length);
  6398. }
  6399. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6400. inline gzip_compressor::gzip_compressor() {
  6401. std::memset(&strm_, 0, sizeof(strm_));
  6402. strm_.zalloc = Z_NULL;
  6403. strm_.zfree = Z_NULL;
  6404. strm_.opaque = Z_NULL;
  6405. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6406. Z_DEFAULT_STRATEGY) == Z_OK;
  6407. }
  6408. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6409. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6410. bool last, Callback callback) {
  6411. assert(is_valid_);
  6412. do {
  6413. constexpr size_t max_avail_in =
  6414. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6415. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6416. (std::min)(data_length, max_avail_in));
  6417. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6418. data_length -= strm_.avail_in;
  6419. data += strm_.avail_in;
  6420. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6421. auto ret = Z_OK;
  6422. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6423. do {
  6424. strm_.avail_out = static_cast<uInt>(buff.size());
  6425. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6426. ret = deflate(&strm_, flush);
  6427. if (ret == Z_STREAM_ERROR) { return false; }
  6428. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6429. return false;
  6430. }
  6431. } while (strm_.avail_out == 0);
  6432. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6433. (flush == Z_NO_FLUSH && ret == Z_OK));
  6434. assert(strm_.avail_in == 0);
  6435. } while (data_length > 0);
  6436. return true;
  6437. }
  6438. inline gzip_decompressor::gzip_decompressor() {
  6439. std::memset(&strm_, 0, sizeof(strm_));
  6440. strm_.zalloc = Z_NULL;
  6441. strm_.zfree = Z_NULL;
  6442. strm_.opaque = Z_NULL;
  6443. // 15 is the value of wbits, which should be at the maximum possible value
  6444. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6445. // that the stream type should be automatically detected either gzip or
  6446. // deflate.
  6447. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6448. }
  6449. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6450. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6451. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6452. Callback callback) {
  6453. assert(is_valid_);
  6454. auto ret = Z_OK;
  6455. do {
  6456. constexpr size_t max_avail_in =
  6457. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6458. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6459. (std::min)(data_length, max_avail_in));
  6460. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6461. data_length -= strm_.avail_in;
  6462. data += strm_.avail_in;
  6463. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6464. while (strm_.avail_in > 0 && ret == Z_OK) {
  6465. strm_.avail_out = static_cast<uInt>(buff.size());
  6466. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6467. ret = inflate(&strm_, Z_NO_FLUSH);
  6468. assert(ret != Z_STREAM_ERROR);
  6469. switch (ret) {
  6470. case Z_NEED_DICT:
  6471. case Z_DATA_ERROR:
  6472. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6473. }
  6474. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6475. return false;
  6476. }
  6477. }
  6478. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6479. } while (data_length > 0);
  6480. return true;
  6481. }
  6482. #endif
  6483. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6484. inline brotli_compressor::brotli_compressor() {
  6485. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6486. }
  6487. inline brotli_compressor::~brotli_compressor() {
  6488. BrotliEncoderDestroyInstance(state_);
  6489. }
  6490. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6491. bool last, Callback callback) {
  6492. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6493. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6494. auto available_in = data_length;
  6495. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6496. for (;;) {
  6497. if (last) {
  6498. if (BrotliEncoderIsFinished(state_)) { break; }
  6499. } else {
  6500. if (!available_in) { break; }
  6501. }
  6502. auto available_out = buff.size();
  6503. auto next_out = buff.data();
  6504. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6505. &available_out, &next_out, nullptr)) {
  6506. return false;
  6507. }
  6508. auto output_bytes = buff.size() - available_out;
  6509. if (output_bytes) {
  6510. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6511. }
  6512. }
  6513. return true;
  6514. }
  6515. inline brotli_decompressor::brotli_decompressor() {
  6516. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6517. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6518. : BROTLI_DECODER_RESULT_ERROR;
  6519. }
  6520. inline brotli_decompressor::~brotli_decompressor() {
  6521. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6522. }
  6523. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6524. inline bool brotli_decompressor::decompress(const char *data,
  6525. size_t data_length,
  6526. Callback callback) {
  6527. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6528. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6529. return 0;
  6530. }
  6531. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6532. size_t avail_in = data_length;
  6533. size_t total_out;
  6534. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6535. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6536. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6537. char *next_out = buff.data();
  6538. size_t avail_out = buff.size();
  6539. decoder_r = BrotliDecoderDecompressStream(
  6540. decoder_s, &avail_in, &next_in, &avail_out,
  6541. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6542. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6543. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6544. }
  6545. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6546. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6547. }
  6548. #endif
  6549. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6550. inline zstd_compressor::zstd_compressor() {
  6551. ctx_ = ZSTD_createCCtx();
  6552. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6553. }
  6554. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6555. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6556. bool last, Callback callback) {
  6557. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6558. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6559. ZSTD_inBuffer input = {data, data_length, 0};
  6560. bool finished;
  6561. do {
  6562. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6563. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6564. if (ZSTD_isError(remaining)) { return false; }
  6565. if (!callback(buff.data(), output.pos)) { return false; }
  6566. finished = last ? (remaining == 0) : (input.pos == input.size);
  6567. } while (!finished);
  6568. return true;
  6569. }
  6570. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6571. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6572. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6573. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6574. Callback callback) {
  6575. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6576. ZSTD_inBuffer input = {data, data_length, 0};
  6577. while (input.pos < input.size) {
  6578. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6579. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6580. if (ZSTD_isError(remaining)) { return false; }
  6581. if (!callback(buff.data(), output.pos)) { return false; }
  6582. }
  6583. return true;
  6584. }
  6585. #endif
  6586. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6587. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6588. // unknown coding, and its payload would be handed back still compressed.
  6589. inline bool is_zlib_encoding(const std::string &encoding) {
  6590. return case_ignore::equal(encoding, "gzip") ||
  6591. case_ignore::equal(encoding, "deflate");
  6592. }
  6593. inline bool is_brotli_encoding(const std::string &encoding) {
  6594. return case_ignore::equal(encoding, "br");
  6595. }
  6596. inline bool is_zstd_encoding(const std::string &encoding) {
  6597. return case_ignore::equal(encoding, "zstd");
  6598. }
  6599. // Returns true if the content coding is one cpp-httplib is able to decompress
  6600. // when the corresponding support is compiled in.
  6601. inline bool is_known_content_encoding(const std::string &encoding) {
  6602. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6603. is_zstd_encoding(encoding);
  6604. }
  6605. inline std::unique_ptr<decompressor>
  6606. create_decompressor(const std::string &encoding) {
  6607. std::unique_ptr<decompressor> decompressor;
  6608. if (is_zlib_encoding(encoding)) {
  6609. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6610. decompressor = detail::make_unique<gzip_decompressor>();
  6611. #endif
  6612. } else if (is_brotli_encoding(encoding)) {
  6613. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6614. decompressor = detail::make_unique<brotli_decompressor>();
  6615. #endif
  6616. } else if (is_zstd_encoding(encoding)) {
  6617. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6618. decompressor = detail::make_unique<zstd_decompressor>();
  6619. #endif
  6620. }
  6621. return decompressor;
  6622. }
  6623. // Returns the best available compressor and its Content-Encoding name.
  6624. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6625. inline std::pair<std::unique_ptr<compressor>, const char *>
  6626. create_compressor() {
  6627. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6628. return {detail::make_unique<brotli_compressor>(), "br"};
  6629. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6630. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6631. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6632. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6633. #else
  6634. return {nullptr, nullptr};
  6635. #endif
  6636. }
  6637. inline bool is_prohibited_header_name(const std::string &name) {
  6638. using udl::operator""_t;
  6639. switch (str2tag(name)) {
  6640. case "REMOTE_ADDR"_t:
  6641. case "REMOTE_PORT"_t:
  6642. case "LOCAL_ADDR"_t:
  6643. case "LOCAL_PORT"_t: return true;
  6644. default: return false;
  6645. }
  6646. }
  6647. inline bool has_header(const Headers &headers, const std::string &key) {
  6648. if (is_prohibited_header_name(key)) { return false; }
  6649. return headers.find(key) != headers.end();
  6650. }
  6651. inline const char *get_header_value(const Headers &headers,
  6652. const std::string &key, const char *def,
  6653. size_t id) {
  6654. if (is_prohibited_header_name(key)) {
  6655. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6656. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6657. throw std::invalid_argument(msg);
  6658. #else
  6659. return "";
  6660. #endif
  6661. }
  6662. auto rng = headers.equal_range(key);
  6663. auto it = rng.first;
  6664. std::advance(it, static_cast<ssize_t>(id));
  6665. if (it != rng.second) { return it->second.c_str(); }
  6666. return def;
  6667. }
  6668. inline size_t get_header_value_count(const Headers &headers,
  6669. const std::string &key) {
  6670. return headers.count(key);
  6671. }
  6672. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6673. // list may be sent as several field lines, and the combined field value is
  6674. // those values joined by commas in the order they were received. Callers that
  6675. // parse such a list must work on the combined value; reading only the first
  6676. // occurrence silently drops whatever the later field lines carry.
  6677. inline std::string get_combined_header_value(const Headers &headers,
  6678. const std::string &key) {
  6679. std::string combined;
  6680. auto rng = headers.equal_range(key);
  6681. for (auto it = rng.first; it != rng.second; ++it) {
  6682. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6683. // elements, so an empty field line must not contribute a bare comma to the
  6684. // combined value.
  6685. if (it->second.empty()) { continue; }
  6686. if (!combined.empty()) { combined += ", "; }
  6687. combined += it->second;
  6688. }
  6689. return combined;
  6690. }
  6691. inline bool has_header_token(const Headers &headers, const std::string &key,
  6692. const std::string &token) {
  6693. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6694. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6695. // several lines. Match complete tokens rather than searching the raw value,
  6696. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6697. auto rng = headers.equal_range(key);
  6698. for (auto it = rng.first; it != rng.second; ++it) {
  6699. const auto &value = it->second;
  6700. if (split_find(value.data(), value.data() + value.size(), ',',
  6701. [&](const char *b, const char *e) {
  6702. return case_ignore::equal(std::string(b, e), token);
  6703. })) {
  6704. return true;
  6705. }
  6706. }
  6707. return false;
  6708. }
  6709. template <typename Map>
  6710. inline typename Map::mapped_type
  6711. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6712. auto rng = m.equal_range(key);
  6713. auto it = rng.first;
  6714. std::advance(it, static_cast<ssize_t>(id));
  6715. if (it != rng.second) { return it->second; }
  6716. return typename Map::mapped_type();
  6717. }
  6718. inline void set_header(Headers &headers, const std::string &key,
  6719. const std::string &val) {
  6720. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6721. }
  6722. inline bool read_headers(Stream &strm, Headers &headers) {
  6723. const auto bufsiz = 2048;
  6724. char buf[bufsiz];
  6725. stream_line_reader line_reader(strm, buf, bufsiz);
  6726. size_t header_count = 0;
  6727. for (;;) {
  6728. if (!line_reader.getline()) { return false; }
  6729. // Check if the line ends with CRLF.
  6730. auto line_terminator_len = 2;
  6731. if (line_reader.end_with_crlf()) {
  6732. // Blank line indicates end of headers.
  6733. if (line_reader.size() == 2) { break; }
  6734. } else {
  6735. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6736. // Blank line indicates end of headers.
  6737. if (line_reader.size() == 1) { break; }
  6738. line_terminator_len = 1;
  6739. #else
  6740. continue; // Skip invalid line.
  6741. #endif
  6742. }
  6743. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6744. // Check header count limit
  6745. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6746. // Exclude line terminator
  6747. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6748. if (!parse_header(line_reader.ptr(), end,
  6749. [&](const std::string &key, const std::string &val) {
  6750. headers.emplace(key, val);
  6751. })) {
  6752. return false;
  6753. }
  6754. header_count++;
  6755. }
  6756. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6757. // headers that have different values to prevent request smuggling.
  6758. auto cl_range = headers.equal_range("Content-Length");
  6759. if (cl_range.first != cl_range.second) {
  6760. const auto &first_val = cl_range.first->second;
  6761. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6762. if (it->second != first_val) { return false; }
  6763. }
  6764. }
  6765. return true;
  6766. }
  6767. inline bool parse_status_line(const char *line, std::string &version,
  6768. int &status, std::string &reason) {
  6769. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6770. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6771. #else
  6772. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6773. #endif
  6774. std::cmatch m;
  6775. if (!std::regex_match(line, m, re)) { return false; }
  6776. version = std::string(m[1]);
  6777. status = std::stoi(std::string(m[2]));
  6778. reason = std::string(m[3]);
  6779. return true;
  6780. }
  6781. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6782. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6783. struct WebSocketUpgradeResponse {
  6784. Error error = Error::Success;
  6785. int status = -1;
  6786. Headers headers;
  6787. std::string selected_subprotocol;
  6788. };
  6789. inline bool read_websocket_upgrade_response(Stream &strm,
  6790. const std::string &expected_accept,
  6791. WebSocketUpgradeResponse &upgrade) {
  6792. // Read status line
  6793. const auto bufsiz = 2048;
  6794. char buf[bufsiz];
  6795. stream_line_reader line_reader(strm, buf, bufsiz);
  6796. if (!line_reader.getline()) {
  6797. upgrade.error = Error::Read;
  6798. return false;
  6799. }
  6800. std::string version;
  6801. std::string reason;
  6802. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6803. upgrade.error = Error::WebSocketHandshake;
  6804. return false;
  6805. }
  6806. // Read the headers even for a rejection so the caller can see why the
  6807. // server refused the upgrade. A non-101 response may carry a body; it is
  6808. // deliberately left unread since the caller closes the socket right away.
  6809. if (!read_headers(strm, upgrade.headers)) {
  6810. upgrade.error = Error::Read;
  6811. return false;
  6812. }
  6813. const auto &headers = upgrade.headers;
  6814. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6815. upgrade.error = Error::WebSocketHandshake;
  6816. return false;
  6817. }
  6818. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6819. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6820. upgrade.error = Error::WebSocketHandshake;
  6821. return false;
  6822. }
  6823. // Verify Connection: Upgrade
  6824. if (!has_header_token(headers, "Connection", "upgrade")) {
  6825. upgrade.error = Error::WebSocketHandshake;
  6826. return false;
  6827. }
  6828. // Verify Sec-WebSocket-Accept header value
  6829. auto it = headers.find("Sec-WebSocket-Accept");
  6830. if (it == headers.end() || it->second != expected_accept) {
  6831. upgrade.error = Error::WebSocketHandshake;
  6832. return false;
  6833. }
  6834. // Extract negotiated subprotocol
  6835. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6836. if (proto_it != headers.end()) {
  6837. upgrade.selected_subprotocol = proto_it->second;
  6838. }
  6839. return true;
  6840. }
  6841. enum class ReadContentResult {
  6842. Success, // Successfully read the content
  6843. PayloadTooLarge, // The content exceeds the specified payload limit
  6844. Error // An error occurred while reading the content
  6845. };
  6846. inline ReadContentResult read_content_with_length(
  6847. Stream &strm, size_t len, DownloadProgress progress,
  6848. ContentReceiverWithProgress out,
  6849. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6850. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6851. detail::BodyReader br;
  6852. br.stream = &strm;
  6853. br.has_content_length = true;
  6854. br.content_length = len;
  6855. br.payload_max_length = payload_max_length;
  6856. br.chunked = false;
  6857. br.bytes_read = 0;
  6858. br.last_error = Error::Success;
  6859. size_t r = 0;
  6860. while (r < len) {
  6861. auto read_len = static_cast<size_t>(len - r);
  6862. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6863. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6864. if (n <= 0) {
  6865. // Check if it was a payload size error
  6866. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6867. return ReadContentResult::PayloadTooLarge;
  6868. }
  6869. return ReadContentResult::Error;
  6870. }
  6871. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6872. return ReadContentResult::Error;
  6873. }
  6874. r += static_cast<size_t>(n);
  6875. if (progress) {
  6876. if (!progress(r, len)) { return ReadContentResult::Error; }
  6877. }
  6878. }
  6879. return ReadContentResult::Success;
  6880. }
  6881. inline ReadContentResult
  6882. read_content_without_length(Stream &strm, size_t payload_max_length,
  6883. ContentReceiverWithProgress out) {
  6884. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6885. size_t r = 0;
  6886. for (;;) {
  6887. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6888. if (n == 0) { return ReadContentResult::Success; }
  6889. if (n < 0) { return ReadContentResult::Error; }
  6890. // Check if adding this data would exceed the payload limit
  6891. if (r > payload_max_length ||
  6892. payload_max_length - r < static_cast<size_t>(n)) {
  6893. return ReadContentResult::PayloadTooLarge;
  6894. }
  6895. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6896. return ReadContentResult::Error;
  6897. }
  6898. r += static_cast<size_t>(n);
  6899. }
  6900. return ReadContentResult::Success;
  6901. }
  6902. template <typename T>
  6903. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6904. size_t payload_max_length,
  6905. ContentReceiverWithProgress out) {
  6906. detail::ChunkedDecoder dec(strm);
  6907. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6908. size_t total_len = 0;
  6909. for (;;) {
  6910. size_t chunk_offset = 0;
  6911. size_t chunk_total = 0;
  6912. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6913. if (n < 0) { return ReadContentResult::Error; }
  6914. if (n == 0) {
  6915. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6916. return ReadContentResult::Error;
  6917. }
  6918. return ReadContentResult::Success;
  6919. }
  6920. if (total_len > payload_max_length ||
  6921. payload_max_length - total_len < static_cast<size_t>(n)) {
  6922. return ReadContentResult::PayloadTooLarge;
  6923. }
  6924. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6925. return ReadContentResult::Error;
  6926. }
  6927. total_len += static_cast<size_t>(n);
  6928. }
  6929. }
  6930. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6931. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6932. // is the final transfer coding. A single field value may list several
  6933. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6934. // several Transfer-Encoding lines, which combine into one comma-separated
  6935. // list in the order the lines were received. Headers preserves that order,
  6936. // so the final coding is the last token of the last line. Match it
  6937. // case-insensitively rather than comparing the whole value against
  6938. // "chunked".
  6939. //
  6940. // Security: reading a chunked message as unframed leaves its body in the
  6941. // socket, where a keep-alive connection parses it as a smuggled request.
  6942. // Server::process_request() answers 400 and closes when the final coding is
  6943. // not chunked, so a request whose framing cannot be determined never
  6944. // reaches the "no body" path.
  6945. auto rng = headers.equal_range("Transfer-Encoding");
  6946. if (rng.first == rng.second) { return false; }
  6947. // Cleared per line, so a trailing line carrying no coding at all leaves the
  6948. // combined list ending in nothing rather than inheriting the line before it.
  6949. std::string last_coding;
  6950. for (auto it = rng.first; it != rng.second; ++it) {
  6951. const auto &value = it->second;
  6952. last_coding.clear();
  6953. split(value.data(), value.data() + value.size(), ',',
  6954. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  6955. }
  6956. return case_ignore::equal(last_coding, "chunked");
  6957. }
  6958. template <typename T, typename U>
  6959. bool prepare_content_receiver(T &x, int &status,
  6960. ContentReceiverWithProgress receiver,
  6961. bool decompress, size_t payload_max_length,
  6962. bool &exceed_payload_max_length, U callback) {
  6963. if (decompress) {
  6964. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  6965. std::unique_ptr<decompressor> decompressor;
  6966. if (!encoding.empty()) {
  6967. // A coding we know about but were not built with is an error. An
  6968. // unrecognized coding (including "identity") is left alone and the
  6969. // payload is passed through as-is, since some servers misuse the header,
  6970. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  6971. decompressor = detail::create_decompressor(encoding);
  6972. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  6973. status = StatusCode::UnsupportedMediaType_415;
  6974. return false;
  6975. }
  6976. }
  6977. if (decompressor) {
  6978. if (decompressor->is_valid()) {
  6979. size_t decompressed_size = 0;
  6980. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  6981. size_t off, size_t len) {
  6982. return decompressor->decompress(
  6983. buf, n, [&](const char *buf2, size_t n2) {
  6984. // Guard against zip-bomb: check
  6985. // decompressed size against limit.
  6986. if (payload_max_length > 0 &&
  6987. (decompressed_size >= payload_max_length ||
  6988. n2 > payload_max_length - decompressed_size)) {
  6989. exceed_payload_max_length = true;
  6990. return false;
  6991. }
  6992. decompressed_size += n2;
  6993. return receiver(buf2, n2, off, len);
  6994. });
  6995. };
  6996. return callback(std::move(out));
  6997. } else {
  6998. status = StatusCode::InternalServerError_500;
  6999. return false;
  7000. }
  7001. }
  7002. }
  7003. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7004. size_t len) {
  7005. return receiver(buf, n, off, len);
  7006. };
  7007. return callback(std::move(out));
  7008. }
  7009. template <typename T>
  7010. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7011. DownloadProgress progress,
  7012. ContentReceiverWithProgress receiver, bool decompress) {
  7013. bool exceed_payload_max_length = false;
  7014. return prepare_content_receiver(
  7015. x, status, std::move(receiver), decompress, payload_max_length,
  7016. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7017. auto ret = true;
  7018. // Note: exceed_payload_max_length may also be set by the decompressor
  7019. // wrapper in prepare_content_receiver when the decompressed payload
  7020. // size exceeds the limit.
  7021. if (is_chunked_transfer_encoding(x.headers)) {
  7022. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7023. if (result == ReadContentResult::Success) {
  7024. ret = true;
  7025. } else if (result == ReadContentResult::PayloadTooLarge) {
  7026. exceed_payload_max_length = true;
  7027. ret = false;
  7028. } else {
  7029. ret = false;
  7030. }
  7031. } else if (!has_header(x.headers, "Content-Length")) {
  7032. auto result =
  7033. read_content_without_length(strm, payload_max_length, out);
  7034. if (result == ReadContentResult::Success) {
  7035. ret = true;
  7036. } else if (result == ReadContentResult::PayloadTooLarge) {
  7037. exceed_payload_max_length = true;
  7038. ret = false;
  7039. } else {
  7040. ret = false;
  7041. }
  7042. } else {
  7043. auto is_invalid_value = false;
  7044. auto len = get_header_value_u64(x.headers, "Content-Length",
  7045. (std::numeric_limits<size_t>::max)(),
  7046. 0, is_invalid_value);
  7047. if (is_invalid_value) {
  7048. ret = false;
  7049. } else if (len > 0) {
  7050. auto result = read_content_with_length(
  7051. strm, len, std::move(progress), out, payload_max_length);
  7052. ret = (result == ReadContentResult::Success);
  7053. if (result == ReadContentResult::PayloadTooLarge) {
  7054. exceed_payload_max_length = true;
  7055. }
  7056. }
  7057. }
  7058. if (!ret) {
  7059. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7060. : StatusCode::BadRequest_400;
  7061. }
  7062. return ret;
  7063. });
  7064. }
  7065. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7066. const std::string &path) {
  7067. // A request target must not carry CR/LF (or other control octets); otherwise
  7068. // a value smuggled into it splits the request line and injects headers or a
  7069. // whole request. The same field-value check already guards header values in
  7070. // check_and_write_headers and the request target in
  7071. // perform_websocket_handshake; apply it here too.
  7072. if (!fields::is_field_value(path)) { return -1; }
  7073. std::string s = method;
  7074. s += ' ';
  7075. s += path;
  7076. s += " HTTP/1.1\r\n";
  7077. return strm.write(s.data(), s.size());
  7078. }
  7079. inline ssize_t write_response_line(Stream &strm, int status) {
  7080. std::string s = "HTTP/1.1 ";
  7081. s += std::to_string(status);
  7082. s += ' ';
  7083. s += httplib::status_message(status);
  7084. s += "\r\n";
  7085. return strm.write(s.data(), s.size());
  7086. }
  7087. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7088. ssize_t write_len = 0;
  7089. for (const auto &x : headers) {
  7090. // Skip fields with invalid names or values to prevent response splitting
  7091. // via CR/LF injection, matching set_header(). The client validates request
  7092. // headers up front in check_and_write_headers, but the server passes
  7093. // res.headers straight to this writer, and res.headers is a public field
  7094. // an application can populate directly with request-derived values.
  7095. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7096. std::string s;
  7097. s = x.first;
  7098. s += ": ";
  7099. s += x.second;
  7100. s += "\r\n";
  7101. auto len = strm.write(s.data(), s.size());
  7102. if (len < 0) { return len; }
  7103. write_len += len;
  7104. }
  7105. auto len = strm.write("\r\n");
  7106. if (len < 0) { return len; }
  7107. write_len += len;
  7108. return write_len;
  7109. }
  7110. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7111. size_t offset = 0;
  7112. while (offset < l) {
  7113. auto length = strm.write(d + offset, l - offset);
  7114. if (length < 0) { return false; }
  7115. offset += static_cast<size_t>(length);
  7116. }
  7117. return true;
  7118. }
  7119. template <typename T>
  7120. inline bool write_content_with_progress(Stream &strm,
  7121. const ContentProvider &content_provider,
  7122. size_t offset, size_t length,
  7123. T is_shutting_down,
  7124. const UploadProgress &upload_progress,
  7125. Error &error) {
  7126. size_t end_offset = offset + length;
  7127. size_t start_offset = offset;
  7128. auto ok = true;
  7129. auto finished = false;
  7130. DataSink data_sink;
  7131. data_sink.write = [&](const char *d, size_t l) -> bool {
  7132. if (ok) {
  7133. if (write_data(strm, d, l)) {
  7134. offset += l;
  7135. if (upload_progress && length > 0) {
  7136. size_t current_written = offset - start_offset;
  7137. if (!upload_progress(current_written, length)) {
  7138. ok = false;
  7139. return false;
  7140. }
  7141. }
  7142. } else {
  7143. ok = false;
  7144. }
  7145. }
  7146. return ok;
  7147. };
  7148. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7149. // The body is framed by `length`, so a provider that reports itself done
  7150. // early has truncated it. Record that and let the short-body check below
  7151. // fail the write, rather than calling the provider again forever.
  7152. data_sink.done = [&]() { finished = true; };
  7153. while (offset < end_offset && !finished && !is_shutting_down()) {
  7154. auto last_offset = offset;
  7155. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7156. error = Error::Write;
  7157. return false;
  7158. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7159. error = Error::Canceled;
  7160. return false;
  7161. } else if (!ok) {
  7162. error = Error::Write;
  7163. return false;
  7164. }
  7165. // A provider that reports success without writing anything and without
  7166. // reporting itself done gets handed the same offset and length again on
  7167. // the next pass, so it would spin here for as long as the peer stays
  7168. // connected. Treat making no progress as a short body, like done() early.
  7169. if (!finished && offset == last_offset) {
  7170. error = Error::Write;
  7171. return false;
  7172. }
  7173. }
  7174. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7175. error = Error::Write;
  7176. return false;
  7177. }
  7178. error = Error::Success;
  7179. return true;
  7180. }
  7181. template <typename T>
  7182. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7183. size_t offset, size_t length, T is_shutting_down,
  7184. Error &error) {
  7185. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7186. is_shutting_down, nullptr, error);
  7187. }
  7188. template <typename T>
  7189. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7190. size_t offset, size_t length,
  7191. const T &is_shutting_down) {
  7192. auto error = Error::Success;
  7193. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7194. error);
  7195. }
  7196. template <typename T>
  7197. inline bool
  7198. write_content_without_length(Stream &strm,
  7199. const ContentProvider &content_provider,
  7200. const T &is_shutting_down) {
  7201. size_t offset = 0;
  7202. auto data_available = true;
  7203. auto ok = true;
  7204. DataSink data_sink;
  7205. data_sink.write = [&](const char *d, size_t l) -> bool {
  7206. if (ok) {
  7207. offset += l;
  7208. if (!write_data(strm, d, l)) { ok = false; }
  7209. }
  7210. return ok;
  7211. };
  7212. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7213. data_sink.done = [&](void) { data_available = false; };
  7214. while (data_available && !is_shutting_down()) {
  7215. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7216. return false;
  7217. } else if (!content_provider(offset, 0, data_sink)) {
  7218. return false;
  7219. } else if (!ok) {
  7220. return false;
  7221. }
  7222. }
  7223. return !data_available; // true only if done() was called, false if shutting
  7224. // down
  7225. }
  7226. // Runs a known-length content provider to completion and compresses what it
  7227. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7228. // by an mmap hands the compressor a pointer straight into the mapping.
  7229. inline bool compress_content_provider(const ContentProvider &content_provider,
  7230. size_t length, compressor &cmp,
  7231. std::string &out) {
  7232. size_t offset = 0;
  7233. auto ok = true;
  7234. auto finished = false;
  7235. DataSink data_sink;
  7236. auto append = [&](const char *data, size_t data_len) {
  7237. out.append(data, data_len);
  7238. return true;
  7239. };
  7240. data_sink.write = [&](const char *d, size_t l) -> bool {
  7241. if (!ok) { return false; }
  7242. offset += l;
  7243. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7244. return ok;
  7245. };
  7246. // The body is framed by `length`, so a provider that reports itself done
  7247. // early has truncated it; the short-body check below turns that into a
  7248. // failure rather than calling the provider again forever.
  7249. data_sink.done = [&]() { finished = true; };
  7250. while (offset < length && !finished) {
  7251. auto prev_offset = offset;
  7252. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7253. return false;
  7254. }
  7255. // No Stream to block on here, so a provider that keeps returning true
  7256. // without writing would spin. Treat a pass that made no progress as a
  7257. // failure.
  7258. if (offset == prev_offset) { return false; }
  7259. }
  7260. if (offset != length) { return false; }
  7261. return cmp.compress(nullptr, 0, true, append);
  7262. }
  7263. // Serves `m` as the response body. `set_content_provider()` clears the coding,
  7264. // so recording it has to come after; keeping both here means a third
  7265. // file-serving path cannot get that order wrong.
  7266. inline void set_file_content_provider(Response &res,
  7267. const std::shared_ptr<mmap> &m,
  7268. const std::string &content_type,
  7269. EncodingType encoding) {
  7270. res.set_content_provider(
  7271. m->size(), content_type,
  7272. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7273. sink.write(m->data() + offset, length);
  7274. return true;
  7275. });
  7276. res.content_coding_ = encoding;
  7277. }
  7278. template <typename T, typename U>
  7279. inline bool
  7280. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7281. const T &is_shutting_down, U &compressor, Error &error) {
  7282. size_t offset = 0;
  7283. auto data_available = true;
  7284. auto ok = true;
  7285. DataSink data_sink;
  7286. data_sink.write = [&](const char *d, size_t l) -> bool {
  7287. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7288. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7289. // zero-length chunk is the terminator, so it must not be emitted here.
  7290. if (ok && l > 0) {
  7291. offset += l;
  7292. std::string payload;
  7293. if (compressor.compress(d, l, false,
  7294. [&](const char *data, size_t data_len) {
  7295. payload.append(data, data_len);
  7296. return true;
  7297. })) {
  7298. if (!payload.empty()) {
  7299. // Emit chunked response header and footer for each chunk
  7300. auto chunk =
  7301. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7302. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7303. }
  7304. } else {
  7305. ok = false;
  7306. }
  7307. }
  7308. return ok;
  7309. };
  7310. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7311. auto done_with_trailer = [&](const Headers *trailer) {
  7312. if (!ok) { return; }
  7313. data_available = false;
  7314. std::string payload;
  7315. if (!compressor.compress(nullptr, 0, true,
  7316. [&](const char *data, size_t data_len) {
  7317. payload.append(data, data_len);
  7318. return true;
  7319. })) {
  7320. ok = false;
  7321. return;
  7322. }
  7323. if (!payload.empty()) {
  7324. // Emit chunked response header and footer for each chunk
  7325. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7326. if (!write_data(strm, chunk.data(), chunk.size())) {
  7327. ok = false;
  7328. return;
  7329. }
  7330. }
  7331. constexpr const char done_marker[] = "0\r\n";
  7332. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7333. // Trailer
  7334. if (trailer) {
  7335. for (const auto &kv : *trailer) {
  7336. // Skip fields with invalid names or values to prevent response
  7337. // splitting via CR/LF injection, matching set_header().
  7338. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7339. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7340. if (!write_data(strm, field_line.data(), field_line.size())) {
  7341. ok = false;
  7342. }
  7343. }
  7344. }
  7345. constexpr const char crlf[] = "\r\n";
  7346. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7347. };
  7348. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7349. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7350. done_with_trailer(&trailer);
  7351. };
  7352. while (data_available && !is_shutting_down()) {
  7353. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7354. error = Error::Write;
  7355. return false;
  7356. } else if (!content_provider(offset, 0, data_sink)) {
  7357. error = Error::Canceled;
  7358. return false;
  7359. } else if (!ok) {
  7360. error = Error::Write;
  7361. return false;
  7362. }
  7363. }
  7364. if (data_available) { // exited due to is_shutting_down(), not done()
  7365. error = Error::Write;
  7366. return false;
  7367. }
  7368. error = Error::Success;
  7369. return true;
  7370. }
  7371. template <typename T, typename U>
  7372. inline bool write_content_chunked(Stream &strm,
  7373. const ContentProvider &content_provider,
  7374. const T &is_shutting_down, U &compressor) {
  7375. auto error = Error::Success;
  7376. return write_content_chunked(strm, content_provider, is_shutting_down,
  7377. compressor, error);
  7378. }
  7379. template <typename T>
  7380. inline bool redirect(T &cli, Request &req, Response &res,
  7381. const std::string &path, const std::string &location,
  7382. Error &error) {
  7383. Request new_req = req;
  7384. new_req.path = path;
  7385. new_req.redirect_count_ -= 1;
  7386. if (res.status == StatusCode::SeeOther_303 &&
  7387. (req.method != "GET" && req.method != "HEAD")) {
  7388. new_req.method = "GET";
  7389. new_req.body.clear();
  7390. new_req.headers.clear();
  7391. }
  7392. Response new_res;
  7393. auto ret = cli.send(new_req, new_res, error);
  7394. if (ret) {
  7395. req = std::move(new_req);
  7396. res = std::move(new_res);
  7397. if (res.location.empty()) { res.location = location; }
  7398. }
  7399. return ret;
  7400. }
  7401. inline std::string params_to_query_str(const Params &params) {
  7402. std::string query;
  7403. for (auto it = params.begin(); it != params.end(); ++it) {
  7404. if (it != params.begin()) { query += '&'; }
  7405. query += encode_query_component(it->first);
  7406. query += '=';
  7407. query += encode_query_component(it->second);
  7408. }
  7409. return query;
  7410. }
  7411. // Splits one "key=value" span of a query string at its first '='. A span with
  7412. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7413. // "?flag" keeps its name.
  7414. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7415. std::string &val) {
  7416. divide(b, static_cast<std::size_t>(e - b), '=',
  7417. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7418. std::size_t rhs_size) {
  7419. key.assign(lhs_data, lhs_size);
  7420. val.assign(rhs_data, rhs_size);
  7421. });
  7422. }
  7423. inline void parse_query_text(const char *data, std::size_t size,
  7424. Params &params) {
  7425. std::set<std::string> cache;
  7426. split(data, data + size, '&', [&](const char *b, const char *e) {
  7427. std::string kv(b, e);
  7428. if (cache.find(kv) != cache.end()) { return; }
  7429. cache.insert(std::move(kv));
  7430. std::string key;
  7431. std::string val;
  7432. divide_query_pair(b, e, key, val);
  7433. if (!key.empty()) {
  7434. params.emplace(decode_query_component(key), decode_query_component(val));
  7435. }
  7436. });
  7437. }
  7438. inline void parse_query_text(const std::string &s, Params &params) {
  7439. parse_query_text(s.data(), s.size(), params);
  7440. }
  7441. // Normalize a query string by decoding and re-encoding each key/value pair
  7442. // while preserving the original parameter order. This avoids double-encoding
  7443. // and ensures consistent encoding. It works on the raw string rather than
  7444. // parsing into Params and re-serializing, because that round trip cannot
  7445. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7446. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7447. // duplicated pairs.
  7448. inline std::string normalize_query_string(const std::string &query) {
  7449. std::string result;
  7450. split(query.data(), query.data() + query.size(), '&',
  7451. [&](const char *b, const char *e) {
  7452. std::string key;
  7453. std::string val;
  7454. divide_query_pair(b, e, key, val);
  7455. if (!key.empty()) {
  7456. auto dec_key = decode_query_component(key);
  7457. auto dec_val = decode_query_component(val);
  7458. if (!result.empty()) { result += '&'; }
  7459. result += encode_query_component(dec_key);
  7460. if (!val.empty() || std::find(b, e, '=') != e) {
  7461. result += '=';
  7462. result += encode_query_component(dec_val);
  7463. }
  7464. }
  7465. });
  7466. return result;
  7467. }
  7468. // Build the request target that goes on the wire from a caller-supplied path.
  7469. // Shared by the buffered send path and the streaming API so that both put the
  7470. // same bytes in the request line for the same input.
  7471. inline std::string encode_request_target(const std::string &target,
  7472. bool path_encode) {
  7473. // `substr(0, npos)` yields the whole string, which is what the no-query
  7474. // case needs.
  7475. auto query_pos = target.find('?');
  7476. auto path_part = target.substr(0, query_pos);
  7477. std::string query_part;
  7478. if (query_pos != std::string::npos) {
  7479. query_part = target.substr(query_pos + 1);
  7480. }
  7481. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7482. if (!query_part.empty()) {
  7483. // When path encoding is disabled the caller has supplied an already-encoded
  7484. // target and expects the exact bytes to be sent on the wire, so skip
  7485. // normalization for the query too. Normalizing would decode-then-re-encode
  7486. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7487. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7488. if (path_encode) {
  7489. auto normalized = normalize_query_string(query_part);
  7490. if (!normalized.empty()) {
  7491. result += '?';
  7492. result += normalized;
  7493. }
  7494. } else {
  7495. result += '?';
  7496. result += query_part;
  7497. }
  7498. }
  7499. return result;
  7500. }
  7501. inline bool parse_multipart_boundary(const std::string &content_type,
  7502. std::string &boundary) {
  7503. std::map<std::string, std::string> params;
  7504. extract_media_type(content_type, &params);
  7505. auto it = params.find("boundary");
  7506. if (it == params.end()) { return false; }
  7507. boundary = it->second;
  7508. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7509. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7510. // bytes costs a nearly full comparison at nearly every position: the
  7511. // boundary's length multiplies the worst-case cost of scanning a body.
  7512. return !boundary.empty() && boundary.size() <= 70;
  7513. }
  7514. inline void parse_disposition_params(const std::string &s, Params &params) {
  7515. std::set<std::string> cache;
  7516. split_unquoted(s.data(), s.data() + s.size(), ';',
  7517. [&](const char *b, const char *e) {
  7518. std::string kv(b, e);
  7519. if (cache.find(kv) != cache.end()) { return; }
  7520. cache.insert(kv);
  7521. std::string key;
  7522. std::string val;
  7523. divide_param_pair(b, e, key, val);
  7524. if (!key.empty()) {
  7525. params.emplace(trim_double_quotes_copy(key),
  7526. trim_double_quotes_copy(val));
  7527. }
  7528. });
  7529. }
  7530. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7531. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7532. #else
  7533. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7534. #endif
  7535. auto is_valid = [](const std::string &str) {
  7536. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7537. };
  7538. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7539. const auto pos = static_cast<size_t>(6);
  7540. const auto len = static_cast<size_t>(s.size() - 6);
  7541. auto all_valid_ranges = true;
  7542. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7543. if (!all_valid_ranges) { return; }
  7544. const auto it = std::find(b, e, '-');
  7545. if (it == e) {
  7546. all_valid_ranges = false;
  7547. return;
  7548. }
  7549. const auto lhs = std::string(b, it);
  7550. const auto rhs = std::string(it + 1, e);
  7551. if (!is_valid(lhs) || !is_valid(rhs)) {
  7552. all_valid_ranges = false;
  7553. return;
  7554. }
  7555. ssize_t first = -1;
  7556. if (!lhs.empty()) {
  7557. ssize_t v;
  7558. auto res = detail::from_chars(lhs.data(), lhs.data() + lhs.size(), v);
  7559. if (res.ec == std::errc{}) { first = v; }
  7560. }
  7561. ssize_t last = -1;
  7562. if (!rhs.empty()) {
  7563. ssize_t v;
  7564. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7565. if (res.ec == std::errc{}) { last = v; }
  7566. }
  7567. if ((first == -1 && last == -1) ||
  7568. (first != -1 && last != -1 && first > last)) {
  7569. all_valid_ranges = false;
  7570. return;
  7571. }
  7572. ranges.emplace_back(first, last);
  7573. });
  7574. return all_valid_ranges && !ranges.empty();
  7575. }
  7576. return false;
  7577. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7578. }
  7579. #else
  7580. } catch (...) { return false; }
  7581. #endif
  7582. inline bool parse_accept_header(const std::string &s,
  7583. std::vector<std::string> &content_types) {
  7584. content_types.clear();
  7585. // Empty string is considered valid (no preference)
  7586. if (s.empty()) { return true; }
  7587. struct AcceptEntry {
  7588. std::string media_type;
  7589. double quality;
  7590. int order;
  7591. };
  7592. std::vector<AcceptEntry> entries;
  7593. int order = 0;
  7594. bool has_invalid_entry = false;
  7595. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7596. // has to parse and ignore empty list elements, so a leading, trailing or
  7597. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7598. // split() skips them, and the header length limit bounds how many a sender
  7599. // can send, so ignoring all of them cannot be used as a denial-of-service
  7600. // vector.
  7601. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7602. std::string entry(b, e);
  7603. entry = trim_copy(entry);
  7604. AcceptEntry accept_entry;
  7605. accept_entry.order = order++;
  7606. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7607. accept_entry.media_type, accept_entry.quality)) {
  7608. has_invalid_entry = true;
  7609. return;
  7610. }
  7611. // Remove additional parameters from media type
  7612. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7613. // Basic validation of media type format
  7614. if (accept_entry.media_type.empty()) {
  7615. has_invalid_entry = true;
  7616. return;
  7617. }
  7618. // Check for basic media type format (should contain '/' or be '*')
  7619. if (accept_entry.media_type != "*" &&
  7620. accept_entry.media_type.find('/') == std::string::npos) {
  7621. has_invalid_entry = true;
  7622. return;
  7623. }
  7624. entries.push_back(std::move(accept_entry));
  7625. });
  7626. // Return false if any invalid entry was found
  7627. if (has_invalid_entry) { return false; }
  7628. // Sort by quality (descending), then by original order (ascending)
  7629. std::sort(entries.begin(), entries.end(),
  7630. [](const AcceptEntry &a, const AcceptEntry &b) {
  7631. if (a.quality != b.quality) {
  7632. return a.quality > b.quality; // Higher quality first
  7633. }
  7634. return a.order < b.order; // Earlier order first for same quality
  7635. });
  7636. // Extract sorted media types
  7637. content_types.reserve(entries.size());
  7638. for (auto &entry : entries) {
  7639. content_types.push_back(std::move(entry.media_type));
  7640. }
  7641. return true;
  7642. }
  7643. class FormDataParser {
  7644. public:
  7645. FormDataParser() = default;
  7646. void set_boundary(std::string &&boundary) {
  7647. boundary_ = std::move(boundary);
  7648. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7649. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7650. }
  7651. bool is_valid() const { return is_valid_; }
  7652. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7653. const ContentReceiver &content_callback) {
  7654. // Once the close delimiter has been seen the rest of the body is epilogue
  7655. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7656. // spread across reads is not copied in only to be erased right away.
  7657. if (state_ == 5) { return true; }
  7658. buf_append(buf, n);
  7659. while (buf_size() > 0) {
  7660. switch (state_) {
  7661. case 0: { // Initial boundary
  7662. auto pos = buf_find(dash_boundary_crlf_);
  7663. if (pos == buf_size()) {
  7664. // Not found yet: keep only a possible partial boundary at the tail so
  7665. // that a body which never contains the boundary cannot grow the
  7666. // buffer (and get rescanned from the start) without bound.
  7667. auto keep = dash_boundary_crlf_.size() - 1;
  7668. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7669. return true;
  7670. }
  7671. buf_erase(pos + dash_boundary_crlf_.size());
  7672. state_ = 1;
  7673. break;
  7674. }
  7675. case 1: { // New entry
  7676. clear_file_info();
  7677. state_ = 2;
  7678. break;
  7679. }
  7680. case 2: { // Headers
  7681. auto pos = buf_find(crlf_);
  7682. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7683. while (pos < buf_size()) {
  7684. // Empty line
  7685. if (pos == 0) {
  7686. if (!header_callback(file_)) {
  7687. is_valid_ = false;
  7688. return false;
  7689. }
  7690. buf_erase(crlf_.size());
  7691. state_ = 3;
  7692. break;
  7693. }
  7694. // Check header count limit
  7695. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7696. is_valid_ = false;
  7697. return false;
  7698. }
  7699. header_count_++;
  7700. const auto header = buf_head(pos);
  7701. if (!parse_header(header.data(), header.data() + header.size(),
  7702. [&](const std::string &, const std::string &) {})) {
  7703. is_valid_ = false;
  7704. return false;
  7705. }
  7706. // Parse and emplace space trimmed headers into a map
  7707. if (!parse_header(
  7708. header.data(), header.data() + header.size(),
  7709. [&](const std::string &key, const std::string &val) {
  7710. file_.headers.emplace(key, val);
  7711. })) {
  7712. is_valid_ = false;
  7713. return false;
  7714. }
  7715. constexpr const char header_content_type[] = "Content-Type:";
  7716. if (start_with_case_ignore(header, header_content_type)) {
  7717. file_.content_type =
  7718. trim_copy(header.substr(str_len(header_content_type)));
  7719. } else {
  7720. std::string disposition_params;
  7721. if (parse_content_disposition(header, disposition_params)) {
  7722. Params params;
  7723. parse_disposition_params(disposition_params, params);
  7724. auto it = params.find("name");
  7725. if (it != params.end()) {
  7726. file_.name = it->second;
  7727. } else {
  7728. is_valid_ = false;
  7729. return false;
  7730. }
  7731. it = params.find("filename");
  7732. if (it != params.end()) { file_.filename = it->second; }
  7733. it = params.find("filename*");
  7734. if (it != params.end()) {
  7735. // RFC 5987: only UTF-8 encoding is allowed
  7736. const auto &val = it->second;
  7737. constexpr const char utf8_prefix[] = "UTF-8''";
  7738. constexpr size_t prefix_len = str_len(utf8_prefix);
  7739. if (val.size() > prefix_len &&
  7740. start_with_case_ignore(val, utf8_prefix)) {
  7741. file_.filename = decode_path_component(
  7742. val.substr(prefix_len)); // override...
  7743. } else {
  7744. is_valid_ = false;
  7745. return false;
  7746. }
  7747. }
  7748. }
  7749. }
  7750. buf_erase(pos + crlf_.size());
  7751. pos = buf_find(crlf_);
  7752. }
  7753. if (state_ != 3) { return true; }
  7754. break;
  7755. }
  7756. case 3: { // Body
  7757. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7758. auto pos = buf_find(crlf_dash_boundary_);
  7759. if (pos < buf_size()) {
  7760. if (!content_callback(buf_data(), pos)) {
  7761. is_valid_ = false;
  7762. return false;
  7763. }
  7764. buf_erase(pos + crlf_dash_boundary_.size());
  7765. state_ = 4;
  7766. } else {
  7767. auto len = buf_size() - crlf_dash_boundary_.size();
  7768. if (len > 0) {
  7769. if (!content_callback(buf_data(), len)) {
  7770. is_valid_ = false;
  7771. return false;
  7772. }
  7773. buf_erase(len);
  7774. }
  7775. return true;
  7776. }
  7777. break;
  7778. }
  7779. case 4: { // Boundary
  7780. if (crlf_.size() > buf_size()) { return true; }
  7781. if (buf_start_with(crlf_)) {
  7782. buf_erase(crlf_.size());
  7783. state_ = 1;
  7784. } else if (buf_start_with(dash_)) {
  7785. buf_erase(dash_.size());
  7786. is_valid_ = true;
  7787. state_ = 5;
  7788. } else {
  7789. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7790. // accepted after a boundary; RFC 2046 allows transport-padding in
  7791. // between, but this parser has never supported it. Either way the
  7792. // body is already destined to be rejected, so fail now instead of
  7793. // buffering the rest of it. Both are two bytes, so the check above
  7794. // already guarantees enough buffered data to decide.
  7795. is_valid_ = false;
  7796. return false;
  7797. }
  7798. break;
  7799. }
  7800. case 5: { // Epilogue
  7801. buf_erase(buf_size());
  7802. break;
  7803. }
  7804. }
  7805. }
  7806. return true;
  7807. }
  7808. private:
  7809. void clear_file_info() {
  7810. file_.name.clear();
  7811. file_.filename.clear();
  7812. file_.content_type.clear();
  7813. file_.headers.clear();
  7814. header_count_ = 0;
  7815. }
  7816. bool start_with_case_ignore(const std::string &a, const char *b,
  7817. size_t offset = 0) const {
  7818. const auto b_len = strlen(b);
  7819. if (a.size() < offset + b_len) { return false; }
  7820. for (size_t i = 0; i < b_len; i++) {
  7821. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7822. return false;
  7823. }
  7824. }
  7825. return true;
  7826. }
  7827. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7828. // Returns true if header matches, with the params portion in `params_out`.
  7829. bool parse_content_disposition(const std::string &header,
  7830. std::string &params_out) const {
  7831. constexpr const char prefix[] = "Content-Disposition:";
  7832. constexpr size_t prefix_len = str_len(prefix);
  7833. if (!start_with_case_ignore(header, prefix)) { return false; }
  7834. // Skip whitespace after "Content-Disposition:"
  7835. auto pos = prefix_len;
  7836. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7837. pos++;
  7838. }
  7839. // Match "form-data;" (case-insensitive)
  7840. constexpr const char form_data[] = "form-data;";
  7841. constexpr size_t form_data_len = str_len(form_data);
  7842. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7843. pos += form_data_len;
  7844. // Skip whitespace after "form-data;"
  7845. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7846. pos++;
  7847. }
  7848. params_out = header.substr(pos);
  7849. return true;
  7850. }
  7851. const std::string dash_ = "--";
  7852. const std::string crlf_ = "\r\n";
  7853. std::string boundary_;
  7854. std::string dash_boundary_crlf_;
  7855. std::string crlf_dash_boundary_;
  7856. size_t state_ = 0;
  7857. bool is_valid_ = false;
  7858. FormData file_;
  7859. size_t header_count_ = 0;
  7860. // Buffer
  7861. bool start_with(const std::string &a, size_t spos, size_t epos,
  7862. const std::string &b) const {
  7863. if (epos - spos < b.size()) { return false; }
  7864. for (size_t i = 0; i < b.size(); i++) {
  7865. if (a[i + spos] != b[i]) { return false; }
  7866. }
  7867. return true;
  7868. }
  7869. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7870. const char *buf_data() const { return &buf_[buf_spos_]; }
  7871. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7872. bool buf_start_with(const std::string &s) const {
  7873. return start_with(buf_, buf_spos_, buf_epos_, s);
  7874. }
  7875. size_t buf_find(const std::string &s) const {
  7876. auto c = s.front();
  7877. size_t off = buf_spos_;
  7878. while (off < buf_epos_) {
  7879. auto pos = off;
  7880. while (true) {
  7881. if (pos == buf_epos_) { return buf_size(); }
  7882. if (buf_[pos] == c) { break; }
  7883. pos++;
  7884. }
  7885. auto remaining_size = buf_epos_ - pos;
  7886. if (s.size() > remaining_size) { return buf_size(); }
  7887. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7888. off = pos + 1;
  7889. }
  7890. return buf_size();
  7891. }
  7892. void buf_append(const char *data, size_t n) {
  7893. auto remaining_size = buf_size();
  7894. if (remaining_size > 0 && buf_spos_ > 0) {
  7895. for (size_t i = 0; i < remaining_size; i++) {
  7896. buf_[i] = buf_[buf_spos_ + i];
  7897. }
  7898. }
  7899. buf_spos_ = 0;
  7900. buf_epos_ = remaining_size;
  7901. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7902. for (size_t i = 0; i < n; i++) {
  7903. buf_[buf_epos_ + i] = data[i];
  7904. }
  7905. buf_epos_ += n;
  7906. }
  7907. void buf_erase(size_t size) { buf_spos_ += size; }
  7908. std::string buf_;
  7909. size_t buf_spos_ = 0;
  7910. size_t buf_epos_ = 0;
  7911. };
  7912. inline std::string random_string(size_t length) {
  7913. constexpr const char data[] =
  7914. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7915. thread_local auto engine([]() {
  7916. // std::random_device might actually be deterministic on some
  7917. // platforms, but due to lack of support in the c++ standard library,
  7918. // doing better requires either some ugly hacks or breaking portability.
  7919. std::random_device seed_gen;
  7920. // Request 128 bits of entropy for initialization
  7921. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  7922. return std::mt19937(seed_sequence);
  7923. }());
  7924. std::string result;
  7925. for (size_t i = 0; i < length; i++) {
  7926. result += data[engine() % (sizeof(data) - 1)];
  7927. }
  7928. return result;
  7929. }
  7930. inline std::string make_multipart_data_boundary() {
  7931. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  7932. }
  7933. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  7934. auto valid = true;
  7935. for (size_t i = 0; i < boundary.size(); i++) {
  7936. auto c = boundary[i];
  7937. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  7938. valid = false;
  7939. break;
  7940. }
  7941. }
  7942. return valid;
  7943. }
  7944. // Escape a multipart field name/filename following the WHATWG HTML standard
  7945. // ("escape a multipart form-data name"), which is what browsers send:
  7946. // '"' -> %22, CR -> %0D, LF -> %0A
  7947. // With escape_quote = false, only CR and LF are escaped; this is for header
  7948. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  7949. inline std::string escape_multipart_field(const std::string &s,
  7950. bool escape_quote = true) {
  7951. std::string result;
  7952. result.reserve(s.size());
  7953. for (auto c : s) {
  7954. switch (c) {
  7955. case '"':
  7956. if (escape_quote) {
  7957. result += "%22";
  7958. } else {
  7959. result += c;
  7960. }
  7961. break;
  7962. case '\r': result += "%0D"; break;
  7963. case '\n': result += "%0A"; break;
  7964. default: result += c; break;
  7965. }
  7966. }
  7967. return result;
  7968. }
  7969. template <typename T>
  7970. inline std::string
  7971. serialize_multipart_formdata_item_begin(const T &item,
  7972. const std::string &boundary) {
  7973. std::string body = "--" + boundary + "\r\n";
  7974. body += "Content-Disposition: form-data; name=\"" +
  7975. escape_multipart_field(item.name) + "\"";
  7976. if (!item.filename.empty()) {
  7977. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  7978. }
  7979. body += "\r\n";
  7980. if (!item.content_type.empty()) {
  7981. body +=
  7982. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  7983. "\r\n";
  7984. }
  7985. body += "\r\n";
  7986. return body;
  7987. }
  7988. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  7989. inline std::string
  7990. serialize_multipart_formdata_finish(const std::string &boundary) {
  7991. return "--" + boundary + "--\r\n";
  7992. }
  7993. inline std::string
  7994. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  7995. return "multipart/form-data; boundary=" + boundary;
  7996. }
  7997. inline std::string
  7998. serialize_multipart_formdata(const UploadFormDataItems &items,
  7999. const std::string &boundary, bool finish = true) {
  8000. std::string body;
  8001. for (const auto &item : items) {
  8002. body += serialize_multipart_formdata_item_begin(item, boundary);
  8003. body += item.content + serialize_multipart_formdata_item_end();
  8004. }
  8005. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8006. return body;
  8007. }
  8008. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8009. const std::string &boundary) {
  8010. size_t total = 0;
  8011. for (const auto &item : items) {
  8012. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8013. total += item.content.size();
  8014. total += serialize_multipart_formdata_item_end().size();
  8015. }
  8016. total += serialize_multipart_formdata_finish(boundary).size();
  8017. return total;
  8018. }
  8019. struct MultipartSegment {
  8020. const char *data;
  8021. size_t size;
  8022. };
  8023. // NOTE: items must outlive the returned ContentProvider
  8024. // (safe for synchronous use inside Post/Put/Patch)
  8025. inline ContentProvider
  8026. make_multipart_content_provider(const UploadFormDataItems &items,
  8027. const std::string &boundary) {
  8028. // Own the per-item header strings and the finish string
  8029. std::vector<std::string> owned;
  8030. owned.reserve(items.size() + 1);
  8031. for (const auto &item : items)
  8032. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8033. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8034. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8035. std::vector<MultipartSegment> segs;
  8036. segs.reserve(items.size() * 3 + 1);
  8037. static const char crlf[] = "\r\n";
  8038. for (size_t i = 0; i < items.size(); i++) {
  8039. segs.push_back({owned[i].data(), owned[i].size()});
  8040. segs.push_back({items[i].content.data(), items[i].content.size()});
  8041. segs.push_back({crlf, 2});
  8042. }
  8043. segs.push_back({owned.back().data(), owned.back().size()});
  8044. struct MultipartState {
  8045. std::vector<std::string> owned;
  8046. std::vector<MultipartSegment> segs;
  8047. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8048. };
  8049. auto state = std::make_shared<MultipartState>();
  8050. state->owned = std::move(owned);
  8051. // `segs` holds raw pointers into owned strings; std::string move preserves
  8052. // the data pointer, so these pointers remain valid after the move above.
  8053. state->segs = std::move(segs);
  8054. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8055. // Buffer multiple small segments into fewer, larger writes to avoid
  8056. // excessive TCP packets when there are many form data items (#2410)
  8057. auto &buf = state->buf;
  8058. auto buf_size = buf.size();
  8059. size_t buf_len = 0;
  8060. size_t remaining = length;
  8061. // Find the first segment containing 'offset'
  8062. size_t pos = 0;
  8063. size_t seg_idx = 0;
  8064. for (; seg_idx < state->segs.size(); seg_idx++) {
  8065. const auto &seg = state->segs[seg_idx];
  8066. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8067. pos += seg.size;
  8068. }
  8069. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8070. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8071. const auto &seg = state->segs[seg_idx];
  8072. size_t available = seg.size - seg_offset;
  8073. size_t to_copy = (std::min)(available, remaining);
  8074. const char *src = seg.data + seg_offset;
  8075. seg_offset = 0; // only the first segment has a non-zero offset
  8076. while (to_copy > 0) {
  8077. size_t space = buf_size - buf_len;
  8078. size_t chunk = (std::min)(to_copy, space);
  8079. std::memcpy(buf.data() + buf_len, src, chunk);
  8080. buf_len += chunk;
  8081. src += chunk;
  8082. to_copy -= chunk;
  8083. remaining -= chunk;
  8084. if (buf_len == buf_size) {
  8085. if (!sink.write(buf.data(), buf_len)) { return false; }
  8086. buf_len = 0;
  8087. }
  8088. }
  8089. }
  8090. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8091. return true;
  8092. };
  8093. }
  8094. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8095. if (ranges.size() <= 1) return;
  8096. // Sort ranges by start position
  8097. std::sort(ranges.begin(), ranges.end(),
  8098. [](const Range &a, const Range &b) { return a.first < b.first; });
  8099. Ranges coalesced;
  8100. coalesced.reserve(ranges.size());
  8101. for (auto &r : ranges) {
  8102. auto first_pos = r.first;
  8103. auto last_pos = r.second;
  8104. // Handle special cases like in range_error
  8105. if (first_pos == -1 && last_pos == -1) {
  8106. first_pos = 0;
  8107. last_pos = static_cast<ssize_t>(content_length);
  8108. }
  8109. if (first_pos == -1) {
  8110. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8111. last_pos = static_cast<ssize_t>(content_length) - 1;
  8112. }
  8113. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8114. last_pos = static_cast<ssize_t>(content_length) - 1;
  8115. }
  8116. // Skip invalid ranges
  8117. if (!(0 <= first_pos && first_pos <= last_pos &&
  8118. last_pos < static_cast<ssize_t>(content_length))) {
  8119. continue;
  8120. }
  8121. // Coalesce with previous range if overlapping or adjacent (but not
  8122. // identical)
  8123. if (!coalesced.empty()) {
  8124. auto &prev = coalesced.back();
  8125. // Check if current range overlaps or is adjacent to previous range
  8126. // but don't coalesce identical ranges (allow duplicates)
  8127. if (first_pos <= prev.second + 1 &&
  8128. !(first_pos == prev.first && last_pos == prev.second)) {
  8129. // Extend the previous range
  8130. prev.second = (std::max)(prev.second, last_pos);
  8131. continue;
  8132. }
  8133. }
  8134. // Add new range
  8135. coalesced.emplace_back(first_pos, last_pos);
  8136. }
  8137. ranges = std::move(coalesced);
  8138. }
  8139. inline bool range_error(Request &req, Response &res) {
  8140. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8141. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8142. req.ranges.clear();
  8143. if (res.status == StatusCode::PartialContent_206) {
  8144. res.status = StatusCode::OK_200;
  8145. }
  8146. return false;
  8147. }
  8148. ssize_t content_len = static_cast<ssize_t>(
  8149. res.content_length_ ? res.content_length_ : res.body.size());
  8150. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8151. size_t overwrapping_count = 0;
  8152. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8153. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8154. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8155. // Too many ranges
  8156. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8157. for (auto &r : req.ranges) {
  8158. auto &first_pos = r.first;
  8159. auto &last_pos = r.second;
  8160. if (first_pos == -1 && last_pos == -1) {
  8161. first_pos = 0;
  8162. last_pos = content_len;
  8163. }
  8164. if (first_pos == -1) {
  8165. first_pos = content_len - last_pos;
  8166. last_pos = content_len - 1;
  8167. }
  8168. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8169. // A client can limit the number of bytes requested without knowing the
  8170. // size of the selected representation. If the last-pos value is absent,
  8171. // or if the value is greater than or equal to the current length of the
  8172. // representation data, the byte range is interpreted as the remainder of
  8173. // the representation (i.e., the server replaces the value of last-pos
  8174. // with a value that is one less than the current length of the selected
  8175. // representation).
  8176. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8177. if (last_pos == -1 || last_pos >= content_len) {
  8178. last_pos = content_len - 1;
  8179. }
  8180. // Range must be within content length
  8181. if (!(0 <= first_pos && first_pos <= last_pos &&
  8182. last_pos <= content_len - 1)) {
  8183. return true;
  8184. }
  8185. // Request must not have more than two overlapping ranges
  8186. for (const auto &processed_range : processed_ranges) {
  8187. if (!(last_pos < processed_range.first ||
  8188. first_pos > processed_range.second)) {
  8189. overwrapping_count++;
  8190. if (overwrapping_count > 2) { return true; }
  8191. break; // Only count once per range
  8192. }
  8193. }
  8194. processed_ranges.emplace_back(first_pos, last_pos);
  8195. }
  8196. // After validation, coalesce overlapping ranges as per RFC 9110
  8197. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8198. }
  8199. return false;
  8200. }
  8201. inline std::pair<size_t, size_t>
  8202. get_range_offset_and_length(Range r, size_t content_length) {
  8203. assert(r.first != -1 && r.second != -1);
  8204. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8205. assert(r.first <= r.second &&
  8206. r.second < static_cast<ssize_t>(content_length));
  8207. (void)(content_length);
  8208. return std::make_pair(static_cast<size_t>(r.first),
  8209. static_cast<size_t>(r.second - r.first) + 1);
  8210. }
  8211. inline std::string make_content_range_header_field(
  8212. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8213. auto st = offset_and_length.first;
  8214. auto ed = st + offset_and_length.second - 1;
  8215. std::string field = "bytes ";
  8216. field += std::to_string(st);
  8217. field += '-';
  8218. field += std::to_string(ed);
  8219. field += '/';
  8220. field += std::to_string(content_length);
  8221. return field;
  8222. }
  8223. template <typename SToken, typename CToken, typename Content>
  8224. bool process_multipart_ranges_data(const Request &req,
  8225. const std::string &boundary,
  8226. const std::string &content_type,
  8227. size_t content_length, SToken stoken,
  8228. CToken ctoken, Content content) {
  8229. for (size_t i = 0; i < req.ranges.size(); i++) {
  8230. ctoken("--");
  8231. stoken(boundary);
  8232. ctoken("\r\n");
  8233. if (!content_type.empty()) {
  8234. ctoken("Content-Type: ");
  8235. stoken(content_type);
  8236. ctoken("\r\n");
  8237. }
  8238. auto offset_and_length =
  8239. get_range_offset_and_length(req.ranges[i], content_length);
  8240. ctoken("Content-Range: ");
  8241. stoken(make_content_range_header_field(offset_and_length, content_length));
  8242. ctoken("\r\n");
  8243. ctoken("\r\n");
  8244. if (!content(offset_and_length.first, offset_and_length.second)) {
  8245. return false;
  8246. }
  8247. ctoken("\r\n");
  8248. }
  8249. ctoken("--");
  8250. stoken(boundary);
  8251. ctoken("--");
  8252. return true;
  8253. }
  8254. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8255. const std::string &boundary,
  8256. const std::string &content_type,
  8257. size_t content_length,
  8258. std::string &data) {
  8259. process_multipart_ranges_data(
  8260. req, boundary, content_type, content_length,
  8261. [&](const std::string &token) { data += token; },
  8262. [&](const std::string &token) { data += token; },
  8263. [&](size_t offset, size_t length) {
  8264. assert(offset + length <= content_length);
  8265. data += res.body.substr(offset, length);
  8266. return true;
  8267. });
  8268. }
  8269. inline size_t get_multipart_ranges_data_length(const Request &req,
  8270. const std::string &boundary,
  8271. const std::string &content_type,
  8272. size_t content_length) {
  8273. size_t data_length = 0;
  8274. process_multipart_ranges_data(
  8275. req, boundary, content_type, content_length,
  8276. [&](const std::string &token) { data_length += token.size(); },
  8277. [&](const std::string &token) { data_length += token.size(); },
  8278. [&](size_t /*offset*/, size_t length) {
  8279. data_length += length;
  8280. return true;
  8281. });
  8282. return data_length;
  8283. }
  8284. template <typename T>
  8285. inline bool
  8286. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8287. const std::string &boundary,
  8288. const std::string &content_type,
  8289. size_t content_length, const T &is_shutting_down) {
  8290. return process_multipart_ranges_data(
  8291. req, boundary, content_type, content_length,
  8292. [&](const std::string &token) { strm.write(token); },
  8293. [&](const std::string &token) { strm.write(token); },
  8294. [&](size_t offset, size_t length) {
  8295. return write_content(strm, res.content_provider_, offset, length,
  8296. is_shutting_down);
  8297. });
  8298. }
  8299. inline bool has_framed_body(const Request &req) {
  8300. return is_chunked_transfer_encoding(req.headers) ||
  8301. req.get_header_value_u64("Content-Length") > 0;
  8302. }
  8303. inline bool is_connection_persistent(const Request &req) {
  8304. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8305. if (req.version == "HTTP/1.0" &&
  8306. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8307. return false;
  8308. }
  8309. return true;
  8310. }
  8311. inline bool expect_content(const Request &req) {
  8312. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8313. req.method == "DELETE") {
  8314. return true;
  8315. }
  8316. return has_framed_body(req);
  8317. }
  8318. #ifdef _WIN32
  8319. class WSInit {
  8320. public:
  8321. WSInit() {
  8322. WSADATA wsaData;
  8323. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8324. }
  8325. ~WSInit() {
  8326. if (is_valid_) WSACleanup();
  8327. }
  8328. bool is_valid_ = false;
  8329. };
  8330. static WSInit wsinit_;
  8331. #endif
  8332. // RFC 9110 Section 11.6.1 defines a challenge list as
  8333. // WWW-Authenticate = #challenge
  8334. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8335. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8336. // so a server may offer several schemes, each with its own comma-separated
  8337. // auth-param list, in either order and either as separate field lines or
  8338. // packed into one. Splitting on every comma would break apart a challenge's
  8339. // own param list; splitting only on the first space would miss a Digest
  8340. // challenge that isn't first. Split on commas that aren't inside a
  8341. // quoted-string instead, then track which scheme each resulting segment
  8342. // belongs to: a segment whose text before "=" contains whitespace (or that
  8343. // has no "=" at all) starts a new challenge named by its leading token.
  8344. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8345. std::vector<std::string> segments;
  8346. size_t start = 0;
  8347. auto in_quotes = false;
  8348. for (size_t i = 0; i < s.size(); i++) {
  8349. auto c = s[i];
  8350. if (in_quotes) {
  8351. if (c == '\\' && i + 1 < s.size()) {
  8352. i++;
  8353. } else if (c == '"') {
  8354. in_quotes = false;
  8355. }
  8356. } else if (c == '"') {
  8357. in_quotes = true;
  8358. } else if (c == ',') {
  8359. segments.push_back(s.substr(start, i - start));
  8360. start = i + 1;
  8361. }
  8362. }
  8363. segments.push_back(s.substr(start));
  8364. return segments;
  8365. }
  8366. inline std::string unescape_quoted_pairs(const std::string &s) {
  8367. std::string out;
  8368. out.reserve(s.size());
  8369. for (size_t i = 0; i < s.size(); i++) {
  8370. if (s[i] == '\\' && i + 1 < s.size()) {
  8371. out += s[++i];
  8372. } else {
  8373. out += s[i];
  8374. }
  8375. }
  8376. return out;
  8377. }
  8378. inline bool parse_www_authenticate(const Response &res,
  8379. std::map<std::string, std::string> &auth,
  8380. bool is_proxy) {
  8381. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8382. auto combined = get_combined_header_value(res.headers, auth_key);
  8383. if (combined.empty()) { return false; }
  8384. auto found_digest = false;
  8385. auto in_digest_challenge = false;
  8386. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8387. auto segment = trim_copy(raw_segment);
  8388. if (segment.empty()) { continue; }
  8389. auto eq_pos = segment.find('=');
  8390. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8391. // for the first segment of a challenge, "<scheme> <key>") must be
  8392. // trimmed before its boundaries are inspected.
  8393. auto key_part = trim_copy(
  8394. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8395. auto space_pos = key_part.find_last_of(" \t");
  8396. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8397. // "<scheme>[ <key>]" starts a new challenge.
  8398. auto scheme_end =
  8399. space_pos == std::string::npos ? key_part.size() : space_pos;
  8400. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8401. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8402. // from one challenge is never paired with another's algorithm.
  8403. in_digest_challenge =
  8404. !found_digest &&
  8405. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8406. if (in_digest_challenge) { found_digest = true; }
  8407. if (space_pos == std::string::npos) {
  8408. // Bare scheme (or a token68), no auth-param on this segment.
  8409. continue;
  8410. }
  8411. key_part = key_part.substr(space_pos + 1);
  8412. }
  8413. if (!in_digest_challenge) { continue; }
  8414. auto val = trim_copy(segment.substr(eq_pos + 1));
  8415. auto unquoted = trim_double_quotes_copy(val);
  8416. if (unquoted.size() != val.size()) {
  8417. unquoted = unescape_quoted_pairs(unquoted);
  8418. }
  8419. auth[std::move(key_part)] = std::move(unquoted);
  8420. }
  8421. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8422. // make_digest_authentication_header() dereferences both unconditionally, so
  8423. // a challenge missing either can't produce a usable Authorization header.
  8424. // Treat it the same as no Digest challenge at all.
  8425. return found_digest && auth.find("realm") != auth.end() &&
  8426. auth.find("nonce") != auth.end();
  8427. }
  8428. class ContentProviderAdapter {
  8429. public:
  8430. explicit ContentProviderAdapter(
  8431. ContentProviderWithoutLength &&content_provider)
  8432. : content_provider_(std::move(content_provider)) {}
  8433. bool operator()(size_t offset, size_t, DataSink &sink) {
  8434. return content_provider_(offset, sink);
  8435. }
  8436. private:
  8437. ContentProviderWithoutLength content_provider_;
  8438. };
  8439. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8440. namespace fields {
  8441. inline bool is_token_char(char c) {
  8442. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8443. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8444. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8445. }
  8446. inline bool is_token(const std::string &s) {
  8447. if (s.empty()) { return false; }
  8448. for (auto c : s) {
  8449. if (!is_token_char(c)) { return false; }
  8450. }
  8451. return true;
  8452. }
  8453. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8454. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8455. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8456. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8457. inline bool is_field_content(const std::string &s) {
  8458. if (s.empty()) { return true; }
  8459. if (s.size() == 1) {
  8460. return is_field_vchar(s[0]);
  8461. } else if (s.size() == 2) {
  8462. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8463. } else {
  8464. size_t i = 0;
  8465. if (!is_field_vchar(s[i])) { return false; }
  8466. i++;
  8467. while (i < s.size() - 1) {
  8468. auto c = s[i++];
  8469. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8470. } else {
  8471. return false;
  8472. }
  8473. }
  8474. return is_field_vchar(s[i]);
  8475. }
  8476. }
  8477. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8478. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8479. return is_field_name(name) && is_field_value(value);
  8480. }
  8481. } // namespace fields
  8482. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8483. WebSocketUpgradeResponse &upgrade) {
  8484. // Generate random Sec-WebSocket-Key
  8485. thread_local std::mt19937 rng(std::random_device{}());
  8486. std::string key_bytes(16, '\0');
  8487. for (size_t i = 0; i < 16; i += 4) {
  8488. auto r = rng();
  8489. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8490. }
  8491. auto client_key = base64_encode(key_bytes);
  8492. req.headers.erase("Upgrade");
  8493. req.headers.erase("Connection");
  8494. req.headers.erase("Sec-WebSocket-Key");
  8495. req.headers.erase("Sec-WebSocket-Version");
  8496. req.headers.emplace("Upgrade", "websocket");
  8497. req.headers.emplace("Connection", "Upgrade");
  8498. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8499. req.headers.emplace("Sec-WebSocket-Version", "13");
  8500. // Build the request in memory first, like ClientImpl::write_request does.
  8501. // Writing straight to the socket would leak a request line onto the wire
  8502. // before check_and_write_headers gets a chance to reject an invalid header,
  8503. // and would emit one small write per header.
  8504. BufferStream bstrm;
  8505. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8506. upgrade.error = Error::Write;
  8507. return false;
  8508. }
  8509. auto error = Error::Success;
  8510. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8511. upgrade.error = error;
  8512. return false;
  8513. }
  8514. const auto &data = bstrm.get_buffer();
  8515. if (!write_data(strm, data.data(), data.size())) {
  8516. upgrade.error = Error::Write;
  8517. return false;
  8518. }
  8519. // Verify 101 response and Sec-WebSocket-Accept header
  8520. auto expected_accept = websocket_accept_key(client_key);
  8521. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8522. }
  8523. inline bool is_ip_address(const std::string &host) {
  8524. struct in_addr addr4;
  8525. struct in6_addr addr6;
  8526. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8527. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8528. }
  8529. // Resolve where a client should connect for `host`, honoring a user-supplied
  8530. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8531. // supplying the Host header and SNI; only the connection target changes.
  8532. //
  8533. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8534. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8535. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8536. // absent or empty mapping leaves `host` as the connection target; without the
  8537. // empty check the value would reach getaddrinfo as a null node and silently
  8538. // resolve to loopback.
  8539. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8540. const std::string &host, std::string &connect_host,
  8541. std::string &ip) {
  8542. connect_host = host;
  8543. ip.clear();
  8544. auto it = addr_map.find(host);
  8545. if (it == addr_map.end() || it->second.empty()) { return; }
  8546. if (is_ip_address(it->second)) {
  8547. ip = it->second;
  8548. } else {
  8549. connect_host = it->second;
  8550. }
  8551. }
  8552. } // namespace detail
  8553. /*
  8554. * Group 2: detail namespace - SSL common utilities
  8555. */
  8556. #ifdef CPPHTTPLIB_SSL_ENABLED
  8557. namespace detail {
  8558. class SSLSocketStream final : public Stream {
  8559. public:
  8560. SSLSocketStream(
  8561. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8562. time_t read_timeout_usec, time_t write_timeout_sec,
  8563. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8564. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8565. (std::chrono::steady_clock::time_point::min)());
  8566. ~SSLSocketStream() override;
  8567. bool is_readable() const override;
  8568. bool wait_readable() const override;
  8569. bool wait_writable() const override;
  8570. bool is_peer_alive() const override;
  8571. ssize_t read(char *ptr, size_t size) override;
  8572. ssize_t write(const char *ptr, size_t size) override;
  8573. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8574. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8575. socket_t socket() const override;
  8576. time_t duration() const override;
  8577. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8578. // See SocketStream::set_readable_hint().
  8579. void set_readable_hint() { readable_hint_ = true; }
  8580. private:
  8581. bool ensure_readable();
  8582. socket_t sock_;
  8583. tls::session_t session_;
  8584. time_t read_timeout_sec_;
  8585. time_t read_timeout_usec_;
  8586. time_t write_timeout_sec_;
  8587. time_t write_timeout_usec_;
  8588. time_t max_timeout_msec_;
  8589. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8590. bool readable_hint_ = false;
  8591. };
  8592. // A TLS stream for WebSocket connections, where the receive path and the
  8593. // send path (application send() plus the heartbeat ping thread) run on
  8594. // different threads. A single TLS session must never be entered
  8595. // concurrently, so every call into the session is serialized by one mutex.
  8596. //
  8597. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8598. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8599. // call under the lock, then waits for readiness with select() outside the
  8600. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8601. // blocked waiting for data never stalls a concurrent sender.
  8602. //
  8603. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8604. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8605. class WebSocketSSLStream final : public Stream {
  8606. public:
  8607. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8608. time_t read_timeout_sec, time_t read_timeout_usec,
  8609. time_t write_timeout_sec, time_t write_timeout_usec);
  8610. ~WebSocketSSLStream() override;
  8611. bool is_readable() const override;
  8612. bool wait_readable() const override;
  8613. bool wait_writable() const override;
  8614. ssize_t read(char *ptr, size_t size) override;
  8615. ssize_t write(const char *ptr, size_t size) override;
  8616. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8617. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8618. socket_t socket() const override;
  8619. time_t duration() const override;
  8620. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8621. private:
  8622. mutable std::mutex session_mutex_;
  8623. socket_t sock_;
  8624. tls::session_t session_;
  8625. // WebSocket::close() shortens the read timeout from the closing thread
  8626. // while the receive thread is inside wait_readable(), so these two are read
  8627. // and written concurrently. The write timeouts are never mutated.
  8628. std::atomic<time_t> read_timeout_sec_;
  8629. std::atomic<time_t> read_timeout_usec_;
  8630. time_t write_timeout_sec_;
  8631. time_t write_timeout_usec_;
  8632. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8633. };
  8634. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8635. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8636. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8637. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8638. unsigned int hash_length = 0;
  8639. unsigned char hash[EVP_MAX_MD_SIZE];
  8640. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8641. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8642. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8643. std::stringstream ss;
  8644. for (auto i = 0u; i < hash_length; ++i) {
  8645. ss << std::hex << std::setw(2) << std::setfill('0')
  8646. << static_cast<unsigned int>(hash[i]);
  8647. }
  8648. return ss.str();
  8649. }
  8650. inline std::string MD5(const std::string &s) {
  8651. return message_digest(s, EVP_md5());
  8652. }
  8653. inline std::string SHA_256(const std::string &s) {
  8654. return message_digest(s, EVP_sha256());
  8655. }
  8656. inline std::string SHA_512(const std::string &s) {
  8657. return message_digest(s, EVP_sha512());
  8658. }
  8659. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8660. namespace {
  8661. template <size_t N>
  8662. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8663. std::stringstream ss;
  8664. for (size_t i = 0; i < N; ++i) {
  8665. ss << std::hex << std::setw(2) << std::setfill('0')
  8666. << static_cast<unsigned int>(hash[i]);
  8667. }
  8668. return ss.str();
  8669. }
  8670. } // namespace
  8671. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8672. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8673. // initialized once. PSA state is process-global; do not free it.
  8674. inline bool ensure_mbedtls_psa_crypto() {
  8675. static std::once_flag once;
  8676. static bool ok = false;
  8677. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8678. return ok;
  8679. }
  8680. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8681. unsigned char *out, size_t out_size) {
  8682. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8683. size_t olen = 0;
  8684. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8685. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8686. olen == out_size;
  8687. }
  8688. #endif
  8689. inline std::string MD5(const std::string &s) {
  8690. unsigned char hash[16];
  8691. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8692. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8693. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8694. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8695. hash);
  8696. #else
  8697. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8698. hash);
  8699. #endif
  8700. return hash_to_hex(hash);
  8701. }
  8702. inline std::string SHA_256(const std::string &s) {
  8703. unsigned char hash[32];
  8704. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8705. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8706. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8707. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8708. hash, 0);
  8709. #else
  8710. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8711. s.size(), hash, 0);
  8712. #endif
  8713. return hash_to_hex(hash);
  8714. }
  8715. inline std::string SHA_512(const std::string &s) {
  8716. unsigned char hash[64];
  8717. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8718. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8719. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8720. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8721. hash, 0);
  8722. #else
  8723. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8724. s.size(), hash, 0);
  8725. #endif
  8726. return hash_to_hex(hash);
  8727. }
  8728. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8729. namespace {
  8730. template <size_t N>
  8731. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8732. std::stringstream ss;
  8733. for (size_t i = 0; i < N; ++i) {
  8734. ss << std::hex << std::setw(2) << std::setfill('0')
  8735. << static_cast<unsigned int>(hash[i]);
  8736. }
  8737. return ss.str();
  8738. }
  8739. } // namespace
  8740. inline std::string MD5(const std::string &s) {
  8741. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8742. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8743. static_cast<word32>(s.size()), hash);
  8744. return hash_to_hex(hash);
  8745. }
  8746. inline std::string SHA_256(const std::string &s) {
  8747. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8748. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8749. static_cast<word32>(s.size()), hash);
  8750. return hash_to_hex(hash);
  8751. }
  8752. inline std::string SHA_512(const std::string &s) {
  8753. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8754. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8755. static_cast<word32>(s.size()), hash);
  8756. return hash_to_hex(hash);
  8757. }
  8758. #endif
  8759. template <typename T>
  8760. inline bool process_server_socket_ssl(
  8761. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8762. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8763. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8764. time_t write_timeout_usec, T callback) {
  8765. return process_server_socket_core(
  8766. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8767. [&](bool close_connection, bool &connection_closed) {
  8768. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8769. write_timeout_sec, write_timeout_usec);
  8770. // See the non-TLS path in process_server_socket().
  8771. strm.set_readable_hint();
  8772. return callback(strm, close_connection, connection_closed);
  8773. });
  8774. }
  8775. template <typename T>
  8776. inline bool process_client_socket_ssl(
  8777. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8778. time_t read_timeout_usec, time_t write_timeout_sec,
  8779. time_t write_timeout_usec, time_t max_timeout_msec,
  8780. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8781. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8782. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8783. start_time);
  8784. return callback(strm);
  8785. }
  8786. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8787. const Request &req, const std::map<std::string, std::string> &auth,
  8788. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8789. const std::string &password, bool is_proxy = false) {
  8790. std::string nc;
  8791. {
  8792. std::stringstream ss;
  8793. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8794. nc = ss.str();
  8795. }
  8796. std::string qop;
  8797. if (auth.find("qop") != auth.end()) {
  8798. qop = auth.at("qop");
  8799. if (qop.find("auth-int") != std::string::npos) {
  8800. qop = "auth-int";
  8801. } else if (qop.find("auth") != std::string::npos) {
  8802. qop = "auth";
  8803. } else {
  8804. qop.clear();
  8805. }
  8806. }
  8807. std::string algo = "MD5";
  8808. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8809. std::string response;
  8810. {
  8811. auto H = algo == "SHA-256" ? detail::SHA_256
  8812. : algo == "SHA-512" ? detail::SHA_512
  8813. : detail::MD5;
  8814. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8815. auto A2 = req.method + ":" + req.path;
  8816. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8817. if (qop.empty()) {
  8818. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8819. } else {
  8820. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8821. ":" + qop + ":" + H(A2));
  8822. }
  8823. }
  8824. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8825. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8826. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8827. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8828. (qop.empty() ? ", response=\""
  8829. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8830. cnonce + "\", response=\"") +
  8831. response + "\"" +
  8832. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8833. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8834. return std::make_pair(key, field);
  8835. }
  8836. inline bool match_hostname(const std::string &pattern,
  8837. const std::string &hostname) {
  8838. // Exact match (case-insensitive)
  8839. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8840. // Split both pattern and hostname into components by '.'
  8841. std::vector<std::string> pattern_components;
  8842. if (!pattern.empty()) {
  8843. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8844. [&](const char *b, const char *e) {
  8845. pattern_components.emplace_back(b, e);
  8846. });
  8847. }
  8848. std::vector<std::string> host_components;
  8849. if (!hostname.empty()) {
  8850. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8851. [&](const char *b, const char *e) {
  8852. host_components.emplace_back(b, e);
  8853. });
  8854. }
  8855. // Component count must match
  8856. if (host_components.size() != pattern_components.size()) { return false; }
  8857. // Compare each component with wildcard support
  8858. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8859. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8860. auto itr = pattern_components.begin();
  8861. for (const auto &h : host_components) {
  8862. auto &p = *itr;
  8863. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8864. bool partial_match = false;
  8865. if (!p.empty() && p[p.size() - 1] == '*') {
  8866. const auto prefix_length = p.size() - 1;
  8867. if (prefix_length == 0) {
  8868. partial_match = true;
  8869. } else if (h.size() >= prefix_length) {
  8870. partial_match =
  8871. std::equal(p.begin(),
  8872. p.begin() + static_cast<std::string::difference_type>(
  8873. prefix_length),
  8874. h.begin(), [](const char ca, const char cb) {
  8875. return detail::case_ignore::to_lower(ca) ==
  8876. detail::case_ignore::to_lower(cb);
  8877. });
  8878. }
  8879. }
  8880. if (!partial_match) { return false; }
  8881. }
  8882. ++itr;
  8883. }
  8884. return true;
  8885. }
  8886. #ifdef _WIN32
  8887. // Verify certificate using Windows CertGetCertificateChain API.
  8888. // This provides real-time certificate validation with Windows Update
  8889. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8890. inline bool
  8891. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8892. const std::string &hostname,
  8893. bool verify_hostname, uint64_t &out_error) {
  8894. if (der_cert.empty()) { return false; }
  8895. out_error = 0;
  8896. // Create Windows certificate context from DER data
  8897. auto cert_context = CertCreateCertificateContext(
  8898. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8899. static_cast<DWORD>(der_cert.size()));
  8900. if (!cert_context) {
  8901. out_error = GetLastError();
  8902. return false;
  8903. }
  8904. auto cert_guard =
  8905. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8906. // Setup chain parameters
  8907. CERT_CHAIN_PARA chain_para = {};
  8908. chain_para.cbSize = sizeof(chain_para);
  8909. // Build certificate chain with revocation checking
  8910. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8911. auto chain_result = CertGetCertificateChain(
  8912. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8913. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8914. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8915. nullptr, &chain_context);
  8916. if (!chain_result || !chain_context) {
  8917. out_error = GetLastError();
  8918. return false;
  8919. }
  8920. auto chain_guard =
  8921. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  8922. // Check if chain has errors
  8923. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  8924. out_error = chain_context->TrustStatus.dwErrorStatus;
  8925. return false;
  8926. }
  8927. // Verify SSL policy
  8928. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  8929. extra_policy_para.cbSize = sizeof(extra_policy_para);
  8930. #ifdef AUTHTYPE_SERVER
  8931. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  8932. #endif
  8933. std::wstring whost;
  8934. if (verify_hostname) {
  8935. whost = u8string_to_wstring(hostname.c_str());
  8936. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  8937. }
  8938. CERT_CHAIN_POLICY_PARA policy_para = {};
  8939. policy_para.cbSize = sizeof(policy_para);
  8940. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  8941. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  8942. #else
  8943. policy_para.dwFlags = 0;
  8944. #endif
  8945. policy_para.pvExtraPolicyPara = &extra_policy_para;
  8946. CERT_CHAIN_POLICY_STATUS policy_status = {};
  8947. policy_status.cbSize = sizeof(policy_status);
  8948. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  8949. &policy_para, &policy_status)) {
  8950. out_error = GetLastError();
  8951. return false;
  8952. }
  8953. if (policy_status.dwError != 0) {
  8954. out_error = policy_status.dwError;
  8955. return false;
  8956. }
  8957. return true;
  8958. }
  8959. #endif // _WIN32
  8960. // Loads CA file/dir configuration and applies the system CA policy to a
  8961. // client TLS context. PEM data and native stores are applied to the context
  8962. // directly at set time; has_custom_store reflects them for the Auto policy
  8963. // decision.
  8964. inline bool load_client_ca_config(tls::ctx_t ctx,
  8965. const std::string &ca_cert_file_path,
  8966. const std::string &ca_cert_dir_path,
  8967. bool has_custom_store, SystemCAMode mode,
  8968. uint64_t &backend_error) {
  8969. auto ret = true;
  8970. if (!ca_cert_file_path.empty()) {
  8971. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  8972. backend_error = tls::get_error();
  8973. ret = false;
  8974. }
  8975. } else if (!ca_cert_dir_path.empty()) {
  8976. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  8977. backend_error = tls::get_error();
  8978. ret = false;
  8979. }
  8980. }
  8981. auto has_custom_ca = !ca_cert_file_path.empty() ||
  8982. !ca_cert_dir_path.empty() || has_custom_store;
  8983. if (mode == SystemCAMode::Enabled ||
  8984. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  8985. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  8986. }
  8987. return ret;
  8988. }
  8989. // The parts of session setup that only SSLClient needs, plus the handful
  8990. // WebSocketClient also exposes; everything else takes the defaults, which is
  8991. // what keeps the two clients on one implementation.
  8992. struct ClientTlsSessionOptions {
  8993. // Both SSLClient and WebSocketClient expose this independently of
  8994. // certificate verification.
  8995. bool server_hostname_verification = true;
  8996. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  8997. // When non-null, guards session creation against concurrent use of the
  8998. // context. A WebSocketClient is not safe to use from several threads to
  8999. // begin with, so it passes nothing.
  9000. std::mutex *ctx_mutex = nullptr;
  9001. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9002. // The caller decides whether Schannel has anything to say about this
  9003. // connection; see SSLClient::initialize_ssl().
  9004. bool windows_cert_verification = false;
  9005. #endif
  9006. };
  9007. // Filled in on failure for callers that report error details.
  9008. struct ClientTlsSessionError {
  9009. Error error = Error::Success;
  9010. int ssl_error = 0;
  9011. uint64_t backend_error = 0;
  9012. };
  9013. // Establishes a client TLS session on an already connected socket. On failure
  9014. // the session is left for the caller to free: SSLClient frees it right away,
  9015. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9016. inline bool setup_client_tls_session(
  9017. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9018. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9019. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9020. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9021. using namespace tls;
  9022. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9023. if (out_error) {
  9024. out_error->error = error;
  9025. out_error->ssl_error = ssl_error;
  9026. out_error->backend_error = backend_error;
  9027. }
  9028. return false;
  9029. };
  9030. if (!ctx) {
  9031. session = nullptr;
  9032. return fail(Error::SSLConnection, 0, 0);
  9033. }
  9034. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9035. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9036. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9037. // verification happens during the handshake even for IP hosts; the
  9038. // certificate identity is verified post-handshake via verify_hostname().
  9039. set_verify_client(ctx, server_certificate_verification);
  9040. #endif
  9041. {
  9042. std::unique_lock<std::mutex> guard;
  9043. if (options.ctx_mutex) {
  9044. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9045. }
  9046. session = create_session(ctx, sock);
  9047. }
  9048. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9049. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9050. // their identity is checked post-handshake below instead. On Mbed TLS and
  9051. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9052. // options.server_hostname_verification is threaded through here.
  9053. if (!is_ip_address(host)) {
  9054. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9055. return fail(Error::SSLConnection, 0, get_error());
  9056. }
  9057. }
  9058. TlsError tls_err;
  9059. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9060. &tls_err)) {
  9061. auto error = Error::SSLConnection;
  9062. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9063. error = Error::SSLServerVerification;
  9064. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9065. error = Error::SSLServerHostnameVerification;
  9066. }
  9067. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9068. }
  9069. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9070. if (options.session_verifier) {
  9071. verification_status = options.session_verifier(session);
  9072. }
  9073. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9074. return fail(Error::SSLServerVerification, 0, get_error());
  9075. }
  9076. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9077. server_certificate_verification) {
  9078. auto verify_result = get_verify_result(session);
  9079. if (verify_result != 0) {
  9080. return fail(Error::SSLServerVerification, 0,
  9081. static_cast<uint64_t>(verify_result));
  9082. }
  9083. auto server_cert = get_peer_cert(session);
  9084. if (!server_cert) {
  9085. return fail(Error::SSLServerVerification, 0, get_error());
  9086. }
  9087. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9088. // Identity check against the peer certificate, post-handshake for all
  9089. // backends. For IP hosts this is the only identity verification, since no
  9090. // hostname is bound during the handshake.
  9091. if (options.server_hostname_verification) {
  9092. if (!verify_hostname(server_cert, host.c_str())) {
  9093. return fail(Error::SSLServerHostnameVerification, 0,
  9094. hostname_mismatch_code());
  9095. }
  9096. }
  9097. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9098. // Additional Windows Schannel verification.
  9099. // This provides real-time certificate validation with Windows Update
  9100. // integration, working with both OpenSSL and MbedTLS backends.
  9101. if (options.windows_cert_verification) {
  9102. std::vector<unsigned char> der;
  9103. if (get_cert_der(server_cert, der)) {
  9104. uint64_t wincrypt_error = 0;
  9105. if (!verify_cert_with_windows_schannel(
  9106. der, host, options.server_hostname_verification,
  9107. wincrypt_error)) {
  9108. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9109. }
  9110. }
  9111. }
  9112. #endif
  9113. }
  9114. return true;
  9115. }
  9116. } // namespace detail
  9117. #endif // CPPHTTPLIB_SSL_ENABLED
  9118. /*
  9119. * Group 3: httplib namespace - Non-SSL public API implementations
  9120. */
  9121. inline void default_socket_options(socket_t sock) {
  9122. set_socket_opt(sock, SOL_SOCKET,
  9123. #ifdef SO_REUSEPORT
  9124. SO_REUSEPORT,
  9125. #else
  9126. SO_REUSEADDR,
  9127. #endif
  9128. 1);
  9129. }
  9130. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9131. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9132. sizeof(optval));
  9133. }
  9134. inline std::string get_bearer_token_auth(const Request &req) {
  9135. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9136. // than the prefix carries no token.
  9137. constexpr const char bearer_prefix[] = "Bearer ";
  9138. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9139. auto value = req.get_header_value("Authorization");
  9140. if (value.size() >= bearer_prefix_len &&
  9141. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9142. bearer_prefix)) {
  9143. return value.substr(bearer_prefix_len);
  9144. }
  9145. return "";
  9146. }
  9147. inline const char *status_message(int status) {
  9148. switch (status) {
  9149. case StatusCode::Continue_100: return "Continue";
  9150. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9151. case StatusCode::Processing_102: return "Processing";
  9152. case StatusCode::EarlyHints_103: return "Early Hints";
  9153. case StatusCode::OK_200: return "OK";
  9154. case StatusCode::Created_201: return "Created";
  9155. case StatusCode::Accepted_202: return "Accepted";
  9156. case StatusCode::NonAuthoritativeInformation_203:
  9157. return "Non-Authoritative Information";
  9158. case StatusCode::NoContent_204: return "No Content";
  9159. case StatusCode::ResetContent_205: return "Reset Content";
  9160. case StatusCode::PartialContent_206: return "Partial Content";
  9161. case StatusCode::MultiStatus_207: return "Multi-Status";
  9162. case StatusCode::AlreadyReported_208: return "Already Reported";
  9163. case StatusCode::IMUsed_226: return "IM Used";
  9164. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9165. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9166. case StatusCode::Found_302: return "Found";
  9167. case StatusCode::SeeOther_303: return "See Other";
  9168. case StatusCode::NotModified_304: return "Not Modified";
  9169. case StatusCode::UseProxy_305: return "Use Proxy";
  9170. case StatusCode::unused_306: return "unused";
  9171. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9172. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9173. case StatusCode::BadRequest_400: return "Bad Request";
  9174. case StatusCode::Unauthorized_401: return "Unauthorized";
  9175. case StatusCode::PaymentRequired_402: return "Payment Required";
  9176. case StatusCode::Forbidden_403: return "Forbidden";
  9177. case StatusCode::NotFound_404: return "Not Found";
  9178. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9179. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9180. case StatusCode::ProxyAuthenticationRequired_407:
  9181. return "Proxy Authentication Required";
  9182. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9183. case StatusCode::Conflict_409: return "Conflict";
  9184. case StatusCode::Gone_410: return "Gone";
  9185. case StatusCode::LengthRequired_411: return "Length Required";
  9186. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9187. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9188. case StatusCode::UriTooLong_414: return "URI Too Long";
  9189. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9190. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9191. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9192. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9193. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9194. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9195. case StatusCode::Locked_423: return "Locked";
  9196. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9197. case StatusCode::TooEarly_425: return "Too Early";
  9198. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9199. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9200. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9201. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9202. return "Request Header Fields Too Large";
  9203. case StatusCode::UnavailableForLegalReasons_451:
  9204. return "Unavailable For Legal Reasons";
  9205. case StatusCode::NotImplemented_501: return "Not Implemented";
  9206. case StatusCode::BadGateway_502: return "Bad Gateway";
  9207. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9208. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9209. case StatusCode::HttpVersionNotSupported_505:
  9210. return "HTTP Version Not Supported";
  9211. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9212. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9213. case StatusCode::LoopDetected_508: return "Loop Detected";
  9214. case StatusCode::NotExtended_510: return "Not Extended";
  9215. case StatusCode::NetworkAuthenticationRequired_511:
  9216. return "Network Authentication Required";
  9217. default:
  9218. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9219. }
  9220. }
  9221. inline std::string to_string(const Error error) {
  9222. switch (error) {
  9223. case Error::Success: return "Success (no error)";
  9224. case Error::Unknown: return "Unknown";
  9225. case Error::Connection: return "Could not establish connection";
  9226. case Error::BindIPAddress: return "Failed to bind IP address";
  9227. case Error::Read: return "Failed to read connection";
  9228. case Error::Write: return "Failed to write connection";
  9229. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9230. case Error::Canceled: return "Connection handling canceled";
  9231. case Error::SSLConnection: return "SSL connection failed";
  9232. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9233. case Error::SSLServerVerification: return "SSL server verification failed";
  9234. case Error::SSLServerHostnameVerification:
  9235. return "SSL server hostname verification failed";
  9236. case Error::UnsupportedMultipartBoundaryChars:
  9237. return "Unsupported HTTP multipart boundary characters";
  9238. case Error::Compression: return "Compression failed";
  9239. case Error::ConnectionTimeout: return "Connection timed out";
  9240. case Error::ProxyConnection: return "Proxy connection failed";
  9241. case Error::ConnectionClosed: return "Connection closed by server";
  9242. case Error::Timeout: return "Read timeout";
  9243. case Error::ResourceExhaustion: return "Resource exhaustion";
  9244. case Error::TooManyFormDataFiles: return "Too many form data files";
  9245. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9246. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9247. case Error::ExceedMaxSocketDescriptorCount:
  9248. return "Exceeded maximum socket descriptor count";
  9249. case Error::InvalidRequestLine: return "Invalid request line";
  9250. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9251. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9252. case Error::InvalidHeaders: return "Invalid headers";
  9253. case Error::MultipartParsing: return "Multipart parsing failed";
  9254. case Error::OpenFile: return "Failed to open file";
  9255. case Error::Listen: return "Failed to listen on socket";
  9256. case Error::GetSockName: return "Failed to get socket name";
  9257. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9258. case Error::HTTPParsing: return "HTTP parsing failed";
  9259. case Error::InvalidRangeHeader: return "Invalid Range header";
  9260. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9261. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9262. case Error::UserCallbackException: return "User callback threw an exception";
  9263. default: break;
  9264. }
  9265. return "Invalid";
  9266. }
  9267. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9268. os << to_string(obj);
  9269. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9270. return os;
  9271. }
  9272. inline std::string hosted_at(const std::string &hostname) {
  9273. std::vector<std::string> addrs;
  9274. hosted_at(hostname, addrs);
  9275. if (addrs.empty()) { return std::string(); }
  9276. return addrs[0];
  9277. }
  9278. inline void hosted_at(const std::string &hostname,
  9279. std::vector<std::string> &addrs) {
  9280. struct addrinfo hints;
  9281. struct addrinfo *result;
  9282. memset(&hints, 0, sizeof(struct addrinfo));
  9283. hints.ai_family = AF_UNSPEC;
  9284. hints.ai_socktype = SOCK_STREAM;
  9285. hints.ai_protocol = 0;
  9286. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9287. &result, 0)) {
  9288. #if defined __linux__ && !defined __ANDROID__
  9289. res_init();
  9290. #endif
  9291. return;
  9292. }
  9293. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9294. for (auto rp = result; rp; rp = rp->ai_next) {
  9295. const auto &addr =
  9296. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9297. std::string ip;
  9298. auto dummy = -1;
  9299. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9300. dummy)) {
  9301. addrs.emplace_back(std::move(ip));
  9302. }
  9303. }
  9304. }
  9305. inline std::string encode_uri_component(const std::string &value) {
  9306. std::ostringstream escaped;
  9307. escaped.fill('0');
  9308. escaped << std::hex;
  9309. for (auto c : value) {
  9310. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9311. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9312. escaped << c;
  9313. } else {
  9314. escaped << std::uppercase;
  9315. escaped << '%' << std::setw(2)
  9316. << static_cast<int>(static_cast<unsigned char>(c));
  9317. escaped << std::nouppercase;
  9318. }
  9319. }
  9320. return escaped.str();
  9321. }
  9322. inline std::string encode_uri(const std::string &value) {
  9323. std::ostringstream escaped;
  9324. escaped.fill('0');
  9325. escaped << std::hex;
  9326. for (auto c : value) {
  9327. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9328. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9329. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9330. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9331. escaped << c;
  9332. } else {
  9333. escaped << std::uppercase;
  9334. escaped << '%' << std::setw(2)
  9335. << static_cast<int>(static_cast<unsigned char>(c));
  9336. escaped << std::nouppercase;
  9337. }
  9338. }
  9339. return escaped.str();
  9340. }
  9341. inline std::string decode_uri_component(const std::string &value) {
  9342. std::string result;
  9343. for (size_t i = 0; i < value.size(); i++) {
  9344. if (value[i] == '%' && i + 2 < value.size()) {
  9345. auto val = 0;
  9346. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9347. result += static_cast<char>(val);
  9348. i += 2;
  9349. } else {
  9350. result += value[i];
  9351. }
  9352. } else {
  9353. result += value[i];
  9354. }
  9355. }
  9356. return result;
  9357. }
  9358. inline std::string decode_uri(const std::string &value) {
  9359. std::string result;
  9360. for (size_t i = 0; i < value.size(); i++) {
  9361. if (value[i] == '%' && i + 2 < value.size()) {
  9362. auto val = 0;
  9363. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9364. auto c = static_cast<char>(val);
  9365. // Keep escapes of the reserved characters that encode_uri leaves
  9366. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9367. // delimiter is not promoted into a real one (as with JS decodeURI).
  9368. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9369. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9370. c == '#') {
  9371. result += value[i];
  9372. result += value[i + 1];
  9373. result += value[i + 2];
  9374. } else {
  9375. result += c;
  9376. }
  9377. i += 2;
  9378. } else {
  9379. result += value[i];
  9380. }
  9381. } else {
  9382. result += value[i];
  9383. }
  9384. }
  9385. return result;
  9386. }
  9387. inline std::string encode_path_component(const std::string &component) {
  9388. std::string result;
  9389. result.reserve(component.size() * 3);
  9390. for (size_t i = 0; i < component.size(); i++) {
  9391. auto c = static_cast<unsigned char>(component[i]);
  9392. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9393. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9394. c == '_' || c == '~') {
  9395. result += static_cast<char>(c);
  9396. }
  9397. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9398. // "," / ";" / "="
  9399. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9400. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9401. c == '=') {
  9402. result += static_cast<char>(c);
  9403. }
  9404. // Colon is allowed in path segments except first segment
  9405. else if (c == ':') {
  9406. result += static_cast<char>(c);
  9407. }
  9408. // @ is allowed in path
  9409. else if (c == '@') {
  9410. result += static_cast<char>(c);
  9411. } else {
  9412. result += '%';
  9413. char hex[3];
  9414. snprintf(hex, sizeof(hex), "%02X", c);
  9415. result.append(hex, 2);
  9416. }
  9417. }
  9418. return result;
  9419. }
  9420. inline std::string decode_path_component(const std::string &component) {
  9421. std::string result;
  9422. result.reserve(component.size());
  9423. for (size_t i = 0; i < component.size(); i++) {
  9424. if (component[i] == '%' && i + 1 < component.size()) {
  9425. if (component[i + 1] == 'u') {
  9426. // Unicode %uXXXX encoding
  9427. auto val = 0;
  9428. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9429. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9430. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9431. char buff[4];
  9432. size_t len = detail::to_utf8(val, buff);
  9433. if (len > 0) { result.append(buff, len); }
  9434. i += 5; // 'u0000'
  9435. } else {
  9436. result += component[i];
  9437. }
  9438. } else {
  9439. // Standard %XX encoding
  9440. auto val = 0;
  9441. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9442. // 2 digits hex codes
  9443. result += static_cast<char>(val);
  9444. i += 2; // 'XX'
  9445. } else {
  9446. result += component[i];
  9447. }
  9448. }
  9449. } else {
  9450. result += component[i];
  9451. }
  9452. }
  9453. return result;
  9454. }
  9455. inline std::string encode_query_component(const std::string &component,
  9456. bool space_as_plus) {
  9457. std::string result;
  9458. result.reserve(component.size() * 3);
  9459. for (size_t i = 0; i < component.size(); i++) {
  9460. auto c = static_cast<unsigned char>(component[i]);
  9461. // Unreserved characters per RFC 3986
  9462. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9463. c == '_' || c == '~') {
  9464. result += static_cast<char>(c);
  9465. }
  9466. // Space handling
  9467. else if (c == ' ') {
  9468. if (space_as_plus) {
  9469. result += '+';
  9470. } else {
  9471. result += "%20";
  9472. }
  9473. }
  9474. // Plus sign handling
  9475. else if (c == '+') {
  9476. if (space_as_plus) {
  9477. result += "%2B";
  9478. } else {
  9479. result += static_cast<char>(c);
  9480. }
  9481. }
  9482. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9483. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9484. c == '*' || c == ',' || c == ';') {
  9485. result += static_cast<char>(c);
  9486. }
  9487. // Colon and @ are allowed in query
  9488. else if (c == ':' || c == '@') {
  9489. result += static_cast<char>(c);
  9490. }
  9491. // Forward slash is allowed in query values
  9492. else if (c == '/') {
  9493. result += static_cast<char>(c);
  9494. }
  9495. // Question mark is allowed in query values (after first ?)
  9496. else if (c == '?') {
  9497. result += static_cast<char>(c);
  9498. } else {
  9499. result += '%';
  9500. char hex[3];
  9501. snprintf(hex, sizeof(hex), "%02X", c);
  9502. result.append(hex, 2);
  9503. }
  9504. }
  9505. return result;
  9506. }
  9507. inline std::string decode_query_component(const std::string &component,
  9508. bool plus_as_space) {
  9509. std::string result;
  9510. result.reserve(component.size());
  9511. for (size_t i = 0; i < component.size(); i++) {
  9512. if (component[i] == '%' && i + 2 < component.size()) {
  9513. auto val = 0;
  9514. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9515. result += static_cast<char>(val);
  9516. i += 2;
  9517. } else {
  9518. result += component[i];
  9519. }
  9520. } else if (component[i] == '+' && plus_as_space) {
  9521. result += ' '; // + becomes space in form-urlencoded
  9522. } else {
  9523. result += component[i];
  9524. }
  9525. }
  9526. return result;
  9527. }
  9528. inline std::string sanitize_filename(const std::string &filename) {
  9529. // Extract basename: find the last path separator (/ or \)
  9530. auto pos = filename.find_last_of("/\\");
  9531. auto result =
  9532. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9533. // Strip null bytes
  9534. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9535. // Trim whitespace
  9536. {
  9537. auto start = result.find_first_not_of(" \t");
  9538. auto end = result.find_last_not_of(" \t");
  9539. result = (start == std::string::npos)
  9540. ? ""
  9541. : result.substr(start, end - start + 1);
  9542. }
  9543. // Reject . and ..
  9544. if (result == "." || result == "..") { return ""; }
  9545. return result;
  9546. }
  9547. inline std::string append_query_params(const std::string &path,
  9548. const Params &params) {
  9549. std::string path_with_query = path;
  9550. thread_local const std::regex re("[^?]+\\?.*");
  9551. auto delm = std::regex_match(path, re) ? '&' : '?';
  9552. path_with_query += delm + detail::params_to_query_str(params);
  9553. return path_with_query;
  9554. }
  9555. // Header utilities
  9556. inline std::pair<std::string, std::string>
  9557. make_range_header(const Ranges &ranges) {
  9558. std::string field = "bytes=";
  9559. auto i = 0;
  9560. for (const auto &r : ranges) {
  9561. if (i != 0) { field += ", "; }
  9562. if (r.first != -1) { field += std::to_string(r.first); }
  9563. field += '-';
  9564. if (r.second != -1) { field += std::to_string(r.second); }
  9565. i++;
  9566. }
  9567. return std::make_pair("Range", std::move(field));
  9568. }
  9569. inline std::pair<std::string, std::string>
  9570. make_basic_authentication_header(const std::string &username,
  9571. const std::string &password, bool is_proxy) {
  9572. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9573. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9574. return std::make_pair(key, std::move(field));
  9575. }
  9576. inline std::pair<std::string, std::string>
  9577. make_bearer_token_authentication_header(const std::string &token,
  9578. bool is_proxy = false) {
  9579. auto field = "Bearer " + token;
  9580. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9581. return std::make_pair(key, std::move(field));
  9582. }
  9583. // Request implementation
  9584. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9585. size_t id) const {
  9586. return detail::get_header_value_u64(headers, key, def, id);
  9587. }
  9588. inline bool Request::has_header(const std::string &key) const {
  9589. return detail::has_header(headers, key);
  9590. }
  9591. inline std::string Request::get_header_value(const std::string &key,
  9592. const char *def, size_t id) const {
  9593. return detail::get_header_value(headers, key, def, id);
  9594. }
  9595. inline size_t Request::get_header_value_count(const std::string &key) const {
  9596. return detail::get_header_value_count(headers, key);
  9597. }
  9598. inline void Request::set_header(const std::string &key,
  9599. const std::string &val) {
  9600. detail::set_header(headers, key, val);
  9601. }
  9602. inline bool Request::has_trailer(const std::string &key) const {
  9603. return trailers.find(key) != trailers.end();
  9604. }
  9605. inline std::string Request::get_trailer_value(const std::string &key,
  9606. size_t id) const {
  9607. return detail::get_multimap_value(trailers, key, id);
  9608. }
  9609. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9610. return trailers.count(key);
  9611. }
  9612. inline bool Request::has_param(const std::string &key) const {
  9613. return params.find(key) != params.end();
  9614. }
  9615. inline std::string Request::get_param_value(const std::string &key,
  9616. size_t id) const {
  9617. return detail::get_multimap_value(params, key, id);
  9618. }
  9619. inline std::vector<std::string>
  9620. Request::get_param_values(const std::string &key) const {
  9621. auto rng = params.equal_range(key);
  9622. std::vector<std::string> values;
  9623. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9624. for (auto it = rng.first; it != rng.second; ++it) {
  9625. values.push_back(it->second);
  9626. }
  9627. return values;
  9628. }
  9629. inline size_t Request::get_param_value_count(const std::string &key) const {
  9630. return params.count(key);
  9631. }
  9632. inline bool Request::is_multipart_form_data() const {
  9633. const auto &content_type = get_header_value("Content-Type");
  9634. return detail::extract_media_type(content_type) == "multipart/form-data";
  9635. }
  9636. // Multipart FormData implementation
  9637. inline std::string MultipartFormData::get_field(const std::string &key,
  9638. size_t id) const {
  9639. auto rng = fields.equal_range(key);
  9640. auto it = rng.first;
  9641. std::advance(it, static_cast<ssize_t>(id));
  9642. if (it != rng.second) { return it->second.content; }
  9643. return std::string();
  9644. }
  9645. inline std::vector<std::string>
  9646. MultipartFormData::get_fields(const std::string &key) const {
  9647. std::vector<std::string> values;
  9648. auto rng = fields.equal_range(key);
  9649. for (auto it = rng.first; it != rng.second; it++) {
  9650. values.push_back(it->second.content);
  9651. }
  9652. return values;
  9653. }
  9654. inline bool MultipartFormData::has_field(const std::string &key) const {
  9655. return fields.find(key) != fields.end();
  9656. }
  9657. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9658. return fields.count(key);
  9659. }
  9660. inline FormData MultipartFormData::get_file(const std::string &key,
  9661. size_t id) const {
  9662. return detail::get_multimap_value(files, key, id);
  9663. }
  9664. inline std::vector<FormData>
  9665. MultipartFormData::get_files(const std::string &key) const {
  9666. std::vector<FormData> values;
  9667. auto rng = files.equal_range(key);
  9668. for (auto it = rng.first; it != rng.second; it++) {
  9669. values.push_back(it->second);
  9670. }
  9671. return values;
  9672. }
  9673. inline bool MultipartFormData::has_file(const std::string &key) const {
  9674. return files.find(key) != files.end();
  9675. }
  9676. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9677. return files.count(key);
  9678. }
  9679. // Multipart FormData writer implementation
  9680. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9681. return detail::is_multipart_boundary_chars_valid(boundary);
  9682. }
  9683. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9684. : boundary_(detail::make_multipart_data_boundary()) {}
  9685. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9686. : boundary_(std::move(boundary)) {}
  9687. inline const std::string &MultipartFormDataWriter::boundary() const {
  9688. return boundary_;
  9689. }
  9690. inline std::string MultipartFormDataWriter::content_type() const {
  9691. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9692. }
  9693. inline std::string
  9694. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9695. return detail::serialize_multipart_formdata(items, boundary_);
  9696. }
  9697. inline size_t MultipartFormDataWriter::content_length(
  9698. const UploadFormDataItems &items) const {
  9699. return detail::get_multipart_content_length(items, boundary_);
  9700. }
  9701. inline std::string
  9702. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9703. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9704. }
  9705. inline std::string MultipartFormDataWriter::item_end() {
  9706. return detail::serialize_multipart_formdata_item_end();
  9707. }
  9708. inline std::string MultipartFormDataWriter::finish() const {
  9709. return detail::serialize_multipart_formdata_finish(boundary_);
  9710. }
  9711. // Response implementation
  9712. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9713. size_t id) const {
  9714. return detail::get_header_value_u64(headers, key, def, id);
  9715. }
  9716. inline bool Response::has_header(const std::string &key) const {
  9717. return headers.find(key) != headers.end();
  9718. }
  9719. inline std::string Response::get_header_value(const std::string &key,
  9720. const char *def,
  9721. size_t id) const {
  9722. return detail::get_header_value(headers, key, def, id);
  9723. }
  9724. inline size_t Response::get_header_value_count(const std::string &key) const {
  9725. return detail::get_header_value_count(headers, key);
  9726. }
  9727. inline void Response::set_header(const std::string &key,
  9728. const std::string &val) {
  9729. detail::set_header(headers, key, val);
  9730. }
  9731. inline bool Response::has_trailer(const std::string &key) const {
  9732. return trailers.find(key) != trailers.end();
  9733. }
  9734. inline std::string Response::get_trailer_value(const std::string &key,
  9735. size_t id) const {
  9736. return detail::get_multimap_value(trailers, key, id);
  9737. }
  9738. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9739. return trailers.count(key);
  9740. }
  9741. inline void Response::set_redirect(const std::string &url, int stat) {
  9742. if (detail::fields::is_field_value(url)) {
  9743. set_header("Location", url);
  9744. if (300 <= stat && stat < 400) {
  9745. this->status = stat;
  9746. } else {
  9747. this->status = StatusCode::Found_302;
  9748. }
  9749. }
  9750. }
  9751. inline void Response::set_content(const char *s, size_t n,
  9752. const std::string &content_type) {
  9753. body.assign(s, n);
  9754. auto rng = headers.equal_range("Content-Type");
  9755. headers.erase(rng.first, rng.second);
  9756. set_header("Content-Type", content_type);
  9757. content_coding_ = detail::EncodingType::None;
  9758. }
  9759. inline void Response::set_content(const std::string &s,
  9760. const std::string &content_type) {
  9761. set_content(s.data(), s.size(), content_type);
  9762. }
  9763. inline void Response::set_content(std::string &&s,
  9764. const std::string &content_type) {
  9765. body = std::move(s);
  9766. auto rng = headers.equal_range("Content-Type");
  9767. headers.erase(rng.first, rng.second);
  9768. set_header("Content-Type", content_type);
  9769. content_coding_ = detail::EncodingType::None;
  9770. }
  9771. inline void Response::set_content_provider(
  9772. size_t in_length, const std::string &content_type, ContentProvider provider,
  9773. ContentProviderResourceReleaser resource_releaser) {
  9774. set_header("Content-Type", content_type);
  9775. content_length_ = in_length;
  9776. if (in_length > 0) { content_provider_ = std::move(provider); }
  9777. content_provider_resource_releaser_ = std::move(resource_releaser);
  9778. is_chunked_content_provider_ = false;
  9779. content_coding_ = detail::EncodingType::None;
  9780. }
  9781. inline void Response::set_content_provider(
  9782. const std::string &content_type, ContentProviderWithoutLength provider,
  9783. ContentProviderResourceReleaser resource_releaser) {
  9784. set_header("Content-Type", content_type);
  9785. content_length_ = 0;
  9786. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9787. content_provider_resource_releaser_ = std::move(resource_releaser);
  9788. is_chunked_content_provider_ = false;
  9789. content_coding_ = detail::EncodingType::None;
  9790. }
  9791. inline void Response::set_chunked_content_provider(
  9792. const std::string &content_type, ContentProviderWithoutLength provider,
  9793. ContentProviderResourceReleaser resource_releaser) {
  9794. set_header("Content-Type", content_type);
  9795. content_length_ = 0;
  9796. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9797. content_provider_resource_releaser_ = std::move(resource_releaser);
  9798. is_chunked_content_provider_ = true;
  9799. content_coding_ = detail::EncodingType::None;
  9800. }
  9801. inline void Response::set_file_content(const std::string &path,
  9802. const std::string &content_type) {
  9803. file_content_path_ = path;
  9804. file_content_content_type_ = content_type;
  9805. }
  9806. inline void Response::set_file_content(const std::string &path) {
  9807. file_content_path_ = path;
  9808. }
  9809. // Result implementation
  9810. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9811. size_t def,
  9812. size_t id) const {
  9813. return detail::get_header_value_u64(request_headers_, key, def, id);
  9814. }
  9815. inline bool Result::has_request_header(const std::string &key) const {
  9816. return request_headers_.find(key) != request_headers_.end();
  9817. }
  9818. inline std::string Result::get_request_header_value(const std::string &key,
  9819. const char *def,
  9820. size_t id) const {
  9821. return detail::get_header_value(request_headers_, key, def, id);
  9822. }
  9823. inline size_t
  9824. Result::get_request_header_value_count(const std::string &key) const {
  9825. return request_headers_.count(key);
  9826. }
  9827. // Stream implementation
  9828. inline ssize_t Stream::write(const char *ptr) {
  9829. return write(ptr, strlen(ptr));
  9830. }
  9831. inline ssize_t Stream::write(const std::string &s) {
  9832. return write(s.data(), s.size());
  9833. }
  9834. // BodyReader implementation
  9835. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9836. if (!stream) {
  9837. last_error = Error::Connection;
  9838. return -1;
  9839. }
  9840. if (eof) { return 0; }
  9841. if (!chunked) {
  9842. // Content-Length based reading
  9843. if (has_content_length && bytes_read >= content_length) {
  9844. eof = true;
  9845. return 0;
  9846. }
  9847. auto to_read = len;
  9848. if (has_content_length) {
  9849. auto remaining = content_length - bytes_read;
  9850. to_read = (std::min)(len, remaining);
  9851. }
  9852. auto n = stream->read(buf, to_read);
  9853. if (n < 0) {
  9854. last_error = stream->get_error();
  9855. if (last_error == Error::Success) { last_error = Error::Read; }
  9856. eof = true;
  9857. return n;
  9858. }
  9859. if (n == 0) {
  9860. // Unexpected EOF before content_length
  9861. last_error = stream->get_error();
  9862. if (last_error == Error::Success) { last_error = Error::Read; }
  9863. eof = true;
  9864. return 0;
  9865. }
  9866. bytes_read += static_cast<size_t>(n);
  9867. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9868. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9869. last_error = Error::ExceedMaxPayloadSize;
  9870. eof = true;
  9871. return -1;
  9872. }
  9873. return n;
  9874. }
  9875. // Chunked transfer encoding: delegate to shared decoder instance.
  9876. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9877. size_t chunk_offset = 0;
  9878. size_t chunk_total = 0;
  9879. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9880. if (n < 0) {
  9881. last_error = stream->get_error();
  9882. if (last_error == Error::Success) { last_error = Error::Read; }
  9883. eof = true;
  9884. return n;
  9885. }
  9886. if (n == 0) {
  9887. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9888. eof = true;
  9889. return 0;
  9890. }
  9891. bytes_read += static_cast<size_t>(n);
  9892. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9893. last_error = Error::ExceedMaxPayloadSize;
  9894. eof = true;
  9895. return -1;
  9896. }
  9897. return n;
  9898. }
  9899. // ThreadPool implementation
  9900. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9901. time_t idle_timeout_sec)
  9902. : base_thread_count_(n), max_queued_requests_(mqr),
  9903. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9904. shutdown_(false) {
  9905. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9906. if (max_n != 0 && max_n < n) {
  9907. std::string msg = "max_threads must be >= base_threads";
  9908. throw std::invalid_argument(msg);
  9909. }
  9910. #endif
  9911. max_thread_count_ = max_n == 0 ? n : max_n;
  9912. threads_.reserve(base_thread_count_);
  9913. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9914. try {
  9915. #endif
  9916. for (size_t i = 0; i < base_thread_count_; i++) {
  9917. threads_.emplace_back(std::thread([this]() { worker(false); }));
  9918. }
  9919. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9920. } catch (...) {
  9921. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  9922. // signal the workers we already spawned to exit and join them so the
  9923. // vector destructor does not see joinable threads (which would call
  9924. // std::terminate). Then rethrow so the caller learns of the failure.
  9925. {
  9926. std::unique_lock<std::mutex> lock(mutex_);
  9927. shutdown_ = true;
  9928. }
  9929. cond_.notify_all();
  9930. for (auto &t : threads_) {
  9931. if (t.joinable()) { t.join(); }
  9932. }
  9933. throw;
  9934. }
  9935. #endif
  9936. }
  9937. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  9938. {
  9939. std::unique_lock<std::mutex> lock(mutex_);
  9940. if (shutdown_) { return false; }
  9941. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  9942. return false;
  9943. }
  9944. jobs_.push_back(std::move(fn));
  9945. // Spawn a dynamic thread if no idle threads and under max
  9946. if (idle_thread_count_ == 0 &&
  9947. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  9948. cleanup_finished_threads();
  9949. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  9950. }
  9951. }
  9952. cond_.notify_one();
  9953. return true;
  9954. }
  9955. inline void ThreadPool::shutdown() {
  9956. {
  9957. std::unique_lock<std::mutex> lock(mutex_);
  9958. shutdown_ = true;
  9959. }
  9960. cond_.notify_all();
  9961. for (auto &t : threads_) {
  9962. if (t.joinable()) { t.join(); }
  9963. }
  9964. // Move dynamic_threads_ to a local list under the lock to avoid racing
  9965. // with worker threads that call move_to_finished() concurrently.
  9966. std::list<std::thread> remaining_dynamic;
  9967. {
  9968. std::unique_lock<std::mutex> lock(mutex_);
  9969. remaining_dynamic = std::move(dynamic_threads_);
  9970. }
  9971. for (auto &t : remaining_dynamic) {
  9972. if (t.joinable()) { t.join(); }
  9973. }
  9974. std::unique_lock<std::mutex> lock(mutex_);
  9975. cleanup_finished_threads();
  9976. }
  9977. inline void ThreadPool::move_to_finished(std::thread::id id) {
  9978. // Must be called with mutex_ held
  9979. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  9980. if (it->get_id() == id) {
  9981. finished_threads_.push_back(std::move(*it));
  9982. dynamic_threads_.erase(it);
  9983. return;
  9984. }
  9985. }
  9986. }
  9987. inline void ThreadPool::cleanup_finished_threads() {
  9988. // Must be called with mutex_ held
  9989. for (auto &t : finished_threads_) {
  9990. if (t.joinable()) { t.join(); }
  9991. }
  9992. finished_threads_.clear();
  9993. }
  9994. inline void ThreadPool::worker(bool is_dynamic) {
  9995. for (;;) {
  9996. std::function<void()> fn;
  9997. {
  9998. std::unique_lock<std::mutex> lock(mutex_);
  9999. idle_thread_count_++;
  10000. if (is_dynamic) {
  10001. auto has_work =
  10002. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10003. [&] { return !jobs_.empty() || shutdown_; });
  10004. if (!has_work) {
  10005. // Timed out with no work - exit this dynamic thread
  10006. idle_thread_count_--;
  10007. move_to_finished(std::this_thread::get_id());
  10008. break;
  10009. }
  10010. } else {
  10011. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10012. }
  10013. idle_thread_count_--;
  10014. if (shutdown_ && jobs_.empty()) { break; }
  10015. fn = std::move(jobs_.front());
  10016. jobs_.pop_front();
  10017. }
  10018. assert(true == static_cast<bool>(fn));
  10019. fn();
  10020. }
  10021. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10022. !defined(LIBRESSL_VERSION_NUMBER)
  10023. OPENSSL_thread_stop();
  10024. #endif
  10025. }
  10026. /*
  10027. * Group 1 (continued): detail namespace - Stream implementations
  10028. */
  10029. namespace detail {
  10030. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10031. time_t timeout_sec, time_t timeout_usec,
  10032. time_t &actual_timeout_sec,
  10033. time_t &actual_timeout_usec) {
  10034. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10035. auto actual_timeout_msec =
  10036. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10037. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10038. actual_timeout_sec = actual_timeout_msec / 1000;
  10039. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10040. }
  10041. // Socket stream implementation
  10042. inline SocketStream::SocketStream(
  10043. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10044. time_t write_timeout_sec, time_t write_timeout_usec,
  10045. time_t max_timeout_msec,
  10046. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10047. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10048. read_timeout_usec_(read_timeout_usec),
  10049. write_timeout_sec_(write_timeout_sec),
  10050. write_timeout_usec_(write_timeout_usec),
  10051. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10052. read_buff_(read_buff_size_, 0) {}
  10053. inline SocketStream::~SocketStream() = default;
  10054. inline bool SocketStream::is_readable() const {
  10055. return read_buff_off_ < read_buff_content_size_;
  10056. }
  10057. inline bool SocketStream::wait_readable() const {
  10058. if (max_timeout_msec_ <= 0) {
  10059. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10060. }
  10061. time_t read_timeout_sec;
  10062. time_t read_timeout_usec;
  10063. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10064. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10065. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10066. }
  10067. inline bool SocketStream::wait_writable() const {
  10068. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10069. }
  10070. inline bool SocketStream::ensure_readable() {
  10071. if (readable_hint_) {
  10072. readable_hint_ = false;
  10073. return true;
  10074. }
  10075. return wait_readable();
  10076. }
  10077. inline const char *SocketStream::buffered_data(size_t &size) const {
  10078. size = read_buff_content_size_ - read_buff_off_;
  10079. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10080. }
  10081. inline void SocketStream::consume_buffered(size_t size) {
  10082. assert(size <= read_buff_content_size_ - read_buff_off_);
  10083. read_buff_off_ += size;
  10084. }
  10085. inline bool SocketStream::is_peer_alive() const {
  10086. return detail::is_socket_alive(sock_);
  10087. }
  10088. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10089. #ifdef _WIN32
  10090. size =
  10091. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10092. #else
  10093. size = (std::min)(size,
  10094. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10095. #endif
  10096. if (read_buff_off_ < read_buff_content_size_) {
  10097. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10098. if (size <= remaining_size) {
  10099. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10100. read_buff_off_ += size;
  10101. return static_cast<ssize_t>(size);
  10102. } else {
  10103. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10104. read_buff_off_ += remaining_size;
  10105. return static_cast<ssize_t>(remaining_size);
  10106. }
  10107. }
  10108. if (!ensure_readable()) {
  10109. error_ = Error::Timeout;
  10110. return -1;
  10111. }
  10112. read_buff_off_ = 0;
  10113. read_buff_content_size_ = 0;
  10114. if (size < read_buff_size_) {
  10115. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10116. CPPHTTPLIB_RECV_FLAGS);
  10117. if (n <= 0) {
  10118. if (n == 0) {
  10119. error_ = Error::ConnectionClosed;
  10120. } else {
  10121. error_ = Error::Read;
  10122. }
  10123. return n;
  10124. } else if (n <= static_cast<ssize_t>(size)) {
  10125. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10126. return n;
  10127. } else {
  10128. memcpy(ptr, read_buff_.data(), size);
  10129. read_buff_off_ = size;
  10130. read_buff_content_size_ = static_cast<size_t>(n);
  10131. return static_cast<ssize_t>(size);
  10132. }
  10133. } else {
  10134. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10135. if (n <= 0) {
  10136. if (n == 0) {
  10137. error_ = Error::ConnectionClosed;
  10138. } else {
  10139. error_ = Error::Read;
  10140. }
  10141. }
  10142. return n;
  10143. }
  10144. }
  10145. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10146. if (!wait_writable()) { return -1; }
  10147. #if defined(_WIN32) && !defined(_WIN64)
  10148. size =
  10149. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10150. #endif
  10151. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10152. }
  10153. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10154. int &port) const {
  10155. return detail::get_remote_ip_and_port(sock_, ip, port);
  10156. }
  10157. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10158. int &port) const {
  10159. return detail::get_local_ip_and_port(sock_, ip, port);
  10160. }
  10161. inline socket_t SocketStream::socket() const { return sock_; }
  10162. inline time_t SocketStream::duration() const {
  10163. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10164. std::chrono::steady_clock::now() - start_time_)
  10165. .count();
  10166. }
  10167. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10168. read_timeout_sec_ = sec;
  10169. read_timeout_usec_ = usec;
  10170. }
  10171. // Buffer stream implementation
  10172. inline bool BufferStream::is_readable() const { return true; }
  10173. inline bool BufferStream::wait_readable() const { return true; }
  10174. inline bool BufferStream::wait_writable() const { return true; }
  10175. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10176. #if defined(_MSC_VER) && _MSC_VER < 1910
  10177. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10178. #else
  10179. auto len_read = buffer.copy(ptr, size, position);
  10180. #endif
  10181. position += static_cast<size_t>(len_read);
  10182. return static_cast<ssize_t>(len_read);
  10183. }
  10184. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10185. buffer.append(ptr, size);
  10186. return static_cast<ssize_t>(size);
  10187. }
  10188. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10189. int & /*port*/) const {}
  10190. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10191. int & /*port*/) const {}
  10192. inline socket_t BufferStream::socket() const { return 0; }
  10193. inline time_t BufferStream::duration() const { return 0; }
  10194. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10195. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10196. : MatcherBase(pattern) {
  10197. constexpr const char marker[] = "/:";
  10198. // One past the last ending position of a path param substring
  10199. std::size_t last_param_end = 0;
  10200. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10201. // Needed to ensure that parameter names are unique during matcher
  10202. // construction
  10203. // If exceptions are disabled, only last duplicate path
  10204. // parameter will be set
  10205. std::unordered_set<std::string> param_name_set;
  10206. #endif
  10207. while (true) {
  10208. const auto marker_pos = pattern.find(
  10209. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10210. if (marker_pos == std::string::npos) { break; }
  10211. static_fragments_.push_back(
  10212. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10213. const auto param_name_start = marker_pos + str_len(marker);
  10214. auto sep_pos = pattern.find(separator, param_name_start);
  10215. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10216. auto param_name =
  10217. pattern.substr(param_name_start, sep_pos - param_name_start);
  10218. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10219. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10220. std::string msg = "Encountered path parameter '" + param_name +
  10221. "' multiple times in route pattern '" + pattern + "'.";
  10222. throw std::invalid_argument(msg);
  10223. }
  10224. #endif
  10225. param_names_.push_back(std::move(param_name));
  10226. last_param_end = sep_pos + 1;
  10227. }
  10228. if (last_param_end < pattern.length()) {
  10229. static_fragments_.push_back(pattern.substr(last_param_end));
  10230. }
  10231. }
  10232. inline bool PathParamsMatcher::match(Request &request) const {
  10233. request.matches = std::smatch();
  10234. request.path_params.clear();
  10235. // A pattern without parameters is just a literal path to compare against
  10236. if (param_names_.empty()) { return request.path == pattern(); }
  10237. request.path_params.reserve(param_names_.size());
  10238. // One past the position at which the path matched the pattern last time
  10239. std::size_t starting_pos = 0;
  10240. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10241. const auto &fragment = static_fragments_[i];
  10242. if (starting_pos + fragment.length() > request.path.length()) {
  10243. return false;
  10244. }
  10245. // Avoid unnecessary allocation by using strncmp instead of substr +
  10246. // comparison
  10247. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10248. fragment.length()) != 0) {
  10249. return false;
  10250. }
  10251. starting_pos += fragment.length();
  10252. // Should only happen when we have a static fragment after a param
  10253. // Example: '/users/:id/subscriptions'
  10254. // The 'subscriptions' fragment here does not have a corresponding param
  10255. if (i >= param_names_.size()) { continue; }
  10256. auto sep_pos = request.path.find(separator, starting_pos);
  10257. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10258. const auto &param_name = param_names_[i];
  10259. request.path_params.emplace(
  10260. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10261. // Mark everything up to '/' as matched
  10262. starting_pos = sep_pos + 1;
  10263. }
  10264. // Returns false if the path is longer than the pattern
  10265. return starting_pos >= request.path.length();
  10266. }
  10267. inline bool RegexMatcher::match(Request &request) const {
  10268. request.path_params.clear();
  10269. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10270. // a non-match rather than risking a stack overflow in std::regex_match.
  10271. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10272. return false;
  10273. }
  10274. return std::regex_match(request.path, request.matches, regex_);
  10275. }
  10276. // Enclose IPv6 address in brackets if needed
  10277. inline std::string prepare_host_string(const std::string &host) {
  10278. // Enclose IPv6 address in brackets (but not if already enclosed)
  10279. if (host.find(':') == std::string::npos ||
  10280. (!host.empty() && host[0] == '[')) {
  10281. // IPv4, hostname, or already bracketed IPv6
  10282. return host;
  10283. } else {
  10284. // IPv6 address without brackets
  10285. return "[" + host + "]";
  10286. }
  10287. }
  10288. inline std::string make_host_and_port_string(const std::string &host, int port,
  10289. bool is_ssl) {
  10290. auto result = prepare_host_string(host);
  10291. // Append port if not default
  10292. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10293. ; // do nothing
  10294. } else {
  10295. result += ":" + std::to_string(port);
  10296. }
  10297. return result;
  10298. }
  10299. // Create "host:port" string always including port number (for CONNECT method)
  10300. inline std::string
  10301. make_host_and_port_string_always_port(const std::string &host, int port) {
  10302. return prepare_host_string(host) + ":" + std::to_string(port);
  10303. }
  10304. // Value for the Host header a client sends when the caller supplied none.
  10305. // Only the value: callers decide where in their header list it goes.
  10306. inline std::string make_default_host_header_value(const std::string &host,
  10307. int port, bool is_ssl,
  10308. int address_family) {
  10309. if (address_family == AF_UNIX) { return "localhost"; }
  10310. return make_host_and_port_string(host, port, is_ssl);
  10311. }
  10312. inline void add_default_user_agent_header(Request &req) {
  10313. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10314. if (!req.has_header("User-Agent")) {
  10315. req.set_header("User-Agent",
  10316. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10317. }
  10318. #else
  10319. (void)req;
  10320. #endif
  10321. }
  10322. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10323. NormalizedTarget normalize_target(const std::string &host);
  10324. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10325. bool host_matches_no_proxy(const NormalizedTarget &target,
  10326. const std::vector<NoProxyEntry> &entries);
  10327. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10328. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10329. if (prefix_bits == 0) { return true; }
  10330. int full_bytes = prefix_bits / 8;
  10331. int rem_bits = prefix_bits % 8;
  10332. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10333. static_cast<size_t>(full_bytes)) != 0) {
  10334. return false;
  10335. }
  10336. if (rem_bits == 0) { return true; }
  10337. auto i = static_cast<size_t>(full_bytes);
  10338. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10339. return (ip[i] & mask) == (net[i] & mask);
  10340. }
  10341. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10342. if (token.empty()) { return false; }
  10343. if (token == "*") {
  10344. out.kind = NoProxyKind::Wildcard;
  10345. return true;
  10346. }
  10347. auto slash = token.find('/');
  10348. std::string addr_part =
  10349. (slash == std::string::npos) ? token : token.substr(0, slash);
  10350. std::string prefix_part =
  10351. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10352. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10353. // don't silently treat it as a /32 (or /128).
  10354. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10355. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10356. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10357. // when brackets are present.
  10358. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10359. addr_part.back() == ']';
  10360. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10361. if (!bracketed) {
  10362. struct in_addr v4;
  10363. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10364. int prefix = 32;
  10365. if (!prefix_part.empty()) {
  10366. auto r = from_chars(prefix_part.data(),
  10367. prefix_part.data() + prefix_part.size(), prefix);
  10368. if (r.ec != std::errc{} ||
  10369. r.ptr != prefix_part.data() + prefix_part.size()) {
  10370. return false;
  10371. }
  10372. if (prefix < 0 || prefix > 32) { return false; }
  10373. }
  10374. out.kind = NoProxyKind::IPv4Cidr;
  10375. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10376. out.prefix_bits = prefix;
  10377. return true;
  10378. }
  10379. }
  10380. struct in6_addr v6;
  10381. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10382. int prefix = 128;
  10383. if (!prefix_part.empty()) {
  10384. auto r = from_chars(prefix_part.data(),
  10385. prefix_part.data() + prefix_part.size(), prefix);
  10386. if (r.ec != std::errc{} ||
  10387. r.ptr != prefix_part.data() + prefix_part.size()) {
  10388. return false;
  10389. }
  10390. if (prefix < 0 || prefix > 128) { return false; }
  10391. }
  10392. out.kind = NoProxyKind::IPv6Cidr;
  10393. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10394. out.prefix_bits = prefix;
  10395. return true;
  10396. }
  10397. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10398. // the entry is malformed — don't fall through to the hostname branch.
  10399. if (bracketed) { return false; }
  10400. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10401. if (slash != std::string::npos) { return false; }
  10402. // Port-specific entries (host:port) are not supported.
  10403. if (token.find(':') != std::string::npos) { return false; }
  10404. std::string hostname = case_ignore::to_lower(token);
  10405. while (!hostname.empty() && hostname.front() == '.') {
  10406. hostname.erase(hostname.begin());
  10407. }
  10408. while (!hostname.empty() && hostname.back() == '.') {
  10409. hostname.pop_back();
  10410. }
  10411. if (hostname.empty()) { return false; }
  10412. out.kind = NoProxyKind::HostnameSuffix;
  10413. out.hostname_pattern = std::move(hostname);
  10414. return true;
  10415. }
  10416. inline NormalizedTarget normalize_target(const std::string &host) {
  10417. NormalizedTarget t;
  10418. std::string h = host;
  10419. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10420. h = h.substr(1, h.size() - 2);
  10421. }
  10422. // Strip a single trailing dot so "example.com." canonicalizes to
  10423. // "example.com".
  10424. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10425. t.hostname = case_ignore::to_lower(h);
  10426. if (!t.hostname.empty()) {
  10427. struct in_addr v4;
  10428. struct in6_addr v6;
  10429. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10430. t.is_ipv4 = true;
  10431. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10432. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10433. t.is_ipv6 = true;
  10434. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10435. }
  10436. }
  10437. return t;
  10438. }
  10439. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10440. const std::vector<NoProxyEntry> &entries) {
  10441. if (target.hostname.empty()) { return false; }
  10442. for (const auto &e : entries) {
  10443. switch (e.kind) {
  10444. case NoProxyKind::Wildcard: return true;
  10445. case NoProxyKind::IPv4Cidr:
  10446. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10447. return true;
  10448. }
  10449. break;
  10450. case NoProxyKind::IPv6Cidr:
  10451. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10452. return true;
  10453. }
  10454. break;
  10455. case NoProxyKind::HostnameSuffix:
  10456. if (target.is_ipv4 || target.is_ipv6) { break; }
  10457. if (target.hostname == e.hostname_pattern) { return true; }
  10458. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10459. // an entry of "example.com".
  10460. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10461. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10462. if (target.hostname[offset - 1] == '.' &&
  10463. target.hostname.compare(offset, e.hostname_pattern.size(),
  10464. e.hostname_pattern) == 0) {
  10465. return true;
  10466. }
  10467. }
  10468. break;
  10469. }
  10470. }
  10471. return false;
  10472. }
  10473. template <typename T>
  10474. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10475. T header_writer, Error &error) {
  10476. for (const auto &h : headers) {
  10477. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10478. error = Error::InvalidHeaders;
  10479. return false;
  10480. }
  10481. }
  10482. if (header_writer(strm, headers) <= 0) {
  10483. error = Error::Write;
  10484. return false;
  10485. }
  10486. return true;
  10487. }
  10488. } // namespace detail
  10489. /*
  10490. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10491. */
  10492. #ifdef CPPHTTPLIB_SSL_ENABLED
  10493. namespace detail {
  10494. // SSL socket stream implementation
  10495. inline SSLSocketStream::SSLSocketStream(
  10496. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10497. time_t read_timeout_usec, time_t write_timeout_sec,
  10498. time_t write_timeout_usec, time_t max_timeout_msec,
  10499. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10500. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10501. read_timeout_usec_(read_timeout_usec),
  10502. write_timeout_sec_(write_timeout_sec),
  10503. write_timeout_usec_(write_timeout_usec),
  10504. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10505. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10506. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10507. // Note: create_session() also clears this, but SSLClient currently
  10508. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10509. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10510. // SSL session was created.
  10511. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10512. #endif
  10513. }
  10514. inline SSLSocketStream::~SSLSocketStream() = default;
  10515. inline bool SSLSocketStream::is_readable() const {
  10516. return tls::pending(session_) > 0;
  10517. }
  10518. inline bool SSLSocketStream::wait_readable() const {
  10519. if (max_timeout_msec_ <= 0) {
  10520. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10521. }
  10522. time_t read_timeout_sec;
  10523. time_t read_timeout_usec;
  10524. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10525. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10526. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10527. }
  10528. inline bool SSLSocketStream::wait_writable() const {
  10529. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10530. !tls::is_peer_closed(session_, sock_);
  10531. }
  10532. inline bool SSLSocketStream::ensure_readable() {
  10533. if (readable_hint_) {
  10534. readable_hint_ = false;
  10535. return true;
  10536. }
  10537. return wait_readable();
  10538. }
  10539. inline bool SSLSocketStream::is_peer_alive() const {
  10540. return !tls::is_peer_closed(session_, sock_);
  10541. }
  10542. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10543. if (tls::pending(session_) > 0) {
  10544. tls::TlsError err;
  10545. auto ret = tls::read(session_, ptr, size, err);
  10546. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10547. error_ = Error::ConnectionClosed;
  10548. }
  10549. return ret;
  10550. } else if (ensure_readable()) {
  10551. tls::TlsError err;
  10552. auto ret = tls::read(session_, ptr, size, err);
  10553. if (ret < 0) {
  10554. auto n = 1000;
  10555. #ifdef _WIN32
  10556. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10557. (err.code == tls::ErrorCode::SyscallError &&
  10558. WSAGetLastError() == WSAETIMEDOUT))) {
  10559. #else
  10560. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10561. #endif
  10562. if (tls::pending(session_) > 0) {
  10563. return tls::read(session_, ptr, size, err);
  10564. } else if (wait_readable()) {
  10565. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10566. ret = tls::read(session_, ptr, size, err);
  10567. if (ret >= 0) { return ret; }
  10568. } else {
  10569. break;
  10570. }
  10571. }
  10572. assert(ret < 0);
  10573. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10574. error_ = Error::ConnectionClosed;
  10575. }
  10576. return ret;
  10577. } else {
  10578. error_ = Error::Timeout;
  10579. return -1;
  10580. }
  10581. }
  10582. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10583. if (wait_writable()) {
  10584. auto handle_size =
  10585. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10586. tls::TlsError err;
  10587. auto ret = tls::write(session_, ptr, handle_size, err);
  10588. if (ret < 0) {
  10589. auto n = 1000;
  10590. #ifdef _WIN32
  10591. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10592. (err.code == tls::ErrorCode::SyscallError &&
  10593. WSAGetLastError() == WSAETIMEDOUT))) {
  10594. #else
  10595. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10596. #endif
  10597. if (wait_writable()) {
  10598. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10599. ret = tls::write(session_, ptr, handle_size, err);
  10600. if (ret >= 0) { return ret; }
  10601. } else {
  10602. break;
  10603. }
  10604. }
  10605. assert(ret < 0);
  10606. }
  10607. return ret;
  10608. }
  10609. return -1;
  10610. }
  10611. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10612. int &port) const {
  10613. detail::get_remote_ip_and_port(sock_, ip, port);
  10614. }
  10615. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10616. int &port) const {
  10617. detail::get_local_ip_and_port(sock_, ip, port);
  10618. }
  10619. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10620. inline time_t SSLSocketStream::duration() const {
  10621. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10622. std::chrono::steady_clock::now() - start_time_)
  10623. .count();
  10624. }
  10625. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10626. read_timeout_sec_ = sec;
  10627. read_timeout_usec_ = usec;
  10628. }
  10629. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10630. tls::session_t session,
  10631. time_t read_timeout_sec,
  10632. time_t read_timeout_usec,
  10633. time_t write_timeout_sec,
  10634. time_t write_timeout_usec)
  10635. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10636. read_timeout_usec_(read_timeout_usec),
  10637. write_timeout_sec_(write_timeout_sec),
  10638. write_timeout_usec_(write_timeout_usec),
  10639. start_time_(std::chrono::steady_clock::now()) {
  10640. // The receive and send paths run on different threads, so each TLS call is
  10641. // driven in non-blocking mode and readiness is awaited with select()
  10642. // outside the session lock. Set the socket non-blocking once here; it is
  10643. // never flipped back, so no thread races on the flag.
  10644. detail::set_nonblocking(sock_, true);
  10645. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10646. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10647. #endif
  10648. }
  10649. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10650. inline bool WebSocketSSLStream::is_readable() const {
  10651. std::lock_guard<std::mutex> guard(session_mutex_);
  10652. return tls::pending(session_) > 0;
  10653. }
  10654. inline bool WebSocketSSLStream::wait_readable() const {
  10655. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10656. }
  10657. inline bool WebSocketSSLStream::wait_writable() const {
  10658. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10659. // that probe toggles the socket's blocking flag, which would race with the
  10660. // concurrent reader on a permanently non-blocking socket.
  10661. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10662. }
  10663. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10664. tls::TlsError err;
  10665. auto n = 1000;
  10666. while (--n >= 0) {
  10667. {
  10668. std::lock_guard<std::mutex> guard(session_mutex_);
  10669. auto ret = tls::read(session_, ptr, size, err);
  10670. if (ret > 0) { return ret; }
  10671. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10672. error_ = Error::ConnectionClosed;
  10673. return ret;
  10674. }
  10675. }
  10676. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10677. // direction: the send path shares this session, so output it left pending
  10678. // has to be flushed before more input can be decrypted. Anything else is
  10679. // a hard error.
  10680. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10681. #ifdef _WIN32
  10682. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10683. needs_readable =
  10684. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10685. WSAGetLastError() == WSAETIMEDOUT);
  10686. #endif
  10687. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10688. error_ = Error::Read;
  10689. return -1;
  10690. }
  10691. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10692. error_ = Error::Timeout;
  10693. return -1;
  10694. }
  10695. }
  10696. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10697. // to tell a timeout from a close would otherwise see whatever the previous
  10698. // failure left behind (error_ is never cleared on success).
  10699. error_ = Error::Read;
  10700. return -1;
  10701. }
  10702. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10703. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10704. tls::TlsError err;
  10705. auto n = 1000;
  10706. while (--n >= 0) {
  10707. {
  10708. std::lock_guard<std::mutex> guard(session_mutex_);
  10709. auto ret = tls::write(session_, ptr, handle_size, err);
  10710. if (ret >= 0) { return ret; }
  10711. }
  10712. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10713. // or a post-handshake message must be consumed before the record goes
  10714. // out. Anything else is a hard error.
  10715. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10716. #ifdef _WIN32
  10717. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10718. needs_writable =
  10719. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10720. WSAGetLastError() == WSAETIMEDOUT);
  10721. #endif
  10722. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10723. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10724. }
  10725. return -1;
  10726. }
  10727. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10728. int &port) const {
  10729. detail::get_remote_ip_and_port(sock_, ip, port);
  10730. }
  10731. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10732. int &port) const {
  10733. detail::get_local_ip_and_port(sock_, ip, port);
  10734. }
  10735. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10736. inline time_t WebSocketSSLStream::duration() const {
  10737. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10738. std::chrono::steady_clock::now() - start_time_)
  10739. .count();
  10740. }
  10741. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10742. read_timeout_sec_ = sec;
  10743. read_timeout_usec_ = usec;
  10744. }
  10745. } // namespace detail
  10746. #endif // CPPHTTPLIB_SSL_ENABLED
  10747. /*
  10748. * Group 4: Server implementation
  10749. */
  10750. // HTTP server implementation
  10751. inline Server::Server()
  10752. : new_task_queue([] {
  10753. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10754. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10755. }) {
  10756. #ifndef _WIN32
  10757. signal(SIGPIPE, SIG_IGN);
  10758. #endif
  10759. }
  10760. inline Server::~Server() = default;
  10761. inline std::unique_ptr<detail::MatcherBase>
  10762. Server::make_matcher(const std::string &pattern) {
  10763. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10764. // a path params pattern
  10765. if (pattern.find("/:") != std::string::npos) {
  10766. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10767. }
  10768. // A pattern with no regex metacharacter only has to be compared literally,
  10769. // which is what PathParamsMatcher already does when it captures no
  10770. // parameter, so std::regex is only worth building for the patterns that
  10771. // actually need it
  10772. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10773. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10774. }
  10775. return detail::make_unique<detail::RegexMatcher>(pattern);
  10776. }
  10777. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10778. return add_handler(get_handlers_, pattern, std::move(handler));
  10779. }
  10780. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10781. return add_handler(post_handlers_, pattern, std::move(handler));
  10782. }
  10783. inline Server &Server::Post(const std::string &pattern,
  10784. HandlerWithContentReader handler) {
  10785. return add_handler(post_handlers_for_content_reader_, pattern,
  10786. std::move(handler));
  10787. }
  10788. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10789. return add_handler(put_handlers_, pattern, std::move(handler));
  10790. }
  10791. inline Server &Server::Put(const std::string &pattern,
  10792. HandlerWithContentReader handler) {
  10793. return add_handler(put_handlers_for_content_reader_, pattern,
  10794. std::move(handler));
  10795. }
  10796. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10797. return add_handler(patch_handlers_, pattern, std::move(handler));
  10798. }
  10799. inline Server &Server::Patch(const std::string &pattern,
  10800. HandlerWithContentReader handler) {
  10801. return add_handler(patch_handlers_for_content_reader_, pattern,
  10802. std::move(handler));
  10803. }
  10804. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10805. return add_handler(delete_handlers_, pattern, std::move(handler));
  10806. }
  10807. inline Server &Server::Delete(const std::string &pattern,
  10808. HandlerWithContentReader handler) {
  10809. return add_handler(delete_handlers_for_content_reader_, pattern,
  10810. std::move(handler));
  10811. }
  10812. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10813. return add_handler(options_handlers_, pattern, std::move(handler));
  10814. }
  10815. inline const std::set<std::string> &Server::builtin_methods() {
  10816. thread_local const std::set<std::string> methods{
  10817. "GET", "HEAD", "POST", "PUT", "DELETE",
  10818. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10819. return methods;
  10820. }
  10821. inline Server::CustomHandlerEntry *
  10822. Server::custom_entry_for_registration(const std::string &method) {
  10823. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10824. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10825. // routing() before the custom tables are consulted, so a route registered
  10826. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10827. // there and would be reachable, but they carry protocol-level meaning
  10828. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10829. // library does not route.
  10830. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10831. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10832. has_invalid_registration_ = true;
  10833. return nullptr;
  10834. }
  10835. return &custom_handlers_[method];
  10836. }
  10837. inline Server &Server::CustomRoute(const std::string &method,
  10838. const std::string &pattern,
  10839. Handler handler) {
  10840. auto *entry = custom_entry_for_registration(method);
  10841. if (!entry) { return *this; }
  10842. return add_handler(entry->handlers, pattern, std::move(handler));
  10843. }
  10844. inline Server &Server::CustomRoute(const std::string &method,
  10845. const std::string &pattern,
  10846. HandlerWithContentReader handler) {
  10847. auto *entry = custom_entry_for_registration(method);
  10848. if (!entry) { return *this; }
  10849. return add_handler(entry->handlers_for_content_reader, pattern,
  10850. std::move(handler));
  10851. }
  10852. inline const Server::CustomHandlerEntry *
  10853. Server::find_custom_entry(const std::string &method) const {
  10854. // find() alone would be correct here. The empty() check is what keeps the
  10855. // per-request cost off servers that never call CustomRoute(), which is the
  10856. // overwhelmingly common case; keep it rather than walking into the tree.
  10857. if (custom_handlers_.empty()) { return nullptr; }
  10858. auto it = custom_handlers_.find(method);
  10859. return it == custom_handlers_.end() ? nullptr : &it->second;
  10860. }
  10861. inline Server &Server::WebSocket(const std::string &pattern,
  10862. WebSocketHandler handler) {
  10863. websocket_handlers_.push_back(
  10864. {make_matcher(pattern), std::move(handler), nullptr});
  10865. return *this;
  10866. }
  10867. inline Server &Server::WebSocket(const std::string &pattern,
  10868. WebSocketHandler handler,
  10869. SubProtocolSelector sub_protocol_selector) {
  10870. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10871. std::move(sub_protocol_selector)});
  10872. return *this;
  10873. }
  10874. inline bool Server::set_base_dir(const std::string &dir,
  10875. const std::string &mount_point) {
  10876. return set_mount_point(mount_point, dir);
  10877. }
  10878. inline bool Server::set_mount_point(const std::string &mount_point,
  10879. const std::string &dir, Headers headers) {
  10880. detail::FileStat stat(dir);
  10881. if (stat.is_dir()) {
  10882. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10883. if (!mnt.empty() && mnt[0] == '/') {
  10884. std::string resolved_base;
  10885. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10886. #if defined(_WIN32)
  10887. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10888. resolved_base += '\\';
  10889. }
  10890. #else
  10891. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10892. #endif
  10893. }
  10894. base_dirs_.push_back(
  10895. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10896. return true;
  10897. }
  10898. }
  10899. return false;
  10900. }
  10901. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10902. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10903. if (it->mount_point == mount_point) {
  10904. base_dirs_.erase(it);
  10905. return true;
  10906. }
  10907. }
  10908. return false;
  10909. }
  10910. inline Server &
  10911. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10912. const std::string &mime) {
  10913. file_extension_and_mimetype_map_[ext] = mime;
  10914. return *this;
  10915. }
  10916. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  10917. default_file_mimetype_ = mime;
  10918. return *this;
  10919. }
  10920. inline Server &Server::set_file_request_handler(Handler handler) {
  10921. file_request_handler_ = std::move(handler);
  10922. return *this;
  10923. }
  10924. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  10925. std::true_type) {
  10926. error_handler_ = std::move(handler);
  10927. return *this;
  10928. }
  10929. inline Server &Server::set_error_handler_core(Handler handler,
  10930. std::false_type) {
  10931. error_handler_ = [handler](const Request &req, Response &res) {
  10932. handler(req, res);
  10933. return HandlerResponse::Handled;
  10934. };
  10935. return *this;
  10936. }
  10937. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  10938. exception_handler_ = std::move(handler);
  10939. return *this;
  10940. }
  10941. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  10942. pre_routing_handler_ = std::move(handler);
  10943. return *this;
  10944. }
  10945. inline Server &Server::set_post_routing_handler(Handler handler) {
  10946. post_routing_handler_ = std::move(handler);
  10947. return *this;
  10948. }
  10949. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  10950. pre_request_handler_ = std::move(handler);
  10951. return *this;
  10952. }
  10953. inline Server &Server::set_logger(Logger logger) {
  10954. logger_ = std::move(logger);
  10955. return *this;
  10956. }
  10957. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  10958. error_logger_ = std::move(error_logger);
  10959. return *this;
  10960. }
  10961. inline Server &Server::set_pre_compression_logger(Logger logger) {
  10962. pre_compression_logger_ = std::move(logger);
  10963. return *this;
  10964. }
  10965. inline Server &
  10966. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  10967. expect_100_continue_handler_ = std::move(handler);
  10968. return *this;
  10969. }
  10970. inline Server &Server::set_start_handler(StartHandler handler) {
  10971. start_handler_ = std::move(handler);
  10972. return *this;
  10973. }
  10974. inline Server &Server::set_address_family(int family) {
  10975. address_family_ = family;
  10976. return *this;
  10977. }
  10978. inline Server &Server::set_tcp_nodelay(bool on) {
  10979. tcp_nodelay_ = on;
  10980. return *this;
  10981. }
  10982. inline Server &Server::set_ipv6_v6only(bool on) {
  10983. ipv6_v6only_ = on;
  10984. return *this;
  10985. }
  10986. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  10987. socket_options_ = std::move(socket_options);
  10988. return *this;
  10989. }
  10990. inline Server &Server::set_default_headers(Headers headers) {
  10991. default_headers_ = std::move(headers);
  10992. return *this;
  10993. }
  10994. inline Server &Server::set_header_writer(
  10995. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  10996. header_writer_ = writer;
  10997. return *this;
  10998. }
  10999. inline Server &
  11000. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11001. trusted_proxies_ = proxies;
  11002. return *this;
  11003. }
  11004. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11005. keep_alive_max_count_ = count;
  11006. return *this;
  11007. }
  11008. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11009. keep_alive_timeout_sec_ = sec;
  11010. return *this;
  11011. }
  11012. template <class Rep, class Period>
  11013. inline Server &Server::set_keep_alive_timeout(
  11014. const std::chrono::duration<Rep, Period> &duration) {
  11015. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11016. set_keep_alive_timeout(sec);
  11017. });
  11018. return *this;
  11019. }
  11020. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11021. read_timeout_sec_ = sec;
  11022. read_timeout_usec_ = usec;
  11023. return *this;
  11024. }
  11025. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11026. write_timeout_sec_ = sec;
  11027. write_timeout_usec_ = usec;
  11028. return *this;
  11029. }
  11030. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11031. idle_interval_sec_ = sec;
  11032. idle_interval_usec_ = usec;
  11033. return *this;
  11034. }
  11035. inline Server &Server::set_payload_max_length(size_t length) {
  11036. payload_max_length_ = length;
  11037. return *this;
  11038. }
  11039. inline Server &Server::set_static_file_compression(bool on) {
  11040. static_file_compression_ = on;
  11041. return *this;
  11042. }
  11043. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11044. static_file_compression_min_length_ = length;
  11045. return *this;
  11046. }
  11047. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11048. static_file_compression_max_length_ = length;
  11049. return *this;
  11050. }
  11051. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11052. websocket_max_missed_pongs_ = count;
  11053. return *this;
  11054. }
  11055. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11056. websocket_ping_interval_sec_ = sec;
  11057. return *this;
  11058. }
  11059. template <class Rep, class Period>
  11060. inline Server &Server::set_websocket_ping_interval(
  11061. const std::chrono::duration<Rep, Period> &duration) {
  11062. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11063. set_websocket_ping_interval(sec);
  11064. });
  11065. return *this;
  11066. }
  11067. inline bool Server::bind_to_port(const std::string &host, int port,
  11068. int socket_flags) {
  11069. auto ret = bind_internal(host, port, socket_flags);
  11070. if (ret == -1) { is_decommissioned = true; }
  11071. return ret >= 0;
  11072. }
  11073. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11074. auto ret = bind_internal(host, 0, socket_flags);
  11075. if (ret == -1) { is_decommissioned = true; }
  11076. return ret;
  11077. }
  11078. inline bool Server::listen_after_bind() { return listen_internal(); }
  11079. inline bool Server::listen(const std::string &host, int port,
  11080. int socket_flags) {
  11081. return bind_to_port(host, port, socket_flags) && listen_internal();
  11082. }
  11083. inline bool Server::is_running() const { return is_running_; }
  11084. inline void Server::wait_until_ready() const {
  11085. while (!is_running_ && !is_decommissioned) {
  11086. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11087. }
  11088. }
  11089. inline void Server::stop() noexcept {
  11090. // Release the listening socket whether or not the accept loop is running:
  11091. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11092. // exchange is what makes this safe to call concurrently with the accept loop.
  11093. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11094. if (sock != INVALID_SOCKET) {
  11095. detail::shutdown_socket(sock);
  11096. detail::close_socket(sock);
  11097. }
  11098. is_decommissioned = false;
  11099. }
  11100. inline void Server::decommission() { is_decommissioned = true; }
  11101. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11102. auto len = strlen(s);
  11103. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11104. len -= 2;
  11105. {
  11106. size_t count = 0;
  11107. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11108. switch (count) {
  11109. case 0: req.method = std::string(b, e); break;
  11110. case 1: req.target = std::string(b, e); break;
  11111. case 2: req.version = std::string(b, e); break;
  11112. default: break;
  11113. }
  11114. count++;
  11115. });
  11116. if (count != 3) { return false; }
  11117. }
  11118. // A method outside the built-in set is accepted only when a handler has been
  11119. // registered for it with CustomRoute().
  11120. const auto &methods = builtin_methods();
  11121. if (methods.find(req.method) == methods.end() &&
  11122. !find_custom_entry(req.method)) {
  11123. output_error_log(Error::InvalidHTTPMethod, &req);
  11124. return false;
  11125. }
  11126. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11127. output_error_log(Error::InvalidHTTPVersion, &req);
  11128. return false;
  11129. }
  11130. {
  11131. // Skip URL fragment
  11132. for (size_t i = 0; i < req.target.size(); i++) {
  11133. if (req.target[i] == '#') {
  11134. req.target.erase(i);
  11135. break;
  11136. }
  11137. }
  11138. detail::divide(req.target, '?',
  11139. [&](const char *lhs_data, std::size_t lhs_size,
  11140. const char *rhs_data, std::size_t rhs_size) {
  11141. req.path =
  11142. decode_path_component(std::string(lhs_data, lhs_size));
  11143. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11144. });
  11145. }
  11146. return true;
  11147. }
  11148. inline bool Server::write_response(Stream &strm, bool close_connection,
  11149. Request &req, Response &res) {
  11150. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11151. // incorrectly to the error content.
  11152. req.ranges.clear();
  11153. return write_response_core(strm, close_connection, req, res, false);
  11154. }
  11155. inline bool Server::write_response_with_content(Stream &strm,
  11156. bool close_connection,
  11157. const Request &req,
  11158. Response &res) {
  11159. return write_response_core(strm, close_connection, req, res, true);
  11160. }
  11161. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11162. const Request &req, Response &res,
  11163. bool need_apply_ranges) {
  11164. assert(res.status != -1);
  11165. if (400 <= res.status && error_handler_ &&
  11166. error_handler_(req, res) == HandlerResponse::Handled) {
  11167. need_apply_ranges = true;
  11168. }
  11169. std::string content_type;
  11170. std::string boundary;
  11171. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11172. // Prepare additional headers
  11173. if (close_connection ||
  11174. detail::has_header_token(req.headers, "Connection", "close") ||
  11175. 400 <= res.status) { // Don't leave connections open after errors
  11176. res.set_header("Connection", "close");
  11177. } else {
  11178. std::string s = "timeout=";
  11179. s += std::to_string(keep_alive_timeout_sec_);
  11180. s += ", max=";
  11181. s += std::to_string(keep_alive_max_count_);
  11182. res.set_header("Keep-Alive", s);
  11183. }
  11184. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11185. !res.has_header("Content-Type")) {
  11186. res.set_header("Content-Type", "text/plain");
  11187. }
  11188. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11189. !res.has_header("Content-Length")) {
  11190. res.set_header("Content-Length", "0");
  11191. }
  11192. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11193. res.set_header("Accept-Ranges", "bytes");
  11194. }
  11195. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11196. // Response line and headers
  11197. detail::BufferStream bstrm;
  11198. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11199. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11200. // Combine small body with headers to reduce write syscalls
  11201. if (req.method != "HEAD" && !res.body.empty() && !res.content_provider_) {
  11202. bstrm.write(res.body.data(), res.body.size());
  11203. }
  11204. // Log before writing to avoid race condition with client-side code that
  11205. // accesses logger-captured data immediately after receiving the response.
  11206. output_log(req, res);
  11207. // Flush buffer
  11208. auto &data = bstrm.get_buffer();
  11209. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11210. // Streaming body
  11211. auto ret = true;
  11212. if (req.method != "HEAD" && res.content_provider_) {
  11213. if (write_content_with_provider(strm, req, res, boundary, content_type)) {
  11214. res.content_provider_success_ = true;
  11215. } else {
  11216. ret = false;
  11217. }
  11218. }
  11219. return ret;
  11220. }
  11221. inline bool
  11222. Server::write_content_with_provider(Stream &strm, const Request &req,
  11223. Response &res, const std::string &boundary,
  11224. const std::string &content_type) {
  11225. auto is_shutting_down = [this]() {
  11226. return this->svr_sock_ == INVALID_SOCKET;
  11227. };
  11228. if (res.content_length_ > 0) {
  11229. // Only a 206 response is served as a partial representation, matching the
  11230. // condition `apply_ranges()` used to decide the Content-Length and the
  11231. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11232. // only for a 2xx status, slicing under any other status would write a body
  11233. // that disagrees with the header already sent, from an unchecked offset.
  11234. auto is_partial =
  11235. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11236. if (!is_partial) {
  11237. return detail::write_content(strm, res.content_provider_, 0,
  11238. res.content_length_, is_shutting_down);
  11239. } else if (req.ranges.size() == 1) {
  11240. auto offset_and_length = detail::get_range_offset_and_length(
  11241. req.ranges[0], res.content_length_);
  11242. return detail::write_content(strm, res.content_provider_,
  11243. offset_and_length.first,
  11244. offset_and_length.second, is_shutting_down);
  11245. } else {
  11246. return detail::write_multipart_ranges_data(
  11247. strm, req, res, boundary, content_type, res.content_length_,
  11248. is_shutting_down);
  11249. }
  11250. } else {
  11251. if (res.is_chunked_content_provider_) {
  11252. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11253. // re-negotiating here would disagree with them, e.g. once a handler's
  11254. // own Content-Encoding header suppresses the negotiation.
  11255. auto compressor = detail::make_compressor(res.content_coding_);
  11256. if (!compressor) {
  11257. compressor = detail::make_unique<detail::nocompressor>();
  11258. }
  11259. return detail::write_content_chunked(strm, res.content_provider_,
  11260. is_shutting_down, *compressor);
  11261. } else {
  11262. return detail::write_content_without_length(strm, res.content_provider_,
  11263. is_shutting_down);
  11264. }
  11265. }
  11266. }
  11267. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11268. FormFields::iterator cur_field;
  11269. FormFiles::iterator cur_file;
  11270. auto is_text_field = false;
  11271. size_t count = 0;
  11272. if (read_content_core(
  11273. strm, req, res,
  11274. // Regular
  11275. [&](const char *buf, size_t n) {
  11276. // Prevent arithmetic overflow when checking sizes.
  11277. // Avoid computing (req.body.size() + n) directly because
  11278. // adding two unsigned `size_t` values can wrap around and
  11279. // produce a small result instead of indicating overflow.
  11280. // Instead, check using subtraction: ensure `n` does not
  11281. // exceed the remaining capacity `max_size() - size()`.
  11282. if (req.body.size() >= req.body.max_size() ||
  11283. n > req.body.max_size() - req.body.size()) {
  11284. return false;
  11285. }
  11286. // Limit decompressed body size to payload_max_length_ to protect
  11287. // against "zip bomb" attacks where a small compressed payload
  11288. // decompresses to a massive size.
  11289. if (payload_max_length_ > 0 &&
  11290. (req.body.size() >= payload_max_length_ ||
  11291. n > payload_max_length_ - req.body.size())) {
  11292. return false;
  11293. }
  11294. req.body.append(buf, n);
  11295. return true;
  11296. },
  11297. // Multipart FormData
  11298. [&](const FormData &file) {
  11299. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11300. output_error_log(Error::TooManyFormDataFiles, &req);
  11301. return false;
  11302. }
  11303. if (file.filename.empty()) {
  11304. cur_field = req.form.fields.emplace(
  11305. file.name, FormField{file.name, file.content, file.headers});
  11306. is_text_field = true;
  11307. } else {
  11308. cur_file = req.form.files.emplace(file.name, file);
  11309. is_text_field = false;
  11310. }
  11311. return true;
  11312. },
  11313. [&](const char *buf, size_t n) {
  11314. if (is_text_field) {
  11315. auto &content = cur_field->second.content;
  11316. if (content.size() + n > content.max_size()) { return false; }
  11317. content.append(buf, n);
  11318. } else {
  11319. auto &content = cur_file->second.content;
  11320. if (content.size() + n > content.max_size()) { return false; }
  11321. content.append(buf, n);
  11322. }
  11323. return true;
  11324. })) {
  11325. const auto &content_type = req.get_header_value("Content-Type");
  11326. if (detail::extract_media_type(content_type) ==
  11327. "application/x-www-form-urlencoded") {
  11328. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11329. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11330. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11331. return false;
  11332. }
  11333. detail::parse_query_text(req.body, req.params);
  11334. }
  11335. return true;
  11336. }
  11337. return false;
  11338. }
  11339. inline bool Server::read_content_with_content_receiver(
  11340. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11341. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11342. return read_content_core(strm, req, res, std::move(receiver),
  11343. std::move(multipart_header),
  11344. std::move(multipart_receiver));
  11345. }
  11346. inline bool Server::read_content_core(
  11347. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11348. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11349. detail::FormDataParser multipart_form_data_parser;
  11350. ContentReceiverWithProgress out;
  11351. if (req.is_multipart_form_data()) {
  11352. const auto &content_type = req.get_header_value("Content-Type");
  11353. std::string boundary;
  11354. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11355. res.status = StatusCode::BadRequest_400;
  11356. output_error_log(Error::MultipartParsing, &req);
  11357. return false;
  11358. }
  11359. multipart_form_data_parser.set_boundary(std::move(boundary));
  11360. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11361. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11362. multipart_receiver);
  11363. };
  11364. } else {
  11365. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11366. size_t /*len*/) { return receiver(buf, n); };
  11367. }
  11368. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11369. // For non-SSL builds we still scan non-persistent connections for stray
  11370. // body bytes so the payload limit is enforced (413). On keep-alive,
  11371. // pending bytes may be the next request (issue #2450), so skip.
  11372. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11373. if (!req.has_header("Content-Length") &&
  11374. !detail::is_chunked_transfer_encoding(req.headers)) {
  11375. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11376. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11377. auto has_data = strm.is_readable();
  11378. if (!has_data) {
  11379. auto s = strm.socket();
  11380. if (s != INVALID_SOCKET) {
  11381. has_data = detail::select_read(s, 0, 0) > 0;
  11382. }
  11383. }
  11384. if (has_data) {
  11385. // Route through the same decompressing reader used by the
  11386. // length-framed and chunked paths below, so payload_max_length_ is
  11387. // enforced on the decompressed size here too instead of only on the
  11388. // compressed wire bytes.
  11389. return detail::read_content(strm, req, payload_max_length_, res.status,
  11390. nullptr, out, true);
  11391. }
  11392. }
  11393. return true;
  11394. }
  11395. #else
  11396. if (!req.has_header("Content-Length") &&
  11397. !detail::is_chunked_transfer_encoding(req.headers)) {
  11398. return true;
  11399. }
  11400. #endif
  11401. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11402. out, true)) {
  11403. return false;
  11404. }
  11405. req.body_consumed_ = true;
  11406. if (req.is_multipart_form_data()) {
  11407. if (!multipart_form_data_parser.is_valid()) {
  11408. res.status = StatusCode::BadRequest_400;
  11409. output_error_log(Error::MultipartParsing, &req);
  11410. return false;
  11411. }
  11412. }
  11413. return true;
  11414. }
  11415. inline bool Server::handle_file_request(Request &req, Response &res) {
  11416. for (const auto &entry : base_dirs_) {
  11417. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11418. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11419. // One that already ends in '/' (the root mount among them) carries its own
  11420. // boundary; set_mount_point() guarantees the mount point is not empty.
  11421. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11422. (entry.mount_point.back() == '/' ||
  11423. req.path.size() == entry.mount_point.size() ||
  11424. req.path[entry.mount_point.size()] == '/')) {
  11425. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11426. if (detail::is_valid_path(sub_path)) {
  11427. auto path = entry.base_dir + sub_path;
  11428. if (path.back() == '/') { path += "index.html"; }
  11429. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11430. // but symlinks/junctions can still escape the base directory.
  11431. if (!entry.resolved_base_dir.empty()) {
  11432. std::string resolved_path;
  11433. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11434. !detail::is_path_within_base(resolved_path,
  11435. entry.resolved_base_dir)) {
  11436. res.status = StatusCode::Forbidden_403;
  11437. return true;
  11438. }
  11439. }
  11440. detail::FileStat stat(path);
  11441. if (stat.is_dir()) {
  11442. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11443. return true;
  11444. }
  11445. if (stat.is_file()) {
  11446. for (const auto &kv : entry.headers) {
  11447. res.set_header(kv.first, kv.second);
  11448. }
  11449. auto content_type_of = [&]() {
  11450. return detail::find_content_type(
  11451. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11452. };
  11453. // Only the ETag needs the content type this early, and only to name
  11454. // the coding. Deciding it here would otherwise put a regex in front
  11455. // of the 304 below, which serving a file never used to pay for.
  11456. std::string content_type;
  11457. auto encoding = detail::EncodingType::None;
  11458. if (static_file_compression_) {
  11459. content_type = content_type_of();
  11460. encoding =
  11461. static_file_encoding(req, res, content_type, stat.size());
  11462. }
  11463. // The ETag names the representation actually sent, so a client that
  11464. // cached the compressed form revalidates against the compressed ETag
  11465. // and still gets a 304, while one that took identity keeps the plain
  11466. // ETag.
  11467. auto etag = detail::compute_etag(
  11468. stat, encoding == detail::EncodingType::None
  11469. ? std::string()
  11470. : std::string("-") + detail::encoding_name(encoding));
  11471. if (!etag.empty()) { res.set_header("ETag", etag); }
  11472. auto mtime = stat.mtime();
  11473. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11474. if (!last_modified.empty()) {
  11475. res.set_header("Last-Modified", last_modified);
  11476. }
  11477. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11478. check_if_range(req, etag, mtime);
  11479. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11480. if (!mm->is_open()) {
  11481. output_error_log(Error::OpenFile, &req);
  11482. return false;
  11483. }
  11484. if (!static_file_compression_) { content_type = content_type_of(); }
  11485. detail::set_file_content_provider(res, mm, content_type, encoding);
  11486. if (req.method != "HEAD" && file_request_handler_) {
  11487. file_request_handler_(req, res);
  11488. }
  11489. return true;
  11490. } else {
  11491. output_error_log(Error::OpenFile, &req);
  11492. }
  11493. }
  11494. }
  11495. }
  11496. return false;
  11497. }
  11498. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11499. const std::string &etag,
  11500. time_t mtime) const {
  11501. // Handle conditional GET:
  11502. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11503. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11504. if (req.has_header("If-None-Match")) {
  11505. if (!etag.empty()) {
  11506. auto val =
  11507. detail::get_combined_header_value(req.headers, "If-None-Match");
  11508. // NOTE: We use exact string matching here. This works correctly
  11509. // because our server always generates weak ETags (W/"..."), and
  11510. // clients typically send back the same ETag they received.
  11511. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11512. // If-None-Match, where W/"x" and "x" would match, but this
  11513. // simplified implementation requires exact matches.
  11514. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11515. [&](const char *b, const char *e) {
  11516. auto seg_len = static_cast<size_t>(e - b);
  11517. return (seg_len == 1 && *b == '*') ||
  11518. (seg_len == etag.size() &&
  11519. std::equal(b, e, etag.begin()));
  11520. });
  11521. if (ret) {
  11522. res.status = StatusCode::NotModified_304;
  11523. return true;
  11524. }
  11525. }
  11526. } else if (req.has_header("If-Modified-Since")) {
  11527. auto val = req.get_header_value("If-Modified-Since");
  11528. auto t = detail::parse_http_date(val);
  11529. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11530. res.status = StatusCode::NotModified_304;
  11531. return true;
  11532. }
  11533. }
  11534. return false;
  11535. }
  11536. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11537. time_t mtime) const {
  11538. // Handle If-Range for partial content requests (RFC 9110
  11539. // Section 13.1.5). If-Range is only evaluated when Range header is
  11540. // present. If the validator matches, serve partial content; otherwise
  11541. // serve full content.
  11542. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11543. auto val = req.get_header_value("If-Range");
  11544. auto is_valid_range = [&]() {
  11545. if (detail::is_strong_etag(val)) {
  11546. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11547. // comparison.
  11548. return (!etag.empty() && val == etag);
  11549. } else if (detail::is_weak_etag(val)) {
  11550. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11551. return false;
  11552. } else {
  11553. // HTTP-date comparison
  11554. auto t = detail::parse_http_date(val);
  11555. return (t != static_cast<time_t>(-1) && mtime <= t);
  11556. }
  11557. };
  11558. if (!is_valid_range()) {
  11559. // Validator doesn't match: ignore Range and serve full content
  11560. req.ranges.clear();
  11561. return false;
  11562. }
  11563. }
  11564. return true;
  11565. }
  11566. inline socket_t
  11567. Server::create_server_socket(const std::string &host, int port,
  11568. int socket_flags,
  11569. SocketOptions socket_options) const {
  11570. return detail::create_socket(
  11571. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11572. ipv6_v6only_, std::move(socket_options),
  11573. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11574. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11575. output_error_log(Error::BindIPAddress, nullptr);
  11576. return false;
  11577. }
  11578. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11579. output_error_log(Error::Listen, nullptr);
  11580. return false;
  11581. }
  11582. return true;
  11583. });
  11584. }
  11585. inline int Server::bind_internal(const std::string &host, int port,
  11586. int socket_flags) {
  11587. if (is_decommissioned) { return -1; }
  11588. if (!is_valid()) { return -1; }
  11589. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11590. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11591. if (port == 0) {
  11592. struct sockaddr_storage addr;
  11593. socklen_t addr_len = sizeof(addr);
  11594. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11595. &addr_len) == -1) {
  11596. output_error_log(Error::GetSockName, nullptr);
  11597. return -1;
  11598. }
  11599. if (addr.ss_family == AF_INET) {
  11600. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11601. } else if (addr.ss_family == AF_INET6) {
  11602. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11603. } else {
  11604. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11605. return -1;
  11606. }
  11607. } else {
  11608. return port;
  11609. }
  11610. }
  11611. inline bool Server::listen_internal() {
  11612. // A stop() between bind and listen leaves nothing to accept on. Report
  11613. // failure instead of returning success without ever serving, and mark the
  11614. // server decommissioned the way any failed listen does so that a concurrent
  11615. // wait_until_ready() wakes up instead of spinning forever.
  11616. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11617. is_decommissioned = true;
  11618. return false;
  11619. }
  11620. auto ret = true;
  11621. is_running_ = true;
  11622. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11623. if (start_handler_) { start_handler_(); }
  11624. {
  11625. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11626. while (svr_sock_ != INVALID_SOCKET) {
  11627. #ifndef _WIN32
  11628. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11629. #endif
  11630. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11631. idle_interval_usec_);
  11632. if (val == 0) { // Timeout
  11633. task_queue->on_idle();
  11634. continue;
  11635. }
  11636. #ifndef _WIN32
  11637. }
  11638. #endif
  11639. #if defined _WIN32
  11640. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11641. // OVERLAPPED
  11642. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11643. #elif defined SOCK_CLOEXEC
  11644. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11645. #else
  11646. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11647. #endif
  11648. if (sock == INVALID_SOCKET) {
  11649. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11650. // touches the CRT errno, so the two have to be asked platform by
  11651. // platform rather than by testing errno here.
  11652. if (detail::is_accept_resource_error()) {
  11653. // The per-process descriptor limit or the network stack's buffer
  11654. // space has been reached. Try to accept new connections after a
  11655. // short sleep.
  11656. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11657. continue;
  11658. } else if (detail::is_accept_transient_error()) {
  11659. continue;
  11660. }
  11661. // Take the descriptor out of svr_sock_ before closing it: a later
  11662. // stop() would otherwise shutdown()/close() a value the OS may have
  11663. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11664. // gone. The exchange also settles the race with a concurrent stop(),
  11665. // since whichever side takes the descriptor closes it exactly once.
  11666. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11667. if (listen_sock != INVALID_SOCKET) {
  11668. detail::close_socket(listen_sock);
  11669. ret = false;
  11670. output_error_log(Error::Connection, nullptr);
  11671. } else {
  11672. ; // The server socket was closed by user.
  11673. }
  11674. break;
  11675. }
  11676. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11677. read_timeout_sec_, read_timeout_usec_);
  11678. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11679. write_timeout_sec_, write_timeout_usec_);
  11680. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11681. if (!task_queue->enqueue(
  11682. [this, sock]() { process_and_close_socket(sock); })) {
  11683. output_error_log(Error::ResourceExhaustion, nullptr);
  11684. detail::shutdown_socket(sock);
  11685. detail::close_socket(sock);
  11686. }
  11687. }
  11688. task_queue->shutdown();
  11689. }
  11690. is_decommissioned = !ret;
  11691. return ret;
  11692. }
  11693. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11694. if (pre_routing_handler_ &&
  11695. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11696. return true;
  11697. }
  11698. // File handler
  11699. if ((req.method == "GET" || req.method == "HEAD") &&
  11700. handle_file_request(req, res)) {
  11701. return true;
  11702. }
  11703. const auto *custom = find_custom_entry(req.method);
  11704. // The second clause mirrors what expect_content() does unconditionally for
  11705. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11706. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11707. // `allprop`) would skip its handler and fall through to 404.
  11708. if (detail::expect_content(req) ||
  11709. (custom && !custom->handlers_for_content_reader.empty())) {
  11710. // Content reader handler
  11711. {
  11712. // Track whether the ContentReader was aborted due to the decompressed
  11713. // payload exceeding `payload_max_length_`.
  11714. // The user handler runs after the lambda returns, so we must restore the
  11715. // 413 status if the handler overwrites it.
  11716. bool content_reader_payload_too_large = false;
  11717. ContentReader reader(
  11718. [&](ContentReceiver receiver) {
  11719. auto result = read_content_with_content_receiver(
  11720. strm, req, res, std::move(receiver), nullptr, nullptr);
  11721. if (!result) {
  11722. output_error_log(Error::Read, &req);
  11723. if (res.status == StatusCode::PayloadTooLarge_413) {
  11724. content_reader_payload_too_large = true;
  11725. }
  11726. }
  11727. return result;
  11728. },
  11729. [&](FormDataHeader header, ContentReceiver receiver) {
  11730. auto result = read_content_with_content_receiver(
  11731. strm, req, res, nullptr, std::move(header),
  11732. std::move(receiver));
  11733. if (!result) {
  11734. output_error_log(Error::Read, &req);
  11735. if (res.status == StatusCode::PayloadTooLarge_413) {
  11736. content_reader_payload_too_large = true;
  11737. }
  11738. }
  11739. return result;
  11740. });
  11741. bool dispatched = false;
  11742. if (req.method == "POST") {
  11743. dispatched = dispatch_request_for_content_reader(
  11744. req, res, std::move(reader), post_handlers_for_content_reader_);
  11745. } else if (req.method == "PUT") {
  11746. dispatched = dispatch_request_for_content_reader(
  11747. req, res, std::move(reader), put_handlers_for_content_reader_);
  11748. } else if (req.method == "PATCH") {
  11749. dispatched = dispatch_request_for_content_reader(
  11750. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11751. } else if (req.method == "DELETE") {
  11752. dispatched = dispatch_request_for_content_reader(
  11753. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11754. } else if (custom) {
  11755. dispatched = dispatch_request_for_content_reader(
  11756. req, res, std::move(reader), custom->handlers_for_content_reader);
  11757. }
  11758. if (dispatched) {
  11759. if (content_reader_payload_too_large) {
  11760. // Enforce the limit: override any status the handler may have set
  11761. // and return false so the error path sends a plain 413 response.
  11762. res.status = StatusCode::PayloadTooLarge_413;
  11763. res.body.clear();
  11764. res.content_length_ = 0;
  11765. res.content_provider_ = nullptr;
  11766. return false;
  11767. }
  11768. return true;
  11769. }
  11770. }
  11771. // NOTE: `req.body` is not read here. For a regular handler the body is
  11772. // read inside dispatch_request(), after the route has matched and the
  11773. // pre-request handler has approved the request, so that a rejected
  11774. // request (e.g. failed authentication) never forces us to buffer a
  11775. // potentially large body.
  11776. }
  11777. // Regular handler
  11778. if (req.method == "GET" || req.method == "HEAD") {
  11779. return dispatch_request(req, res, get_handlers_, strm);
  11780. } else if (req.method == "POST") {
  11781. return dispatch_request(req, res, post_handlers_, strm);
  11782. } else if (req.method == "PUT") {
  11783. return dispatch_request(req, res, put_handlers_, strm);
  11784. } else if (req.method == "DELETE") {
  11785. return dispatch_request(req, res, delete_handlers_, strm);
  11786. } else if (req.method == "OPTIONS") {
  11787. return dispatch_request(req, res, options_handlers_, strm);
  11788. } else if (req.method == "PATCH") {
  11789. return dispatch_request(req, res, patch_handlers_, strm);
  11790. } else if (custom) {
  11791. return dispatch_request(req, res, custom->handlers, strm);
  11792. }
  11793. res.status = StatusCode::BadRequest_400;
  11794. return false;
  11795. }
  11796. inline bool Server::dispatch_request(Request &req, Response &res,
  11797. const Handlers &handlers, Stream &strm) {
  11798. for (const auto &x : handlers) {
  11799. const auto &matcher = x.first;
  11800. const auto &handler = x.second;
  11801. if (matcher->match(req)) {
  11802. req.matched_route = matcher->pattern();
  11803. // Run the pre-request handler before reading the body so a rejected
  11804. // request (e.g. failed authentication) never forces us to buffer a
  11805. // potentially large body. `req.matched_route` is available here.
  11806. if (pre_request_handler_ &&
  11807. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11808. return true;
  11809. }
  11810. // The route matched and the request was approved; read the body now.
  11811. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11812. output_error_log(Error::Read, &req);
  11813. return false;
  11814. }
  11815. handler(req, res);
  11816. return true;
  11817. }
  11818. }
  11819. return false;
  11820. }
  11821. // Decides the content coding for a response served straight from a file. Both
  11822. // the ETag, which has to name the representation actually sent, and
  11823. // `apply_static_file_compression()` go through this, so the two cannot drift
  11824. // apart.
  11825. inline detail::EncodingType
  11826. Server::static_file_encoding(const Request &req, const Response &res,
  11827. const std::string &content_type,
  11828. size_t length) const {
  11829. if (!static_file_compression_) { return detail::EncodingType::None; }
  11830. // Nothing to compress, and an empty file already answers with
  11831. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11832. // turn an empty body into a 20-byte gzip stream.
  11833. if (length == 0) { return detail::EncodingType::None; }
  11834. // A file that already fits in a single packet gains nothing from being made
  11835. // smaller, since it still travels in that one segment, and a file of a few
  11836. // bytes comes out larger than it went in.
  11837. if (length < static_file_compression_min_length_) {
  11838. return detail::EncodingType::None;
  11839. }
  11840. // RFC 9110 applies Range to the representation after content coding, so a
  11841. // compressed 206 would mean compressing the whole file and then slicing it.
  11842. // Serve ranges from the identity representation instead.
  11843. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11844. if (static_file_compression_max_length_ > 0 &&
  11845. length > static_file_compression_max_length_) {
  11846. return detail::EncodingType::None;
  11847. }
  11848. return detail::encoding_type(req, res, content_type);
  11849. }
  11850. // Compresses a file-backed content provider into `res.body` and takes over the
  11851. // framing headers. Returns false when the response is left untouched.
  11852. inline bool Server::apply_static_file_compression(const Request &req,
  11853. Response &res) const {
  11854. auto type = res.content_coding_;
  11855. if (type == detail::EncodingType::None || !res.content_provider_) {
  11856. return false;
  11857. }
  11858. auto compressor = detail::make_compressor(type);
  11859. if (!compressor) { return false; }
  11860. output_pre_compression_log(req, res);
  11861. std::string compressed;
  11862. if (!detail::compress_content_provider(res.content_provider_,
  11863. res.content_length_, *compressor,
  11864. compressed)) {
  11865. return false;
  11866. }
  11867. res.body.swap(compressed);
  11868. // The provider was consumed in full, so a resource releaser registered with
  11869. // it should hear about a success when the response goes away.
  11870. res.content_provider_success_ = true;
  11871. res.content_provider_ = nullptr;
  11872. res.content_length_ = 0;
  11873. res.content_coding_ = detail::EncodingType::None;
  11874. res.set_header("Content-Encoding", detail::encoding_name(type));
  11875. res.set_header("Vary", "Accept-Encoding");
  11876. res.set_header("Content-Length", std::to_string(res.body.size()));
  11877. return true;
  11878. }
  11879. inline void Server::apply_ranges(const Request &req, Response &res,
  11880. std::string &content_type,
  11881. std::string &boundary) const {
  11882. // A known-length content provider leaves `res.body` empty, so the compressor
  11883. // at the end of this function never runs for one (issue #2545). A file-backed
  11884. // provider is fully readable right here, so compress it and answer with an
  11885. // ordinary body: `Content-Length` and HEAD keep working, and the response
  11886. // takes the same path as `set_content()` from here on. Range requests never
  11887. // get a content coding, so `Content-Range` still names identity bytes and
  11888. // none of the framing below applies.
  11889. if (apply_static_file_compression(req, res)) { return; }
  11890. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  11891. auto it = res.headers.find("Content-Type");
  11892. if (it != res.headers.end()) {
  11893. content_type = it->second;
  11894. res.headers.erase(it);
  11895. }
  11896. boundary = detail::make_multipart_data_boundary();
  11897. res.set_header("Content-Type",
  11898. "multipart/byteranges; boundary=" + boundary);
  11899. }
  11900. auto type = detail::encoding_type(req, res);
  11901. if (res.body.empty()) {
  11902. if (res.content_length_ > 0) {
  11903. size_t length = 0;
  11904. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11905. length = res.content_length_;
  11906. } else if (req.ranges.size() == 1) {
  11907. auto offset_and_length = detail::get_range_offset_and_length(
  11908. req.ranges[0], res.content_length_);
  11909. length = offset_and_length.second;
  11910. auto content_range = detail::make_content_range_header_field(
  11911. offset_and_length, res.content_length_);
  11912. res.set_header("Content-Range", content_range);
  11913. } else {
  11914. length = detail::get_multipart_ranges_data_length(
  11915. req, boundary, content_type, res.content_length_);
  11916. }
  11917. res.set_header("Content-Length", std::to_string(length));
  11918. } else {
  11919. if (res.content_provider_) {
  11920. if (res.is_chunked_content_provider_) {
  11921. res.set_header("Transfer-Encoding", "chunked");
  11922. res.content_coding_ = type;
  11923. if (type != detail::EncodingType::None) {
  11924. res.set_header("Content-Encoding", detail::encoding_name(type));
  11925. res.set_header("Vary", "Accept-Encoding");
  11926. }
  11927. }
  11928. }
  11929. }
  11930. } else {
  11931. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11932. ;
  11933. } else if (req.ranges.size() == 1) {
  11934. auto offset_and_length =
  11935. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  11936. auto offset = offset_and_length.first;
  11937. auto length = offset_and_length.second;
  11938. auto content_range = detail::make_content_range_header_field(
  11939. offset_and_length, res.body.size());
  11940. res.set_header("Content-Range", content_range);
  11941. assert(offset + length <= res.body.size());
  11942. res.body = res.body.substr(offset, length);
  11943. } else {
  11944. std::string data;
  11945. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  11946. res.body.size(), data);
  11947. res.body.swap(data);
  11948. }
  11949. if (type != detail::EncodingType::None) {
  11950. output_pre_compression_log(req, res);
  11951. if (auto compressor = detail::make_compressor(type)) {
  11952. std::string compressed;
  11953. if (compressor->compress(res.body.data(), res.body.size(), true,
  11954. [&](const char *data, size_t data_len) {
  11955. compressed.append(data, data_len);
  11956. return true;
  11957. })) {
  11958. res.body.swap(compressed);
  11959. res.set_header("Content-Encoding", detail::encoding_name(type));
  11960. res.set_header("Vary", "Accept-Encoding");
  11961. }
  11962. }
  11963. }
  11964. res.content_length_ = res.body.size();
  11965. res.set_header("Content-Length", std::to_string(res.content_length_));
  11966. }
  11967. }
  11968. inline bool Server::dispatch_request_for_content_reader(
  11969. Request &req, Response &res, ContentReader content_reader,
  11970. const HandlersForContentReader &handlers) const {
  11971. for (const auto &x : handlers) {
  11972. const auto &matcher = x.first;
  11973. const auto &handler = x.second;
  11974. if (matcher->match(req)) {
  11975. req.matched_route = matcher->pattern();
  11976. if (!pre_request_handler_ ||
  11977. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  11978. handler(req, res, content_reader);
  11979. }
  11980. return true;
  11981. }
  11982. }
  11983. return false;
  11984. }
  11985. inline std::string
  11986. get_client_ip(const std::string &x_forwarded_for,
  11987. const std::vector<std::string> &trusted_proxies) {
  11988. // X-Forwarded-For is a comma-separated list per RFC 7239
  11989. std::vector<std::string> ip_list;
  11990. detail::split(x_forwarded_for.data(),
  11991. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  11992. [&](const char *b, const char *e) {
  11993. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  11994. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  11995. });
  11996. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  11997. // no segments. Signal "no client IP derived" with an empty string so the
  11998. // caller can fall back to the connection-level remote address.
  11999. if (ip_list.empty()) { return std::string(); }
  12000. // Each hop appends the address it received the request from, so the rightmost
  12001. // entries are the ones written by our own infrastructure while the leftmost
  12002. // are whatever the original client chose to send. Walk from the right and
  12003. // skip trusted proxies; the first address that is not a trusted proxy is the
  12004. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12005. // from the left instead lets a client forge an arbitrary address by following
  12006. // it with a trusted proxy's address, which the left-to-right scan then
  12007. // returned as the client.
  12008. for (size_t i = ip_list.size(); i-- > 0;) {
  12009. const auto &ip = ip_list[i];
  12010. auto is_trusted_proxy =
  12011. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12012. [&](const std::string &proxy) { return ip == proxy; });
  12013. if (!is_trusted_proxy) { return ip; }
  12014. }
  12015. // Every hop was a trusted proxy; fall back to the first entry.
  12016. return ip_list.front();
  12017. }
  12018. inline bool
  12019. Server::process_request(Stream &strm, const std::string &remote_addr,
  12020. int remote_port, const std::string &local_addr,
  12021. int local_port, bool close_connection,
  12022. bool &connection_closed,
  12023. const std::function<void(Request &)> &setup_request,
  12024. bool *websocket_upgraded) {
  12025. std::array<char, 2048> buf{};
  12026. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12027. // Connection has been closed on client
  12028. if (!line_reader.getline()) { return false; }
  12029. Request req;
  12030. req.start_time_ = std::chrono::steady_clock::now();
  12031. req.remote_addr = remote_addr;
  12032. req.remote_port = remote_port;
  12033. req.local_addr = local_addr;
  12034. req.local_port = local_port;
  12035. Response res;
  12036. res.version = "HTTP/1.1";
  12037. res.headers = default_headers_;
  12038. // Request line and headers
  12039. if (!parse_request_line(line_reader.ptr(), req)) {
  12040. res.status = StatusCode::BadRequest_400;
  12041. output_error_log(Error::InvalidRequestLine, &req);
  12042. return write_response(strm, close_connection, req, res);
  12043. }
  12044. // Request headers
  12045. if (!detail::read_headers(strm, req.headers)) {
  12046. res.status = StatusCode::BadRequest_400;
  12047. output_error_log(Error::InvalidHeaders, &req);
  12048. return write_response(strm, close_connection, req, res);
  12049. }
  12050. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  12051. // otherwise let an intermediary and this parser disagree on where the body
  12052. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  12053. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  12054. // compatibility with existing clients), and a Transfer-Encoding whose final
  12055. // coding is not chunked, which leaves the body length undeterminable. The
  12056. // latter must not fall through to the "no body" path, or the body bytes are
  12057. // parsed as the next request on a persistent connection.
  12058. if (req.has_header("Transfer-Encoding") &&
  12059. (req.get_header_value_u64("Content-Length") > 0 ||
  12060. !detail::is_chunked_transfer_encoding(req.headers))) {
  12061. connection_closed = true;
  12062. res.status = StatusCode::BadRequest_400;
  12063. return write_response(strm, close_connection, req, res);
  12064. }
  12065. // Check if the request URI doesn't exceed the limit
  12066. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12067. connection_closed = true;
  12068. res.status = StatusCode::UriTooLong_414;
  12069. output_error_log(Error::ExceedUriMaxLength, &req);
  12070. return write_response(strm, close_connection, req, res);
  12071. }
  12072. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12073. connection_closed = true;
  12074. }
  12075. if (req.version == "HTTP/1.0" &&
  12076. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12077. connection_closed = true;
  12078. }
  12079. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12080. // itself a trusted proxy. Otherwise any direct client could spoof
  12081. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12082. auto is_trusted_peer = std::any_of(
  12083. trusted_proxies_.begin(), trusted_proxies_.end(),
  12084. [&](const std::string &proxy) { return proxy == remote_addr; });
  12085. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12086. // Some proxies append the address they observed as a separate
  12087. // X-Forwarded-For field line instead of extending the one the client sent
  12088. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12089. // be scanned. Reading only the first occurrence would hand back the
  12090. // client-supplied, and therefore forgeable, value.
  12091. auto x_forwarded_for =
  12092. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12093. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12094. req.remote_addr = derived.empty() ? remote_addr : derived;
  12095. } else {
  12096. req.remote_addr = remote_addr;
  12097. }
  12098. req.remote_port = remote_port;
  12099. req.local_addr = local_addr;
  12100. req.local_port = local_port;
  12101. if (req.has_header("Accept")) {
  12102. auto accept_header =
  12103. detail::get_combined_header_value(req.headers, "Accept");
  12104. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12105. connection_closed = true;
  12106. res.status = StatusCode::BadRequest_400;
  12107. output_error_log(Error::HTTPParsing, &req);
  12108. return write_response(strm, close_connection, req, res);
  12109. }
  12110. }
  12111. if (req.has_header("Range")) {
  12112. const auto &range_header_value = req.get_header_value("Range");
  12113. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12114. connection_closed = true;
  12115. res.status = StatusCode::RangeNotSatisfiable_416;
  12116. output_error_log(Error::InvalidRangeHeader, &req);
  12117. return write_response(strm, close_connection, req, res);
  12118. }
  12119. }
  12120. if (setup_request) { setup_request(req); }
  12121. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12122. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12123. // must be ignored. An expectation we do not recognize is left alone; the
  12124. // 417 the section allows for one is a MAY, not a requirement.
  12125. if (req.version != "HTTP/1.0" &&
  12126. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12127. int status = StatusCode::Continue_100;
  12128. if (expect_100_continue_handler_) {
  12129. status = expect_100_continue_handler_(req, res);
  12130. }
  12131. switch (status) {
  12132. case StatusCode::Continue_100:
  12133. case StatusCode::ExpectationFailed_417:
  12134. detail::write_response_line(strm, status);
  12135. strm.write("\r\n");
  12136. break;
  12137. default:
  12138. connection_closed = true;
  12139. return write_response(strm, true, req, res);
  12140. }
  12141. }
  12142. // Setup `is_connection_closed` method
  12143. auto sock = strm.socket();
  12144. req.is_connection_closed = [sock]() {
  12145. return !detail::is_socket_alive(sock);
  12146. };
  12147. // WebSocket upgrade
  12148. // Check pre_routing_handler_ before upgrading so that authentication
  12149. // and other middleware can reject the request with an HTTP response
  12150. // (e.g., 401) before the protocol switches.
  12151. if (detail::is_websocket_upgrade(req)) {
  12152. if (pre_routing_handler_ &&
  12153. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12154. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12155. return write_response(strm, close_connection, req, res);
  12156. }
  12157. // Find matching WebSocket handler
  12158. for (const auto &entry : websocket_handlers_) {
  12159. if (entry.matcher->match(req)) {
  12160. // Compute accept key
  12161. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12162. auto accept_key = detail::websocket_accept_key(client_key);
  12163. // Negotiate subprotocol
  12164. std::string selected_subprotocol;
  12165. if (entry.sub_protocol_selector) {
  12166. auto protocol_header = detail::get_combined_header_value(
  12167. req.headers, "Sec-WebSocket-Protocol");
  12168. if (!protocol_header.empty()) {
  12169. std::vector<std::string> protocols;
  12170. detail::split(protocol_header.data(),
  12171. protocol_header.data() + protocol_header.size(), ',',
  12172. [&](const char *b, const char *e) {
  12173. protocols.emplace_back(b, e);
  12174. });
  12175. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12176. }
  12177. }
  12178. // Send 101 Switching Protocols
  12179. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12180. "Upgrade: websocket\r\n"
  12181. "Connection: Upgrade\r\n"
  12182. "Sec-WebSocket-Accept: " +
  12183. accept_key + "\r\n";
  12184. if (!selected_subprotocol.empty()) {
  12185. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12186. return false;
  12187. }
  12188. handshake_response +=
  12189. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12190. }
  12191. handshake_response += "\r\n";
  12192. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12193. 0) {
  12194. return false;
  12195. }
  12196. connection_closed = true;
  12197. if (websocket_upgraded) { *websocket_upgraded = true; }
  12198. {
  12199. #ifdef CPPHTTPLIB_SSL_ENABLED
  12200. if (req.ssl) {
  12201. // wss: the heartbeat ping thread and the read path enter the same
  12202. // TLS session from different threads. Hand the WebSocket a stream
  12203. // that serializes every TLS call, so the shared SSLSocketStream on
  12204. // the plain HTTP/HTTPS paths stays untouched.
  12205. auto ws_strm =
  12206. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12207. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12208. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12209. write_timeout_sec_, write_timeout_usec_));
  12210. ws::WebSocket ws(std::move(ws_strm), req, true,
  12211. websocket_ping_interval_sec_,
  12212. websocket_max_missed_pongs_);
  12213. entry.handler(req, ws);
  12214. return true;
  12215. }
  12216. #endif
  12217. // Use WebSocket-specific read timeout instead of HTTP timeout
  12218. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12219. 0);
  12220. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12221. websocket_max_missed_pongs_);
  12222. entry.handler(req, ws);
  12223. }
  12224. return true;
  12225. }
  12226. }
  12227. // No matching handler - fall through to 404
  12228. }
  12229. // Routing
  12230. auto routed = false;
  12231. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12232. routed = routing(req, res, strm);
  12233. #else
  12234. try {
  12235. routed = routing(req, res, strm);
  12236. } catch (std::exception &) {
  12237. if (exception_handler_) {
  12238. auto ep = std::current_exception();
  12239. exception_handler_(req, res, ep);
  12240. routed = true;
  12241. } else {
  12242. res.status = StatusCode::InternalServerError_500;
  12243. }
  12244. } catch (...) {
  12245. if (exception_handler_) {
  12246. auto ep = std::current_exception();
  12247. exception_handler_(req, res, ep);
  12248. routed = true;
  12249. } else {
  12250. res.status = StatusCode::InternalServerError_500;
  12251. }
  12252. }
  12253. #endif
  12254. auto ret = false;
  12255. if (routed) {
  12256. if (res.status == -1) {
  12257. res.status = req.ranges.empty() ? StatusCode::OK_200
  12258. : StatusCode::PartialContent_206;
  12259. }
  12260. // Serve file content by using a content provider
  12261. auto file_open_error = false;
  12262. if (!res.file_content_path_.empty()) {
  12263. const auto &path = res.file_content_path_;
  12264. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12265. if (!mm->is_open()) {
  12266. res.body.clear();
  12267. res.content_length_ = 0;
  12268. res.content_provider_ = nullptr;
  12269. res.status = StatusCode::NotFound_404;
  12270. output_error_log(Error::OpenFile, &req);
  12271. file_open_error = true;
  12272. } else {
  12273. auto content_type = res.file_content_content_type_;
  12274. if (content_type.empty()) {
  12275. content_type = detail::find_content_type(
  12276. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12277. }
  12278. detail::set_file_content_provider(
  12279. res, mm, content_type,
  12280. static_file_encoding(req, res, content_type, mm->size()));
  12281. }
  12282. }
  12283. if (file_open_error) {
  12284. ret = write_response(strm, close_connection, req, res);
  12285. } else if (detail::range_error(req, res)) {
  12286. res.body.clear();
  12287. res.content_length_ = 0;
  12288. res.content_provider_ = nullptr;
  12289. res.status = StatusCode::RangeNotSatisfiable_416;
  12290. ret = write_response(strm, close_connection, req, res);
  12291. } else {
  12292. ret = write_response_with_content(strm, close_connection, req, res);
  12293. }
  12294. } else {
  12295. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12296. ret = write_response(strm, close_connection, req, res);
  12297. }
  12298. // Drain any unconsumed framed body to prevent request smuggling on
  12299. // keep-alive. Without framing there is no body to drain — reading would
  12300. // consume the next request (issue #2450). If the response has committed the
  12301. // connection to close, there is no next request to protect.
  12302. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12303. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12304. connection_closed = true;
  12305. } else {
  12306. int dummy_status;
  12307. if (!detail::read_content(
  12308. strm, req, payload_max_length_, dummy_status, nullptr,
  12309. [](const char *, size_t, size_t, size_t) { return true; },
  12310. false)) {
  12311. connection_closed = true;
  12312. }
  12313. }
  12314. }
  12315. return ret;
  12316. }
  12317. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12318. inline bool Server::process_and_close_socket(socket_t sock) {
  12319. std::string remote_addr;
  12320. int remote_port = 0;
  12321. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12322. std::string local_addr;
  12323. int local_port = 0;
  12324. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12325. bool websocket_upgraded = false;
  12326. auto ret = serve_guarded([&]() {
  12327. return detail::process_server_socket(
  12328. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12329. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12330. write_timeout_usec_,
  12331. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12332. return process_request(strm, remote_addr, remote_port, local_addr,
  12333. local_port, close_connection,
  12334. connection_closed, nullptr,
  12335. &websocket_upgraded);
  12336. });
  12337. });
  12338. detail::drain_and_close_socket(sock);
  12339. return ret;
  12340. }
  12341. inline void Server::output_log(const Request &req, const Response &res) const {
  12342. if (logger_) {
  12343. std::lock_guard<std::mutex> guard(logger_mutex_);
  12344. logger_(req, res);
  12345. }
  12346. }
  12347. inline void Server::output_pre_compression_log(const Request &req,
  12348. const Response &res) const {
  12349. if (pre_compression_logger_) {
  12350. std::lock_guard<std::mutex> guard(logger_mutex_);
  12351. pre_compression_logger_(req, res);
  12352. }
  12353. }
  12354. inline void Server::output_error_log(const Error &err,
  12355. const Request *req) const {
  12356. if (error_logger_) {
  12357. std::lock_guard<std::mutex> guard(logger_mutex_);
  12358. error_logger_(err, req);
  12359. }
  12360. }
  12361. /*
  12362. * Group 5: ClientImpl and Client (Universal) implementation
  12363. */
  12364. // HTTP client implementation
  12365. inline ClientImpl::ClientImpl(const std::string &host)
  12366. : ClientImpl(host, 80, std::string(), std::string()) {}
  12367. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12368. : ClientImpl(host, port, std::string(), std::string()) {}
  12369. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12370. const std::string &client_cert_path,
  12371. const std::string &client_key_path)
  12372. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12373. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12374. inline ClientImpl::~ClientImpl() {
  12375. // Wait until all the requests in flight are handled.
  12376. size_t retry_count = 10;
  12377. while (retry_count-- > 0) {
  12378. {
  12379. std::lock_guard<std::mutex> guard(socket_mutex_);
  12380. if (socket_requests_in_flight_ == 0) { break; }
  12381. }
  12382. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12383. }
  12384. std::lock_guard<std::mutex> guard(socket_mutex_);
  12385. shutdown_socket(socket_);
  12386. close_socket(socket_);
  12387. }
  12388. inline bool ClientImpl::is_valid() const { return true; }
  12389. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12390. client_cert_path_ = rhs.client_cert_path_;
  12391. client_key_path_ = rhs.client_key_path_;
  12392. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12393. read_timeout_sec_ = rhs.read_timeout_sec_;
  12394. read_timeout_usec_ = rhs.read_timeout_usec_;
  12395. write_timeout_sec_ = rhs.write_timeout_sec_;
  12396. write_timeout_usec_ = rhs.write_timeout_usec_;
  12397. max_timeout_msec_ = rhs.max_timeout_msec_;
  12398. basic_auth_username_ = rhs.basic_auth_username_;
  12399. basic_auth_password_ = rhs.basic_auth_password_;
  12400. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12401. keep_alive_ = rhs.keep_alive_;
  12402. follow_location_ = rhs.follow_location_;
  12403. path_encode_ = rhs.path_encode_;
  12404. address_family_ = rhs.address_family_;
  12405. tcp_nodelay_ = rhs.tcp_nodelay_;
  12406. ipv6_v6only_ = rhs.ipv6_v6only_;
  12407. socket_options_ = rhs.socket_options_;
  12408. compress_ = rhs.compress_;
  12409. decompress_ = rhs.decompress_;
  12410. payload_max_length_ = rhs.payload_max_length_;
  12411. has_payload_max_length_ = rhs.has_payload_max_length_;
  12412. interface_ = rhs.interface_;
  12413. proxy_host_ = rhs.proxy_host_;
  12414. proxy_port_ = rhs.proxy_port_;
  12415. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12416. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12417. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12418. no_proxy_entries_ = rhs.no_proxy_entries_;
  12419. logger_ = rhs.logger_;
  12420. error_logger_ = rhs.error_logger_;
  12421. #ifdef CPPHTTPLIB_SSL_ENABLED
  12422. digest_auth_username_ = rhs.digest_auth_username_;
  12423. digest_auth_password_ = rhs.digest_auth_password_;
  12424. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12425. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12426. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12427. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12428. server_certificate_verification_ = rhs.server_certificate_verification_;
  12429. server_hostname_verification_ = rhs.server_hostname_verification_;
  12430. system_ca_mode_ = rhs.system_ca_mode_;
  12431. #endif
  12432. }
  12433. inline bool
  12434. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12435. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12436. if (no_proxy_entries_.empty()) { return true; }
  12437. // host_ is const so its normalized form is invariant; cache it. The
  12438. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12439. if (host == host_) {
  12440. if (!host_normalized_valid_) {
  12441. host_normalized_ = detail::normalize_target(host_);
  12442. host_normalized_valid_ = true;
  12443. }
  12444. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12445. }
  12446. auto target = detail::normalize_target(host);
  12447. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12448. }
  12449. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12450. if (is_proxy_enabled_for_host(host_)) {
  12451. return detail::create_client_socket(
  12452. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12453. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12454. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12455. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12456. }
  12457. // Check is custom IP or hostname specified for host_
  12458. std::string connect_host;
  12459. std::string ip;
  12460. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12461. return detail::create_client_socket(
  12462. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12463. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12464. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12465. write_timeout_usec_, interface_, error);
  12466. }
  12467. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12468. Error &error) {
  12469. auto sock = create_client_socket(error);
  12470. if (sock == INVALID_SOCKET) { return false; }
  12471. socket.sock = sock;
  12472. return true;
  12473. }
  12474. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12475. return create_and_connect_socket(socket, error);
  12476. }
  12477. inline bool ClientImpl::setup_proxy_connection(
  12478. Socket & /*socket*/,
  12479. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12480. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12481. return true;
  12482. }
  12483. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12484. bool /*shutdown_gracefully*/) {
  12485. // If there are any requests in flight from threads other than us, then it's
  12486. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12487. assert(socket_requests_in_flight_ == 0 ||
  12488. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12489. }
  12490. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12491. if (socket.sock == INVALID_SOCKET) { return; }
  12492. detail::shutdown_socket(socket.sock);
  12493. }
  12494. inline void ClientImpl::close_socket(Socket &socket) {
  12495. // If there are requests in flight in another thread, usually closing
  12496. // the socket will be fine and they will simply receive an error when
  12497. // using the closed socket, but it is still a bug since rarely the OS
  12498. // may reassign the socket id to be used for a new socket, and then
  12499. // suddenly they will be operating on a live socket that is different
  12500. // than the one they intended!
  12501. assert(socket_requests_in_flight_ == 0 ||
  12502. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12503. // It is also a bug if this happens while SSL is still active
  12504. #ifdef CPPHTTPLIB_SSL_ENABLED
  12505. assert(socket.ssl == nullptr);
  12506. #endif
  12507. if (socket.sock == INVALID_SOCKET) { return; }
  12508. detail::close_socket(socket.sock);
  12509. socket.sock = INVALID_SOCKET;
  12510. }
  12511. inline void ClientImpl::disconnect(bool gracefully) {
  12512. shutdown_ssl(socket_, gracefully);
  12513. shutdown_socket(socket_);
  12514. close_socket(socket_);
  12515. }
  12516. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12517. Response &res,
  12518. bool skip_100_continue) const {
  12519. std::array<char, 2048> buf{};
  12520. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12521. if (!line_reader.getline()) { return false; }
  12522. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12523. res.reason)) {
  12524. return req.method == "CONNECT";
  12525. }
  12526. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12527. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12528. if (!line_reader.getline()) { return false; } // CRLF
  12529. if (!line_reader.getline()) { return false; } // next response line
  12530. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12531. res.reason)) {
  12532. return false;
  12533. }
  12534. }
  12535. return true;
  12536. }
  12537. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12538. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12539. auto ret = send_(req, res, error);
  12540. if (error == Error::SSLPeerCouldBeClosed_) {
  12541. assert(!ret);
  12542. ret = send_(req, res, error);
  12543. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12544. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12545. }
  12546. return ret;
  12547. }
  12548. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12549. {
  12550. std::lock_guard<std::mutex> guard(socket_mutex_);
  12551. // Set this to false immediately - if it ever gets set to true by the end
  12552. // of the request, we know another thread instructed us to close the
  12553. // socket.
  12554. socket_should_be_closed_when_request_is_done_ = false;
  12555. auto is_alive = false;
  12556. if (socket_.is_open()) {
  12557. is_alive = detail::is_socket_alive(socket_.sock);
  12558. #ifdef CPPHTTPLIB_SSL_ENABLED
  12559. if (is_alive && is_ssl()) {
  12560. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12561. is_alive = false;
  12562. }
  12563. }
  12564. #endif
  12565. if (!is_alive) {
  12566. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12567. disconnect(/*gracefully=*/false);
  12568. }
  12569. }
  12570. if (!is_alive) {
  12571. if (!ensure_socket_connection(socket_, error)) {
  12572. output_error_log(error, &req);
  12573. return false;
  12574. }
  12575. {
  12576. auto success = true;
  12577. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12578. error)) {
  12579. if (!success) { output_error_log(error, &req); }
  12580. return success;
  12581. }
  12582. }
  12583. }
  12584. // Mark the current socket as being in use so that it cannot be closed by
  12585. // anyone else while this request is ongoing, even though we will be
  12586. // releasing the mutex.
  12587. if (socket_requests_in_flight_ > 1) {
  12588. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12589. }
  12590. socket_requests_in_flight_ += 1;
  12591. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12592. }
  12593. for (const auto &header : default_headers_) {
  12594. if (req.headers.find(header.first) == req.headers.end()) {
  12595. req.headers.insert(header);
  12596. }
  12597. }
  12598. auto ret = false;
  12599. auto close_connection = !keep_alive_;
  12600. auto se = detail::scope_exit([&]() {
  12601. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12602. std::lock_guard<std::mutex> guard(socket_mutex_);
  12603. socket_requests_in_flight_ -= 1;
  12604. if (socket_requests_in_flight_ <= 0) {
  12605. assert(socket_requests_in_flight_ == 0);
  12606. socket_requests_are_from_thread_ = std::thread::id();
  12607. }
  12608. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12609. !ret) {
  12610. disconnect(/*gracefully=*/true);
  12611. }
  12612. });
  12613. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12614. return handle_request(strm, req, res, close_connection, error);
  12615. });
  12616. if (!ret) {
  12617. if (error == Error::Success) {
  12618. error = Error::Unknown;
  12619. output_error_log(error, &req);
  12620. }
  12621. }
  12622. return ret;
  12623. }
  12624. inline Result ClientImpl::send(const Request &req) {
  12625. auto req2 = req;
  12626. return send_(std::move(req2));
  12627. }
  12628. inline Result ClientImpl::send_(Request &&req) {
  12629. auto res = detail::make_unique<Response>();
  12630. auto error = Error::Success;
  12631. auto ret = send(req, *res, error);
  12632. #ifdef CPPHTTPLIB_SSL_ENABLED
  12633. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12634. last_ssl_error_, last_backend_error_};
  12635. #else
  12636. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12637. #endif
  12638. }
  12639. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12640. const std::string &ct) {
  12641. (void)for_stream;
  12642. for (const auto &header : default_headers_) {
  12643. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12644. }
  12645. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12646. // prepend it rather than appending it after the caller's own fields.
  12647. if (!r.has_header("Host")) {
  12648. r.headers.emplace_front(
  12649. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12650. address_family_));
  12651. }
  12652. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12653. if (!r.content_receiver) {
  12654. if (!r.has_header("Accept-Encoding")) {
  12655. std::string accept_encoding;
  12656. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12657. accept_encoding = "br";
  12658. #endif
  12659. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12660. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12661. accept_encoding += "gzip, deflate";
  12662. #endif
  12663. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12664. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12665. accept_encoding += "zstd";
  12666. #endif
  12667. r.set_header("Accept-Encoding", accept_encoding);
  12668. }
  12669. detail::add_default_user_agent_header(r);
  12670. }
  12671. if (!r.body.empty()) {
  12672. if (!ct.empty() && !r.has_header("Content-Type")) {
  12673. r.headers.emplace("Content-Type", ct);
  12674. }
  12675. if (!r.has_header("Content-Length")) {
  12676. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12677. }
  12678. }
  12679. }
  12680. inline ClientImpl::StreamHandle
  12681. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12682. const Params &params, const Headers &headers,
  12683. const std::string &body,
  12684. const std::string &content_type) {
  12685. StreamHandle handle;
  12686. handle.response = detail::make_unique<Response>();
  12687. handle.error = Error::Success;
  12688. // Encode the target exactly like the buffered send path does, so that the
  12689. // same `path` produces the same request line through either API.
  12690. auto raw_query_path =
  12691. params.empty() ? path : append_query_params(path, params);
  12692. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12693. handle.connection_ = detail::make_unique<ClientConnection>();
  12694. {
  12695. std::lock_guard<std::mutex> guard(socket_mutex_);
  12696. auto is_alive = false;
  12697. if (socket_.is_open()) {
  12698. is_alive = detail::is_socket_alive(socket_.sock);
  12699. #ifdef CPPHTTPLIB_SSL_ENABLED
  12700. if (is_alive && is_ssl()) {
  12701. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12702. is_alive = false;
  12703. }
  12704. }
  12705. #endif
  12706. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12707. }
  12708. if (!is_alive) {
  12709. if (!ensure_socket_connection(socket_, handle.error)) {
  12710. handle.response.reset();
  12711. return handle;
  12712. }
  12713. {
  12714. auto success = true;
  12715. auto start_time = std::chrono::steady_clock::now();
  12716. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12717. success, handle.error)) {
  12718. if (!success) { handle.response.reset(); }
  12719. return handle;
  12720. }
  12721. }
  12722. }
  12723. transfer_socket_ownership_to_handle(handle);
  12724. }
  12725. #ifdef CPPHTTPLIB_SSL_ENABLED
  12726. if (is_ssl() && handle.connection_->session) {
  12727. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12728. handle.connection_->sock, handle.connection_->session,
  12729. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12730. write_timeout_usec_);
  12731. } else {
  12732. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12733. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12734. write_timeout_sec_, write_timeout_usec_);
  12735. }
  12736. #else
  12737. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12738. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12739. write_timeout_sec_, write_timeout_usec_);
  12740. #endif
  12741. handle.stream_ = handle.socket_stream_.get();
  12742. Request req;
  12743. req.method = method;
  12744. req.path = query_path;
  12745. req.headers = headers;
  12746. req.body = body;
  12747. prepare_default_headers(req, true, content_type);
  12748. auto &strm = *handle.stream_;
  12749. if (detail::write_request_line(strm, req.method, req.path) < 0) {
  12750. handle.error = Error::Write;
  12751. handle.response.reset();
  12752. return handle;
  12753. }
  12754. if (!detail::check_and_write_headers(strm, req.headers, header_writer_,
  12755. handle.error)) {
  12756. handle.response.reset();
  12757. return handle;
  12758. }
  12759. if (!body.empty()) {
  12760. if (strm.write(body.data(), body.size()) < 0) {
  12761. handle.error = Error::Write;
  12762. handle.response.reset();
  12763. return handle;
  12764. }
  12765. }
  12766. if (!read_response_line(strm, req, *handle.response) ||
  12767. !detail::read_headers(strm, handle.response->headers)) {
  12768. handle.error = Error::Read;
  12769. handle.response.reset();
  12770. return handle;
  12771. }
  12772. handle.body_reader_.stream = handle.stream_;
  12773. handle.body_reader_.payload_max_length = payload_max_length_;
  12774. if (handle.response->has_header("Content-Length")) {
  12775. bool is_invalid = false;
  12776. auto content_length = detail::get_header_value_u64(
  12777. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12778. if (is_invalid) {
  12779. handle.error = Error::Read;
  12780. handle.response.reset();
  12781. return handle;
  12782. }
  12783. handle.body_reader_.has_content_length = true;
  12784. handle.body_reader_.content_length = content_length;
  12785. }
  12786. handle.body_reader_.chunked =
  12787. detail::is_chunked_transfer_encoding(handle.response->headers);
  12788. auto content_encoding = detail::get_combined_header_value(
  12789. handle.response->headers, "Content-Encoding");
  12790. if (!content_encoding.empty()) {
  12791. // Same policy as prepare_content_receiver(): reject a coding we know about
  12792. // but were not built with, pass an unrecognized one through as-is.
  12793. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12794. if (!handle.decompressor_) {
  12795. if (detail::is_known_content_encoding(content_encoding)) {
  12796. handle.error = Error::UnsupportedContentEncoding;
  12797. handle.response.reset();
  12798. return handle;
  12799. }
  12800. } else if (!handle.decompressor_->is_valid()) {
  12801. handle.error = Error::Compression;
  12802. handle.response.reset();
  12803. return handle;
  12804. }
  12805. }
  12806. return handle;
  12807. }
  12808. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12809. if (!is_valid() || !response) { return -1; }
  12810. if (decompressor_) { return read_with_decompression(buf, len); }
  12811. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12812. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12813. trailers_parsed_ = true;
  12814. if (body_reader_.chunked_decoder) {
  12815. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12816. response->trailers, response->headers)) {
  12817. return n;
  12818. }
  12819. } else {
  12820. detail::ChunkedDecoder dec(*stream_);
  12821. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12822. return n;
  12823. }
  12824. }
  12825. }
  12826. return n;
  12827. }
  12828. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12829. size_t len) {
  12830. if (decompress_offset_ < decompress_buffer_.size()) {
  12831. auto available = decompress_buffer_.size() - decompress_offset_;
  12832. auto to_copy = (std::min)(len, available);
  12833. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12834. decompress_offset_ += to_copy;
  12835. decompressed_bytes_read_ += to_copy;
  12836. return static_cast<ssize_t>(to_copy);
  12837. }
  12838. decompress_buffer_.clear();
  12839. decompress_offset_ = 0;
  12840. constexpr size_t kDecompressionBufferSize = 8192;
  12841. char compressed_buf[kDecompressionBufferSize];
  12842. while (true) {
  12843. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12844. sizeof(compressed_buf));
  12845. if (n <= 0) { return n; }
  12846. bool decompress_ok = decompressor_->decompress(
  12847. compressed_buf, static_cast<size_t>(n),
  12848. [this](const char *data, size_t data_len) {
  12849. decompress_buffer_.append(data, data_len);
  12850. auto limit = body_reader_.payload_max_length;
  12851. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12852. return false;
  12853. }
  12854. return true;
  12855. });
  12856. if (!decompress_ok) {
  12857. body_reader_.last_error = Error::Read;
  12858. return -1;
  12859. }
  12860. if (!decompress_buffer_.empty()) { break; }
  12861. }
  12862. auto to_copy = (std::min)(len, decompress_buffer_.size());
  12863. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  12864. decompress_offset_ = to_copy;
  12865. decompressed_bytes_read_ += to_copy;
  12866. return static_cast<ssize_t>(to_copy);
  12867. }
  12868. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  12869. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  12870. return;
  12871. }
  12872. trailers_parsed_ = true;
  12873. const auto bufsiz = 128;
  12874. char line_buf[bufsiz];
  12875. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  12876. if (!line_reader.getline()) { return; }
  12877. if (!detail::parse_trailers(line_reader, response->trailers,
  12878. response->headers)) {
  12879. return;
  12880. }
  12881. }
  12882. namespace detail {
  12883. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  12884. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  12885. size_t &out_chunk_offset,
  12886. size_t &out_chunk_total) {
  12887. if (finished) { return 0; }
  12888. if (chunk_remaining == 0) {
  12889. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12890. if (!lr.getline()) { return -1; }
  12891. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  12892. const char *p = lr.ptr();
  12893. int v = 0;
  12894. if (!is_hex(*p, v)) { return -1; }
  12895. size_t chunk_len = 0;
  12896. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  12897. for (; is_hex(*p, v); ++p) {
  12898. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  12899. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  12900. }
  12901. while (is_space_or_tab(*p)) {
  12902. ++p;
  12903. }
  12904. if (*p != '\0' && *p != ';' && *p != '\r' && *p != '\n') { return -1; }
  12905. if (chunk_len == 0) {
  12906. chunk_remaining = 0;
  12907. finished = true;
  12908. out_chunk_offset = 0;
  12909. out_chunk_total = 0;
  12910. return 0;
  12911. }
  12912. chunk_remaining = chunk_len;
  12913. last_chunk_total = chunk_remaining;
  12914. last_chunk_offset = 0;
  12915. }
  12916. auto to_read = (std::min)(chunk_remaining, len);
  12917. auto n = strm.read(buf, to_read);
  12918. if (n <= 0) { return -1; }
  12919. auto offset_before = last_chunk_offset;
  12920. last_chunk_offset += static_cast<size_t>(n);
  12921. chunk_remaining -= static_cast<size_t>(n);
  12922. out_chunk_offset = offset_before;
  12923. out_chunk_total = last_chunk_total;
  12924. if (chunk_remaining == 0) {
  12925. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12926. if (!lr.getline()) { return -1; }
  12927. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  12928. }
  12929. return n;
  12930. }
  12931. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  12932. const Headers &src_headers) {
  12933. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12934. if (!lr.getline()) { return false; }
  12935. return parse_trailers(lr, dest, src_headers);
  12936. }
  12937. } // namespace detail
  12938. inline void
  12939. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  12940. handle.connection_->sock = socket_.sock;
  12941. #ifdef CPPHTTPLIB_SSL_ENABLED
  12942. handle.connection_->session = socket_.ssl;
  12943. socket_.ssl = nullptr;
  12944. #endif
  12945. socket_.sock = INVALID_SOCKET;
  12946. }
  12947. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  12948. Response &res, bool close_connection,
  12949. Error &error) {
  12950. if (req.path.empty()) {
  12951. error = Error::Connection;
  12952. output_error_log(error, &req);
  12953. return false;
  12954. }
  12955. auto req_save = req;
  12956. bool ret;
  12957. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  12958. auto req2 = req;
  12959. req2.path = "http://" +
  12960. detail::make_host_and_port_string(host_, port_, false) +
  12961. req.path;
  12962. ret = process_request(strm, req2, res, close_connection, error);
  12963. req = std::move(req2);
  12964. req.path = req_save.path;
  12965. } else {
  12966. ret = process_request(strm, req, res, close_connection, error);
  12967. }
  12968. if (!ret) { return false; }
  12969. if (detail::has_header_token(res.headers, "Connection", "close") ||
  12970. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  12971. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  12972. // for this to be safe.
  12973. // This is safe to call because handle_request is only called by send_
  12974. // which locks the request mutex during the process. It would be a bug
  12975. // to call it from a different thread since it's a thread-safety issue
  12976. // to do these things to the socket if another thread is using the socket.
  12977. std::lock_guard<std::mutex> guard(socket_mutex_);
  12978. disconnect(/*gracefully=*/true);
  12979. }
  12980. if (300 < res.status && res.status < 400 && follow_location_) {
  12981. req = std::move(req_save);
  12982. ret = redirect(req, res, error);
  12983. }
  12984. #ifdef CPPHTTPLIB_SSL_ENABLED
  12985. if ((res.status == StatusCode::Unauthorized_401 ||
  12986. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  12987. req.authorization_count_ < 5) {
  12988. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  12989. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  12990. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  12991. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  12992. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  12993. return ret;
  12994. }
  12995. const auto &username =
  12996. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  12997. const auto &password =
  12998. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  12999. if (!username.empty() && !password.empty()) {
  13000. std::map<std::string, std::string> auth;
  13001. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13002. Request new_req = req;
  13003. new_req.authorization_count_ += 1;
  13004. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13005. : "Authorization");
  13006. new_req.headers.insert(detail::make_digest_authentication_header(
  13007. req, auth, new_req.authorization_count_, detail::random_string(10),
  13008. username, password, is_proxy));
  13009. Response new_res;
  13010. ret = send(new_req, new_res, error);
  13011. if (ret) { res = std::move(new_res); }
  13012. }
  13013. }
  13014. }
  13015. #endif
  13016. return ret;
  13017. }
  13018. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13019. if (req.redirect_count_ == 0) {
  13020. error = Error::ExceedRedirectCount;
  13021. output_error_log(error, &req);
  13022. return false;
  13023. }
  13024. auto location = res.get_header_value("location");
  13025. if (location.empty()) { return false; }
  13026. detail::UrlComponents uc;
  13027. if (!detail::parse_url(location, uc)) { return false; }
  13028. // Only follow http/https redirects
  13029. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13030. return false;
  13031. }
  13032. auto scheme = is_ssl() ? "https" : "http";
  13033. auto next_scheme = std::move(uc.scheme);
  13034. auto next_host = std::move(uc.host);
  13035. auto port_str = std::move(uc.port);
  13036. auto next_path = std::move(uc.path);
  13037. auto next_query = std::move(uc.query);
  13038. auto next_port = port_;
  13039. if (!port_str.empty()) {
  13040. if (!detail::parse_port(port_str, next_port)) { return false; }
  13041. } else if (!next_scheme.empty()) {
  13042. next_port = next_scheme == "https" ? 443 : 80;
  13043. }
  13044. if (next_scheme.empty()) { next_scheme = scheme; }
  13045. if (next_host.empty()) { next_host = host_; }
  13046. if (next_path.empty()) { next_path = "/"; }
  13047. auto path = decode_path_component(next_path) + next_query;
  13048. // Same host redirect - use current client
  13049. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13050. return detail::redirect(*this, req, res, path, location, error);
  13051. }
  13052. // Cross-host/scheme redirect - create new client with robust setup
  13053. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13054. path, location, error);
  13055. }
  13056. // New method for robust redirect client creation
  13057. inline bool ClientImpl::create_redirect_client(
  13058. const std::string &scheme, const std::string &host, int port, Request &req,
  13059. Response &res, const std::string &path, const std::string &location,
  13060. Error &error) {
  13061. // Determine if we need SSL
  13062. auto need_ssl = (scheme == "https");
  13063. // Clean up request headers that are host/client specific
  13064. // Remove headers that should not be carried over to new host
  13065. auto headers_to_remove = std::vector<std::string>{
  13066. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13067. for (const auto &header_name : headers_to_remove) {
  13068. auto it = req.headers.find(header_name);
  13069. while (it != req.headers.end()) {
  13070. it = req.headers.erase(it);
  13071. it = req.headers.find(header_name);
  13072. }
  13073. }
  13074. // Create appropriate client type and handle redirect
  13075. if (need_ssl) {
  13076. #ifdef CPPHTTPLIB_SSL_ENABLED
  13077. // Create SSL client for HTTPS redirect
  13078. SSLClient redirect_client(host, port);
  13079. // Setup basic client configuration first
  13080. setup_redirect_client(redirect_client);
  13081. redirect_client.enable_server_certificate_verification(
  13082. server_certificate_verification_);
  13083. redirect_client.enable_server_hostname_verification(
  13084. server_hostname_verification_);
  13085. redirect_client.system_ca_mode_ = system_ca_mode_;
  13086. // Transfer CA certificate to redirect client
  13087. if (!ca_cert_pem_.empty()) {
  13088. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13089. ca_cert_pem_.size());
  13090. }
  13091. if (!ca_cert_file_path_.empty()) {
  13092. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13093. }
  13094. // Client certificates are set through constructor for SSLClient
  13095. // NOTE: SSLClient constructor already takes client_cert_path and
  13096. // client_key_path so we need to create it properly if client certs are
  13097. // needed
  13098. // Execute the redirect
  13099. return detail::redirect(redirect_client, req, res, path, location, error);
  13100. #else
  13101. // SSL not supported - set appropriate error
  13102. error = Error::SSLConnection;
  13103. output_error_log(error, &req);
  13104. return false;
  13105. #endif
  13106. } else {
  13107. // HTTP redirect
  13108. ClientImpl redirect_client(host, port);
  13109. // Setup client with robust configuration
  13110. setup_redirect_client(redirect_client);
  13111. // Execute the redirect
  13112. return detail::redirect(redirect_client, req, res, path, location, error);
  13113. }
  13114. }
  13115. // New method for robust client setup (based on basic_manual_redirect.cpp
  13116. // logic)
  13117. template <typename ClientType>
  13118. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13119. // Copy basic settings first
  13120. client.set_connection_timeout(connection_timeout_sec_);
  13121. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13122. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13123. client.set_keep_alive(keep_alive_);
  13124. client.set_follow_location(
  13125. true); // Enable redirects to handle multi-step redirects
  13126. client.set_path_encode(path_encode_);
  13127. client.set_compress(compress_);
  13128. client.set_decompress(decompress_);
  13129. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13130. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13131. // 15.4, credentials must not be forwarded when redirecting to a different
  13132. // host. This function is only called for cross-host redirects; same-host
  13133. // redirects are handled directly in ClientImpl::redirect().
  13134. // Copy the proxy configuration unconditionally; the per-target bypass is
  13135. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13136. // still use the proxy.
  13137. client.no_proxy_entries_ = no_proxy_entries_;
  13138. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13139. client.set_proxy(proxy_host_, proxy_port_);
  13140. if (!proxy_basic_auth_username_.empty()) {
  13141. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13142. proxy_basic_auth_password_);
  13143. }
  13144. if (!proxy_bearer_token_auth_token_.empty()) {
  13145. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13146. }
  13147. #ifdef CPPHTTPLIB_SSL_ENABLED
  13148. if (!proxy_digest_auth_username_.empty()) {
  13149. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13150. proxy_digest_auth_password_);
  13151. }
  13152. #endif
  13153. }
  13154. // Copy network and socket settings
  13155. client.set_address_family(address_family_);
  13156. client.set_tcp_nodelay(tcp_nodelay_);
  13157. client.set_ipv6_v6only(ipv6_v6only_);
  13158. if (socket_options_) { client.set_socket_options(socket_options_); }
  13159. if (!interface_.empty()) { client.set_interface(interface_); }
  13160. // Copy logging and headers
  13161. if (logger_) { client.set_logger(logger_); }
  13162. if (error_logger_) { client.set_error_logger(error_logger_); }
  13163. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13164. // Each new client should generate its own headers based on its target host
  13165. }
  13166. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13167. const Request &req,
  13168. Error &error) const {
  13169. auto is_shutting_down = []() { return false; };
  13170. if (req.is_chunked_content_provider_) {
  13171. auto compressor = compress_ ? detail::create_compressor().first
  13172. : std::unique_ptr<detail::compressor>();
  13173. if (!compressor) {
  13174. compressor = detail::make_unique<detail::nocompressor>();
  13175. }
  13176. return detail::write_content_chunked(strm, req.content_provider_,
  13177. is_shutting_down, *compressor, error);
  13178. } else {
  13179. return detail::write_content_with_progress(
  13180. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13181. req.upload_progress, error);
  13182. }
  13183. }
  13184. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13185. bool close_connection, Error &error,
  13186. bool skip_body) {
  13187. // Prepare additional headers
  13188. if (close_connection) {
  13189. if (!req.has_header("Connection")) {
  13190. req.set_header("Connection", "close");
  13191. }
  13192. }
  13193. std::string ct_for_defaults;
  13194. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13195. ct_for_defaults = "text/plain";
  13196. }
  13197. prepare_default_headers(req, false, ct_for_defaults);
  13198. if (req.body.empty()) {
  13199. if (req.content_provider_) {
  13200. if (!req.is_chunked_content_provider_) {
  13201. if (!req.has_header("Content-Length")) {
  13202. auto length = std::to_string(req.content_length_);
  13203. req.set_header("Content-Length", length);
  13204. }
  13205. }
  13206. } else {
  13207. if (req.method == "POST" || req.method == "PUT" ||
  13208. req.method == "PATCH") {
  13209. req.set_header("Content-Length", "0");
  13210. }
  13211. }
  13212. }
  13213. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13214. if (!req.has_header("Authorization")) {
  13215. req.headers.insert(make_basic_authentication_header(
  13216. basic_auth_username_, basic_auth_password_, false));
  13217. }
  13218. }
  13219. if (!bearer_token_auth_token_.empty()) {
  13220. if (!req.has_header("Authorization")) {
  13221. req.headers.insert(make_bearer_token_authentication_header(
  13222. bearer_token_auth_token_, false));
  13223. }
  13224. }
  13225. // Proxy-Authorization is only sent when the proxy is actually used for
  13226. // this target — otherwise NO_PROXY-matched requests would leak proxy
  13227. // credentials directly to the destination server.
  13228. if (is_proxy_enabled_for_host(host_)) {
  13229. if (!proxy_basic_auth_username_.empty() &&
  13230. !proxy_basic_auth_password_.empty() &&
  13231. !req.has_header("Proxy-Authorization")) {
  13232. req.headers.insert(make_basic_authentication_header(
  13233. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13234. }
  13235. if (!proxy_bearer_token_auth_token_.empty() &&
  13236. !req.has_header("Proxy-Authorization")) {
  13237. req.headers.insert(make_bearer_token_authentication_header(
  13238. proxy_bearer_token_auth_token_, true));
  13239. }
  13240. }
  13241. // Request line and headers
  13242. {
  13243. detail::BufferStream bstrm;
  13244. // Extract the query from req.path. The encoding itself is delegated to
  13245. // `encode_request_target`; the raw query is still needed here to decide
  13246. // between populating `req.params` from it and falling back to building a
  13247. // query out of caller-supplied `req.params`.
  13248. auto query_pos = req.path.find('?');
  13249. auto query_part = query_pos == std::string::npos
  13250. ? std::string()
  13251. : req.path.substr(query_pos + 1);
  13252. auto path_with_query =
  13253. detail::encode_request_target(req.path, path_encode_);
  13254. if (!query_part.empty()) {
  13255. // The query already came in through `req.path`; still populate
  13256. // `req.params` for handlers/users who read them.
  13257. detail::parse_query_text(query_part, req.params);
  13258. } else if (!req.params.empty()) {
  13259. // No query in `req.path`; build one from `req.params` so existing
  13260. // callers that pass `Params` separately continue to work.
  13261. path_with_query = append_query_params(path_with_query, req.params);
  13262. }
  13263. // Write request line and headers
  13264. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13265. // A rejected target (e.g. CR/LF smuggled in via a decoded redirect
  13266. // Location under set_path_encode(false)) must fail the request cleanly
  13267. // instead of emitting a request-line-less, header-injecting request.
  13268. error = Error::Write;
  13269. output_error_log(error, &req);
  13270. return false;
  13271. }
  13272. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13273. error)) {
  13274. output_error_log(error, &req);
  13275. return false;
  13276. }
  13277. // Flush buffer
  13278. auto &data = bstrm.get_buffer();
  13279. if (!detail::write_data(strm, data.data(), data.size())) {
  13280. error = Error::Write;
  13281. output_error_log(error, &req);
  13282. return false;
  13283. }
  13284. }
  13285. // After sending request line and headers, wait briefly for an early server
  13286. // response (e.g. 4xx) and avoid sending a potentially large request body
  13287. // unnecessarily. This workaround is only enabled on Windows because Unix
  13288. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13289. // buffering can accept large writes even when the peer already responded.
  13290. // Check the stream first (which covers SSL via `is_readable()`), then
  13291. // fall back to select on the socket. Only perform the wait for very large
  13292. // request bodies to avoid interfering with normal small requests and
  13293. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13294. // response. Skip this check when using Expect: 100-continue, as the protocol
  13295. // handles early responses properly.
  13296. #if defined(_WIN32)
  13297. if (!skip_body &&
  13298. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13299. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13300. auto start = std::chrono::high_resolution_clock::now();
  13301. for (;;) {
  13302. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13303. // from SSL internals. If the underlying socket is readable, assume an
  13304. // early response may be present.
  13305. auto sock = strm.socket();
  13306. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13307. return false;
  13308. }
  13309. // Fallback to stream-level check for non-socket streams or when the
  13310. // socket isn't reporting readable. Avoid using `is_readable()` for
  13311. // SSL, since `SSL_pending()` may report buffered records that do not
  13312. // indicate a complete application-level response yet.
  13313. if (!is_ssl() && strm.is_readable()) { return false; }
  13314. auto now = std::chrono::high_resolution_clock::now();
  13315. auto elapsed =
  13316. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13317. .count();
  13318. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13319. break;
  13320. }
  13321. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13322. }
  13323. }
  13324. #endif
  13325. // Body
  13326. if (skip_body) { return true; }
  13327. return write_request_body(strm, req, error);
  13328. }
  13329. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13330. Error &error) {
  13331. if (req.body.empty()) {
  13332. return write_content_with_provider(strm, req, error);
  13333. }
  13334. if (req.upload_progress) {
  13335. auto body_size = req.body.size();
  13336. size_t written = 0;
  13337. auto data = req.body.data();
  13338. while (written < body_size) {
  13339. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13340. if (!detail::write_data(strm, data + written, to_write)) {
  13341. error = Error::Write;
  13342. output_error_log(error, &req);
  13343. return false;
  13344. }
  13345. written += to_write;
  13346. if (!req.upload_progress(written, body_size)) {
  13347. error = Error::Canceled;
  13348. output_error_log(error, &req);
  13349. return false;
  13350. }
  13351. }
  13352. } else {
  13353. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13354. error = Error::Write;
  13355. output_error_log(error, &req);
  13356. return false;
  13357. }
  13358. }
  13359. return true;
  13360. }
  13361. inline std::unique_ptr<Response>
  13362. ClientImpl::send_with_content_provider_and_receiver(
  13363. Request &req, const char *body, size_t content_length,
  13364. ContentProvider content_provider,
  13365. ContentProviderWithoutLength content_provider_without_length,
  13366. const std::string &content_type, ContentReceiver content_receiver,
  13367. Error &error) {
  13368. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13369. auto enc = compress_
  13370. ? detail::create_compressor()
  13371. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13372. nullptr, nullptr);
  13373. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13374. if (enc.first && !content_provider_without_length) {
  13375. auto &compressor = enc.first;
  13376. if (content_provider) {
  13377. auto ok = true;
  13378. auto finished = false;
  13379. size_t offset = 0;
  13380. DataSink data_sink;
  13381. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13382. if (ok) {
  13383. auto last = offset + data_len == content_length;
  13384. auto ret = compressor->compress(
  13385. data, data_len, last,
  13386. [&](const char *compressed_data, size_t compressed_data_len) {
  13387. req.body.append(compressed_data, compressed_data_len);
  13388. return true;
  13389. });
  13390. if (ret) {
  13391. offset += data_len;
  13392. } else {
  13393. ok = false;
  13394. }
  13395. }
  13396. return ok;
  13397. };
  13398. // As in detail::write_content_with_progress(): the body is framed by
  13399. // content_length, so a provider that finishes early has truncated it.
  13400. // Stop and report that instead of calling the provider forever.
  13401. data_sink.done = [&]() { finished = true; };
  13402. while (ok && !finished && offset < content_length) {
  13403. if (!content_provider(offset, content_length - offset, data_sink)) {
  13404. error = Error::Canceled;
  13405. output_error_log(error, &req);
  13406. return nullptr;
  13407. }
  13408. }
  13409. // A short body here means either the provider stopped early or the
  13410. // compressor gave up. The branch below reports a failing compressor as
  13411. // Error::Compression, so keep the two distinguishable.
  13412. if (offset < content_length) {
  13413. error = ok ? Error::Write : Error::Compression;
  13414. output_error_log(error, &req);
  13415. return nullptr;
  13416. }
  13417. } else {
  13418. if (!compressor->compress(body, content_length, true,
  13419. [&](const char *data, size_t data_len) {
  13420. req.body.append(data, data_len);
  13421. return true;
  13422. })) {
  13423. error = Error::Compression;
  13424. output_error_log(error, &req);
  13425. return nullptr;
  13426. }
  13427. }
  13428. } else {
  13429. if (content_provider) {
  13430. req.content_length_ = content_length;
  13431. req.content_provider_ = std::move(content_provider);
  13432. req.is_chunked_content_provider_ = false;
  13433. } else if (content_provider_without_length) {
  13434. req.content_length_ = 0;
  13435. req.content_provider_ = detail::ContentProviderAdapter(
  13436. std::move(content_provider_without_length));
  13437. req.is_chunked_content_provider_ = true;
  13438. req.set_header("Transfer-Encoding", "chunked");
  13439. } else {
  13440. req.body.assign(body, content_length);
  13441. }
  13442. }
  13443. if (content_receiver) {
  13444. req.content_receiver =
  13445. [content_receiver](const char *data, size_t data_length,
  13446. size_t /*offset*/, size_t /*total_length*/) {
  13447. return content_receiver(data, data_length);
  13448. };
  13449. }
  13450. auto res = detail::make_unique<Response>();
  13451. return send(req, *res, error) ? std::move(res) : nullptr;
  13452. }
  13453. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13454. const std::string &method, const std::string &path, const Headers &headers,
  13455. const char *body, size_t content_length, ContentProvider content_provider,
  13456. ContentProviderWithoutLength content_provider_without_length,
  13457. const std::string &content_type, ContentReceiver content_receiver,
  13458. UploadProgress progress) {
  13459. Request req;
  13460. req.method = method;
  13461. req.headers = headers;
  13462. req.path = path;
  13463. req.upload_progress = std::move(progress);
  13464. if (max_timeout_msec_ > 0) {
  13465. req.start_time_ = std::chrono::steady_clock::now();
  13466. }
  13467. auto error = Error::Success;
  13468. auto res = send_with_content_provider_and_receiver(
  13469. req, body, content_length, std::move(content_provider),
  13470. std::move(content_provider_without_length), content_type,
  13471. std::move(content_receiver), error);
  13472. #ifdef CPPHTTPLIB_SSL_ENABLED
  13473. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13474. last_backend_error_};
  13475. #else
  13476. return Result{std::move(res), error, std::move(req.headers)};
  13477. #endif
  13478. }
  13479. inline void ClientImpl::output_log(const Request &req,
  13480. const Response &res) const {
  13481. if (logger_) {
  13482. std::lock_guard<std::mutex> guard(logger_mutex_);
  13483. logger_(req, res);
  13484. }
  13485. }
  13486. inline void ClientImpl::output_error_log(const Error &err,
  13487. const Request *req) const {
  13488. if (error_logger_) {
  13489. std::lock_guard<std::mutex> guard(logger_mutex_);
  13490. error_logger_(err, req);
  13491. }
  13492. }
  13493. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13494. Response &res, bool close_connection,
  13495. Error &error) {
  13496. // Auto-add Expect: 100-continue for large bodies
  13497. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13498. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13499. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13500. req.set_header("Expect", "100-continue");
  13501. }
  13502. }
  13503. // Check for Expect: 100-continue
  13504. auto expect_100_continue =
  13505. detail::has_header_token(req.headers, "Expect", "100-continue");
  13506. // Send request (skip body if using Expect: 100-continue)
  13507. auto write_request_success =
  13508. write_request(strm, req, close_connection, error, expect_100_continue);
  13509. #ifdef CPPHTTPLIB_SSL_ENABLED
  13510. if (is_ssl() && !expect_100_continue) {
  13511. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13512. if (!is_proxy_enabled) {
  13513. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13514. error = Error::SSLPeerCouldBeClosed_;
  13515. output_error_log(error, &req);
  13516. return false;
  13517. }
  13518. }
  13519. }
  13520. #endif
  13521. // Handle Expect: 100-continue.
  13522. //
  13523. // Wait for an interim/early response by attempting to read the status line
  13524. // under a short timeout, instead of trusting raw socket readability. Over
  13525. // TLS, post-handshake records (e.g. session tickets) make the socket
  13526. // readable without any HTTP response being available; relying on
  13527. // `select_read` there caused the body to be withheld forever and the
  13528. // request to fail with `Read` (#2458). If no status line arrives within the
  13529. // timeout, send the body anyway (matching curl's behavior).
  13530. auto status_line_read = false;
  13531. if (expect_100_continue && write_request_success) {
  13532. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13533. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13534. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13535. strm.set_read_timeout(sec, usec);
  13536. status_line_read = read_response_line(strm, req, res, false);
  13537. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13538. }
  13539. if (!status_line_read) {
  13540. // No interim response within the timeout: send the body and handle the
  13541. // response as usual.
  13542. if (!write_request_body(strm, req, error)) { return false; }
  13543. expect_100_continue = false; // Switch to normal response handling
  13544. }
  13545. }
  13546. // Receive response and headers
  13547. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13548. if ((!status_line_read &&
  13549. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13550. !detail::read_headers(strm, res.headers)) {
  13551. if (write_request_success) { error = Error::Read; }
  13552. output_error_log(error, &req);
  13553. return false;
  13554. }
  13555. if (!write_request_success) { return false; }
  13556. // Handle Expect: 100-continue response
  13557. if (expect_100_continue) {
  13558. if (res.status == StatusCode::Continue_100) {
  13559. // Server accepted, send the body
  13560. if (!write_request_body(strm, req, error)) { return false; }
  13561. // Read the actual response
  13562. res.headers.clear();
  13563. res.body.clear();
  13564. if (!read_response_line(strm, req, res) ||
  13565. !detail::read_headers(strm, res.headers)) {
  13566. error = Error::Read;
  13567. output_error_log(error, &req);
  13568. return false;
  13569. }
  13570. }
  13571. // If not 100 Continue, server returned an error; proceed with that response
  13572. }
  13573. // Body
  13574. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13575. req.method != "CONNECT") {
  13576. auto redirect = 300 < res.status && res.status < 400 &&
  13577. res.status != StatusCode::NotModified_304 &&
  13578. follow_location_;
  13579. if (req.response_handler && !redirect) {
  13580. if (!req.response_handler(res)) {
  13581. error = Error::Canceled;
  13582. output_error_log(error, &req);
  13583. return false;
  13584. }
  13585. }
  13586. auto out =
  13587. req.content_receiver
  13588. ? static_cast<ContentReceiverWithProgress>(
  13589. [&](const char *buf, size_t n, size_t off, size_t len) {
  13590. if (redirect) { return true; }
  13591. auto ret = req.content_receiver(buf, n, off, len);
  13592. if (!ret) {
  13593. error = Error::Canceled;
  13594. output_error_log(error, &req);
  13595. }
  13596. return ret;
  13597. })
  13598. : static_cast<ContentReceiverWithProgress>(
  13599. [&](const char *buf, size_t n, size_t /*off*/,
  13600. size_t /*len*/) {
  13601. assert(res.body.size() + n <= res.body.max_size());
  13602. if (payload_max_length_ > 0 &&
  13603. (res.body.size() >= payload_max_length_ ||
  13604. n > payload_max_length_ - res.body.size())) {
  13605. return false;
  13606. }
  13607. res.body.append(buf, n);
  13608. return true;
  13609. });
  13610. auto progress = [&](size_t current, size_t total) {
  13611. if (!req.download_progress || redirect) { return true; }
  13612. auto ret = req.download_progress(current, total);
  13613. if (!ret) {
  13614. error = Error::Canceled;
  13615. output_error_log(error, &req);
  13616. }
  13617. return ret;
  13618. };
  13619. if (res.has_header("Content-Length")) {
  13620. if (!req.content_receiver) {
  13621. auto len = res.get_header_value_u64("Content-Length");
  13622. if (len > res.body.max_size()) {
  13623. error = Error::Read;
  13624. output_error_log(error, &req);
  13625. return false;
  13626. }
  13627. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13628. // hostile or malformed server sends an enormous Content-Length.
  13629. // The actual body read below is bounded by payload_max_length_,
  13630. // so reserving more than that is never useful.
  13631. auto reserve_len = static_cast<size_t>(len);
  13632. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13633. reserve_len = payload_max_length_;
  13634. }
  13635. res.body.reserve(reserve_len);
  13636. }
  13637. }
  13638. if (res.status != StatusCode::NotModified_304) {
  13639. auto content_status = 0;
  13640. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13641. ? (std::numeric_limits<size_t>::max)()
  13642. : payload_max_length_;
  13643. if (!detail::read_content(strm, res, max_length, content_status,
  13644. std::move(progress), std::move(out),
  13645. decompress_)) {
  13646. if (error != Error::Canceled) {
  13647. // Tell the caller apart from a plain read failure when the body could
  13648. // not be decoded because of its Content-Encoding.
  13649. switch (content_status) {
  13650. case StatusCode::UnsupportedMediaType_415:
  13651. error = Error::UnsupportedContentEncoding;
  13652. break;
  13653. case StatusCode::InternalServerError_500:
  13654. error = Error::Compression;
  13655. break;
  13656. default: error = Error::Read; break;
  13657. }
  13658. }
  13659. output_error_log(error, &req);
  13660. return false;
  13661. }
  13662. }
  13663. }
  13664. // Log
  13665. output_log(req, res);
  13666. return true;
  13667. }
  13668. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13669. const std::string &boundary, const UploadFormDataItems &items,
  13670. const FormDataProviderItems &provider_items) const {
  13671. size_t cur_item = 0;
  13672. size_t cur_start = 0;
  13673. // cur_item and cur_start are copied to within the std::function and
  13674. // maintain state between successive calls
  13675. return [&, cur_item, cur_start](size_t offset,
  13676. DataSink &sink) mutable -> bool {
  13677. if (!offset && !items.empty()) {
  13678. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13679. return true;
  13680. } else if (cur_item < provider_items.size()) {
  13681. if (!cur_start) {
  13682. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13683. provider_items[cur_item], boundary);
  13684. offset += begin.size();
  13685. cur_start = offset;
  13686. sink.os << begin;
  13687. }
  13688. DataSink cur_sink;
  13689. auto has_data = true;
  13690. cur_sink.write = sink.write;
  13691. // Forward is_writable so a provider item asking whether it may keep
  13692. // going gets the outer sink's answer rather than the default `true`.
  13693. cur_sink.is_writable = sink.is_writable;
  13694. cur_sink.done = [&]() { has_data = false; };
  13695. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13696. return false;
  13697. }
  13698. if (!has_data) {
  13699. sink.os << detail::serialize_multipart_formdata_item_end();
  13700. cur_item++;
  13701. cur_start = 0;
  13702. }
  13703. return true;
  13704. } else {
  13705. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13706. sink.done();
  13707. return true;
  13708. }
  13709. };
  13710. }
  13711. inline bool ClientImpl::process_socket(
  13712. const Socket &socket,
  13713. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13714. std::function<bool(Stream &strm)> callback) {
  13715. return detail::process_client_socket(
  13716. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13717. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13718. }
  13719. inline bool ClientImpl::is_ssl() const { return false; }
  13720. inline Result ClientImpl::Get(const std::string &path,
  13721. DownloadProgress progress) {
  13722. return Get(path, Headers(), std::move(progress));
  13723. }
  13724. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13725. DownloadProgress progress) {
  13726. return Get(path, params, Headers(), std::move(progress));
  13727. }
  13728. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13729. const Headers &headers,
  13730. DownloadProgress progress) {
  13731. if (params.empty()) { return Get(path, headers); }
  13732. std::string path_with_query = append_query_params(path, params);
  13733. return Get(path_with_query, headers, std::move(progress));
  13734. }
  13735. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13736. DownloadProgress progress) {
  13737. Request req;
  13738. req.method = "GET";
  13739. req.path = path;
  13740. req.headers = headers;
  13741. req.download_progress = std::move(progress);
  13742. if (max_timeout_msec_ > 0) {
  13743. req.start_time_ = std::chrono::steady_clock::now();
  13744. }
  13745. return send_(std::move(req));
  13746. }
  13747. inline Result ClientImpl::Get(const std::string &path,
  13748. ContentReceiver content_receiver,
  13749. DownloadProgress progress) {
  13750. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13751. std::move(progress));
  13752. }
  13753. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13754. ContentReceiver content_receiver,
  13755. DownloadProgress progress) {
  13756. return Get(path, headers, nullptr, std::move(content_receiver),
  13757. std::move(progress));
  13758. }
  13759. inline Result ClientImpl::Get(const std::string &path,
  13760. ResponseHandler response_handler,
  13761. ContentReceiver content_receiver,
  13762. DownloadProgress progress) {
  13763. return Get(path, Headers(), std::move(response_handler),
  13764. std::move(content_receiver), std::move(progress));
  13765. }
  13766. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13767. ResponseHandler response_handler,
  13768. ContentReceiver content_receiver,
  13769. DownloadProgress progress) {
  13770. Request req;
  13771. req.method = "GET";
  13772. req.path = path;
  13773. req.headers = headers;
  13774. req.response_handler = std::move(response_handler);
  13775. req.content_receiver =
  13776. [content_receiver](const char *data, size_t data_length,
  13777. size_t /*offset*/, size_t /*total_length*/) {
  13778. return content_receiver(data, data_length);
  13779. };
  13780. req.download_progress = std::move(progress);
  13781. if (max_timeout_msec_ > 0) {
  13782. req.start_time_ = std::chrono::steady_clock::now();
  13783. }
  13784. return send_(std::move(req));
  13785. }
  13786. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13787. const Headers &headers,
  13788. ContentReceiver content_receiver,
  13789. DownloadProgress progress) {
  13790. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13791. std::move(progress));
  13792. }
  13793. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13794. const Headers &headers,
  13795. ResponseHandler response_handler,
  13796. ContentReceiver content_receiver,
  13797. DownloadProgress progress) {
  13798. if (params.empty()) {
  13799. return Get(path, headers, std::move(response_handler),
  13800. std::move(content_receiver), std::move(progress));
  13801. }
  13802. std::string path_with_query = append_query_params(path, params);
  13803. return Get(path_with_query, headers, std::move(response_handler),
  13804. std::move(content_receiver), std::move(progress));
  13805. }
  13806. inline Result ClientImpl::Head(const std::string &path) {
  13807. return Head(path, Headers());
  13808. }
  13809. inline Result ClientImpl::Head(const std::string &path,
  13810. const Headers &headers) {
  13811. Request req;
  13812. req.method = "HEAD";
  13813. req.headers = headers;
  13814. req.path = path;
  13815. if (max_timeout_msec_ > 0) {
  13816. req.start_time_ = std::chrono::steady_clock::now();
  13817. }
  13818. return send_(std::move(req));
  13819. }
  13820. inline Result ClientImpl::Post(const std::string &path) {
  13821. return Post(path, std::string(), std::string());
  13822. }
  13823. inline Result ClientImpl::Post(const std::string &path,
  13824. const Headers &headers) {
  13825. return Post(path, headers, nullptr, 0, std::string());
  13826. }
  13827. inline Result ClientImpl::Post(const std::string &path, const char *body,
  13828. size_t content_length,
  13829. const std::string &content_type,
  13830. UploadProgress progress) {
  13831. return Post(path, Headers(), body, content_length, content_type, progress);
  13832. }
  13833. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  13834. const std::string &content_type,
  13835. UploadProgress progress) {
  13836. return Post(path, Headers(), body, content_type, progress);
  13837. }
  13838. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  13839. return Post(path, Headers(), params);
  13840. }
  13841. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13842. ContentProvider content_provider,
  13843. const std::string &content_type,
  13844. UploadProgress progress) {
  13845. return Post(path, Headers(), content_length, std::move(content_provider),
  13846. content_type, progress);
  13847. }
  13848. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13849. ContentProvider content_provider,
  13850. const std::string &content_type,
  13851. ContentReceiver content_receiver,
  13852. UploadProgress progress) {
  13853. return Post(path, Headers(), content_length, std::move(content_provider),
  13854. content_type, std::move(content_receiver), progress);
  13855. }
  13856. inline Result ClientImpl::Post(const std::string &path,
  13857. ContentProviderWithoutLength content_provider,
  13858. const std::string &content_type,
  13859. UploadProgress progress) {
  13860. return Post(path, Headers(), std::move(content_provider), content_type,
  13861. progress);
  13862. }
  13863. inline Result ClientImpl::Post(const std::string &path,
  13864. ContentProviderWithoutLength content_provider,
  13865. const std::string &content_type,
  13866. ContentReceiver content_receiver,
  13867. UploadProgress progress) {
  13868. return Post(path, Headers(), std::move(content_provider), content_type,
  13869. std::move(content_receiver), progress);
  13870. }
  13871. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13872. const Params &params) {
  13873. auto query = detail::params_to_query_str(params);
  13874. return Post(path, headers, query, "application/x-www-form-urlencoded");
  13875. }
  13876. inline Result ClientImpl::Post(const std::string &path,
  13877. const UploadFormDataItems &items,
  13878. UploadProgress progress) {
  13879. return Post(path, Headers(), items, progress);
  13880. }
  13881. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13882. const UploadFormDataItems &items,
  13883. UploadProgress progress) {
  13884. const auto &boundary = detail::make_multipart_data_boundary();
  13885. const auto &content_type =
  13886. detail::serialize_multipart_formdata_get_content_type(boundary);
  13887. auto content_length = detail::get_multipart_content_length(items, boundary);
  13888. return Post(path, headers, content_length,
  13889. detail::make_multipart_content_provider(items, boundary),
  13890. content_type, progress);
  13891. }
  13892. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13893. const UploadFormDataItems &items,
  13894. const std::string &boundary,
  13895. UploadProgress progress) {
  13896. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13897. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13898. }
  13899. const auto &content_type =
  13900. detail::serialize_multipart_formdata_get_content_type(boundary);
  13901. auto content_length = detail::get_multipart_content_length(items, boundary);
  13902. return Post(path, headers, content_length,
  13903. detail::make_multipart_content_provider(items, boundary),
  13904. content_type, progress);
  13905. }
  13906. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13907. const char *body, size_t content_length,
  13908. const std::string &content_type,
  13909. UploadProgress progress) {
  13910. return send_with_content_provider_and_receiver(
  13911. "POST", path, headers, body, content_length, nullptr, nullptr,
  13912. content_type, nullptr, progress);
  13913. }
  13914. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13915. const std::string &body,
  13916. const std::string &content_type,
  13917. UploadProgress progress) {
  13918. return send_with_content_provider_and_receiver(
  13919. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  13920. content_type, nullptr, progress);
  13921. }
  13922. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13923. size_t content_length,
  13924. ContentProvider content_provider,
  13925. const std::string &content_type,
  13926. UploadProgress progress) {
  13927. return send_with_content_provider_and_receiver(
  13928. "POST", path, headers, nullptr, content_length,
  13929. std::move(content_provider), nullptr, content_type, nullptr, progress);
  13930. }
  13931. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13932. size_t content_length,
  13933. ContentProvider content_provider,
  13934. const std::string &content_type,
  13935. ContentReceiver content_receiver,
  13936. DownloadProgress progress) {
  13937. return send_with_content_provider_and_receiver(
  13938. "POST", path, headers, nullptr, content_length,
  13939. std::move(content_provider), nullptr, content_type,
  13940. std::move(content_receiver), std::move(progress));
  13941. }
  13942. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13943. ContentProviderWithoutLength content_provider,
  13944. const std::string &content_type,
  13945. UploadProgress progress) {
  13946. return send_with_content_provider_and_receiver(
  13947. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13948. content_type, nullptr, progress);
  13949. }
  13950. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13951. ContentProviderWithoutLength content_provider,
  13952. const std::string &content_type,
  13953. ContentReceiver content_receiver,
  13954. DownloadProgress progress) {
  13955. return send_with_content_provider_and_receiver(
  13956. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13957. content_type, std::move(content_receiver), std::move(progress));
  13958. }
  13959. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13960. const UploadFormDataItems &items,
  13961. const FormDataProviderItems &provider_items,
  13962. UploadProgress progress) {
  13963. const auto &boundary = detail::make_multipart_data_boundary();
  13964. const auto &content_type =
  13965. detail::serialize_multipart_formdata_get_content_type(boundary);
  13966. return send_with_content_provider_and_receiver(
  13967. "POST", path, headers, nullptr, 0, nullptr,
  13968. get_multipart_content_provider(boundary, items, provider_items),
  13969. content_type, nullptr, progress);
  13970. }
  13971. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13972. const std::string &body,
  13973. const std::string &content_type,
  13974. ContentReceiver content_receiver,
  13975. DownloadProgress progress) {
  13976. Request req;
  13977. req.method = "POST";
  13978. req.path = path;
  13979. req.headers = headers;
  13980. req.body = body;
  13981. req.content_receiver =
  13982. [content_receiver](const char *data, size_t data_length,
  13983. size_t /*offset*/, size_t /*total_length*/) {
  13984. return content_receiver(data, data_length);
  13985. };
  13986. req.download_progress = std::move(progress);
  13987. if (max_timeout_msec_ > 0) {
  13988. req.start_time_ = std::chrono::steady_clock::now();
  13989. }
  13990. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13991. return send_(std::move(req));
  13992. }
  13993. inline Result ClientImpl::Put(const std::string &path) {
  13994. return Put(path, std::string(), std::string());
  13995. }
  13996. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  13997. return Put(path, headers, nullptr, 0, std::string());
  13998. }
  13999. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14000. size_t content_length,
  14001. const std::string &content_type,
  14002. UploadProgress progress) {
  14003. return Put(path, Headers(), body, content_length, content_type, progress);
  14004. }
  14005. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14006. const std::string &content_type,
  14007. UploadProgress progress) {
  14008. return Put(path, Headers(), body, content_type, progress);
  14009. }
  14010. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14011. return Put(path, Headers(), params);
  14012. }
  14013. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14014. ContentProvider content_provider,
  14015. const std::string &content_type,
  14016. UploadProgress progress) {
  14017. return Put(path, Headers(), content_length, std::move(content_provider),
  14018. content_type, progress);
  14019. }
  14020. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14021. ContentProvider content_provider,
  14022. const std::string &content_type,
  14023. ContentReceiver content_receiver,
  14024. UploadProgress progress) {
  14025. return Put(path, Headers(), content_length, std::move(content_provider),
  14026. content_type, std::move(content_receiver), progress);
  14027. }
  14028. inline Result ClientImpl::Put(const std::string &path,
  14029. ContentProviderWithoutLength content_provider,
  14030. const std::string &content_type,
  14031. UploadProgress progress) {
  14032. return Put(path, Headers(), std::move(content_provider), content_type,
  14033. progress);
  14034. }
  14035. inline Result ClientImpl::Put(const std::string &path,
  14036. ContentProviderWithoutLength content_provider,
  14037. const std::string &content_type,
  14038. ContentReceiver content_receiver,
  14039. UploadProgress progress) {
  14040. return Put(path, Headers(), std::move(content_provider), content_type,
  14041. std::move(content_receiver), progress);
  14042. }
  14043. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14044. const Params &params) {
  14045. auto query = detail::params_to_query_str(params);
  14046. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14047. }
  14048. inline Result ClientImpl::Put(const std::string &path,
  14049. const UploadFormDataItems &items,
  14050. UploadProgress progress) {
  14051. return Put(path, Headers(), items, progress);
  14052. }
  14053. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14054. const UploadFormDataItems &items,
  14055. UploadProgress progress) {
  14056. const auto &boundary = detail::make_multipart_data_boundary();
  14057. const auto &content_type =
  14058. detail::serialize_multipart_formdata_get_content_type(boundary);
  14059. auto content_length = detail::get_multipart_content_length(items, boundary);
  14060. return Put(path, headers, content_length,
  14061. detail::make_multipart_content_provider(items, boundary),
  14062. content_type, progress);
  14063. }
  14064. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14065. const UploadFormDataItems &items,
  14066. const std::string &boundary,
  14067. UploadProgress progress) {
  14068. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14069. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14070. }
  14071. const auto &content_type =
  14072. detail::serialize_multipart_formdata_get_content_type(boundary);
  14073. auto content_length = detail::get_multipart_content_length(items, boundary);
  14074. return Put(path, headers, content_length,
  14075. detail::make_multipart_content_provider(items, boundary),
  14076. content_type, progress);
  14077. }
  14078. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14079. const char *body, size_t content_length,
  14080. const std::string &content_type,
  14081. UploadProgress progress) {
  14082. return send_with_content_provider_and_receiver(
  14083. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14084. content_type, nullptr, progress);
  14085. }
  14086. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14087. const std::string &body,
  14088. const std::string &content_type,
  14089. UploadProgress progress) {
  14090. return send_with_content_provider_and_receiver(
  14091. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14092. content_type, nullptr, progress);
  14093. }
  14094. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14095. size_t content_length,
  14096. ContentProvider content_provider,
  14097. const std::string &content_type,
  14098. UploadProgress progress) {
  14099. return send_with_content_provider_and_receiver(
  14100. "PUT", path, headers, nullptr, content_length,
  14101. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14102. }
  14103. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14104. size_t content_length,
  14105. ContentProvider content_provider,
  14106. const std::string &content_type,
  14107. ContentReceiver content_receiver,
  14108. UploadProgress progress) {
  14109. return send_with_content_provider_and_receiver(
  14110. "PUT", path, headers, nullptr, content_length,
  14111. std::move(content_provider), nullptr, content_type,
  14112. std::move(content_receiver), progress);
  14113. }
  14114. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14115. ContentProviderWithoutLength content_provider,
  14116. const std::string &content_type,
  14117. UploadProgress progress) {
  14118. return send_with_content_provider_and_receiver(
  14119. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14120. content_type, nullptr, progress);
  14121. }
  14122. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14123. ContentProviderWithoutLength content_provider,
  14124. const std::string &content_type,
  14125. ContentReceiver content_receiver,
  14126. UploadProgress progress) {
  14127. return send_with_content_provider_and_receiver(
  14128. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14129. content_type, std::move(content_receiver), progress);
  14130. }
  14131. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14132. const UploadFormDataItems &items,
  14133. const FormDataProviderItems &provider_items,
  14134. UploadProgress progress) {
  14135. const auto &boundary = detail::make_multipart_data_boundary();
  14136. const auto &content_type =
  14137. detail::serialize_multipart_formdata_get_content_type(boundary);
  14138. return send_with_content_provider_and_receiver(
  14139. "PUT", path, headers, nullptr, 0, nullptr,
  14140. get_multipart_content_provider(boundary, items, provider_items),
  14141. content_type, nullptr, progress);
  14142. }
  14143. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14144. const std::string &body,
  14145. const std::string &content_type,
  14146. ContentReceiver content_receiver,
  14147. DownloadProgress progress) {
  14148. Request req;
  14149. req.method = "PUT";
  14150. req.path = path;
  14151. req.headers = headers;
  14152. req.body = body;
  14153. req.content_receiver =
  14154. [content_receiver](const char *data, size_t data_length,
  14155. size_t /*offset*/, size_t /*total_length*/) {
  14156. return content_receiver(data, data_length);
  14157. };
  14158. req.download_progress = std::move(progress);
  14159. if (max_timeout_msec_ > 0) {
  14160. req.start_time_ = std::chrono::steady_clock::now();
  14161. }
  14162. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14163. return send_(std::move(req));
  14164. }
  14165. inline Result ClientImpl::Patch(const std::string &path) {
  14166. return Patch(path, std::string(), std::string());
  14167. }
  14168. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14169. UploadProgress progress) {
  14170. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14171. }
  14172. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14173. size_t content_length,
  14174. const std::string &content_type,
  14175. UploadProgress progress) {
  14176. return Patch(path, Headers(), body, content_length, content_type, progress);
  14177. }
  14178. inline Result ClientImpl::Patch(const std::string &path,
  14179. const std::string &body,
  14180. const std::string &content_type,
  14181. UploadProgress progress) {
  14182. return Patch(path, Headers(), body, content_type, progress);
  14183. }
  14184. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14185. return Patch(path, Headers(), params);
  14186. }
  14187. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14188. ContentProvider content_provider,
  14189. const std::string &content_type,
  14190. UploadProgress progress) {
  14191. return Patch(path, Headers(), content_length, std::move(content_provider),
  14192. content_type, progress);
  14193. }
  14194. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14195. ContentProvider content_provider,
  14196. const std::string &content_type,
  14197. ContentReceiver content_receiver,
  14198. UploadProgress progress) {
  14199. return Patch(path, Headers(), content_length, std::move(content_provider),
  14200. content_type, std::move(content_receiver), progress);
  14201. }
  14202. inline Result ClientImpl::Patch(const std::string &path,
  14203. ContentProviderWithoutLength content_provider,
  14204. const std::string &content_type,
  14205. UploadProgress progress) {
  14206. return Patch(path, Headers(), std::move(content_provider), content_type,
  14207. progress);
  14208. }
  14209. inline Result ClientImpl::Patch(const std::string &path,
  14210. ContentProviderWithoutLength content_provider,
  14211. const std::string &content_type,
  14212. ContentReceiver content_receiver,
  14213. UploadProgress progress) {
  14214. return Patch(path, Headers(), std::move(content_provider), content_type,
  14215. std::move(content_receiver), progress);
  14216. }
  14217. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14218. const Params &params) {
  14219. auto query = detail::params_to_query_str(params);
  14220. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14221. }
  14222. inline Result ClientImpl::Patch(const std::string &path,
  14223. const UploadFormDataItems &items,
  14224. UploadProgress progress) {
  14225. return Patch(path, Headers(), items, progress);
  14226. }
  14227. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14228. const UploadFormDataItems &items,
  14229. UploadProgress progress) {
  14230. const auto &boundary = detail::make_multipart_data_boundary();
  14231. const auto &content_type =
  14232. detail::serialize_multipart_formdata_get_content_type(boundary);
  14233. auto content_length = detail::get_multipart_content_length(items, boundary);
  14234. return Patch(path, headers, content_length,
  14235. detail::make_multipart_content_provider(items, boundary),
  14236. content_type, progress);
  14237. }
  14238. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14239. const UploadFormDataItems &items,
  14240. const std::string &boundary,
  14241. UploadProgress progress) {
  14242. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14243. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14244. }
  14245. const auto &content_type =
  14246. detail::serialize_multipart_formdata_get_content_type(boundary);
  14247. auto content_length = detail::get_multipart_content_length(items, boundary);
  14248. return Patch(path, headers, content_length,
  14249. detail::make_multipart_content_provider(items, boundary),
  14250. content_type, progress);
  14251. }
  14252. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14253. const char *body, size_t content_length,
  14254. const std::string &content_type,
  14255. UploadProgress progress) {
  14256. return send_with_content_provider_and_receiver(
  14257. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14258. content_type, nullptr, progress);
  14259. }
  14260. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14261. const std::string &body,
  14262. const std::string &content_type,
  14263. UploadProgress progress) {
  14264. return send_with_content_provider_and_receiver(
  14265. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14266. content_type, nullptr, progress);
  14267. }
  14268. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14269. size_t content_length,
  14270. ContentProvider content_provider,
  14271. const std::string &content_type,
  14272. UploadProgress progress) {
  14273. return send_with_content_provider_and_receiver(
  14274. "PATCH", path, headers, nullptr, content_length,
  14275. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14276. }
  14277. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14278. size_t content_length,
  14279. ContentProvider content_provider,
  14280. const std::string &content_type,
  14281. ContentReceiver content_receiver,
  14282. UploadProgress progress) {
  14283. return send_with_content_provider_and_receiver(
  14284. "PATCH", path, headers, nullptr, content_length,
  14285. std::move(content_provider), nullptr, content_type,
  14286. std::move(content_receiver), progress);
  14287. }
  14288. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14289. ContentProviderWithoutLength content_provider,
  14290. const std::string &content_type,
  14291. UploadProgress progress) {
  14292. return send_with_content_provider_and_receiver(
  14293. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14294. content_type, nullptr, progress);
  14295. }
  14296. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14297. ContentProviderWithoutLength content_provider,
  14298. const std::string &content_type,
  14299. ContentReceiver content_receiver,
  14300. UploadProgress progress) {
  14301. return send_with_content_provider_and_receiver(
  14302. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14303. content_type, std::move(content_receiver), progress);
  14304. }
  14305. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14306. const UploadFormDataItems &items,
  14307. const FormDataProviderItems &provider_items,
  14308. UploadProgress progress) {
  14309. const auto &boundary = detail::make_multipart_data_boundary();
  14310. const auto &content_type =
  14311. detail::serialize_multipart_formdata_get_content_type(boundary);
  14312. return send_with_content_provider_and_receiver(
  14313. "PATCH", path, headers, nullptr, 0, nullptr,
  14314. get_multipart_content_provider(boundary, items, provider_items),
  14315. content_type, nullptr, progress);
  14316. }
  14317. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14318. const std::string &body,
  14319. const std::string &content_type,
  14320. ContentReceiver content_receiver,
  14321. DownloadProgress progress) {
  14322. Request req;
  14323. req.method = "PATCH";
  14324. req.path = path;
  14325. req.headers = headers;
  14326. req.body = body;
  14327. req.content_receiver =
  14328. [content_receiver](const char *data, size_t data_length,
  14329. size_t /*offset*/, size_t /*total_length*/) {
  14330. return content_receiver(data, data_length);
  14331. };
  14332. req.download_progress = std::move(progress);
  14333. if (max_timeout_msec_ > 0) {
  14334. req.start_time_ = std::chrono::steady_clock::now();
  14335. }
  14336. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14337. return send_(std::move(req));
  14338. }
  14339. inline Result ClientImpl::Delete(const std::string &path,
  14340. DownloadProgress progress) {
  14341. return Delete(path, Headers(), std::string(), std::string(), progress);
  14342. }
  14343. inline Result ClientImpl::Delete(const std::string &path,
  14344. const Headers &headers,
  14345. DownloadProgress progress) {
  14346. return Delete(path, headers, std::string(), std::string(), progress);
  14347. }
  14348. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14349. size_t content_length,
  14350. const std::string &content_type,
  14351. DownloadProgress progress) {
  14352. return Delete(path, Headers(), body, content_length, content_type, progress);
  14353. }
  14354. inline Result ClientImpl::Delete(const std::string &path,
  14355. const std::string &body,
  14356. const std::string &content_type,
  14357. DownloadProgress progress) {
  14358. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14359. progress);
  14360. }
  14361. inline Result ClientImpl::Delete(const std::string &path,
  14362. const Headers &headers,
  14363. const std::string &body,
  14364. const std::string &content_type,
  14365. DownloadProgress progress) {
  14366. return Delete(path, headers, body.data(), body.size(), content_type,
  14367. progress);
  14368. }
  14369. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14370. DownloadProgress progress) {
  14371. return Delete(path, Headers(), params, progress);
  14372. }
  14373. inline Result ClientImpl::Delete(const std::string &path,
  14374. const Headers &headers, const Params &params,
  14375. DownloadProgress progress) {
  14376. auto query = detail::params_to_query_str(params);
  14377. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14378. progress);
  14379. }
  14380. inline Result ClientImpl::Delete(const std::string &path,
  14381. const Headers &headers, const char *body,
  14382. size_t content_length,
  14383. const std::string &content_type,
  14384. DownloadProgress progress) {
  14385. Request req;
  14386. req.method = "DELETE";
  14387. req.headers = headers;
  14388. req.path = path;
  14389. req.download_progress = std::move(progress);
  14390. if (max_timeout_msec_ > 0) {
  14391. req.start_time_ = std::chrono::steady_clock::now();
  14392. }
  14393. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14394. req.body.assign(body, content_length);
  14395. return send_(std::move(req));
  14396. }
  14397. inline Result ClientImpl::Options(const std::string &path) {
  14398. return Options(path, Headers());
  14399. }
  14400. inline Result ClientImpl::Options(const std::string &path,
  14401. const Headers &headers) {
  14402. Request req;
  14403. req.method = "OPTIONS";
  14404. req.headers = headers;
  14405. req.path = path;
  14406. if (max_timeout_msec_ > 0) {
  14407. req.start_time_ = std::chrono::steady_clock::now();
  14408. }
  14409. return send_(std::move(req));
  14410. }
  14411. inline void ClientImpl::stop() {
  14412. std::lock_guard<std::mutex> guard(socket_mutex_);
  14413. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14414. // do is to shutdown_socket, so that threads using this socket suddenly
  14415. // discover they can't read/write any more and error out. Everything else
  14416. // (closing the socket, shutting ssl down) is unsafe because these actions
  14417. // are not thread-safe.
  14418. if (socket_requests_in_flight_ > 0) {
  14419. shutdown_socket(socket_);
  14420. // Aside from that, we set a flag for the socket to be closed when we're
  14421. // done.
  14422. socket_should_be_closed_when_request_is_done_ = true;
  14423. return;
  14424. }
  14425. disconnect(/*gracefully=*/true);
  14426. }
  14427. inline std::string ClientImpl::host() const { return host_; }
  14428. inline int ClientImpl::port() const { return port_; }
  14429. inline size_t ClientImpl::is_socket_open() const {
  14430. std::lock_guard<std::mutex> guard(socket_mutex_);
  14431. return socket_.is_open();
  14432. }
  14433. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14434. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14435. connection_timeout_sec_ = sec;
  14436. connection_timeout_usec_ = usec;
  14437. }
  14438. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14439. read_timeout_sec_ = sec;
  14440. read_timeout_usec_ = usec;
  14441. }
  14442. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14443. write_timeout_sec_ = sec;
  14444. write_timeout_usec_ = usec;
  14445. }
  14446. inline void ClientImpl::set_max_timeout(time_t msec) {
  14447. max_timeout_msec_ = msec;
  14448. }
  14449. inline void ClientImpl::set_basic_auth(const std::string &username,
  14450. const std::string &password) {
  14451. basic_auth_username_ = username;
  14452. basic_auth_password_ = password;
  14453. }
  14454. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14455. bearer_token_auth_token_ = token;
  14456. }
  14457. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14458. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14459. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14460. inline void
  14461. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14462. addr_map_ = std::move(addr_map);
  14463. }
  14464. inline void ClientImpl::set_default_headers(Headers headers) {
  14465. default_headers_ = std::move(headers);
  14466. }
  14467. inline void ClientImpl::set_header_writer(
  14468. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14469. header_writer_ = writer;
  14470. }
  14471. inline void ClientImpl::set_address_family(int family) {
  14472. address_family_ = family;
  14473. }
  14474. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14475. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14476. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14477. socket_options_ = std::move(socket_options);
  14478. }
  14479. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14480. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14481. inline void ClientImpl::set_payload_max_length(size_t length) {
  14482. payload_max_length_ = length;
  14483. has_payload_max_length_ = true;
  14484. }
  14485. inline void ClientImpl::set_interface(const std::string &intf) {
  14486. interface_ = intf;
  14487. }
  14488. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14489. proxy_host_ = host;
  14490. proxy_port_ = port;
  14491. std::lock_guard<std::mutex> guard(socket_mutex_);
  14492. disconnect(/*gracefully=*/true);
  14493. }
  14494. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14495. const std::string &password) {
  14496. proxy_basic_auth_username_ = username;
  14497. proxy_basic_auth_password_ = password;
  14498. }
  14499. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14500. proxy_bearer_token_auth_token_ = token;
  14501. }
  14502. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14503. std::vector<detail::NoProxyEntry> parsed;
  14504. parsed.reserve(patterns.size());
  14505. for (const auto &p : patterns) {
  14506. auto trimmed = detail::trim_copy(p);
  14507. if (trimmed.empty()) { continue; }
  14508. detail::NoProxyEntry entry;
  14509. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14510. parsed.push_back(std::move(entry));
  14511. }
  14512. }
  14513. no_proxy_entries_ = std::move(parsed);
  14514. std::lock_guard<std::mutex> guard(socket_mutex_);
  14515. disconnect(/*gracefully=*/true);
  14516. }
  14517. #ifdef CPPHTTPLIB_SSL_ENABLED
  14518. inline void ClientImpl::set_digest_auth(const std::string &username,
  14519. const std::string &password) {
  14520. digest_auth_username_ = username;
  14521. digest_auth_password_ = password;
  14522. }
  14523. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14524. const std::string &ca_cert_dir_path) {
  14525. ca_cert_file_path_ = ca_cert_file_path;
  14526. ca_cert_dir_path_ = ca_cert_dir_path;
  14527. }
  14528. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14529. const std::string &password) {
  14530. proxy_digest_auth_username_ = username;
  14531. proxy_digest_auth_password_ = password;
  14532. }
  14533. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14534. server_certificate_verification_ = enabled;
  14535. }
  14536. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14537. server_hostname_verification_ = enabled;
  14538. }
  14539. inline void ClientImpl::enable_system_ca(bool enabled) {
  14540. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14541. }
  14542. #endif
  14543. inline void ClientImpl::set_logger(Logger logger) {
  14544. logger_ = std::move(logger);
  14545. }
  14546. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14547. error_logger_ = std::move(error_logger);
  14548. }
  14549. /*
  14550. * SSL/TLS Common Implementation
  14551. */
  14552. inline ClientConnection::~ClientConnection() {
  14553. #ifdef CPPHTTPLIB_SSL_ENABLED
  14554. if (session) {
  14555. tls::shutdown(session, true);
  14556. tls::free_session(session);
  14557. session = nullptr;
  14558. }
  14559. #endif
  14560. if (sock != INVALID_SOCKET) {
  14561. detail::close_socket(sock);
  14562. sock = INVALID_SOCKET;
  14563. }
  14564. }
  14565. // Universal client implementation
  14566. inline Client::Client(const std::string &scheme_host_port)
  14567. : Client(scheme_host_port, std::string(), std::string()) {}
  14568. inline Client::Client(const std::string &scheme_host_port,
  14569. const std::string &client_cert_path,
  14570. const std::string &client_key_path) {
  14571. detail::UrlComponents uc;
  14572. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14573. auto &scheme = uc.scheme;
  14574. #ifdef CPPHTTPLIB_SSL_ENABLED
  14575. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14576. #else
  14577. if (!scheme.empty() && scheme != "http") {
  14578. #endif
  14579. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14580. std::string msg = "'" + scheme + "' scheme is not supported.";
  14581. throw std::invalid_argument(msg);
  14582. #endif
  14583. return;
  14584. }
  14585. auto is_ssl = scheme == "https";
  14586. auto host = std::move(uc.host);
  14587. auto port = is_ssl ? 443 : 80;
  14588. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14589. if (is_ssl) {
  14590. #ifdef CPPHTTPLIB_SSL_ENABLED
  14591. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14592. client_key_path);
  14593. is_ssl_ = is_ssl;
  14594. #endif
  14595. } else {
  14596. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14597. client_key_path);
  14598. }
  14599. } else {
  14600. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14601. // if port param below changes.
  14602. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14603. client_cert_path, client_key_path);
  14604. }
  14605. }
  14606. inline Client::Client(const std::string &host, int port)
  14607. : Client(host, port, std::string(), std::string()) {}
  14608. inline Client::Client(const std::string &host, int port,
  14609. const std::string &client_cert_path,
  14610. const std::string &client_key_path)
  14611. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14612. client_key_path)) {}
  14613. inline Client::~Client() = default;
  14614. inline bool Client::is_valid() const {
  14615. return cli_ != nullptr && cli_->is_valid();
  14616. }
  14617. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14618. return cli_->Get(path, std::move(progress));
  14619. }
  14620. inline Result Client::Get(const std::string &path, const Headers &headers,
  14621. DownloadProgress progress) {
  14622. return cli_->Get(path, headers, std::move(progress));
  14623. }
  14624. inline Result Client::Get(const std::string &path,
  14625. ContentReceiver content_receiver,
  14626. DownloadProgress progress) {
  14627. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14628. }
  14629. inline Result Client::Get(const std::string &path, const Headers &headers,
  14630. ContentReceiver content_receiver,
  14631. DownloadProgress progress) {
  14632. return cli_->Get(path, headers, std::move(content_receiver),
  14633. std::move(progress));
  14634. }
  14635. inline Result Client::Get(const std::string &path,
  14636. ResponseHandler response_handler,
  14637. ContentReceiver content_receiver,
  14638. DownloadProgress progress) {
  14639. return cli_->Get(path, std::move(response_handler),
  14640. std::move(content_receiver), std::move(progress));
  14641. }
  14642. inline Result Client::Get(const std::string &path, const Headers &headers,
  14643. ResponseHandler response_handler,
  14644. ContentReceiver content_receiver,
  14645. DownloadProgress progress) {
  14646. return cli_->Get(path, headers, std::move(response_handler),
  14647. std::move(content_receiver), std::move(progress));
  14648. }
  14649. inline Result Client::Get(const std::string &path, const Params &params,
  14650. DownloadProgress progress) {
  14651. return cli_->Get(path, params, std::move(progress));
  14652. }
  14653. inline Result Client::Get(const std::string &path, const Params &params,
  14654. const Headers &headers, DownloadProgress progress) {
  14655. return cli_->Get(path, params, headers, std::move(progress));
  14656. }
  14657. inline Result Client::Get(const std::string &path, const Params &params,
  14658. const Headers &headers,
  14659. ContentReceiver content_receiver,
  14660. DownloadProgress progress) {
  14661. return cli_->Get(path, params, headers, std::move(content_receiver),
  14662. std::move(progress));
  14663. }
  14664. inline Result Client::Get(const std::string &path, const Params &params,
  14665. const Headers &headers,
  14666. ResponseHandler response_handler,
  14667. ContentReceiver content_receiver,
  14668. DownloadProgress progress) {
  14669. return cli_->Get(path, params, headers, std::move(response_handler),
  14670. std::move(content_receiver), std::move(progress));
  14671. }
  14672. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14673. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14674. return cli_->Head(path, headers);
  14675. }
  14676. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14677. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14678. return cli_->Post(path, headers);
  14679. }
  14680. inline Result Client::Post(const std::string &path, const char *body,
  14681. size_t content_length,
  14682. const std::string &content_type,
  14683. UploadProgress progress) {
  14684. return cli_->Post(path, body, content_length, content_type, progress);
  14685. }
  14686. inline Result Client::Post(const std::string &path, const Headers &headers,
  14687. const char *body, size_t content_length,
  14688. const std::string &content_type,
  14689. UploadProgress progress) {
  14690. return cli_->Post(path, headers, body, content_length, content_type,
  14691. progress);
  14692. }
  14693. inline Result Client::Post(const std::string &path, const std::string &body,
  14694. const std::string &content_type,
  14695. UploadProgress progress) {
  14696. return cli_->Post(path, body, content_type, progress);
  14697. }
  14698. inline Result Client::Post(const std::string &path, const Headers &headers,
  14699. const std::string &body,
  14700. const std::string &content_type,
  14701. UploadProgress progress) {
  14702. return cli_->Post(path, headers, body, content_type, progress);
  14703. }
  14704. inline Result Client::Post(const std::string &path, size_t content_length,
  14705. ContentProvider content_provider,
  14706. const std::string &content_type,
  14707. UploadProgress progress) {
  14708. return cli_->Post(path, content_length, std::move(content_provider),
  14709. content_type, progress);
  14710. }
  14711. inline Result Client::Post(const std::string &path, size_t content_length,
  14712. ContentProvider content_provider,
  14713. const std::string &content_type,
  14714. ContentReceiver content_receiver,
  14715. UploadProgress progress) {
  14716. return cli_->Post(path, content_length, std::move(content_provider),
  14717. content_type, std::move(content_receiver), progress);
  14718. }
  14719. inline Result Client::Post(const std::string &path,
  14720. ContentProviderWithoutLength content_provider,
  14721. const std::string &content_type,
  14722. UploadProgress progress) {
  14723. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14724. }
  14725. inline Result Client::Post(const std::string &path,
  14726. ContentProviderWithoutLength content_provider,
  14727. const std::string &content_type,
  14728. ContentReceiver content_receiver,
  14729. UploadProgress progress) {
  14730. return cli_->Post(path, std::move(content_provider), content_type,
  14731. std::move(content_receiver), progress);
  14732. }
  14733. inline Result Client::Post(const std::string &path, const Headers &headers,
  14734. size_t content_length,
  14735. ContentProvider content_provider,
  14736. const std::string &content_type,
  14737. UploadProgress progress) {
  14738. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14739. content_type, progress);
  14740. }
  14741. inline Result Client::Post(const std::string &path, const Headers &headers,
  14742. size_t content_length,
  14743. ContentProvider content_provider,
  14744. const std::string &content_type,
  14745. ContentReceiver content_receiver,
  14746. DownloadProgress progress) {
  14747. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14748. content_type, std::move(content_receiver), progress);
  14749. }
  14750. inline Result Client::Post(const std::string &path, const Headers &headers,
  14751. ContentProviderWithoutLength content_provider,
  14752. const std::string &content_type,
  14753. UploadProgress progress) {
  14754. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14755. progress);
  14756. }
  14757. inline Result Client::Post(const std::string &path, const Headers &headers,
  14758. ContentProviderWithoutLength content_provider,
  14759. const std::string &content_type,
  14760. ContentReceiver content_receiver,
  14761. DownloadProgress progress) {
  14762. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14763. std::move(content_receiver), progress);
  14764. }
  14765. inline Result Client::Post(const std::string &path, const Params &params) {
  14766. return cli_->Post(path, params);
  14767. }
  14768. inline Result Client::Post(const std::string &path, const Headers &headers,
  14769. const Params &params) {
  14770. return cli_->Post(path, headers, params);
  14771. }
  14772. inline Result Client::Post(const std::string &path,
  14773. const UploadFormDataItems &items,
  14774. UploadProgress progress) {
  14775. return cli_->Post(path, items, progress);
  14776. }
  14777. inline Result Client::Post(const std::string &path, const Headers &headers,
  14778. const UploadFormDataItems &items,
  14779. UploadProgress progress) {
  14780. return cli_->Post(path, headers, items, progress);
  14781. }
  14782. inline Result Client::Post(const std::string &path, const Headers &headers,
  14783. const UploadFormDataItems &items,
  14784. const std::string &boundary,
  14785. UploadProgress progress) {
  14786. return cli_->Post(path, headers, items, boundary, progress);
  14787. }
  14788. inline Result Client::Post(const std::string &path, const Headers &headers,
  14789. const UploadFormDataItems &items,
  14790. const FormDataProviderItems &provider_items,
  14791. UploadProgress progress) {
  14792. return cli_->Post(path, headers, items, provider_items, progress);
  14793. }
  14794. inline Result Client::Post(const std::string &path, const Headers &headers,
  14795. const std::string &body,
  14796. const std::string &content_type,
  14797. ContentReceiver content_receiver,
  14798. DownloadProgress progress) {
  14799. return cli_->Post(path, headers, body, content_type,
  14800. std::move(content_receiver), progress);
  14801. }
  14802. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14803. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14804. return cli_->Put(path, headers);
  14805. }
  14806. inline Result Client::Put(const std::string &path, const char *body,
  14807. size_t content_length,
  14808. const std::string &content_type,
  14809. UploadProgress progress) {
  14810. return cli_->Put(path, body, content_length, content_type, progress);
  14811. }
  14812. inline Result Client::Put(const std::string &path, const Headers &headers,
  14813. const char *body, size_t content_length,
  14814. const std::string &content_type,
  14815. UploadProgress progress) {
  14816. return cli_->Put(path, headers, body, content_length, content_type, progress);
  14817. }
  14818. inline Result Client::Put(const std::string &path, const std::string &body,
  14819. const std::string &content_type,
  14820. UploadProgress progress) {
  14821. return cli_->Put(path, body, content_type, progress);
  14822. }
  14823. inline Result Client::Put(const std::string &path, const Headers &headers,
  14824. const std::string &body,
  14825. const std::string &content_type,
  14826. UploadProgress progress) {
  14827. return cli_->Put(path, headers, body, content_type, progress);
  14828. }
  14829. inline Result Client::Put(const std::string &path, size_t content_length,
  14830. ContentProvider content_provider,
  14831. const std::string &content_type,
  14832. UploadProgress progress) {
  14833. return cli_->Put(path, content_length, std::move(content_provider),
  14834. content_type, progress);
  14835. }
  14836. inline Result Client::Put(const std::string &path, size_t content_length,
  14837. ContentProvider content_provider,
  14838. const std::string &content_type,
  14839. ContentReceiver content_receiver,
  14840. UploadProgress progress) {
  14841. return cli_->Put(path, content_length, std::move(content_provider),
  14842. content_type, std::move(content_receiver), progress);
  14843. }
  14844. inline Result Client::Put(const std::string &path,
  14845. ContentProviderWithoutLength content_provider,
  14846. const std::string &content_type,
  14847. UploadProgress progress) {
  14848. return cli_->Put(path, std::move(content_provider), content_type, progress);
  14849. }
  14850. inline Result Client::Put(const std::string &path,
  14851. ContentProviderWithoutLength content_provider,
  14852. const std::string &content_type,
  14853. ContentReceiver content_receiver,
  14854. UploadProgress progress) {
  14855. return cli_->Put(path, std::move(content_provider), content_type,
  14856. std::move(content_receiver), progress);
  14857. }
  14858. inline Result Client::Put(const std::string &path, const Headers &headers,
  14859. size_t content_length,
  14860. ContentProvider content_provider,
  14861. const std::string &content_type,
  14862. UploadProgress progress) {
  14863. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14864. content_type, progress);
  14865. }
  14866. inline Result Client::Put(const std::string &path, const Headers &headers,
  14867. size_t content_length,
  14868. ContentProvider content_provider,
  14869. const std::string &content_type,
  14870. ContentReceiver content_receiver,
  14871. UploadProgress progress) {
  14872. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14873. content_type, std::move(content_receiver), progress);
  14874. }
  14875. inline Result Client::Put(const std::string &path, const Headers &headers,
  14876. ContentProviderWithoutLength content_provider,
  14877. const std::string &content_type,
  14878. UploadProgress progress) {
  14879. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14880. progress);
  14881. }
  14882. inline Result Client::Put(const std::string &path, const Headers &headers,
  14883. ContentProviderWithoutLength content_provider,
  14884. const std::string &content_type,
  14885. ContentReceiver content_receiver,
  14886. UploadProgress progress) {
  14887. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14888. std::move(content_receiver), progress);
  14889. }
  14890. inline Result Client::Put(const std::string &path, const Params &params) {
  14891. return cli_->Put(path, params);
  14892. }
  14893. inline Result Client::Put(const std::string &path, const Headers &headers,
  14894. const Params &params) {
  14895. return cli_->Put(path, headers, params);
  14896. }
  14897. inline Result Client::Put(const std::string &path,
  14898. const UploadFormDataItems &items,
  14899. UploadProgress progress) {
  14900. return cli_->Put(path, items, progress);
  14901. }
  14902. inline Result Client::Put(const std::string &path, const Headers &headers,
  14903. const UploadFormDataItems &items,
  14904. UploadProgress progress) {
  14905. return cli_->Put(path, headers, items, progress);
  14906. }
  14907. inline Result Client::Put(const std::string &path, const Headers &headers,
  14908. const UploadFormDataItems &items,
  14909. const std::string &boundary,
  14910. UploadProgress progress) {
  14911. return cli_->Put(path, headers, items, boundary, progress);
  14912. }
  14913. inline Result Client::Put(const std::string &path, const Headers &headers,
  14914. const UploadFormDataItems &items,
  14915. const FormDataProviderItems &provider_items,
  14916. UploadProgress progress) {
  14917. return cli_->Put(path, headers, items, provider_items, progress);
  14918. }
  14919. inline Result Client::Put(const std::string &path, const Headers &headers,
  14920. const std::string &body,
  14921. const std::string &content_type,
  14922. ContentReceiver content_receiver,
  14923. DownloadProgress progress) {
  14924. return cli_->Put(path, headers, body, content_type, content_receiver,
  14925. progress);
  14926. }
  14927. inline Result Client::Patch(const std::string &path) {
  14928. return cli_->Patch(path);
  14929. }
  14930. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  14931. return cli_->Patch(path, headers);
  14932. }
  14933. inline Result Client::Patch(const std::string &path, const char *body,
  14934. size_t content_length,
  14935. const std::string &content_type,
  14936. UploadProgress progress) {
  14937. return cli_->Patch(path, body, content_length, content_type, progress);
  14938. }
  14939. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14940. const char *body, size_t content_length,
  14941. const std::string &content_type,
  14942. UploadProgress progress) {
  14943. return cli_->Patch(path, headers, body, content_length, content_type,
  14944. progress);
  14945. }
  14946. inline Result Client::Patch(const std::string &path, const std::string &body,
  14947. const std::string &content_type,
  14948. UploadProgress progress) {
  14949. return cli_->Patch(path, body, content_type, progress);
  14950. }
  14951. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14952. const std::string &body,
  14953. const std::string &content_type,
  14954. UploadProgress progress) {
  14955. return cli_->Patch(path, headers, body, content_type, progress);
  14956. }
  14957. inline Result Client::Patch(const std::string &path, size_t content_length,
  14958. ContentProvider content_provider,
  14959. const std::string &content_type,
  14960. UploadProgress progress) {
  14961. return cli_->Patch(path, content_length, std::move(content_provider),
  14962. content_type, progress);
  14963. }
  14964. inline Result Client::Patch(const std::string &path, size_t content_length,
  14965. ContentProvider content_provider,
  14966. const std::string &content_type,
  14967. ContentReceiver content_receiver,
  14968. UploadProgress progress) {
  14969. return cli_->Patch(path, content_length, std::move(content_provider),
  14970. content_type, std::move(content_receiver), progress);
  14971. }
  14972. inline Result Client::Patch(const std::string &path,
  14973. ContentProviderWithoutLength content_provider,
  14974. const std::string &content_type,
  14975. UploadProgress progress) {
  14976. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  14977. }
  14978. inline Result Client::Patch(const std::string &path,
  14979. ContentProviderWithoutLength content_provider,
  14980. const std::string &content_type,
  14981. ContentReceiver content_receiver,
  14982. UploadProgress progress) {
  14983. return cli_->Patch(path, std::move(content_provider), content_type,
  14984. std::move(content_receiver), progress);
  14985. }
  14986. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14987. size_t content_length,
  14988. ContentProvider content_provider,
  14989. const std::string &content_type,
  14990. UploadProgress progress) {
  14991. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  14992. content_type, progress);
  14993. }
  14994. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14995. size_t content_length,
  14996. ContentProvider content_provider,
  14997. const std::string &content_type,
  14998. ContentReceiver content_receiver,
  14999. UploadProgress progress) {
  15000. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15001. content_type, std::move(content_receiver), progress);
  15002. }
  15003. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15004. ContentProviderWithoutLength content_provider,
  15005. const std::string &content_type,
  15006. UploadProgress progress) {
  15007. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15008. progress);
  15009. }
  15010. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15011. ContentProviderWithoutLength content_provider,
  15012. const std::string &content_type,
  15013. ContentReceiver content_receiver,
  15014. UploadProgress progress) {
  15015. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15016. std::move(content_receiver), progress);
  15017. }
  15018. inline Result Client::Patch(const std::string &path, const Params &params) {
  15019. return cli_->Patch(path, params);
  15020. }
  15021. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15022. const Params &params) {
  15023. return cli_->Patch(path, headers, params);
  15024. }
  15025. inline Result Client::Patch(const std::string &path,
  15026. const UploadFormDataItems &items,
  15027. UploadProgress progress) {
  15028. return cli_->Patch(path, items, progress);
  15029. }
  15030. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15031. const UploadFormDataItems &items,
  15032. UploadProgress progress) {
  15033. return cli_->Patch(path, headers, items, progress);
  15034. }
  15035. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15036. const UploadFormDataItems &items,
  15037. const std::string &boundary,
  15038. UploadProgress progress) {
  15039. return cli_->Patch(path, headers, items, boundary, progress);
  15040. }
  15041. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15042. const UploadFormDataItems &items,
  15043. const FormDataProviderItems &provider_items,
  15044. UploadProgress progress) {
  15045. return cli_->Patch(path, headers, items, provider_items, progress);
  15046. }
  15047. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15048. const std::string &body,
  15049. const std::string &content_type,
  15050. ContentReceiver content_receiver,
  15051. DownloadProgress progress) {
  15052. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15053. progress);
  15054. }
  15055. inline Result Client::Delete(const std::string &path,
  15056. DownloadProgress progress) {
  15057. return cli_->Delete(path, progress);
  15058. }
  15059. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15060. DownloadProgress progress) {
  15061. return cli_->Delete(path, headers, progress);
  15062. }
  15063. inline Result Client::Delete(const std::string &path, const char *body,
  15064. size_t content_length,
  15065. const std::string &content_type,
  15066. DownloadProgress progress) {
  15067. return cli_->Delete(path, body, content_length, content_type, progress);
  15068. }
  15069. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15070. const char *body, size_t content_length,
  15071. const std::string &content_type,
  15072. DownloadProgress progress) {
  15073. return cli_->Delete(path, headers, body, content_length, content_type,
  15074. progress);
  15075. }
  15076. inline Result Client::Delete(const std::string &path, const std::string &body,
  15077. const std::string &content_type,
  15078. DownloadProgress progress) {
  15079. return cli_->Delete(path, body, content_type, progress);
  15080. }
  15081. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15082. const std::string &body,
  15083. const std::string &content_type,
  15084. DownloadProgress progress) {
  15085. return cli_->Delete(path, headers, body, content_type, progress);
  15086. }
  15087. inline Result Client::Delete(const std::string &path, const Params &params,
  15088. DownloadProgress progress) {
  15089. return cli_->Delete(path, params, progress);
  15090. }
  15091. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15092. const Params &params, DownloadProgress progress) {
  15093. return cli_->Delete(path, headers, params, progress);
  15094. }
  15095. inline Result Client::Options(const std::string &path) {
  15096. return cli_->Options(path);
  15097. }
  15098. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15099. return cli_->Options(path, headers);
  15100. }
  15101. inline ClientImpl::StreamHandle
  15102. Client::open_stream(const std::string &method, const std::string &path,
  15103. const Params &params, const Headers &headers,
  15104. const std::string &body, const std::string &content_type) {
  15105. return cli_->open_stream(method, path, params, headers, body, content_type);
  15106. }
  15107. inline bool Client::send(Request &req, Response &res, Error &error) {
  15108. return cli_->send(req, res, error);
  15109. }
  15110. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15111. inline void Client::stop() { cli_->stop(); }
  15112. inline std::string Client::host() const { return cli_->host(); }
  15113. inline int Client::port() const { return cli_->port(); }
  15114. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15115. inline socket_t Client::socket() const { return cli_->socket(); }
  15116. inline void
  15117. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15118. cli_->set_hostname_addr_map(std::move(addr_map));
  15119. }
  15120. inline void Client::set_default_headers(Headers headers) {
  15121. cli_->set_default_headers(std::move(headers));
  15122. }
  15123. inline void Client::set_header_writer(
  15124. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15125. cli_->set_header_writer(writer);
  15126. }
  15127. inline void Client::set_address_family(int family) {
  15128. cli_->set_address_family(family);
  15129. }
  15130. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15131. inline void Client::set_socket_options(SocketOptions socket_options) {
  15132. cli_->set_socket_options(std::move(socket_options));
  15133. }
  15134. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15135. cli_->set_connection_timeout(sec, usec);
  15136. }
  15137. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15138. cli_->set_read_timeout(sec, usec);
  15139. }
  15140. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15141. cli_->set_write_timeout(sec, usec);
  15142. }
  15143. inline void Client::set_basic_auth(const std::string &username,
  15144. const std::string &password) {
  15145. cli_->set_basic_auth(username, password);
  15146. }
  15147. inline void Client::set_bearer_token_auth(const std::string &token) {
  15148. cli_->set_bearer_token_auth(token);
  15149. }
  15150. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15151. inline void Client::set_follow_location(bool on) {
  15152. cli_->set_follow_location(on);
  15153. }
  15154. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15155. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15156. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15157. inline void Client::set_payload_max_length(size_t length) {
  15158. cli_->set_payload_max_length(length);
  15159. }
  15160. inline void Client::set_interface(const std::string &intf) {
  15161. cli_->set_interface(intf);
  15162. }
  15163. inline void Client::set_proxy(const std::string &host, int port) {
  15164. cli_->set_proxy(host, port);
  15165. }
  15166. inline void Client::set_proxy_basic_auth(const std::string &username,
  15167. const std::string &password) {
  15168. cli_->set_proxy_basic_auth(username, password);
  15169. }
  15170. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15171. cli_->set_proxy_bearer_token_auth(token);
  15172. }
  15173. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15174. cli_->set_no_proxy(patterns);
  15175. }
  15176. inline void Client::set_logger(Logger logger) {
  15177. cli_->set_logger(std::move(logger));
  15178. }
  15179. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15180. cli_->set_error_logger(std::move(error_logger));
  15181. }
  15182. /*
  15183. * Group 6: SSL Server and Client implementation
  15184. */
  15185. #ifdef CPPHTTPLIB_SSL_ENABLED
  15186. // SSL HTTP server implementation
  15187. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15188. const char *client_ca_cert_file_path,
  15189. const char *client_ca_cert_dir_path,
  15190. const char *private_key_password) {
  15191. using namespace tls;
  15192. ctx_ = create_server_context();
  15193. if (!ctx_) { return; }
  15194. // Load server certificate and private key
  15195. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15196. private_key_password)) {
  15197. last_ssl_error_ = static_cast<int>(get_error());
  15198. free_context(ctx_);
  15199. ctx_ = nullptr;
  15200. return;
  15201. }
  15202. // Load client CA certificates for client authentication
  15203. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15204. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15205. client_ca_cert_dir_path)) {
  15206. last_ssl_error_ = static_cast<int>(get_error());
  15207. free_context(ctx_);
  15208. ctx_ = nullptr;
  15209. return;
  15210. }
  15211. // Enable client certificate verification
  15212. set_verify_client(ctx_, true);
  15213. }
  15214. }
  15215. inline SSLServer::SSLServer(const PemMemory &pem) {
  15216. using namespace tls;
  15217. ctx_ = create_server_context();
  15218. if (ctx_) {
  15219. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15220. pem.private_key_password)) {
  15221. last_ssl_error_ = static_cast<int>(get_error());
  15222. free_context(ctx_);
  15223. ctx_ = nullptr;
  15224. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15225. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15226. last_ssl_error_ = static_cast<int>(get_error());
  15227. free_context(ctx_);
  15228. ctx_ = nullptr;
  15229. } else {
  15230. set_verify_client(ctx_, true);
  15231. }
  15232. }
  15233. }
  15234. }
  15235. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15236. using namespace tls;
  15237. ctx_ = create_server_context();
  15238. if (ctx_) {
  15239. if (!setup_callback(ctx_)) {
  15240. free_context(ctx_);
  15241. ctx_ = nullptr;
  15242. }
  15243. }
  15244. }
  15245. inline SSLServer::~SSLServer() {
  15246. if (ctx_) { tls::free_context(ctx_); }
  15247. }
  15248. inline bool SSLServer::is_valid() const {
  15249. return ctx_ != nullptr && Server::is_valid();
  15250. }
  15251. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15252. using namespace tls;
  15253. // Create TLS session with mutex protection
  15254. session_t session = nullptr;
  15255. {
  15256. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15257. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15258. }
  15259. if (!session) {
  15260. last_ssl_error_ = static_cast<int>(get_error());
  15261. detail::shutdown_socket(sock);
  15262. detail::close_socket(sock);
  15263. return false;
  15264. }
  15265. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15266. bool handshake_done = false;
  15267. bool ret = false;
  15268. bool websocket_upgraded = false;
  15269. auto cleanup = detail::scope_exit([&] {
  15270. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15271. free_session(session);
  15272. detail::shutdown_socket(sock);
  15273. detail::close_socket(sock);
  15274. });
  15275. // Perform TLS accept handshake with timeout
  15276. TlsError tls_err;
  15277. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15278. &tls_err)) {
  15279. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15280. // Map TlsError to legacy ssl_error for backward compatibility
  15281. if (tls_err.code == ErrorCode::WantRead) {
  15282. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15283. } else if (tls_err.code == ErrorCode::WantWrite) {
  15284. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15285. } else {
  15286. last_ssl_error_ = SSL_ERROR_SSL;
  15287. }
  15288. #else
  15289. last_ssl_error_ = static_cast<int>(get_error());
  15290. #endif
  15291. return false;
  15292. }
  15293. handshake_done = true;
  15294. std::string remote_addr;
  15295. int remote_port = 0;
  15296. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15297. std::string local_addr;
  15298. int local_port = 0;
  15299. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15300. ret = serve_guarded([&]() {
  15301. return detail::process_server_socket_ssl(
  15302. svr_sock_, session, sock, keep_alive_max_count_,
  15303. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15304. write_timeout_sec_, write_timeout_usec_,
  15305. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15306. return process_request(
  15307. strm, remote_addr, remote_port, local_addr, local_port,
  15308. close_connection, connection_closed,
  15309. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15310. });
  15311. });
  15312. return ret;
  15313. }
  15314. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15315. const char *key_pem,
  15316. const char *client_ca_pem,
  15317. const char *password) {
  15318. if (!ctx_) { return false; }
  15319. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15320. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15321. return false;
  15322. }
  15323. if (client_ca_pem) {
  15324. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15325. }
  15326. return true;
  15327. }
  15328. // SSL HTTP client implementation
  15329. inline SSLClient::~SSLClient() {
  15330. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15331. // base function rather than the derived function once we get to the
  15332. // base class destructor, and won't free the SSL (causing a leak).
  15333. // This must happen before the context is freed below: some backends
  15334. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15335. // context, so freeing the context first leaves close_notify reading
  15336. // freed memory.
  15337. shutdown_ssl_impl(socket_, true);
  15338. if (ctx_) {
  15339. tls::free_context(ctx_);
  15340. ctx_ = nullptr;
  15341. }
  15342. }
  15343. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15344. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15345. shutdown_ssl_impl(socket, shutdown_gracefully);
  15346. }
  15347. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15348. bool shutdown_gracefully) {
  15349. if (socket.sock == INVALID_SOCKET) {
  15350. assert(socket.ssl == nullptr);
  15351. return;
  15352. }
  15353. if (socket.ssl) {
  15354. tls::shutdown(socket.ssl, shutdown_gracefully);
  15355. {
  15356. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15357. tls::free_session(socket.ssl);
  15358. }
  15359. socket.ssl = nullptr;
  15360. }
  15361. assert(socket.ssl == nullptr);
  15362. }
  15363. inline bool SSLClient::process_socket(
  15364. const Socket &socket,
  15365. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15366. std::function<bool(Stream &strm)> callback) {
  15367. assert(socket.ssl);
  15368. return detail::process_client_socket_ssl(
  15369. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15370. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15371. std::move(callback));
  15372. }
  15373. inline bool SSLClient::is_ssl() const { return true; }
  15374. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15375. if (!is_valid()) {
  15376. error = Error::SSLConnection;
  15377. return false;
  15378. }
  15379. return ClientImpl::create_and_connect_socket(socket, error);
  15380. }
  15381. inline bool SSLClient::setup_proxy_connection(
  15382. Socket &socket,
  15383. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15384. Response &res, bool &success, Error &error) {
  15385. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15386. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15387. return false;
  15388. }
  15389. if (!initialize_ssl(socket, error)) {
  15390. success = false;
  15391. return false;
  15392. }
  15393. return true;
  15394. }
  15395. // Assumes that socket_mutex_ is locked and that there are no requests in
  15396. // flight
  15397. inline bool SSLClient::connect_with_proxy(
  15398. Socket &socket,
  15399. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15400. Response &res, bool &success, Error &error) {
  15401. success = true;
  15402. Response proxy_res;
  15403. if (!detail::process_client_socket(
  15404. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15405. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15406. start_time, [&](Stream &strm) {
  15407. Request req2;
  15408. req2.method = "CONNECT";
  15409. req2.path =
  15410. detail::make_host_and_port_string_always_port(host_, port_);
  15411. if (max_timeout_msec_ > 0) {
  15412. req2.start_time_ = std::chrono::steady_clock::now();
  15413. }
  15414. return process_request(strm, req2, proxy_res, false, error);
  15415. })) {
  15416. // Thread-safe to close everything because we are assuming there are no
  15417. // requests in flight
  15418. shutdown_ssl(socket, true);
  15419. shutdown_socket(socket);
  15420. close_socket(socket);
  15421. success = false;
  15422. return false;
  15423. }
  15424. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15425. if (!proxy_digest_auth_username_.empty() &&
  15426. !proxy_digest_auth_password_.empty()) {
  15427. std::map<std::string, std::string> auth;
  15428. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15429. // Close the current socket and create a new one for the authenticated
  15430. // request
  15431. shutdown_ssl(socket, true);
  15432. shutdown_socket(socket);
  15433. close_socket(socket);
  15434. // Create a new socket for the authenticated CONNECT request
  15435. if (!ensure_socket_connection(socket, error)) {
  15436. success = false;
  15437. output_error_log(error, nullptr);
  15438. return false;
  15439. }
  15440. proxy_res = Response();
  15441. if (!detail::process_client_socket(
  15442. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15443. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15444. start_time, [&](Stream &strm) {
  15445. Request req3;
  15446. req3.method = "CONNECT";
  15447. req3.path = detail::make_host_and_port_string_always_port(
  15448. host_, port_);
  15449. req3.headers.insert(detail::make_digest_authentication_header(
  15450. req3, auth, 1, detail::random_string(10),
  15451. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15452. true));
  15453. if (max_timeout_msec_ > 0) {
  15454. req3.start_time_ = std::chrono::steady_clock::now();
  15455. }
  15456. return process_request(strm, req3, proxy_res, false, error);
  15457. })) {
  15458. // Thread-safe to close everything because we are assuming there are
  15459. // no requests in flight
  15460. shutdown_ssl(socket, true);
  15461. shutdown_socket(socket);
  15462. close_socket(socket);
  15463. success = false;
  15464. return false;
  15465. }
  15466. }
  15467. }
  15468. }
  15469. // If status code is not 200, proxy request is failed.
  15470. // Set error to ProxyConnection and return proxy response
  15471. // as the response of the request
  15472. if (proxy_res.status != StatusCode::OK_200) {
  15473. error = Error::ProxyConnection;
  15474. output_error_log(error, nullptr);
  15475. res = std::move(proxy_res);
  15476. // Thread-safe to close everything because we are assuming there are
  15477. // no requests in flight
  15478. shutdown_ssl(socket, true);
  15479. shutdown_socket(socket);
  15480. close_socket(socket);
  15481. return false;
  15482. }
  15483. return true;
  15484. }
  15485. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15486. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15487. if (is_proxy_enabled_for_host(host_)) { return true; }
  15488. if (!initialize_ssl(socket, error)) {
  15489. shutdown_socket(socket);
  15490. close_socket(socket);
  15491. return false;
  15492. }
  15493. return true;
  15494. }
  15495. // SSL HTTP client implementation
  15496. inline SSLClient::SSLClient(const std::string &host)
  15497. : SSLClient(host, 443, std::string(), std::string()) {}
  15498. inline SSLClient::SSLClient(const std::string &host, int port)
  15499. : SSLClient(host, port, std::string(), std::string()) {}
  15500. inline void SSLClient::init_ctx() {
  15501. ctx_ = tls::create_client_context();
  15502. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15503. }
  15504. inline void SSLClient::reset_ctx_on_error() {
  15505. last_backend_error_ = tls::get_error();
  15506. tls::free_context(ctx_);
  15507. ctx_ = nullptr;
  15508. }
  15509. inline SSLClient::SSLClient(const std::string &host, int port,
  15510. const std::string &client_cert_path,
  15511. const std::string &client_key_path,
  15512. const std::string &private_key_password)
  15513. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15514. init_ctx();
  15515. if (!ctx_) { return; }
  15516. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15517. const char *password =
  15518. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15519. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15520. client_key_path.c_str(), password)) {
  15521. reset_ctx_on_error();
  15522. }
  15523. }
  15524. }
  15525. inline SSLClient::SSLClient(const std::string &host, int port,
  15526. const PemMemory &pem)
  15527. : ClientImpl(host, port) {
  15528. init_ctx();
  15529. if (!ctx_) { return; }
  15530. if (pem.cert_pem && pem.key_pem) {
  15531. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15532. pem.private_key_password)) {
  15533. reset_ctx_on_error();
  15534. }
  15535. }
  15536. }
  15537. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15538. if (ca_cert_store && ctx_) {
  15539. // set_ca_store takes ownership of ca_cert_store
  15540. tls::set_ca_store(ctx_, ca_cert_store);
  15541. ca_cert_store_set_ = true;
  15542. } else if (ca_cert_store) {
  15543. tls::free_ca_store(ca_cert_store);
  15544. }
  15545. }
  15546. inline void
  15547. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15548. if (!ctx_) { return; }
  15549. tls::set_verify_callback(ctx_, verifier);
  15550. }
  15551. inline void SSLClient::set_session_verifier(
  15552. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15553. session_verifier_ = std::move(verifier);
  15554. }
  15555. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15556. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15557. enable_windows_cert_verification_ = enabled;
  15558. }
  15559. #endif
  15560. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15561. std::size_t size) {
  15562. if (ctx_ && ca_cert && size > 0) {
  15563. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15564. tls::load_ca_pem(ctx_, ca_cert, size);
  15565. }
  15566. }
  15567. inline bool SSLClient::load_certs() {
  15568. auto ret = true;
  15569. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15570. // one client is shared across concurrent requests here.
  15571. std::call_once(initialize_cert_, [&]() {
  15572. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15573. ret = detail::load_client_ca_config(
  15574. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15575. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15576. last_backend_error_);
  15577. });
  15578. return ret;
  15579. }
  15580. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15581. // Load CA certificates if server verification is enabled
  15582. if (server_certificate_verification_) {
  15583. if (!load_certs()) {
  15584. error = Error::SSLLoadingCerts;
  15585. output_error_log(error, nullptr);
  15586. return false;
  15587. }
  15588. }
  15589. detail::ClientTlsSessionOptions options;
  15590. options.server_hostname_verification = server_hostname_verification_;
  15591. options.session_verifier = session_verifier_;
  15592. options.ctx_mutex = &ctx_mutex_;
  15593. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15594. // Skip Schannel when a custom CA cert is specified, as the Windows
  15595. // certificate store would not know about user-provided CA certificates.
  15596. // Also skip when system CA trust is explicitly disabled.
  15597. options.windows_cert_verification =
  15598. enable_windows_cert_verification_ &&
  15599. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15600. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15601. #endif
  15602. tls::session_t session = nullptr;
  15603. // Use scope_exit to ensure session is freed on error paths
  15604. bool success = false;
  15605. auto session_guard = detail::scope_exit([&] {
  15606. if (!success) { tls::free_session(session); }
  15607. });
  15608. detail::ClientTlsSessionError tls_error;
  15609. if (!detail::setup_client_tls_session(
  15610. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15611. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15612. options)) {
  15613. error = tls_error.error;
  15614. last_ssl_error_ = tls_error.ssl_error;
  15615. last_backend_error_ = tls_error.backend_error;
  15616. output_error_log(error, nullptr);
  15617. return false;
  15618. }
  15619. success = true;
  15620. socket.ssl = session;
  15621. return true;
  15622. }
  15623. inline void Client::set_digest_auth(const std::string &username,
  15624. const std::string &password) {
  15625. cli_->set_digest_auth(username, password);
  15626. }
  15627. inline void Client::set_proxy_digest_auth(const std::string &username,
  15628. const std::string &password) {
  15629. cli_->set_proxy_digest_auth(username, password);
  15630. }
  15631. inline void Client::enable_server_certificate_verification(bool enabled) {
  15632. cli_->enable_server_certificate_verification(enabled);
  15633. }
  15634. inline void Client::enable_server_hostname_verification(bool enabled) {
  15635. cli_->enable_server_hostname_verification(enabled);
  15636. }
  15637. inline void Client::enable_system_ca(bool enabled) {
  15638. cli_->enable_system_ca(enabled);
  15639. }
  15640. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15641. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15642. if (is_ssl_) {
  15643. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15644. enabled);
  15645. }
  15646. }
  15647. #endif
  15648. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15649. const std::string &ca_cert_dir_path) {
  15650. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15651. }
  15652. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15653. if (is_ssl_) {
  15654. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15655. } else if (ca_cert_store) {
  15656. tls::free_ca_store(ca_cert_store);
  15657. }
  15658. }
  15659. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15660. if (is_ssl_) {
  15661. // Use the PEM-based path so the CA data is retained for redirect transfer
  15662. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15663. }
  15664. }
  15665. inline void
  15666. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15667. if (is_ssl_) {
  15668. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15669. std::move(verifier));
  15670. }
  15671. }
  15672. inline void Client::set_session_verifier(
  15673. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15674. if (is_ssl_) {
  15675. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15676. }
  15677. }
  15678. inline tls::ctx_t Client::tls_context() const {
  15679. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15680. return nullptr;
  15681. }
  15682. #endif // CPPHTTPLIB_SSL_ENABLED
  15683. /*
  15684. * Group 7: TLS abstraction layer - Common API
  15685. */
  15686. #ifdef CPPHTTPLIB_SSL_ENABLED
  15687. namespace tls {
  15688. // Helper for PeerCert construction
  15689. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15690. return PeerCert(get_peer_cert(session));
  15691. }
  15692. namespace impl {
  15693. inline VerifyCallback &get_verify_callback() {
  15694. static thread_local VerifyCallback callback;
  15695. return callback;
  15696. }
  15697. inline VerifyCallback &get_mbedtls_verify_callback() {
  15698. static thread_local VerifyCallback callback;
  15699. return callback;
  15700. }
  15701. // Check if a string is an IPv4 address
  15702. inline bool is_ipv4_address(const std::string &str) {
  15703. int dots = 0;
  15704. for (char c : str) {
  15705. if (c == '.') {
  15706. dots++;
  15707. } else if (!detail::is_ascii_digit(c)) {
  15708. return false;
  15709. }
  15710. }
  15711. return dots == 3;
  15712. }
  15713. // Parse IPv4 address string to bytes
  15714. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15715. const char *p = str.c_str();
  15716. for (int i = 0; i < 4; i++) {
  15717. if (i > 0) {
  15718. if (*p != '.') { return false; }
  15719. p++;
  15720. }
  15721. int val = 0;
  15722. int digits = 0;
  15723. while (detail::is_ascii_digit(*p)) {
  15724. val = val * 10 + (*p - '0');
  15725. if (val > 255) { return false; }
  15726. p++;
  15727. digits++;
  15728. }
  15729. if (digits == 0) { return false; }
  15730. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15731. if (digits > 1 && *(p - digits) == '0') { return false; }
  15732. out[i] = static_cast<unsigned char>(val);
  15733. }
  15734. return *p == '\0';
  15735. }
  15736. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15737. // `out` must have room for at least 16 bytes. Returns the address length
  15738. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15739. // literal. Used to match a host against iPAddress SANs the same way the
  15740. // OpenSSL backend does via X509_check_ip.
  15741. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15742. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15743. struct in6_addr addr6 = {};
  15744. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15745. memcpy(out, &addr6, 16);
  15746. return 16;
  15747. }
  15748. return 0;
  15749. }
  15750. #ifdef _WIN32
  15751. // Enumerate Windows system certificates and call callback with DER data
  15752. template <typename Callback>
  15753. inline bool enumerate_windows_system_certs(Callback cb) {
  15754. bool loaded = false;
  15755. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15756. for (auto store_name : store_names) {
  15757. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15758. if (hStore) {
  15759. PCCERT_CONTEXT pContext = nullptr;
  15760. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15761. nullptr) {
  15762. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15763. loaded = true;
  15764. }
  15765. }
  15766. CertCloseStore(hStore, 0);
  15767. }
  15768. }
  15769. return loaded;
  15770. }
  15771. #endif
  15772. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15773. // Enumerate macOS Keychain certificates and call callback with DER data
  15774. template <typename Callback>
  15775. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15776. bool loaded = false;
  15777. const SecTrustSettingsDomain domains[] = {
  15778. kSecTrustSettingsDomainSystem,
  15779. kSecTrustSettingsDomainAdmin,
  15780. kSecTrustSettingsDomainUser,
  15781. };
  15782. for (auto domain : domains) {
  15783. CFArrayRef certs = nullptr;
  15784. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15785. if (status != errSecSuccess || !certs) {
  15786. if (certs) CFRelease(certs);
  15787. continue;
  15788. }
  15789. CFIndex count = CFArrayGetCount(certs);
  15790. for (CFIndex i = 0; i < count; i++) {
  15791. SecCertificateRef cert =
  15792. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15793. CFDataRef data = SecCertificateCopyData(cert);
  15794. if (data) {
  15795. if (cb(CFDataGetBytePtr(data),
  15796. static_cast<size_t>(CFDataGetLength(data)))) {
  15797. loaded = true;
  15798. }
  15799. CFRelease(data);
  15800. }
  15801. }
  15802. CFRelease(certs);
  15803. }
  15804. return loaded;
  15805. }
  15806. #endif
  15807. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  15808. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  15809. // Common CA certificate file paths on Linux/Unix
  15810. inline const char **system_ca_paths() {
  15811. static const char *paths[] = {
  15812. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  15813. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  15814. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  15815. "/etc/pki/tls/cacert.pem", // OpenELEC
  15816. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  15817. nullptr};
  15818. return paths;
  15819. }
  15820. // Common CA certificate directory paths on Linux/Unix
  15821. inline const char **system_ca_dirs() {
  15822. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  15823. "/etc/pki/tls/certs", // RHEL/CentOS
  15824. "/usr/share/ca-certificates", // Other
  15825. nullptr};
  15826. return dirs;
  15827. }
  15828. #endif
  15829. } // namespace impl
  15830. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  15831. const char *ca_dir) {
  15832. if (!ctx) { return false; }
  15833. bool success = true;
  15834. if (ca_file && *ca_file) {
  15835. if (!load_ca_file(ctx, ca_file)) { success = false; }
  15836. }
  15837. if (ca_dir && *ca_dir) {
  15838. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  15839. }
  15840. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15841. // Set CA list for client certificate request (CertificateRequest message)
  15842. if (ca_file && *ca_file) {
  15843. auto list = SSL_load_client_CA_file(ca_file);
  15844. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  15845. }
  15846. #endif
  15847. return success;
  15848. }
  15849. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  15850. const char *password) {
  15851. return set_client_cert_pem(ctx, cert, key, password);
  15852. }
  15853. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  15854. const char *key_path, const char *password) {
  15855. return set_client_cert_file(ctx, cert_path, key_path, password);
  15856. }
  15857. // PeerCert implementation
  15858. inline PeerCert::PeerCert() = default;
  15859. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  15860. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  15861. other.cert_ = nullptr;
  15862. }
  15863. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  15864. if (this != &other) {
  15865. if (cert_) { free_cert(cert_); }
  15866. cert_ = other.cert_;
  15867. other.cert_ = nullptr;
  15868. }
  15869. return *this;
  15870. }
  15871. inline PeerCert::~PeerCert() {
  15872. if (cert_) { free_cert(cert_); }
  15873. }
  15874. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  15875. inline std::string PeerCert::subject_cn() const {
  15876. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  15877. }
  15878. inline std::string PeerCert::issuer_name() const {
  15879. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  15880. }
  15881. inline bool PeerCert::check_hostname(const char *hostname) const {
  15882. return cert_ ? verify_hostname(cert_, hostname) : false;
  15883. }
  15884. inline std::vector<SanEntry> PeerCert::sans() const {
  15885. std::vector<SanEntry> result;
  15886. if (cert_) { get_cert_sans(cert_, result); }
  15887. return result;
  15888. }
  15889. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  15890. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  15891. }
  15892. inline std::string PeerCert::serial() const {
  15893. return cert_ ? get_cert_serial(cert_) : std::string();
  15894. }
  15895. // VerifyContext method implementations
  15896. inline std::string VerifyContext::subject_cn() const {
  15897. return cert ? get_cert_subject_cn(cert) : std::string();
  15898. }
  15899. inline std::string VerifyContext::issuer_name() const {
  15900. return cert ? get_cert_issuer_name(cert) : std::string();
  15901. }
  15902. inline bool VerifyContext::check_hostname(const char *hostname) const {
  15903. return cert ? verify_hostname(cert, hostname) : false;
  15904. }
  15905. inline std::vector<SanEntry> VerifyContext::sans() const {
  15906. std::vector<SanEntry> result;
  15907. if (cert) { get_cert_sans(cert, result); }
  15908. return result;
  15909. }
  15910. inline bool VerifyContext::validity(time_t &not_before,
  15911. time_t &not_after) const {
  15912. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  15913. }
  15914. inline std::string VerifyContext::serial() const {
  15915. return cert ? get_cert_serial(cert) : std::string();
  15916. }
  15917. // TlsError static method implementation
  15918. inline std::string TlsError::verify_error_to_string(long error_code) {
  15919. return verify_error_string(error_code);
  15920. }
  15921. } // namespace tls
  15922. // Request::peer_cert() implementation
  15923. inline tls::PeerCert Request::peer_cert() const {
  15924. return tls::get_peer_cert_from_session(ssl);
  15925. }
  15926. // Request::sni() implementation
  15927. inline std::string Request::sni() const {
  15928. if (!ssl) { return std::string(); }
  15929. const char *s = tls::get_sni(ssl);
  15930. return s ? std::string(s) : std::string();
  15931. }
  15932. #endif // CPPHTTPLIB_SSL_ENABLED
  15933. /*
  15934. * Group 8: TLS abstraction layer - OpenSSL backend
  15935. */
  15936. /*
  15937. * OpenSSL Backend Implementation
  15938. */
  15939. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15940. namespace tls {
  15941. namespace impl {
  15942. // Helper to map OpenSSL SSL_get_error to ErrorCode
  15943. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  15944. switch (ssl_error) {
  15945. case SSL_ERROR_NONE: return ErrorCode::Success;
  15946. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  15947. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  15948. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  15949. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  15950. case SSL_ERROR_SSL:
  15951. default: return ErrorCode::Fatal;
  15952. }
  15953. }
  15954. // Helper: Create client CA list from PEM string
  15955. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  15956. // Caller takes ownership of returned list
  15957. inline STACK_OF(X509_NAME) *
  15958. create_client_ca_list_from_pem(const char *ca_pem) {
  15959. if (!ca_pem) { return nullptr; }
  15960. auto ca_list = sk_X509_NAME_new_null();
  15961. if (!ca_list) { return nullptr; }
  15962. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  15963. if (!bio) {
  15964. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  15965. return nullptr;
  15966. }
  15967. X509 *cert = nullptr;
  15968. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  15969. nullptr) {
  15970. const X509_NAME *name = X509_get_subject_name(cert);
  15971. if (name) {
  15972. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  15973. }
  15974. X509_free(cert);
  15975. }
  15976. BIO_free(bio);
  15977. return ca_list;
  15978. }
  15979. // OpenSSL verify callback wrapper
  15980. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  15981. auto &callback = get_verify_callback();
  15982. if (!callback) { return preverify_ok; }
  15983. // Get SSL object from X509_STORE_CTX
  15984. auto ssl = static_cast<SSL *>(
  15985. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  15986. if (!ssl) { return preverify_ok; }
  15987. // Get current certificate and depth
  15988. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  15989. int depth = X509_STORE_CTX_get_error_depth(ctx);
  15990. int error = X509_STORE_CTX_get_error(ctx);
  15991. // Build context
  15992. VerifyContext verify_ctx;
  15993. verify_ctx.session = static_cast<session_t>(ssl);
  15994. verify_ctx.cert = static_cast<cert_t>(cert);
  15995. verify_ctx.depth = depth;
  15996. verify_ctx.preverify_ok = (preverify_ok != 0);
  15997. verify_ctx.error_code = error;
  15998. verify_ctx.error_string =
  15999. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16000. return callback(verify_ctx) ? 1 : 0;
  16001. }
  16002. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16003. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16004. // that must be released with release_store_objects
  16005. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16006. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16007. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16008. #endif
  16009. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16010. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16011. return X509_STORE_get1_objects(store);
  16012. #else
  16013. return X509_STORE_get0_objects(store);
  16014. #endif
  16015. }
  16016. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16017. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16018. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16019. #else
  16020. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16021. #endif
  16022. }
  16023. } // namespace impl
  16024. inline ctx_t create_client_context() {
  16025. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16026. if (ctx) {
  16027. // Disable auto-retry to properly handle non-blocking I/O
  16028. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16029. // Set minimum TLS version
  16030. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16031. }
  16032. return static_cast<ctx_t>(ctx);
  16033. }
  16034. inline void free_context(ctx_t ctx) {
  16035. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16036. }
  16037. inline bool set_min_version(ctx_t ctx, Version version) {
  16038. if (!ctx) return false;
  16039. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16040. static_cast<int>(version)) == 1;
  16041. }
  16042. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16043. if (!ctx || !pem || len == 0) return false;
  16044. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16045. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16046. if (!store) return false;
  16047. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16048. if (!bio) return false;
  16049. bool ok = true;
  16050. X509 *cert = nullptr;
  16051. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16052. nullptr) {
  16053. if (X509_STORE_add_cert(store, cert) != 1) {
  16054. // Ignore duplicate errors
  16055. auto err = ERR_peek_last_error();
  16056. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16057. ok = false;
  16058. }
  16059. }
  16060. X509_free(cert);
  16061. if (!ok) break;
  16062. }
  16063. BIO_free(bio);
  16064. // Clear any "no more certificates" errors
  16065. ERR_clear_error();
  16066. return ok;
  16067. }
  16068. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16069. if (!ctx || !file_path) return false;
  16070. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16071. nullptr) == 1;
  16072. }
  16073. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16074. if (!ctx || !dir_path) return false;
  16075. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16076. dir_path) == 1;
  16077. }
  16078. inline bool load_system_certs(ctx_t ctx) {
  16079. if (!ctx) return false;
  16080. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16081. #ifdef _WIN32
  16082. // Windows: Load from system certificate store (ROOT and CA)
  16083. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16084. if (!store) return false;
  16085. bool loaded_any = false;
  16086. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16087. for (auto store_name : store_names) {
  16088. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16089. if (!hStore) continue;
  16090. PCCERT_CONTEXT pContext = nullptr;
  16091. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16092. nullptr) {
  16093. const unsigned char *data = pContext->pbCertEncoded;
  16094. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16095. if (x509) {
  16096. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16097. X509_free(x509);
  16098. }
  16099. }
  16100. CertCloseStore(hStore, 0);
  16101. }
  16102. return loaded_any;
  16103. #elif defined(__APPLE__)
  16104. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16105. // macOS: Load from Keychain
  16106. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16107. if (!store) return false;
  16108. bool loaded_any = false;
  16109. const SecTrustSettingsDomain domains[] = {
  16110. kSecTrustSettingsDomainSystem,
  16111. kSecTrustSettingsDomainAdmin,
  16112. kSecTrustSettingsDomainUser,
  16113. };
  16114. for (auto domain : domains) {
  16115. CFArrayRef certs = nullptr;
  16116. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16117. !certs) {
  16118. if (certs) CFRelease(certs);
  16119. continue;
  16120. }
  16121. auto count = CFArrayGetCount(certs);
  16122. for (CFIndex i = 0; i < count; i++) {
  16123. auto cert = reinterpret_cast<SecCertificateRef>(
  16124. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16125. CFDataRef der = SecCertificateCopyData(cert);
  16126. if (der) {
  16127. const unsigned char *data = CFDataGetBytePtr(der);
  16128. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16129. if (x509) {
  16130. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16131. X509_free(x509);
  16132. }
  16133. CFRelease(der);
  16134. }
  16135. }
  16136. CFRelease(certs);
  16137. }
  16138. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16139. #else
  16140. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16141. #endif
  16142. #else
  16143. // Other Unix: use default verify paths
  16144. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16145. #endif
  16146. }
  16147. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16148. const char *password) {
  16149. if (!ctx || !cert || !key) return false;
  16150. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16151. // Load certificate
  16152. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16153. if (!cert_bio) return false;
  16154. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16155. BIO_free(cert_bio);
  16156. if (!x509) return false;
  16157. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16158. X509_free(x509);
  16159. if (!cert_ok) return false;
  16160. // Load private key
  16161. auto key_bio = BIO_new_mem_buf(key, -1);
  16162. if (!key_bio) return false;
  16163. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16164. password ? const_cast<char *>(password)
  16165. : nullptr);
  16166. BIO_free(key_bio);
  16167. if (!pkey) return false;
  16168. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16169. EVP_PKEY_free(pkey);
  16170. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16171. }
  16172. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16173. const char *key_path, const char *password) {
  16174. if (!ctx || !cert_path || !key_path) return false;
  16175. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16176. if (password && password[0] != '\0') {
  16177. SSL_CTX_set_default_passwd_cb_userdata(
  16178. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16179. }
  16180. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16181. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16182. }
  16183. inline ctx_t create_server_context() {
  16184. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16185. if (ctx) {
  16186. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16187. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16188. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16189. }
  16190. return static_cast<ctx_t>(ctx);
  16191. }
  16192. inline void set_verify_client(ctx_t ctx, bool require) {
  16193. if (!ctx) return;
  16194. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16195. require
  16196. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16197. : SSL_VERIFY_NONE,
  16198. nullptr);
  16199. }
  16200. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16201. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16202. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16203. SSL *ssl = SSL_new(ssl_ctx);
  16204. if (!ssl) return nullptr;
  16205. // Disable auto-retry for proper non-blocking I/O handling
  16206. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16207. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16208. if (!bio) {
  16209. SSL_free(ssl);
  16210. return nullptr;
  16211. }
  16212. SSL_set_bio(ssl, bio, bio);
  16213. return static_cast<session_t>(ssl);
  16214. }
  16215. inline void free_session(session_t session) {
  16216. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16217. }
  16218. inline bool set_sni(session_t session, const char *hostname,
  16219. bool /*verify_hostname*/) {
  16220. if (!session || !hostname) return false;
  16221. auto ssl = static_cast<SSL *>(session);
  16222. // Set SNI (Server Name Indication) only - does not enable verification.
  16223. // OpenSSL never binds identity checking to SNI (that happens post-
  16224. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16225. #if defined(OPENSSL_IS_BORINGSSL)
  16226. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16227. #else
  16228. // Direct call instead of macro to suppress -Wold-style-cast warning
  16229. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16230. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16231. #endif
  16232. }
  16233. inline TlsError connect(session_t session) {
  16234. if (!session) { return TlsError(); }
  16235. auto ssl = static_cast<SSL *>(session);
  16236. auto ret = SSL_connect(ssl);
  16237. TlsError err;
  16238. if (ret == 1) {
  16239. err.code = ErrorCode::Success;
  16240. } else {
  16241. auto ssl_err = SSL_get_error(ssl, ret);
  16242. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16243. err.backend_code = ERR_get_error();
  16244. }
  16245. return err;
  16246. }
  16247. inline TlsError accept(session_t session) {
  16248. if (!session) { return TlsError(); }
  16249. auto ssl = static_cast<SSL *>(session);
  16250. auto ret = SSL_accept(ssl);
  16251. TlsError err;
  16252. if (ret == 1) {
  16253. err.code = ErrorCode::Success;
  16254. } else {
  16255. auto ssl_err = SSL_get_error(ssl, ret);
  16256. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16257. err.backend_code = ERR_get_error();
  16258. }
  16259. return err;
  16260. }
  16261. inline bool connect_nonblocking(session_t session, socket_t sock,
  16262. time_t timeout_sec, time_t timeout_usec,
  16263. TlsError *err) {
  16264. if (!session) {
  16265. if (err) { err->code = ErrorCode::Fatal; }
  16266. return false;
  16267. }
  16268. auto ssl = static_cast<SSL *>(session);
  16269. auto bio = SSL_get_rbio(ssl);
  16270. // Set non-blocking mode for handshake
  16271. detail::set_nonblocking(sock, true);
  16272. if (bio) { BIO_set_nbio(bio, 1); }
  16273. auto cleanup = detail::scope_exit([&]() {
  16274. // Restore blocking mode after handshake
  16275. if (bio) { BIO_set_nbio(bio, 0); }
  16276. detail::set_nonblocking(sock, false);
  16277. });
  16278. auto res = 0;
  16279. while ((res = SSL_connect(ssl)) != 1) {
  16280. auto ssl_err = SSL_get_error(ssl, res);
  16281. switch (ssl_err) {
  16282. case SSL_ERROR_WANT_READ:
  16283. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16284. continue;
  16285. }
  16286. break;
  16287. case SSL_ERROR_WANT_WRITE:
  16288. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16289. continue;
  16290. }
  16291. break;
  16292. default: break;
  16293. }
  16294. if (err) {
  16295. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16296. err->backend_code = ERR_get_error();
  16297. }
  16298. return false;
  16299. }
  16300. if (err) { err->code = ErrorCode::Success; }
  16301. return true;
  16302. }
  16303. inline bool accept_nonblocking(session_t session, socket_t sock,
  16304. time_t timeout_sec, time_t timeout_usec,
  16305. TlsError *err) {
  16306. if (!session) {
  16307. if (err) { err->code = ErrorCode::Fatal; }
  16308. return false;
  16309. }
  16310. auto ssl = static_cast<SSL *>(session);
  16311. auto bio = SSL_get_rbio(ssl);
  16312. // Set non-blocking mode for handshake
  16313. detail::set_nonblocking(sock, true);
  16314. if (bio) { BIO_set_nbio(bio, 1); }
  16315. auto cleanup = detail::scope_exit([&]() {
  16316. // Restore blocking mode after handshake
  16317. if (bio) { BIO_set_nbio(bio, 0); }
  16318. detail::set_nonblocking(sock, false);
  16319. });
  16320. auto res = 0;
  16321. while ((res = SSL_accept(ssl)) != 1) {
  16322. auto ssl_err = SSL_get_error(ssl, res);
  16323. switch (ssl_err) {
  16324. case SSL_ERROR_WANT_READ:
  16325. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16326. continue;
  16327. }
  16328. break;
  16329. case SSL_ERROR_WANT_WRITE:
  16330. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16331. continue;
  16332. }
  16333. break;
  16334. default: break;
  16335. }
  16336. if (err) {
  16337. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16338. err->backend_code = ERR_get_error();
  16339. }
  16340. return false;
  16341. }
  16342. if (err) { err->code = ErrorCode::Success; }
  16343. return true;
  16344. }
  16345. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16346. if (!session || !buf) {
  16347. err.code = ErrorCode::Fatal;
  16348. return -1;
  16349. }
  16350. auto ssl = static_cast<SSL *>(session);
  16351. constexpr auto max_len =
  16352. static_cast<size_t>((std::numeric_limits<int>::max)());
  16353. if (len > max_len) { len = max_len; }
  16354. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16355. if (ret > 0) {
  16356. err.code = ErrorCode::Success;
  16357. return ret;
  16358. }
  16359. auto ssl_err = SSL_get_error(ssl, ret);
  16360. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16361. if (err.code == ErrorCode::PeerClosed) {
  16362. return 0;
  16363. } // Gracefully handle the peer closed state.
  16364. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16365. return -1;
  16366. }
  16367. inline ssize_t write(session_t session, const void *buf, size_t len,
  16368. TlsError &err) {
  16369. if (!session || !buf) {
  16370. err.code = ErrorCode::Fatal;
  16371. return -1;
  16372. }
  16373. auto ssl = static_cast<SSL *>(session);
  16374. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16375. if (ret > 0) {
  16376. err.code = ErrorCode::Success;
  16377. return ret;
  16378. }
  16379. auto ssl_err = SSL_get_error(ssl, ret);
  16380. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16381. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16382. return -1;
  16383. }
  16384. inline int pending(const_session_t session) {
  16385. if (!session) return 0;
  16386. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16387. }
  16388. inline void shutdown(session_t session, bool graceful) {
  16389. if (!session) return;
  16390. auto ssl = static_cast<SSL *>(session);
  16391. if (graceful) {
  16392. // First call sends close_notify
  16393. if (SSL_shutdown(ssl) == 0) {
  16394. // Second call waits for peer's close_notify
  16395. SSL_shutdown(ssl);
  16396. }
  16397. }
  16398. }
  16399. inline bool is_peer_closed(session_t session, socket_t sock) {
  16400. if (!session) return true;
  16401. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16402. detail::set_nonblocking(sock, true);
  16403. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16404. auto ssl = static_cast<SSL *>(session);
  16405. char buf;
  16406. auto ret = SSL_peek(ssl, &buf, 1);
  16407. if (ret > 0) return false;
  16408. auto err = SSL_get_error(ssl, ret);
  16409. return err == SSL_ERROR_ZERO_RETURN;
  16410. }
  16411. inline cert_t get_peer_cert(const_session_t session) {
  16412. if (!session) return nullptr;
  16413. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16414. static_cast<SSL *>(const_cast<void *>(session))));
  16415. }
  16416. inline void free_cert(cert_t cert) {
  16417. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16418. }
  16419. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16420. if (!cert || !hostname) return false;
  16421. auto x509 = static_cast<X509 *>(cert);
  16422. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16423. if (detail::is_ip_address(hostname)) {
  16424. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16425. }
  16426. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16427. }
  16428. inline uint64_t hostname_mismatch_code() {
  16429. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16430. }
  16431. inline long get_verify_result(const_session_t session) {
  16432. if (!session) return X509_V_ERR_UNSPECIFIED;
  16433. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16434. }
  16435. inline std::string get_cert_subject_cn(cert_t cert) {
  16436. if (!cert) return "";
  16437. auto x509 = static_cast<X509 *>(cert);
  16438. auto subject_name = X509_get_subject_name(x509);
  16439. if (!subject_name) return "";
  16440. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16441. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16442. if (idx < 0) return "";
  16443. auto entry = X509_NAME_get_entry(subject_name, idx);
  16444. if (!entry) return "";
  16445. auto data = X509_NAME_ENTRY_get_data(entry);
  16446. if (!data) return "";
  16447. return std::string(
  16448. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16449. static_cast<size_t>(ASN1_STRING_length(data)));
  16450. }
  16451. inline std::string get_cert_issuer_name(cert_t cert) {
  16452. if (!cert) return "";
  16453. auto x509 = static_cast<X509 *>(cert);
  16454. auto issuer_name = X509_get_issuer_name(x509);
  16455. if (!issuer_name) return "";
  16456. char buf[256];
  16457. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16458. return std::string(buf);
  16459. }
  16460. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16461. sans.clear();
  16462. if (!cert) return false;
  16463. auto x509 = static_cast<X509 *>(cert);
  16464. auto names = static_cast<GENERAL_NAMES *>(
  16465. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16466. if (!names) return true; // No SANs is valid
  16467. auto count = sk_GENERAL_NAME_num(names);
  16468. for (decltype(count) i = 0; i < count; i++) {
  16469. auto gen = sk_GENERAL_NAME_value(names, i);
  16470. if (!gen) continue;
  16471. SanEntry entry;
  16472. switch (gen->type) {
  16473. case GEN_DNS:
  16474. entry.type = SanType::DNS;
  16475. if (gen->d.dNSName) {
  16476. entry.value = std::string(
  16477. reinterpret_cast<const char *>(
  16478. ASN1_STRING_get0_data(gen->d.dNSName)),
  16479. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16480. }
  16481. break;
  16482. case GEN_IPADD:
  16483. entry.type = SanType::IP;
  16484. if (gen->d.iPAddress) {
  16485. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16486. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16487. if (len == 4) {
  16488. // IPv4
  16489. char buf[INET_ADDRSTRLEN];
  16490. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16491. entry.value = buf;
  16492. } else if (len == 16) {
  16493. // IPv6
  16494. char buf[INET6_ADDRSTRLEN];
  16495. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16496. entry.value = buf;
  16497. }
  16498. }
  16499. break;
  16500. case GEN_EMAIL:
  16501. entry.type = SanType::EMAIL;
  16502. if (gen->d.rfc822Name) {
  16503. entry.value = std::string(
  16504. reinterpret_cast<const char *>(
  16505. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16506. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16507. }
  16508. break;
  16509. case GEN_URI:
  16510. entry.type = SanType::URI;
  16511. if (gen->d.uniformResourceIdentifier) {
  16512. entry.value = std::string(
  16513. reinterpret_cast<const char *>(
  16514. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16515. static_cast<size_t>(
  16516. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16517. }
  16518. break;
  16519. default: entry.type = SanType::OTHER; break;
  16520. }
  16521. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16522. }
  16523. GENERAL_NAMES_free(names);
  16524. return true;
  16525. }
  16526. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16527. time_t &not_after) {
  16528. if (!cert) return false;
  16529. auto x509 = static_cast<X509 *>(cert);
  16530. auto nb = X509_get0_notBefore(x509);
  16531. auto na = X509_get0_notAfter(x509);
  16532. if (!nb || !na) return false;
  16533. ASN1_TIME *epoch = ASN1_TIME_new();
  16534. if (!epoch) return false;
  16535. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16536. if (!ASN1_TIME_set(epoch, 0)) return false;
  16537. int pday, psec;
  16538. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16539. not_before = 86400 * (time_t)pday + psec;
  16540. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16541. not_after = 86400 * (time_t)pday + psec;
  16542. return true;
  16543. }
  16544. inline std::string get_cert_serial(cert_t cert) {
  16545. if (!cert) return "";
  16546. auto x509 = static_cast<X509 *>(cert);
  16547. auto serial = X509_get_serialNumber(x509);
  16548. if (!serial) return "";
  16549. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16550. if (!bn) return "";
  16551. auto hex = BN_bn2hex(bn);
  16552. BN_free(bn);
  16553. if (!hex) return "";
  16554. std::string result(hex);
  16555. OPENSSL_free(hex);
  16556. return result;
  16557. }
  16558. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16559. if (!cert) return false;
  16560. auto x509 = static_cast<X509 *>(cert);
  16561. auto len = i2d_X509(x509, nullptr);
  16562. if (len < 0) return false;
  16563. der.resize(static_cast<size_t>(len));
  16564. auto p = der.data();
  16565. i2d_X509(x509, &p);
  16566. return true;
  16567. }
  16568. inline const char *get_sni(const_session_t session) {
  16569. if (!session) return nullptr;
  16570. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16571. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16572. }
  16573. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16574. inline uint64_t get_error() { return ERR_get_error(); }
  16575. inline std::string error_string(uint64_t code) {
  16576. char buf[256];
  16577. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16578. return std::string(buf);
  16579. }
  16580. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16581. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16582. if (!mem) { return nullptr; }
  16583. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16584. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16585. if (!inf) { return nullptr; }
  16586. auto store = X509_STORE_new();
  16587. if (store) {
  16588. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16589. auto itmp = sk_X509_INFO_value(inf, i);
  16590. if (!itmp) { continue; }
  16591. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16592. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16593. }
  16594. }
  16595. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16596. return static_cast<ca_store_t>(store);
  16597. }
  16598. inline void free_ca_store(ca_store_t store) {
  16599. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16600. }
  16601. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16602. if (!ctx || !store) { return false; }
  16603. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16604. auto x509_store = static_cast<X509_STORE *>(store);
  16605. // Check if same store is already set
  16606. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16607. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16608. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16609. return true;
  16610. }
  16611. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16612. certs.clear();
  16613. if (!ctx) { return 0; }
  16614. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16615. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16616. if (!store) { return 0; }
  16617. auto objs = impl::get_store_objects(store);
  16618. if (!objs) { return 0; }
  16619. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16620. auto count = sk_X509_OBJECT_num(objs);
  16621. for (decltype(count) i = 0; i < count; i++) {
  16622. auto obj = sk_X509_OBJECT_value(objs, i);
  16623. if (!obj) { continue; }
  16624. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16625. auto x509 = X509_OBJECT_get0_X509(obj);
  16626. if (x509) {
  16627. // Increment reference count so caller can free it
  16628. X509_up_ref(x509);
  16629. certs.push_back(static_cast<cert_t>(x509));
  16630. }
  16631. }
  16632. }
  16633. return certs.size();
  16634. }
  16635. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16636. std::vector<std::string> names;
  16637. if (!ctx) { return names; }
  16638. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16639. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16640. if (!store) { return names; }
  16641. auto objs = impl::get_store_objects(store);
  16642. if (!objs) { return names; }
  16643. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16644. auto count = sk_X509_OBJECT_num(objs);
  16645. for (decltype(count) i = 0; i < count; i++) {
  16646. auto obj = sk_X509_OBJECT_value(objs, i);
  16647. if (!obj) { continue; }
  16648. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16649. auto x509 = X509_OBJECT_get0_X509(obj);
  16650. if (x509) {
  16651. auto subject = X509_get_subject_name(x509);
  16652. if (subject) {
  16653. char buf[512];
  16654. X509_NAME_oneline(subject, buf, sizeof(buf));
  16655. names.push_back(buf);
  16656. }
  16657. }
  16658. }
  16659. }
  16660. return names;
  16661. }
  16662. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16663. const char *key_pem, const char *password) {
  16664. if (!ctx || !cert_pem || !key_pem) { return false; }
  16665. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16666. // Load certificate from PEM
  16667. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16668. if (!cert_bio) { return false; }
  16669. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16670. BIO_free(cert_bio);
  16671. if (!cert) { return false; }
  16672. // Load private key from PEM
  16673. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16674. if (!key_bio) {
  16675. X509_free(cert);
  16676. return false;
  16677. }
  16678. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16679. password ? const_cast<char *>(password)
  16680. : nullptr);
  16681. BIO_free(key_bio);
  16682. if (!key) {
  16683. X509_free(cert);
  16684. return false;
  16685. }
  16686. // Update certificate and key
  16687. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16688. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16689. X509_free(cert);
  16690. EVP_PKEY_free(key);
  16691. return ret;
  16692. }
  16693. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16694. if (!ctx || !ca_pem) { return false; }
  16695. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16696. // Create new X509_STORE from PEM
  16697. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16698. if (!store) { return false; }
  16699. // SSL_CTX_set_cert_store takes ownership
  16700. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16701. // Set client CA list for client certificate request
  16702. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16703. if (ca_list) {
  16704. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16705. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16706. }
  16707. return true;
  16708. }
  16709. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16710. if (!ctx) { return false; }
  16711. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16712. impl::get_verify_callback() = std::move(callback);
  16713. if (impl::get_verify_callback()) {
  16714. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16715. } else {
  16716. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16717. }
  16718. return true;
  16719. }
  16720. inline long get_verify_error(const_session_t session) {
  16721. if (!session) { return -1; }
  16722. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16723. return SSL_get_verify_result(ssl);
  16724. }
  16725. inline std::string verify_error_string(long error_code) {
  16726. if (error_code == X509_V_OK) { return ""; }
  16727. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16728. return str ? str : "unknown error";
  16729. }
  16730. } // namespace tls
  16731. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16732. /*
  16733. * Group 9: TLS abstraction layer - Mbed TLS backend
  16734. */
  16735. /*
  16736. * Mbed TLS Backend Implementation
  16737. */
  16738. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16739. namespace tls {
  16740. namespace impl {
  16741. // Mbed TLS session wrapper
  16742. struct MbedTlsSession {
  16743. mbedtls_ssl_context ssl;
  16744. socket_t sock = INVALID_SOCKET;
  16745. std::string hostname; // For client: set via set_sni
  16746. std::string sni_hostname; // For server: received from client via SNI callback
  16747. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16748. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16749. // (e.g. a response that arrived while this side was still in its post-write
  16750. // check), the byte is pushed back here and served by the next read().
  16751. unsigned char peeked_byte = 0;
  16752. bool has_peeked_byte = false;
  16753. // Set by set_sni() when the caller disabled hostname verification, so the
  16754. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16755. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16756. // OpenSSL and wolfSSL keep them independent).
  16757. bool suppress_hostname_mismatch = false;
  16758. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16759. // decide which verify callback to install when hostname verification is
  16760. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16761. // wired for this context, or a self-contained one otherwise, so a session
  16762. // that never opted into a callback never consults the process-wide
  16763. // set_verify_callback() slot (which some other, unrelated client may have
  16764. // populated).
  16765. bool has_verify_callback = false;
  16766. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16767. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16768. MbedTlsSession(const MbedTlsSession &) = delete;
  16769. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16770. };
  16771. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16772. // queue)
  16773. inline int &mbedtls_last_error() {
  16774. static thread_local int err = 0;
  16775. return err;
  16776. }
  16777. // Helper to map Mbed TLS error to ErrorCode
  16778. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16779. uint32_t verify_flags) {
  16780. if (ret == 0) { return ErrorCode::Success; }
  16781. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16782. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16783. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16784. return ErrorCode::PeerClosed;
  16785. }
  16786. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16787. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16788. out_errno = errno;
  16789. return ErrorCode::SyscallError;
  16790. }
  16791. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16792. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16793. // the handshake's chain verification (see set_sni()); a mismatch there
  16794. // is reported the same way as any other verify_flags bit. Report it as
  16795. // HostnameMismatch, matching the other backends and the post-handshake
  16796. // identity check below, but only when naming is the sole problem -
  16797. // if the chain itself is also untrusted/expired/etc., that takes
  16798. // priority over the naming detail.
  16799. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16800. return ErrorCode::HostnameMismatch;
  16801. }
  16802. return ErrorCode::CertVerifyFailed;
  16803. }
  16804. return ErrorCode::Fatal;
  16805. }
  16806. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16807. // return value, including the verify-flags-dependent HostnameMismatch
  16808. // mapping; shared by connect() and connect_nonblocking() so the
  16809. // backend_code policy for that mapping only lives in one place.
  16810. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  16811. int ret) {
  16812. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  16813. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  16814. err.backend_code = err.code == ErrorCode::HostnameMismatch
  16815. ? static_cast<uint64_t>(verify_flags)
  16816. : static_cast<uint64_t>(-ret);
  16817. }
  16818. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  16819. // non-fatal notification delivered between records, not an error and not
  16820. // application data, so I/O calls that see it should just be retried. Kept in
  16821. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  16822. // splitting the closing brace across an #if.
  16823. inline bool mbedtls_is_session_ticket(int ret) {
  16824. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  16825. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  16826. #else
  16827. (void)ret;
  16828. return false;
  16829. #endif
  16830. }
  16831. // BIO-like send callback for Mbed TLS
  16832. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  16833. size_t len) {
  16834. auto sock = *static_cast<socket_t *>(ctx);
  16835. #ifdef _WIN32
  16836. auto ret =
  16837. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  16838. if (ret == SOCKET_ERROR) {
  16839. int err = WSAGetLastError();
  16840. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  16841. return MBEDTLS_ERR_NET_SEND_FAILED;
  16842. }
  16843. #else
  16844. auto ret = send(sock, buf, len, 0);
  16845. if (ret < 0) {
  16846. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16847. return MBEDTLS_ERR_SSL_WANT_WRITE;
  16848. }
  16849. return MBEDTLS_ERR_NET_SEND_FAILED;
  16850. }
  16851. #endif
  16852. return static_cast<int>(ret);
  16853. }
  16854. // BIO-like recv callback for Mbed TLS
  16855. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  16856. auto sock = *static_cast<socket_t *>(ctx);
  16857. #ifdef _WIN32
  16858. auto ret =
  16859. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  16860. if (ret == SOCKET_ERROR) {
  16861. int err = WSAGetLastError();
  16862. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  16863. return MBEDTLS_ERR_NET_RECV_FAILED;
  16864. }
  16865. #else
  16866. auto ret = recv(sock, buf, len, 0);
  16867. if (ret < 0) {
  16868. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16869. return MBEDTLS_ERR_SSL_WANT_READ;
  16870. }
  16871. return MBEDTLS_ERR_NET_RECV_FAILED;
  16872. }
  16873. #endif
  16874. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  16875. return static_cast<int>(ret);
  16876. }
  16877. // MbedTlsContext constructor/destructor implementations
  16878. inline MbedTlsContext::MbedTlsContext() {
  16879. mbedtls_ssl_config_init(&conf);
  16880. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16881. mbedtls_entropy_init(&entropy);
  16882. mbedtls_ctr_drbg_init(&ctr_drbg);
  16883. #endif
  16884. mbedtls_x509_crt_init(&ca_chain);
  16885. mbedtls_x509_crt_init(&own_cert);
  16886. mbedtls_pk_init(&own_key);
  16887. }
  16888. inline MbedTlsContext::~MbedTlsContext() {
  16889. mbedtls_pk_free(&own_key);
  16890. mbedtls_x509_crt_free(&own_cert);
  16891. mbedtls_x509_crt_free(&ca_chain);
  16892. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16893. mbedtls_ctr_drbg_free(&ctr_drbg);
  16894. mbedtls_entropy_free(&entropy);
  16895. #endif
  16896. mbedtls_ssl_config_free(&conf);
  16897. }
  16898. // Thread-local storage for SNI captured during handshake
  16899. // This is needed because the SNI callback doesn't have a way to pass
  16900. // session-specific data before the session is fully set up
  16901. inline std::string &mbedpending_sni() {
  16902. static thread_local std::string sni;
  16903. return sni;
  16904. }
  16905. // SNI callback for Mbed TLS server to capture client's SNI hostname
  16906. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  16907. const unsigned char *name, size_t name_len) {
  16908. (void)p_ctx;
  16909. (void)ssl;
  16910. // Store SNI name in thread-local storage
  16911. // It will be retrieved and stored in the session after handshake
  16912. if (name && name_len > 0) {
  16913. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  16914. } else {
  16915. mbedpending_sni().clear();
  16916. }
  16917. return 0; // Accept any SNI
  16918. }
  16919. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  16920. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  16921. }
  16922. // Verify callback used when hostname verification is disabled for a session
  16923. // that has no user-supplied verify callback of its own (MbedTlsSession::
  16924. // has_verify_callback is false). Deliberately does not consult
  16925. // get_verify_callback(): that slot is process-wide, so reading it here would
  16926. // pick up whatever another, unrelated client last installed there.
  16927. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  16928. mbedtls_x509_crt *, int,
  16929. uint32_t *flags) {
  16930. (void)data;
  16931. mbedtls_clear_cn_mismatch(flags);
  16932. return 0;
  16933. }
  16934. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16935. int cert_depth, uint32_t *flags);
  16936. // MbedTLS verify callback wrapper
  16937. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16938. int cert_depth, uint32_t *flags) {
  16939. // data points to the MbedTlsSession
  16940. auto *session = static_cast<MbedTlsSession *>(data);
  16941. // set_sni() disabled hostname verification for this session: drop the
  16942. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  16943. // the OpenSSL/wolfSSL backends where identity checking is independent of
  16944. // SNI. The final pass/fail decision still comes from the remaining flags
  16945. // (or, below, from the user's own verify callback).
  16946. if (session && session->suppress_hostname_mismatch) {
  16947. mbedtls_clear_cn_mismatch(flags);
  16948. }
  16949. auto &callback = get_verify_callback();
  16950. if (!callback) { return 0; } // Continue with default verification
  16951. // Build context
  16952. VerifyContext verify_ctx;
  16953. verify_ctx.session = static_cast<session_t>(session);
  16954. verify_ctx.cert = static_cast<cert_t>(crt);
  16955. verify_ctx.depth = cert_depth;
  16956. verify_ctx.preverify_ok = (*flags == 0);
  16957. verify_ctx.error_code = static_cast<long>(*flags);
  16958. // Convert Mbed TLS flags to error string
  16959. static thread_local char error_buf[256];
  16960. if (*flags != 0) {
  16961. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  16962. verify_ctx.error_string = error_buf;
  16963. } else {
  16964. verify_ctx.error_string = nullptr;
  16965. }
  16966. bool accepted = callback(verify_ctx);
  16967. if (accepted) {
  16968. *flags = 0; // Clear all error flags
  16969. return 0;
  16970. }
  16971. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  16972. }
  16973. } // namespace impl
  16974. inline ctx_t create_client_context() {
  16975. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  16976. if (!ctx) { return nullptr; }
  16977. ctx->is_server = false;
  16978. #ifdef CPPHTTPLIB_MBEDTLS_V4
  16979. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  16980. if (!detail::ensure_mbedtls_psa_crypto()) {
  16981. delete ctx;
  16982. return nullptr;
  16983. }
  16984. int ret;
  16985. #else
  16986. // Seed the random number generator
  16987. const char *pers = "httplib_client";
  16988. int ret = mbedtls_ctr_drbg_seed(
  16989. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  16990. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  16991. if (ret != 0) {
  16992. impl::mbedtls_last_error() = ret;
  16993. delete ctx;
  16994. return nullptr;
  16995. }
  16996. #endif
  16997. // Set up SSL config for client
  16998. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  16999. MBEDTLS_SSL_TRANSPORT_STREAM,
  17000. MBEDTLS_SSL_PRESET_DEFAULT);
  17001. if (ret != 0) {
  17002. impl::mbedtls_last_error() = ret;
  17003. delete ctx;
  17004. return nullptr;
  17005. }
  17006. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17007. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17008. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17009. #endif
  17010. // Default: verify peer certificate
  17011. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17012. // Set minimum TLS version to 1.2
  17013. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17014. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17015. #else
  17016. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17017. MBEDTLS_SSL_MINOR_VERSION_3);
  17018. #endif
  17019. return static_cast<ctx_t>(ctx);
  17020. }
  17021. inline ctx_t create_server_context() {
  17022. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17023. if (!ctx) { return nullptr; }
  17024. ctx->is_server = true;
  17025. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17026. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17027. if (!detail::ensure_mbedtls_psa_crypto()) {
  17028. delete ctx;
  17029. return nullptr;
  17030. }
  17031. int ret;
  17032. #else
  17033. // Seed the random number generator
  17034. const char *pers = "httplib_server";
  17035. int ret = mbedtls_ctr_drbg_seed(
  17036. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17037. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17038. if (ret != 0) {
  17039. impl::mbedtls_last_error() = ret;
  17040. delete ctx;
  17041. return nullptr;
  17042. }
  17043. #endif
  17044. // Set up SSL config for server
  17045. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17046. MBEDTLS_SSL_TRANSPORT_STREAM,
  17047. MBEDTLS_SSL_PRESET_DEFAULT);
  17048. if (ret != 0) {
  17049. impl::mbedtls_last_error() = ret;
  17050. delete ctx;
  17051. return nullptr;
  17052. }
  17053. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17054. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17055. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17056. #endif
  17057. // Default: don't verify client
  17058. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17059. // Set minimum TLS version to 1.2
  17060. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17061. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17062. #else
  17063. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17064. MBEDTLS_SSL_MINOR_VERSION_3);
  17065. #endif
  17066. // Set SNI callback to capture client's SNI hostname
  17067. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17068. return static_cast<ctx_t>(ctx);
  17069. }
  17070. inline void free_context(ctx_t ctx) {
  17071. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17072. }
  17073. inline bool set_min_version(ctx_t ctx, Version version) {
  17074. if (!ctx) { return false; }
  17075. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17076. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17077. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17078. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17079. if (version >= Version::TLS1_3) {
  17080. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17081. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17082. #endif
  17083. }
  17084. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17085. #else
  17086. // Mbed TLS 2.x uses major/minor version numbers
  17087. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17088. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17089. if (version >= Version::TLS1_3) {
  17090. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17091. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17092. #else
  17093. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17094. #endif
  17095. }
  17096. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17097. #endif
  17098. return true;
  17099. }
  17100. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17101. if (!ctx || !pem) { return false; }
  17102. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17103. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17104. // Add null terminator if not present
  17105. std::string pem_str(pem, len);
  17106. int ret = mbedtls_x509_crt_parse(
  17107. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17108. pem_str.size() + 1);
  17109. if (ret != 0) {
  17110. impl::mbedtls_last_error() = ret;
  17111. return false;
  17112. }
  17113. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17114. return true;
  17115. }
  17116. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17117. if (!ctx || !file_path) { return false; }
  17118. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17119. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17120. if (ret != 0) {
  17121. impl::mbedtls_last_error() = ret;
  17122. return false;
  17123. }
  17124. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17125. return true;
  17126. }
  17127. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17128. if (!ctx || !dir_path) { return false; }
  17129. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17130. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17131. if (ret < 0) { // Returns number of certs on success, negative on error
  17132. impl::mbedtls_last_error() = ret;
  17133. return false;
  17134. }
  17135. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17136. return true;
  17137. }
  17138. inline bool load_system_certs(ctx_t ctx) {
  17139. if (!ctx) { return false; }
  17140. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17141. bool loaded = false;
  17142. #ifdef _WIN32
  17143. loaded = impl::enumerate_windows_system_certs(
  17144. [&](const unsigned char *data, size_t len) {
  17145. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17146. });
  17147. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17148. loaded = impl::enumerate_macos_keychain_certs(
  17149. [&](const unsigned char *data, size_t len) {
  17150. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17151. });
  17152. #else
  17153. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17154. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17155. loaded = true;
  17156. break;
  17157. }
  17158. }
  17159. if (!loaded) {
  17160. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17161. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17162. loaded = true;
  17163. break;
  17164. }
  17165. }
  17166. }
  17167. #endif
  17168. if (loaded) {
  17169. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17170. }
  17171. return loaded;
  17172. }
  17173. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17174. const char *password) {
  17175. if (!ctx || !cert || !key) { return false; }
  17176. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17177. // Parse certificate
  17178. std::string cert_str(cert);
  17179. int ret = mbedtls_x509_crt_parse(
  17180. &mctx->own_cert,
  17181. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17182. cert_str.size() + 1);
  17183. if (ret != 0) {
  17184. impl::mbedtls_last_error() = ret;
  17185. return false;
  17186. }
  17187. // Parse private key
  17188. std::string key_str(key);
  17189. const unsigned char *pwd =
  17190. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17191. size_t pwd_len = password ? strlen(password) : 0;
  17192. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17193. ret = mbedtls_pk_parse_key(
  17194. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17195. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17196. &mctx->ctr_drbg);
  17197. #else
  17198. ret = mbedtls_pk_parse_key(
  17199. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17200. key_str.size() + 1, pwd, pwd_len);
  17201. #endif
  17202. if (ret != 0) {
  17203. impl::mbedtls_last_error() = ret;
  17204. return false;
  17205. }
  17206. // Verify that the certificate and private key match.
  17207. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17208. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17209. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17210. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17211. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17212. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17213. #else
  17214. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17215. #endif
  17216. if (ret != 0) {
  17217. impl::mbedtls_last_error() = ret;
  17218. return false;
  17219. }
  17220. #endif
  17221. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17222. if (ret != 0) {
  17223. impl::mbedtls_last_error() = ret;
  17224. return false;
  17225. }
  17226. return true;
  17227. }
  17228. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17229. const char *key_path, const char *password) {
  17230. if (!ctx || !cert_path || !key_path) { return false; }
  17231. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17232. // Parse certificate file
  17233. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17234. if (ret != 0) {
  17235. impl::mbedtls_last_error() = ret;
  17236. return false;
  17237. }
  17238. // Parse private key file
  17239. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17240. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17241. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17242. #else
  17243. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17244. #endif
  17245. if (ret != 0) {
  17246. impl::mbedtls_last_error() = ret;
  17247. return false;
  17248. }
  17249. // Verify that the certificate and private key match.
  17250. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17251. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17252. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17253. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17254. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17255. #else
  17256. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17257. #endif
  17258. if (ret != 0) {
  17259. impl::mbedtls_last_error() = ret;
  17260. return false;
  17261. }
  17262. #endif
  17263. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17264. if (ret != 0) {
  17265. impl::mbedtls_last_error() = ret;
  17266. return false;
  17267. }
  17268. return true;
  17269. }
  17270. inline void set_verify_client(ctx_t ctx, bool require) {
  17271. if (!ctx) { return; }
  17272. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17273. mctx->verify_client = require;
  17274. if (require) {
  17275. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17276. } else {
  17277. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17278. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17279. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17280. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17281. : MBEDTLS_SSL_VERIFY_NONE);
  17282. }
  17283. }
  17284. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17285. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17286. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17287. auto session = new (std::nothrow) impl::MbedTlsSession();
  17288. if (!session) { return nullptr; }
  17289. session->sock = sock;
  17290. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17291. if (ret != 0) {
  17292. impl::mbedtls_last_error() = ret;
  17293. delete session;
  17294. return nullptr;
  17295. }
  17296. // Explicitly opt out of in-handshake hostname verification by default;
  17297. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17298. // fails outright when no hostname was set. set_sni() installs the real
  17299. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17300. // caller verifies the certificate identity post-handshake via
  17301. // verify_hostname().
  17302. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17303. // Set BIO callbacks
  17304. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17305. impl::mbedtls_net_recv_cb, nullptr);
  17306. // Set per-session verify callback with session pointer if callback is
  17307. // registered
  17308. session->has_verify_callback = mctx->has_verify_callback;
  17309. if (mctx->has_verify_callback) {
  17310. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17311. session);
  17312. }
  17313. return static_cast<session_t>(session);
  17314. }
  17315. inline void free_session(session_t session) {
  17316. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17317. }
  17318. inline bool set_sni(session_t session, const char *hostname,
  17319. bool verify_hostname) {
  17320. if (!session || !hostname) { return false; }
  17321. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17322. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17323. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17324. // independently, so a disabled hostname check is handled below by masking
  17325. // the resulting mismatch flag instead of skipping this call.
  17326. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17327. if (ret != 0) {
  17328. impl::mbedtls_last_error() = ret;
  17329. return false;
  17330. }
  17331. msession->hostname = hostname;
  17332. if (!verify_hostname) {
  17333. msession->suppress_hostname_mismatch = true;
  17334. // If a user verify callback is already wired for this session,
  17335. // mbedtls_verify_callback() masks the mismatch flag itself before
  17336. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17337. // here would be redundant. Otherwise install the self-contained masking
  17338. // callback, which never touches the process-wide callback slot.
  17339. if (!msession->has_verify_callback) {
  17340. mbedtls_ssl_set_verify(&msession->ssl,
  17341. impl::mbedtls_mask_hostname_mismatch_callback,
  17342. msession);
  17343. }
  17344. }
  17345. return true;
  17346. }
  17347. inline TlsError connect(session_t session) {
  17348. TlsError err;
  17349. if (!session) {
  17350. err.code = ErrorCode::Fatal;
  17351. return err;
  17352. }
  17353. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17354. int ret;
  17355. do {
  17356. ret = mbedtls_ssl_handshake(&msession->ssl);
  17357. } while (impl::mbedtls_is_session_ticket(ret));
  17358. if (ret == 0) {
  17359. err.code = ErrorCode::Success;
  17360. } else {
  17361. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17362. impl::mbedtls_last_error() = ret;
  17363. }
  17364. return err;
  17365. }
  17366. inline TlsError accept(session_t session) {
  17367. // Same as connect for Mbed TLS - handshake works for both client and server
  17368. auto result = connect(session);
  17369. // After successful handshake, capture SNI from thread-local storage
  17370. if (result.code == ErrorCode::Success && session) {
  17371. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17372. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17373. impl::mbedpending_sni().clear();
  17374. }
  17375. return result;
  17376. }
  17377. inline bool connect_nonblocking(session_t session, socket_t sock,
  17378. time_t timeout_sec, time_t timeout_usec,
  17379. TlsError *err) {
  17380. if (!session) {
  17381. if (err) { err->code = ErrorCode::Fatal; }
  17382. return false;
  17383. }
  17384. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17385. // Set socket to non-blocking mode
  17386. detail::set_nonblocking(sock, true);
  17387. auto cleanup =
  17388. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17389. int ret;
  17390. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17391. // Non-fatal TLS 1.3 ticket; retry immediately.
  17392. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17393. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17394. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17395. continue;
  17396. }
  17397. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17398. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17399. continue;
  17400. }
  17401. }
  17402. // TlsError or timeout
  17403. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17404. impl::mbedtls_last_error() = ret;
  17405. return false;
  17406. }
  17407. if (err) { err->code = ErrorCode::Success; }
  17408. return true;
  17409. }
  17410. inline bool accept_nonblocking(session_t session, socket_t sock,
  17411. time_t timeout_sec, time_t timeout_usec,
  17412. TlsError *err) {
  17413. // Same implementation as connect for Mbed TLS
  17414. bool result =
  17415. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17416. // After successful handshake, capture SNI from thread-local storage
  17417. if (result && session) {
  17418. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17419. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17420. impl::mbedpending_sni().clear();
  17421. }
  17422. return result;
  17423. }
  17424. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17425. if (!session || !buf) {
  17426. err.code = ErrorCode::Fatal;
  17427. return -1;
  17428. }
  17429. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17430. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17431. if (msession->has_peeked_byte) {
  17432. if (len == 0) { return 0; }
  17433. auto p = static_cast<unsigned char *>(buf);
  17434. p[0] = msession->peeked_byte;
  17435. msession->has_peeked_byte = false;
  17436. size_t n = 1;
  17437. // Top up with any already-decrypted bytes without risking a block.
  17438. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17439. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17440. if (extra > 0) { n += static_cast<size_t>(extra); }
  17441. }
  17442. err.code = ErrorCode::Success;
  17443. return static_cast<ssize_t>(n);
  17444. }
  17445. int ret;
  17446. do {
  17447. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17448. len);
  17449. } while (impl::mbedtls_is_session_ticket(ret));
  17450. if (ret > 0) {
  17451. err.code = ErrorCode::Success;
  17452. return static_cast<ssize_t>(ret);
  17453. }
  17454. if (ret == 0) {
  17455. err.code = ErrorCode::PeerClosed;
  17456. return 0;
  17457. }
  17458. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17459. err.backend_code = static_cast<uint64_t>(-ret);
  17460. impl::mbedtls_last_error() = ret;
  17461. // mbedTLS signals a clean close_notify via a negative error code rather
  17462. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17463. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17464. return -1;
  17465. }
  17466. inline ssize_t write(session_t session, const void *buf, size_t len,
  17467. TlsError &err) {
  17468. if (!session || !buf) {
  17469. err.code = ErrorCode::Fatal;
  17470. return -1;
  17471. }
  17472. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17473. int ret;
  17474. do {
  17475. ret = mbedtls_ssl_write(&msession->ssl,
  17476. static_cast<const unsigned char *>(buf), len);
  17477. } while (impl::mbedtls_is_session_ticket(ret));
  17478. if (ret > 0) {
  17479. err.code = ErrorCode::Success;
  17480. return static_cast<ssize_t>(ret);
  17481. }
  17482. if (ret == 0) {
  17483. err.code = ErrorCode::PeerClosed;
  17484. return 0;
  17485. }
  17486. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17487. err.backend_code = static_cast<uint64_t>(-ret);
  17488. impl::mbedtls_last_error() = ret;
  17489. return -1;
  17490. }
  17491. inline int pending(const_session_t session) {
  17492. if (!session) { return 0; }
  17493. auto msession =
  17494. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17495. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17496. (msession->has_peeked_byte ? 1 : 0);
  17497. }
  17498. inline void shutdown(session_t session, bool graceful) {
  17499. if (!session) { return; }
  17500. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17501. if (graceful) {
  17502. // Try to send close_notify, but don't block forever
  17503. int ret;
  17504. int attempts = 0;
  17505. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17506. attempts < 3) {
  17507. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17508. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17509. break;
  17510. }
  17511. attempts++;
  17512. }
  17513. }
  17514. }
  17515. inline bool is_peer_closed(session_t session, socket_t sock) {
  17516. if (!session || sock == INVALID_SOCKET) { return true; }
  17517. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17518. // Check if there's already decrypted or pushed-back data available.
  17519. // If so, the connection is definitely alive.
  17520. if (msession->has_peeked_byte ||
  17521. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17522. return false;
  17523. }
  17524. // Set socket to non-blocking to avoid blocking on read
  17525. detail::set_nonblocking(sock, true);
  17526. auto cleanup =
  17527. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17528. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17529. // on application data — e.g. a response that already arrived — push the
  17530. // byte back so the next read() delivers it instead of losing it.
  17531. unsigned char buf;
  17532. int ret;
  17533. do {
  17534. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17535. } while (impl::mbedtls_is_session_ticket(ret));
  17536. // If we got data or WANT_READ (would block), connection is alive
  17537. if (ret > 0) {
  17538. msession->peeked_byte = buf;
  17539. msession->has_peeked_byte = true;
  17540. return false;
  17541. }
  17542. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17543. // If we get a peer close notify or a connection reset, the peer is closed
  17544. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17545. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17546. }
  17547. inline cert_t get_peer_cert(const_session_t session) {
  17548. if (!session) { return nullptr; }
  17549. auto msession =
  17550. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17551. // Mbed TLS returns a pointer to the internal peer cert chain.
  17552. // WARNING: This pointer is only valid while the session is active.
  17553. // Do not use the certificate after calling free_session().
  17554. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17555. return const_cast<mbedtls_x509_crt *>(cert);
  17556. }
  17557. inline void free_cert(cert_t cert) {
  17558. // Mbed TLS: peer certificate is owned by the SSL context.
  17559. // No-op here, but callers should still call this for cross-backend
  17560. // portability.
  17561. (void)cert;
  17562. }
  17563. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17564. if (!cert || !hostname) { return false; }
  17565. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17566. std::string host_str(hostname);
  17567. // Check if hostname is an IP address (IPv4 or IPv6)
  17568. unsigned char ip_bytes[16];
  17569. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17570. auto is_ip = ip_len > 0;
  17571. // Check Subject Alternative Names (SAN)
  17572. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17573. // - DNS names: raw string bytes
  17574. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17575. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17576. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17577. const unsigned char *p = san->buf.p;
  17578. size_t len = san->buf.len;
  17579. if (is_ip) {
  17580. // For an IP host, only a matching iPAddress SAN of the same family
  17581. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17582. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17583. } else {
  17584. // Check if this SAN is a DNS name (printable ASCII string)
  17585. bool is_dns = len > 0;
  17586. for (size_t i = 0; i < len && is_dns; i++) {
  17587. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17588. }
  17589. if (is_dns) {
  17590. std::string san_name(reinterpret_cast<const char *>(p), len);
  17591. if (detail::match_hostname(san_name, host_str)) { return true; }
  17592. }
  17593. }
  17594. san = san->next;
  17595. }
  17596. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17597. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17598. // the OpenSSL backend's X509_check_ip behaves the same way).
  17599. if (!is_ip) {
  17600. char cn[256];
  17601. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17602. if (ret > 0) {
  17603. std::string cn_str(cn);
  17604. // Look for "CN=" in the DN string
  17605. size_t cn_pos = cn_str.find("CN=");
  17606. if (cn_pos != std::string::npos) {
  17607. size_t start = cn_pos + 3;
  17608. size_t end = cn_str.find(',', start);
  17609. std::string cn_value =
  17610. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17611. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17612. }
  17613. }
  17614. }
  17615. return false;
  17616. }
  17617. inline uint64_t hostname_mismatch_code() {
  17618. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17619. }
  17620. inline long get_verify_result(const_session_t session) {
  17621. if (!session) { return -1; }
  17622. auto msession =
  17623. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17624. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17625. // Return 0 (X509_V_OK equivalent) if verification passed
  17626. return flags == 0 ? 0 : static_cast<long>(flags);
  17627. }
  17628. inline std::string get_cert_subject_cn(cert_t cert) {
  17629. if (!cert) return "";
  17630. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17631. // Find the CN in the subject
  17632. const mbedtls_x509_name *name = &x509->subject;
  17633. while (name != nullptr) {
  17634. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17635. return std::string(reinterpret_cast<const char *>(name->val.p),
  17636. name->val.len);
  17637. }
  17638. name = name->next;
  17639. }
  17640. return "";
  17641. }
  17642. inline std::string get_cert_issuer_name(cert_t cert) {
  17643. if (!cert) return "";
  17644. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17645. // Build a human-readable issuer name string
  17646. char buf[512];
  17647. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17648. if (ret < 0) return "";
  17649. return std::string(buf);
  17650. }
  17651. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17652. sans.clear();
  17653. if (!cert) return false;
  17654. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17655. // Parse the Subject Alternative Name extension
  17656. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17657. while (cur != nullptr) {
  17658. if (cur->buf.len > 0) {
  17659. // Mbed TLS stores SAN as ASN.1 sequences
  17660. // The tag byte indicates the type
  17661. const unsigned char *p = cur->buf.p;
  17662. size_t len = cur->buf.len;
  17663. // First byte is the tag
  17664. unsigned char tag = *p;
  17665. p++;
  17666. len--;
  17667. // Parse length (simple single-byte length assumed)
  17668. if (len > 0 && *p < 0x80) {
  17669. size_t value_len = *p;
  17670. p++;
  17671. len--;
  17672. if (value_len <= len) {
  17673. SanEntry entry;
  17674. // ASN.1 context tags for GeneralName
  17675. switch (tag & 0x1F) {
  17676. case 2: // dNSName
  17677. entry.type = SanType::DNS;
  17678. entry.value =
  17679. std::string(reinterpret_cast<const char *>(p), value_len);
  17680. break;
  17681. case 7: // iPAddress
  17682. entry.type = SanType::IP;
  17683. if (value_len == 4) {
  17684. // IPv4
  17685. char buf[16];
  17686. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17687. entry.value = buf;
  17688. } else if (value_len == 16) {
  17689. // IPv6
  17690. char buf[64];
  17691. snprintf(buf, sizeof(buf),
  17692. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17693. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17694. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17695. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17696. entry.value = buf;
  17697. }
  17698. break;
  17699. case 1: // rfc822Name (email)
  17700. entry.type = SanType::EMAIL;
  17701. entry.value =
  17702. std::string(reinterpret_cast<const char *>(p), value_len);
  17703. break;
  17704. case 6: // uniformResourceIdentifier
  17705. entry.type = SanType::URI;
  17706. entry.value =
  17707. std::string(reinterpret_cast<const char *>(p), value_len);
  17708. break;
  17709. default: entry.type = SanType::OTHER; break;
  17710. }
  17711. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17712. }
  17713. }
  17714. }
  17715. cur = cur->next;
  17716. }
  17717. return true;
  17718. }
  17719. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17720. time_t &not_after) {
  17721. if (!cert) return false;
  17722. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17723. // Convert mbedtls_x509_time to time_t
  17724. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17725. struct tm tm_time = {};
  17726. tm_time.tm_year = t.year - 1900;
  17727. tm_time.tm_mon = t.mon - 1;
  17728. tm_time.tm_mday = t.day;
  17729. tm_time.tm_hour = t.hour;
  17730. tm_time.tm_min = t.min;
  17731. tm_time.tm_sec = t.sec;
  17732. #ifdef _WIN32
  17733. return _mkgmtime(&tm_time);
  17734. #else
  17735. return timegm(&tm_time);
  17736. #endif
  17737. };
  17738. not_before = to_time_t(x509->valid_from);
  17739. not_after = to_time_t(x509->valid_to);
  17740. return true;
  17741. }
  17742. inline std::string get_cert_serial(cert_t cert) {
  17743. if (!cert) return "";
  17744. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17745. // Convert serial number to hex string
  17746. std::string result;
  17747. result.reserve(x509->serial.len * 2);
  17748. for (size_t i = 0; i < x509->serial.len; i++) {
  17749. char hex[3];
  17750. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17751. result += hex;
  17752. }
  17753. return result;
  17754. }
  17755. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17756. if (!cert) return false;
  17757. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17758. if (!crt->raw.p || crt->raw.len == 0) return false;
  17759. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17760. return true;
  17761. }
  17762. inline const char *get_sni(const_session_t session) {
  17763. if (!session) return nullptr;
  17764. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17765. // For server: return SNI received from client during handshake
  17766. if (!msession->sni_hostname.empty()) {
  17767. return msession->sni_hostname.c_str();
  17768. }
  17769. // For client: return the hostname set via set_sni
  17770. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17771. return nullptr;
  17772. }
  17773. inline uint64_t peek_error() {
  17774. // Mbed TLS doesn't have an error queue, return the last error
  17775. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17776. }
  17777. inline uint64_t get_error() {
  17778. // Mbed TLS doesn't have an error queue, return and clear the last error
  17779. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17780. impl::mbedtls_last_error() = 0;
  17781. return err;
  17782. }
  17783. inline std::string error_string(uint64_t code) {
  17784. char buf[256];
  17785. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17786. return std::string(buf);
  17787. }
  17788. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17789. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17790. if (!ca_chain) { return nullptr; }
  17791. mbedtls_x509_crt_init(ca_chain);
  17792. // mbedtls_x509_crt_parse expects null-terminated PEM
  17793. int ret = mbedtls_x509_crt_parse(ca_chain,
  17794. reinterpret_cast<const unsigned char *>(pem),
  17795. len + 1); // +1 for null terminator
  17796. if (ret != 0) {
  17797. // Try without +1 in case PEM is already null-terminated
  17798. ret = mbedtls_x509_crt_parse(
  17799. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17800. if (ret != 0) {
  17801. mbedtls_x509_crt_free(ca_chain);
  17802. delete ca_chain;
  17803. return nullptr;
  17804. }
  17805. }
  17806. return static_cast<ca_store_t>(ca_chain);
  17807. }
  17808. inline void free_ca_store(ca_store_t store) {
  17809. if (store) {
  17810. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17811. mbedtls_x509_crt_free(ca_chain);
  17812. delete ca_chain;
  17813. }
  17814. }
  17815. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17816. if (!ctx || !store) { return false; }
  17817. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17818. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17819. // Free existing CA chain
  17820. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17821. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17822. // Copy the CA chain (deep copy)
  17823. // Parse from the raw data of the source cert
  17824. mbedtls_x509_crt *src = ca_chain;
  17825. while (src != nullptr) {
  17826. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  17827. src->raw.len);
  17828. if (ret != 0) {
  17829. free_ca_store(store);
  17830. return false;
  17831. }
  17832. src = src->next;
  17833. }
  17834. // This function takes ownership of the store; the chain was deep-copied
  17835. // above, so release the source
  17836. free_ca_store(store);
  17837. // Update the SSL config to use the new CA chain
  17838. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17839. return true;
  17840. }
  17841. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17842. certs.clear();
  17843. if (!ctx) { return 0; }
  17844. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17845. // Iterate through the CA chain
  17846. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17847. while (cert != nullptr && cert->raw.len > 0) {
  17848. // Create a copy of the certificate for the caller
  17849. auto *copy = new mbedtls_x509_crt;
  17850. mbedtls_x509_crt_init(copy);
  17851. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  17852. if (ret == 0) {
  17853. certs.push_back(static_cast<cert_t>(copy));
  17854. } else {
  17855. mbedtls_x509_crt_free(copy);
  17856. delete copy;
  17857. }
  17858. cert = cert->next;
  17859. }
  17860. return certs.size();
  17861. }
  17862. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17863. std::vector<std::string> names;
  17864. if (!ctx) { return names; }
  17865. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17866. // Iterate through the CA chain
  17867. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17868. while (cert != nullptr && cert->raw.len > 0) {
  17869. char buf[512];
  17870. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  17871. if (ret > 0) { names.push_back(buf); }
  17872. cert = cert->next;
  17873. }
  17874. return names;
  17875. }
  17876. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17877. const char *key_pem, const char *password) {
  17878. if (!ctx || !cert_pem || !key_pem) { return false; }
  17879. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17880. // Free existing certificate and key
  17881. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  17882. mbedtls_pk_free(&mbed_ctx->own_key);
  17883. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  17884. mbedtls_pk_init(&mbed_ctx->own_key);
  17885. // Parse certificate PEM
  17886. int ret = mbedtls_x509_crt_parse(
  17887. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  17888. strlen(cert_pem) + 1);
  17889. if (ret != 0) {
  17890. impl::mbedtls_last_error() = ret;
  17891. return false;
  17892. }
  17893. // Parse private key PEM
  17894. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17895. ret = mbedtls_pk_parse_key(
  17896. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17897. strlen(key_pem) + 1,
  17898. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17899. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  17900. &mbed_ctx->ctr_drbg);
  17901. #else
  17902. ret = mbedtls_pk_parse_key(
  17903. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17904. strlen(key_pem) + 1,
  17905. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17906. password ? strlen(password) : 0);
  17907. #endif
  17908. if (ret != 0) {
  17909. impl::mbedtls_last_error() = ret;
  17910. return false;
  17911. }
  17912. // Configure SSL to use the new certificate and key
  17913. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  17914. &mbed_ctx->own_key);
  17915. if (ret != 0) {
  17916. impl::mbedtls_last_error() = ret;
  17917. return false;
  17918. }
  17919. return true;
  17920. }
  17921. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17922. if (!ctx || !ca_pem) { return false; }
  17923. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17924. // Free existing CA chain
  17925. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17926. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17927. // Parse CA PEM
  17928. int ret = mbedtls_x509_crt_parse(
  17929. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  17930. strlen(ca_pem) + 1);
  17931. if (ret != 0) {
  17932. impl::mbedtls_last_error() = ret;
  17933. return false;
  17934. }
  17935. // Update SSL config to use new CA chain
  17936. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17937. return true;
  17938. }
  17939. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17940. if (!ctx) { return false; }
  17941. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17942. impl::get_verify_callback() = std::move(callback);
  17943. mbed_ctx->has_verify_callback =
  17944. static_cast<bool>(impl::get_verify_callback());
  17945. if (mbed_ctx->has_verify_callback) {
  17946. // Set OPTIONAL mode to ensure callback is called even when verification
  17947. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  17948. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  17949. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  17950. nullptr);
  17951. } else {
  17952. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  17953. }
  17954. return true;
  17955. }
  17956. inline long get_verify_error(const_session_t session) {
  17957. if (!session) { return -1; }
  17958. auto *msession =
  17959. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17960. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  17961. }
  17962. inline std::string verify_error_string(long error_code) {
  17963. if (error_code == 0) { return ""; }
  17964. char buf[256];
  17965. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  17966. static_cast<uint32_t>(error_code));
  17967. // Remove trailing newline if present
  17968. std::string result(buf);
  17969. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  17970. result.pop_back();
  17971. }
  17972. return result;
  17973. }
  17974. } // namespace tls
  17975. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  17976. /*
  17977. * Group 10: TLS abstraction layer - wolfSSL backend
  17978. */
  17979. /*
  17980. * wolfSSL Backend Implementation
  17981. */
  17982. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  17983. namespace tls {
  17984. namespace impl {
  17985. // wolfSSL session wrapper
  17986. struct WolfSSLSession {
  17987. WOLFSSL *ssl = nullptr;
  17988. socket_t sock = INVALID_SOCKET;
  17989. std::string hostname; // For client: set via set_sni
  17990. std::string sni_hostname; // For server: received from client via SNI callback
  17991. WolfSSLSession() = default;
  17992. ~WolfSSLSession() {
  17993. if (ssl) { wolfSSL_free(ssl); }
  17994. }
  17995. WolfSSLSession(const WolfSSLSession &) = delete;
  17996. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  17997. };
  17998. // Thread-local error code accessor for wolfSSL
  17999. inline uint64_t &wolfssl_last_error() {
  18000. static thread_local uint64_t err = 0;
  18001. return err;
  18002. }
  18003. // Helper to map wolfSSL error to ErrorCode.
  18004. // ssl_error is the value from wolfSSL_get_error().
  18005. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18006. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18007. int &out_errno) {
  18008. switch (ssl_error) {
  18009. case SSL_ERROR_NONE: return ErrorCode::Success;
  18010. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18011. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18012. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18013. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18014. default:
  18015. if (ssl) {
  18016. // wolfSSL stores the low-level error code as a negative value.
  18017. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18018. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18019. if (low_err == DOMAIN_NAME_MISMATCH) {
  18020. return ErrorCode::HostnameMismatch;
  18021. }
  18022. // Check verify result to distinguish cert verification from generic SSL
  18023. // errors.
  18024. long vr = wolfSSL_get_verify_result(ssl);
  18025. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18026. }
  18027. return ErrorCode::Fatal;
  18028. }
  18029. }
  18030. // WolfSSLContext constructor/destructor implementations
  18031. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18032. inline WolfSSLContext::~WolfSSLContext() {
  18033. if (ctx) { wolfSSL_CTX_free(ctx); }
  18034. }
  18035. // Thread-local storage for SNI captured during handshake
  18036. inline std::string &wolfssl_pending_sni() {
  18037. static thread_local std::string sni;
  18038. return sni;
  18039. }
  18040. // SNI callback for wolfSSL server to capture client's SNI hostname
  18041. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18042. (void)ret;
  18043. (void)exArg;
  18044. void *name_data = nullptr;
  18045. unsigned short name_len =
  18046. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18047. if (name_data && name_len > 0) {
  18048. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18049. name_len);
  18050. } else {
  18051. wolfssl_pending_sni().clear();
  18052. }
  18053. return 0; // Continue regardless
  18054. }
  18055. // wolfSSL verify callback wrapper
  18056. inline int wolfssl_verify_callback(int preverify_ok,
  18057. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18058. auto &callback = get_verify_callback();
  18059. if (!callback) { return preverify_ok; }
  18060. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18061. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18062. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18063. // Get the WOLFSSL object from the X509_STORE_CTX
  18064. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18065. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18066. VerifyContext verify_ctx;
  18067. verify_ctx.session = static_cast<session_t>(ssl);
  18068. verify_ctx.cert = static_cast<cert_t>(cert);
  18069. verify_ctx.depth = depth;
  18070. verify_ctx.preverify_ok = (preverify_ok != 0);
  18071. verify_ctx.error_code = static_cast<long>(err);
  18072. if (err != 0) {
  18073. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18074. } else {
  18075. verify_ctx.error_string = nullptr;
  18076. }
  18077. bool accepted = callback(verify_ctx);
  18078. return accepted ? 1 : 0;
  18079. }
  18080. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18081. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18082. wolfSSL_CTX_set_default_passwd_cb(
  18083. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18084. auto *pwd = static_cast<const char *>(userdata);
  18085. if (!pwd) return 0;
  18086. auto len = static_cast<int>(strlen(pwd));
  18087. if (len > size) len = size;
  18088. memcpy(buf, pwd, static_cast<size_t>(len));
  18089. return len;
  18090. });
  18091. }
  18092. } // namespace impl
  18093. inline ctx_t create_client_context() {
  18094. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18095. if (!ctx) { return nullptr; }
  18096. ctx->is_server = false;
  18097. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18098. if (!method) {
  18099. delete ctx;
  18100. return nullptr;
  18101. }
  18102. ctx->ctx = wolfSSL_CTX_new(method);
  18103. if (!ctx->ctx) {
  18104. delete ctx;
  18105. return nullptr;
  18106. }
  18107. // Default: verify peer certificate
  18108. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18109. return static_cast<ctx_t>(ctx);
  18110. }
  18111. inline ctx_t create_server_context() {
  18112. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18113. if (!ctx) { return nullptr; }
  18114. ctx->is_server = true;
  18115. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18116. if (!method) {
  18117. delete ctx;
  18118. return nullptr;
  18119. }
  18120. ctx->ctx = wolfSSL_CTX_new(method);
  18121. if (!ctx->ctx) {
  18122. delete ctx;
  18123. return nullptr;
  18124. }
  18125. // Default: don't verify client
  18126. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18127. // Enable SNI on server
  18128. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18129. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18130. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18131. return static_cast<ctx_t>(ctx);
  18132. }
  18133. inline void free_context(ctx_t ctx) {
  18134. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18135. }
  18136. inline bool set_min_version(ctx_t ctx, Version version) {
  18137. if (!ctx) { return false; }
  18138. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18139. int min_ver = WOLFSSL_TLSV1_2;
  18140. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18141. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18142. }
  18143. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18144. if (!ctx || !pem) { return false; }
  18145. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18146. int ret = wolfSSL_CTX_load_verify_buffer(
  18147. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18148. static_cast<long>(len), SSL_FILETYPE_PEM);
  18149. if (ret != SSL_SUCCESS) {
  18150. impl::wolfssl_last_error() =
  18151. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18152. return false;
  18153. }
  18154. wctx->ca_pem_data_.append(pem, len);
  18155. return true;
  18156. }
  18157. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18158. if (!ctx || !file_path) { return false; }
  18159. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18160. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18161. if (ret != SSL_SUCCESS) {
  18162. impl::wolfssl_last_error() =
  18163. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18164. return false;
  18165. }
  18166. return true;
  18167. }
  18168. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18169. if (!ctx || !dir_path) { return false; }
  18170. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18171. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18172. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18173. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18174. // immediately. Return true even on failure since the CA file may have
  18175. // already been loaded, matching OpenSSL's lenient behavior.
  18176. (void)ret;
  18177. return true;
  18178. }
  18179. inline bool load_system_certs(ctx_t ctx) {
  18180. if (!ctx) { return false; }
  18181. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18182. bool loaded = false;
  18183. #ifdef _WIN32
  18184. loaded = impl::enumerate_windows_system_certs(
  18185. [&](const unsigned char *data, size_t len) {
  18186. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18187. static_cast<long>(len),
  18188. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18189. });
  18190. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18191. loaded = impl::enumerate_macos_keychain_certs(
  18192. [&](const unsigned char *data, size_t len) {
  18193. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18194. static_cast<long>(len),
  18195. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18196. });
  18197. #else
  18198. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18199. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18200. SSL_SUCCESS) {
  18201. loaded = true;
  18202. break;
  18203. }
  18204. }
  18205. if (!loaded) {
  18206. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18207. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18208. SSL_SUCCESS) {
  18209. loaded = true;
  18210. break;
  18211. }
  18212. }
  18213. }
  18214. #endif
  18215. return loaded;
  18216. }
  18217. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18218. const char *password) {
  18219. if (!ctx || !cert || !key) { return false; }
  18220. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18221. // Load certificate
  18222. int ret = wolfSSL_CTX_use_certificate_buffer(
  18223. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18224. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18225. if (ret != SSL_SUCCESS) {
  18226. impl::wolfssl_last_error() =
  18227. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18228. return false;
  18229. }
  18230. // Set password callback if password is provided
  18231. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18232. // Load private key
  18233. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18234. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18235. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18236. if (ret != SSL_SUCCESS) {
  18237. impl::wolfssl_last_error() =
  18238. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18239. return false;
  18240. }
  18241. // Verify that the certificate and private key match
  18242. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18243. }
  18244. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18245. const char *key_path, const char *password) {
  18246. if (!ctx || !cert_path || !key_path) { return false; }
  18247. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18248. // Load certificate file
  18249. int ret =
  18250. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18251. if (ret != SSL_SUCCESS) {
  18252. impl::wolfssl_last_error() =
  18253. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18254. return false;
  18255. }
  18256. // Set password callback if password is provided
  18257. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18258. // Load private key file
  18259. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18260. if (ret != SSL_SUCCESS) {
  18261. impl::wolfssl_last_error() =
  18262. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18263. return false;
  18264. }
  18265. // Verify that the certificate and private key match
  18266. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18267. }
  18268. inline void set_verify_client(ctx_t ctx, bool require) {
  18269. if (!ctx) { return; }
  18270. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18271. wctx->verify_client = require;
  18272. if (require) {
  18273. wolfSSL_CTX_set_verify(
  18274. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18275. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18276. } else {
  18277. if (wctx->has_verify_callback) {
  18278. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18279. impl::wolfssl_verify_callback);
  18280. } else {
  18281. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18282. }
  18283. }
  18284. }
  18285. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18286. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18287. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18288. auto session = new (std::nothrow) impl::WolfSSLSession();
  18289. if (!session) { return nullptr; }
  18290. session->sock = sock;
  18291. session->ssl = wolfSSL_new(wctx->ctx);
  18292. if (!session->ssl) {
  18293. impl::wolfssl_last_error() =
  18294. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18295. delete session;
  18296. return nullptr;
  18297. }
  18298. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18299. return static_cast<session_t>(session);
  18300. }
  18301. inline void free_session(session_t session) {
  18302. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18303. }
  18304. inline bool set_sni(session_t session, const char *hostname,
  18305. bool verify_hostname) {
  18306. if (!session || !hostname) { return false; }
  18307. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18308. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18309. static_cast<word16>(strlen(hostname)));
  18310. if (ret != WOLFSSL_SUCCESS) {
  18311. impl::wolfssl_last_error() =
  18312. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18313. return false;
  18314. }
  18315. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18316. // separately from the SNI extension sent above; skip it when hostname
  18317. // verification is disabled so only the chain is checked, matching OpenSSL.
  18318. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18319. wsession->hostname = hostname;
  18320. return true;
  18321. }
  18322. inline TlsError connect(session_t session) {
  18323. TlsError err;
  18324. if (!session) {
  18325. err.code = ErrorCode::Fatal;
  18326. return err;
  18327. }
  18328. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18329. int ret = wolfSSL_connect(wsession->ssl);
  18330. if (ret == SSL_SUCCESS) {
  18331. err.code = ErrorCode::Success;
  18332. } else {
  18333. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18334. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18335. err.backend_code = static_cast<uint64_t>(ssl_error);
  18336. impl::wolfssl_last_error() = err.backend_code;
  18337. }
  18338. return err;
  18339. }
  18340. inline TlsError accept(session_t session) {
  18341. TlsError err;
  18342. if (!session) {
  18343. err.code = ErrorCode::Fatal;
  18344. return err;
  18345. }
  18346. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18347. int ret = wolfSSL_accept(wsession->ssl);
  18348. if (ret == SSL_SUCCESS) {
  18349. err.code = ErrorCode::Success;
  18350. // Capture SNI from thread-local storage after successful handshake
  18351. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18352. impl::wolfssl_pending_sni().clear();
  18353. } else {
  18354. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18355. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18356. err.backend_code = static_cast<uint64_t>(ssl_error);
  18357. impl::wolfssl_last_error() = err.backend_code;
  18358. }
  18359. return err;
  18360. }
  18361. inline bool connect_nonblocking(session_t session, socket_t sock,
  18362. time_t timeout_sec, time_t timeout_usec,
  18363. TlsError *err) {
  18364. if (!session) {
  18365. if (err) { err->code = ErrorCode::Fatal; }
  18366. return false;
  18367. }
  18368. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18369. // Set socket to non-blocking mode
  18370. detail::set_nonblocking(sock, true);
  18371. auto cleanup =
  18372. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18373. int ret;
  18374. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18375. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18376. if (ssl_error == SSL_ERROR_WANT_READ) {
  18377. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18378. continue;
  18379. }
  18380. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18381. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18382. continue;
  18383. }
  18384. }
  18385. // Error or timeout
  18386. if (err) {
  18387. err->code =
  18388. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18389. err->backend_code = static_cast<uint64_t>(ssl_error);
  18390. }
  18391. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18392. return false;
  18393. }
  18394. if (err) { err->code = ErrorCode::Success; }
  18395. return true;
  18396. }
  18397. inline bool accept_nonblocking(session_t session, socket_t sock,
  18398. time_t timeout_sec, time_t timeout_usec,
  18399. TlsError *err) {
  18400. if (!session) {
  18401. if (err) { err->code = ErrorCode::Fatal; }
  18402. return false;
  18403. }
  18404. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18405. // Set socket to non-blocking mode
  18406. detail::set_nonblocking(sock, true);
  18407. auto cleanup =
  18408. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18409. int ret;
  18410. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18411. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18412. if (ssl_error == SSL_ERROR_WANT_READ) {
  18413. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18414. continue;
  18415. }
  18416. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18417. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18418. continue;
  18419. }
  18420. }
  18421. // Error or timeout
  18422. if (err) {
  18423. err->code =
  18424. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18425. err->backend_code = static_cast<uint64_t>(ssl_error);
  18426. }
  18427. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18428. return false;
  18429. }
  18430. if (err) { err->code = ErrorCode::Success; }
  18431. // Capture SNI from thread-local storage after successful handshake
  18432. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18433. impl::wolfssl_pending_sni().clear();
  18434. return true;
  18435. }
  18436. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18437. if (!session || !buf) {
  18438. err.code = ErrorCode::Fatal;
  18439. return -1;
  18440. }
  18441. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18442. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18443. if (ret > 0) {
  18444. err.code = ErrorCode::Success;
  18445. return static_cast<ssize_t>(ret);
  18446. }
  18447. if (ret == 0) {
  18448. err.code = ErrorCode::PeerClosed;
  18449. return 0;
  18450. }
  18451. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18452. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18453. err.backend_code = static_cast<uint64_t>(ssl_error);
  18454. impl::wolfssl_last_error() = err.backend_code;
  18455. return -1;
  18456. }
  18457. inline ssize_t write(session_t session, const void *buf, size_t len,
  18458. TlsError &err) {
  18459. if (!session || !buf) {
  18460. err.code = ErrorCode::Fatal;
  18461. return -1;
  18462. }
  18463. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18464. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18465. if (ret > 0) {
  18466. err.code = ErrorCode::Success;
  18467. return static_cast<ssize_t>(ret);
  18468. }
  18469. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18470. // Treat this as an error (return -1) so callers don't spin in a
  18471. // write loop adding zero to the offset.
  18472. if (ret == 0) {
  18473. err.code = ErrorCode::PeerClosed;
  18474. return -1;
  18475. }
  18476. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18477. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18478. err.backend_code = static_cast<uint64_t>(ssl_error);
  18479. impl::wolfssl_last_error() = err.backend_code;
  18480. return -1;
  18481. }
  18482. inline int pending(const_session_t session) {
  18483. if (!session) { return 0; }
  18484. auto wsession =
  18485. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18486. return wolfSSL_pending(wsession->ssl);
  18487. }
  18488. inline void shutdown(session_t session, bool graceful) {
  18489. if (!session) { return; }
  18490. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18491. if (graceful) {
  18492. int ret;
  18493. int attempts = 0;
  18494. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18495. attempts < 3) {
  18496. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18497. if (ssl_error != SSL_ERROR_WANT_READ &&
  18498. ssl_error != SSL_ERROR_WANT_WRITE) {
  18499. break;
  18500. }
  18501. attempts++;
  18502. }
  18503. } else {
  18504. wolfSSL_shutdown(wsession->ssl);
  18505. }
  18506. }
  18507. inline bool is_peer_closed(session_t session, socket_t sock) {
  18508. if (!session || sock == INVALID_SOCKET) { return true; }
  18509. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18510. // Check if there's already decrypted data available
  18511. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18512. // Set socket to non-blocking to avoid blocking on read
  18513. detail::set_nonblocking(sock, true);
  18514. auto cleanup =
  18515. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18516. // Peek 1 byte to check connection status without consuming data
  18517. unsigned char buf;
  18518. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18519. // If we got data or WANT_READ (would block), connection is alive
  18520. if (ret > 0) { return false; }
  18521. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18522. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18523. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18524. ret == 0;
  18525. }
  18526. inline cert_t get_peer_cert(const_session_t session) {
  18527. if (!session) { return nullptr; }
  18528. auto wsession =
  18529. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18530. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18531. return static_cast<cert_t>(cert);
  18532. }
  18533. inline void free_cert(cert_t cert) {
  18534. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18535. }
  18536. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18537. if (!cert || !hostname) { return false; }
  18538. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18539. std::string host_str(hostname);
  18540. // Check if hostname is an IP address (IPv4 or IPv6)
  18541. unsigned char ip_bytes[16];
  18542. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18543. auto is_ip = ip_len > 0;
  18544. // Check Subject Alternative Names
  18545. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18546. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18547. if (san_names) {
  18548. int san_count = wolfSSL_sk_num(san_names);
  18549. for (int i = 0; i < san_count; i++) {
  18550. auto *names =
  18551. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18552. if (!names) continue;
  18553. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18554. // DNS name
  18555. unsigned char *dns_name = nullptr;
  18556. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18557. if (dns_name && dns_len > 0) {
  18558. std::string san_name(reinterpret_cast<char *>(dns_name),
  18559. static_cast<size_t>(dns_len));
  18560. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18561. if (detail::match_hostname(san_name, host_str)) {
  18562. wolfSSL_sk_free(san_names);
  18563. return true;
  18564. }
  18565. }
  18566. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18567. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18568. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18569. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18570. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18571. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18572. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18573. wolfSSL_sk_free(san_names);
  18574. return true;
  18575. }
  18576. }
  18577. }
  18578. wolfSSL_sk_free(san_names);
  18579. }
  18580. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18581. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18582. // the OpenSSL backend's X509_check_ip behaves the same way).
  18583. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18584. if (subject) {
  18585. char cn[256] = {};
  18586. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18587. sizeof(cn));
  18588. if (cn_len > 0) {
  18589. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18590. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18591. }
  18592. }
  18593. return false;
  18594. }
  18595. inline uint64_t hostname_mismatch_code() {
  18596. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18597. }
  18598. inline long get_verify_result(const_session_t session) {
  18599. if (!session) { return -1; }
  18600. auto wsession =
  18601. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18602. long result = wolfSSL_get_verify_result(wsession->ssl);
  18603. return result;
  18604. }
  18605. inline std::string get_cert_subject_cn(cert_t cert) {
  18606. if (!cert) return "";
  18607. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18608. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18609. if (!subject) return "";
  18610. char cn[256] = {};
  18611. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18612. sizeof(cn));
  18613. if (cn_len <= 0) return "";
  18614. return std::string(cn, static_cast<size_t>(cn_len));
  18615. }
  18616. inline std::string get_cert_issuer_name(cert_t cert) {
  18617. if (!cert) return "";
  18618. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18619. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18620. if (!issuer) return "";
  18621. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18622. if (!name_str) return "";
  18623. std::string result(name_str);
  18624. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18625. return result;
  18626. }
  18627. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18628. sans.clear();
  18629. if (!cert) return false;
  18630. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18631. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18632. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18633. if (!san_names) return true; // No SANs is not an error
  18634. int count = wolfSSL_sk_num(san_names);
  18635. for (int i = 0; i < count; i++) {
  18636. auto *name =
  18637. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18638. if (!name) continue;
  18639. SanEntry entry;
  18640. switch (name->type) {
  18641. case WOLFSSL_GEN_DNS: {
  18642. entry.type = SanType::DNS;
  18643. unsigned char *dns_name = nullptr;
  18644. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18645. if (dns_name && dns_len > 0) {
  18646. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18647. static_cast<size_t>(dns_len));
  18648. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18649. }
  18650. break;
  18651. }
  18652. case WOLFSSL_GEN_IPADD: {
  18653. entry.type = SanType::IP;
  18654. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18655. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18656. if (ip_data && ip_len == 4) {
  18657. char buf[16];
  18658. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18659. ip_data[2], ip_data[3]);
  18660. entry.value = buf;
  18661. } else if (ip_data && ip_len == 16) {
  18662. char buf[64];
  18663. snprintf(buf, sizeof(buf),
  18664. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18665. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18666. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18667. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18668. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18669. ip_data[14], ip_data[15]);
  18670. entry.value = buf;
  18671. }
  18672. break;
  18673. }
  18674. case WOLFSSL_GEN_EMAIL:
  18675. entry.type = SanType::EMAIL;
  18676. {
  18677. unsigned char *email = nullptr;
  18678. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18679. if (email && email_len > 0) {
  18680. entry.value = std::string(reinterpret_cast<char *>(email),
  18681. static_cast<size_t>(email_len));
  18682. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18683. }
  18684. }
  18685. break;
  18686. case WOLFSSL_GEN_URI:
  18687. entry.type = SanType::URI;
  18688. {
  18689. unsigned char *uri = nullptr;
  18690. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18691. &uri, name->d.uniformResourceIdentifier);
  18692. if (uri && uri_len > 0) {
  18693. entry.value = std::string(reinterpret_cast<char *>(uri),
  18694. static_cast<size_t>(uri_len));
  18695. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18696. }
  18697. }
  18698. break;
  18699. default: entry.type = SanType::OTHER; break;
  18700. }
  18701. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18702. }
  18703. wolfSSL_sk_free(san_names);
  18704. return true;
  18705. }
  18706. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18707. time_t &not_after) {
  18708. if (!cert) return false;
  18709. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18710. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18711. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18712. if (!nb || !na) return false;
  18713. // wolfSSL_ASN1_TIME_to_tm is available
  18714. struct tm tm_nb = {}, tm_na = {};
  18715. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18716. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18717. #ifdef _WIN32
  18718. not_before = _mkgmtime(&tm_nb);
  18719. not_after = _mkgmtime(&tm_na);
  18720. #else
  18721. not_before = timegm(&tm_nb);
  18722. not_after = timegm(&tm_na);
  18723. #endif
  18724. return true;
  18725. }
  18726. inline std::string get_cert_serial(cert_t cert) {
  18727. if (!cert) return "";
  18728. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18729. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18730. if (!serial_asn1) return "";
  18731. // Get the serial number data
  18732. int len = serial_asn1->length;
  18733. unsigned char *data = serial_asn1->data;
  18734. if (!data || len <= 0) return "";
  18735. std::string result;
  18736. result.reserve(static_cast<size_t>(len) * 2);
  18737. for (int i = 0; i < len; i++) {
  18738. char hex[3];
  18739. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18740. result += hex;
  18741. }
  18742. return result;
  18743. }
  18744. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18745. if (!cert) return false;
  18746. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18747. int der_len = 0;
  18748. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18749. if (!der_data || der_len <= 0) return false;
  18750. der.assign(der_data, der_data + der_len);
  18751. return true;
  18752. }
  18753. inline const char *get_sni(const_session_t session) {
  18754. if (!session) return nullptr;
  18755. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18756. // For server: return SNI received from client during handshake
  18757. if (!wsession->sni_hostname.empty()) {
  18758. return wsession->sni_hostname.c_str();
  18759. }
  18760. // For client: return the hostname set via set_sni
  18761. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18762. return nullptr;
  18763. }
  18764. inline uint64_t peek_error() {
  18765. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18766. }
  18767. inline uint64_t get_error() {
  18768. uint64_t err = impl::wolfssl_last_error();
  18769. impl::wolfssl_last_error() = 0;
  18770. return err;
  18771. }
  18772. inline std::string error_string(uint64_t code) {
  18773. char buf[256];
  18774. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18775. return std::string(buf);
  18776. }
  18777. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18778. if (!pem || len == 0) { return nullptr; }
  18779. // Validate by attempting to load into a temporary ctx
  18780. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18781. if (!tmp_ctx) { return nullptr; }
  18782. int ret = wolfSSL_CTX_load_verify_buffer(
  18783. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18784. static_cast<long>(len), SSL_FILETYPE_PEM);
  18785. wolfSSL_CTX_free(tmp_ctx);
  18786. if (ret != SSL_SUCCESS) { return nullptr; }
  18787. return static_cast<ca_store_t>(
  18788. new impl::WolfSSLCAStore{std::string(pem, len)});
  18789. }
  18790. inline void free_ca_store(ca_store_t store) {
  18791. delete static_cast<impl::WolfSSLCAStore *>(store);
  18792. }
  18793. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18794. if (!ctx || !store) { return false; }
  18795. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18796. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18797. int ret = wolfSSL_CTX_load_verify_buffer(
  18798. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18799. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18800. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18801. // This function takes ownership of the store; the PEM data was copied into
  18802. // the context, so release the source
  18803. free_ca_store(store);
  18804. return ret == SSL_SUCCESS;
  18805. }
  18806. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18807. certs.clear();
  18808. if (!ctx) { return 0; }
  18809. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18810. if (wctx->ca_pem_data_.empty()) { return 0; }
  18811. const std::string &pem = wctx->ca_pem_data_;
  18812. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18813. const std::string end_marker = "-----END CERTIFICATE-----";
  18814. size_t pos = 0;
  18815. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18816. size_t end_pos = pem.find(end_marker, pos);
  18817. if (end_pos == std::string::npos) { break; }
  18818. end_pos += end_marker.size();
  18819. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18820. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18821. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18822. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18823. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18824. pos = end_pos;
  18825. }
  18826. return certs.size();
  18827. }
  18828. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18829. std::vector<std::string> names;
  18830. if (!ctx) { return names; }
  18831. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18832. if (wctx->ca_pem_data_.empty()) { return names; }
  18833. const std::string &pem = wctx->ca_pem_data_;
  18834. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18835. const std::string end_marker = "-----END CERTIFICATE-----";
  18836. size_t pos = 0;
  18837. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18838. size_t end_pos = pem.find(end_marker, pos);
  18839. if (end_pos == std::string::npos) { break; }
  18840. end_pos += end_marker.size();
  18841. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18842. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18843. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18844. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18845. if (x509) {
  18846. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18847. if (subject) {
  18848. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  18849. if (name_str) {
  18850. names.push_back(name_str);
  18851. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18852. }
  18853. }
  18854. wolfSSL_X509_free(x509);
  18855. }
  18856. pos = end_pos;
  18857. }
  18858. return names;
  18859. }
  18860. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18861. const char *key_pem, const char *password) {
  18862. if (!ctx || !cert_pem || !key_pem) { return false; }
  18863. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18864. // Load new certificate
  18865. int ret = wolfSSL_CTX_use_certificate_buffer(
  18866. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  18867. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  18868. if (ret != SSL_SUCCESS) {
  18869. impl::wolfssl_last_error() =
  18870. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18871. return false;
  18872. }
  18873. // Set password if provided
  18874. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18875. // Load new private key
  18876. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18877. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  18878. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  18879. if (ret != SSL_SUCCESS) {
  18880. impl::wolfssl_last_error() =
  18881. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18882. return false;
  18883. }
  18884. return true;
  18885. }
  18886. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18887. if (!ctx || !ca_pem) { return false; }
  18888. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18889. int ret = wolfSSL_CTX_load_verify_buffer(
  18890. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  18891. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  18892. if (ret != SSL_SUCCESS) {
  18893. impl::wolfssl_last_error() =
  18894. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18895. return false;
  18896. }
  18897. return true;
  18898. }
  18899. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18900. if (!ctx) { return false; }
  18901. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18902. impl::get_verify_callback() = std::move(callback);
  18903. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  18904. if (wctx->has_verify_callback) {
  18905. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18906. impl::wolfssl_verify_callback);
  18907. } else {
  18908. wolfSSL_CTX_set_verify(
  18909. wctx->ctx,
  18910. wctx->verify_client
  18911. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  18912. : SSL_VERIFY_NONE,
  18913. nullptr);
  18914. }
  18915. return true;
  18916. }
  18917. inline long get_verify_error(const_session_t session) {
  18918. if (!session) { return -1; }
  18919. auto *wsession =
  18920. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18921. return wolfSSL_get_verify_result(wsession->ssl);
  18922. }
  18923. inline std::string verify_error_string(long error_code) {
  18924. if (error_code == 0) { return ""; }
  18925. const char *str =
  18926. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  18927. return str ? std::string(str) : std::string();
  18928. }
  18929. } // namespace tls
  18930. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  18931. // WebSocket implementation
  18932. namespace ws {
  18933. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  18934. bool fin) {
  18935. std::lock_guard<std::mutex> lock(write_mutex_);
  18936. if (closed_) { return false; }
  18937. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  18938. }
  18939. inline ReadResult WebSocket::read(std::string &msg) {
  18940. std::unique_lock<std::mutex> read_lock(read_mutex_);
  18941. while (!closed_) {
  18942. Opcode opcode;
  18943. std::string payload;
  18944. bool fin;
  18945. impl::FrameRead r =
  18946. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  18947. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  18948. // A timeout landed on a frame boundary: the connection is untouched and
  18949. // still usable, so hand control back without closing it.
  18950. if (r == impl::FrameRead::Timeout) { return Timeout; }
  18951. if (r != impl::FrameRead::Ok) {
  18952. closed_ = true;
  18953. return Fail;
  18954. }
  18955. switch (opcode) {
  18956. case Opcode::Ping: {
  18957. std::lock_guard<std::mutex> lock(write_mutex_);
  18958. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  18959. payload.size(), true, !is_server_);
  18960. continue;
  18961. }
  18962. case Opcode::Pong: {
  18963. std::lock_guard<std::mutex> lock(ping_mutex_);
  18964. unacked_pings_ = 0;
  18965. continue;
  18966. }
  18967. case Opcode::Close: {
  18968. if (!closed_.exchange(true)) {
  18969. // Echo close frame back
  18970. std::lock_guard<std::mutex> lock(write_mutex_);
  18971. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  18972. payload.size(), true, !is_server_);
  18973. }
  18974. return Fail;
  18975. }
  18976. case Opcode::Text:
  18977. case Opcode::Binary: {
  18978. auto result = opcode == Opcode::Text ? Text : Binary;
  18979. msg = std::move(payload);
  18980. // Handle fragmentation
  18981. if (!fin) {
  18982. while (true) {
  18983. Opcode cont_opcode;
  18984. std::string cont_payload;
  18985. bool cont_fin;
  18986. // A timeout is not reportable here: half of a fragmented message is
  18987. // already in `msg` and read() has no way to resume it, so it is a
  18988. // failure like any other. Timeouts are only ever seen on a message
  18989. // boundary.
  18990. if (impl::read_websocket_frame(
  18991. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  18992. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  18993. impl::FrameRead::Ok) {
  18994. closed_ = true;
  18995. return Fail;
  18996. }
  18997. if (cont_opcode == Opcode::Ping) {
  18998. std::lock_guard<std::mutex> lock(write_mutex_);
  18999. detail::write_websocket_frame(
  19000. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19001. true, !is_server_);
  19002. continue;
  19003. }
  19004. if (cont_opcode == Opcode::Pong) {
  19005. std::lock_guard<std::mutex> lock(ping_mutex_);
  19006. unacked_pings_ = 0;
  19007. continue;
  19008. }
  19009. if (cont_opcode == Opcode::Close) {
  19010. if (!closed_.exchange(true)) {
  19011. std::lock_guard<std::mutex> lock(write_mutex_);
  19012. detail::write_websocket_frame(
  19013. strm_, Opcode::Close, cont_payload.data(),
  19014. cont_payload.size(), true, !is_server_);
  19015. }
  19016. return Fail;
  19017. }
  19018. // RFC 6455: continuation frames must use opcode 0x0
  19019. if (cont_opcode != Opcode::Continuation) {
  19020. closed_ = true;
  19021. return Fail;
  19022. }
  19023. msg += cont_payload;
  19024. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19025. closed_ = true;
  19026. return Fail;
  19027. }
  19028. if (cont_fin) { break; }
  19029. }
  19030. }
  19031. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19032. if (result == Text && !impl::is_valid_utf8(msg)) {
  19033. // close() takes the read lock to wait for the peer's Close reply, so
  19034. // it must not run while this thread still holds it.
  19035. read_lock.unlock();
  19036. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19037. return Fail;
  19038. }
  19039. return result;
  19040. }
  19041. default: closed_ = true; return Fail;
  19042. }
  19043. }
  19044. return Fail;
  19045. }
  19046. inline bool WebSocket::send(const std::string &data) {
  19047. return send_frame(Opcode::Text, data.data(), data.size());
  19048. }
  19049. inline bool WebSocket::send(const char *data, size_t len) {
  19050. return send_frame(Opcode::Binary, data, len);
  19051. }
  19052. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19053. if (closed_.exchange(true)) { return; }
  19054. ping_cv_.notify_all();
  19055. std::string payload;
  19056. auto code = static_cast<uint16_t>(status);
  19057. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19058. payload.push_back(static_cast<char>(code & 0xFF));
  19059. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19060. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19061. payload += reason.substr(0, 123);
  19062. {
  19063. std::lock_guard<std::mutex> lock(write_mutex_);
  19064. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19065. payload.size(), true, !is_server_);
  19066. }
  19067. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19068. // Close response before closing the TCP connection.
  19069. //
  19070. // Wait only when no other thread is parsing frames. When one is, it is the
  19071. // thread positioned to see the peer's reply, and reading here would take
  19072. // bytes out of the message it is assembling. Bailing out also leaves the
  19073. // stream, including its read timeout, entirely to that thread.
  19074. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19075. if (!read_lock.owns_lock()) { return; }
  19076. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19077. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19078. Opcode op;
  19079. std::string resp;
  19080. bool fin;
  19081. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19082. impl::FrameRead::Ok) {
  19083. if (op == Opcode::Close) { break; }
  19084. }
  19085. }
  19086. inline WebSocket::~WebSocket() {
  19087. {
  19088. std::lock_guard<std::mutex> lock(ping_mutex_);
  19089. closed_ = true;
  19090. }
  19091. ping_cv_.notify_all();
  19092. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19093. }
  19094. inline void WebSocket::start_heartbeat() {
  19095. if (ping_interval_sec_ == 0) { return; }
  19096. ping_thread_ = std::thread([this]() {
  19097. std::unique_lock<std::mutex> lock(ping_mutex_);
  19098. while (!closed_) {
  19099. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19100. if (closed_) { break; }
  19101. // If the peer has failed to respond to the previous pings, give up.
  19102. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19103. // opt-in liveness check controlled by max_missed_pongs_.
  19104. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19105. lock.unlock();
  19106. close(CloseStatus::GoingAway, "pong timeout");
  19107. return;
  19108. }
  19109. lock.unlock();
  19110. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19111. lock.lock();
  19112. closed_ = true;
  19113. break;
  19114. }
  19115. lock.lock();
  19116. unacked_pings_++;
  19117. }
  19118. });
  19119. }
  19120. inline const Request &WebSocket::request() const { return req_; }
  19121. inline bool WebSocket::is_open() const { return !closed_; }
  19122. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19123. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19124. // poll(), where 0 would instead mean "return immediately", so hand it the
  19125. // negative poll uses for an unbounded wait.
  19126. if (sec == 0 && usec == 0) { sec = -1; }
  19127. strm_.set_read_timeout(sec, usec);
  19128. }
  19129. template <class Rep, class Period>
  19130. inline void WebSocket::set_read_timeout(
  19131. const std::chrono::duration<Rep, Period> &duration) {
  19132. detail::duration_to_sec_and_usec(
  19133. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  19134. }
  19135. // WebSocketClient implementation
  19136. inline WebSocketClient::WebSocketClient(
  19137. const std::string &scheme_host_port_path, const Headers &headers)
  19138. : headers_(headers) {
  19139. detail::UrlComponents uc;
  19140. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19141. !uc.host.empty() && !uc.path.empty()) {
  19142. auto &scheme = uc.scheme;
  19143. #ifdef CPPHTTPLIB_SSL_ENABLED
  19144. if (scheme != "ws" && scheme != "wss") {
  19145. #else
  19146. if (scheme != "ws") {
  19147. #endif
  19148. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19149. std::string msg = "'" + scheme + "' scheme is not supported.";
  19150. throw std::invalid_argument(msg);
  19151. #endif
  19152. return;
  19153. }
  19154. auto is_ssl = scheme == "wss";
  19155. host_ = std::move(uc.host);
  19156. port_ = is_ssl ? 443 : 80;
  19157. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19158. path_ = std::move(uc.path);
  19159. if (!uc.query.empty()) { path_ += uc.query; }
  19160. #ifdef CPPHTTPLIB_SSL_ENABLED
  19161. is_ssl_ = is_ssl;
  19162. if (is_ssl_) {
  19163. // The context lives as long as the client so that CA configuration
  19164. // survives reconnects; sessions are created per connection.
  19165. tls_ctx_ = tls::create_client_context();
  19166. if (!tls_ctx_) { return; }
  19167. }
  19168. #else
  19169. if (is_ssl) { return; }
  19170. #endif
  19171. is_valid_ = true;
  19172. }
  19173. }
  19174. #ifdef CPPHTTPLIB_SSL_ENABLED
  19175. inline WebSocketClient::WebSocketClient(
  19176. const std::string &scheme_host_port_path, const PemMemory &pem,
  19177. const Headers &headers)
  19178. : WebSocketClient(scheme_host_port_path, headers) {
  19179. // For ws:// URLs the client certificate is silently ignored, consistent
  19180. // with the TLS-only setters such as set_ca_cert_path().
  19181. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19182. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19183. pem.private_key_password)) {
  19184. tls::free_context(tls_ctx_);
  19185. tls_ctx_ = nullptr;
  19186. is_valid_ = false;
  19187. }
  19188. }
  19189. }
  19190. #endif
  19191. inline WebSocketClient::~WebSocketClient() {
  19192. shutdown_and_close();
  19193. #ifdef CPPHTTPLIB_SSL_ENABLED
  19194. if (tls_ctx_) {
  19195. tls::free_context(tls_ctx_);
  19196. tls_ctx_ = nullptr;
  19197. }
  19198. #endif
  19199. }
  19200. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19201. inline void WebSocketClient::shutdown_and_close() {
  19202. // Send the close frame while the TLS session is still alive: ws_ holds an
  19203. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19204. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19205. if (ws_ && ws_->is_open()) { ws_->close(); }
  19206. ws_.reset();
  19207. #ifdef CPPHTTPLIB_SSL_ENABLED
  19208. if (is_ssl_) {
  19209. if (tls_session_) {
  19210. tls::shutdown(tls_session_, true);
  19211. tls::free_session(tls_session_);
  19212. tls_session_ = nullptr;
  19213. }
  19214. }
  19215. #endif
  19216. if (sock_ != INVALID_SOCKET) {
  19217. detail::shutdown_socket(sock_);
  19218. detail::close_socket(sock_);
  19219. sock_ = INVALID_SOCKET;
  19220. }
  19221. }
  19222. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19223. Error &error, int &ssl_error,
  19224. uint64_t &ssl_backend_error) {
  19225. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19226. // The streams wait with poll(), where 0 instead means "return immediately",
  19227. // so they are given the negative poll uses for an unbounded wait.
  19228. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19229. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19230. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19231. // The handshake belongs to establishing the connection, so an unset read
  19232. // timeout leaves it bounded by the connection timeout instead of forever.
  19233. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19234. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19235. #ifdef CPPHTTPLIB_SSL_ENABLED
  19236. if (is_ssl_) {
  19237. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19238. // is not safe to call concurrently on one client to begin with, since
  19239. // nothing else here is guarded either.
  19240. if (server_certificate_verification_ && !certs_loaded_) {
  19241. uint64_t backend_error = 0;
  19242. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19243. ca_cert_dir_path_, custom_ca_loaded_,
  19244. system_ca_mode_, backend_error);
  19245. certs_loaded_ = true;
  19246. }
  19247. detail::ClientTlsSessionOptions options;
  19248. options.server_hostname_verification = server_hostname_verification_;
  19249. detail::ClientTlsSessionError tls_error;
  19250. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19251. server_certificate_verification_,
  19252. hs_sec, hs_usec, &tls_error,
  19253. options)) {
  19254. error = tls_error.error;
  19255. ssl_error = tls_error.ssl_error;
  19256. ssl_backend_error = tls_error.backend_error;
  19257. return false;
  19258. }
  19259. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19260. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19261. write_timeout_usec_));
  19262. return true;
  19263. }
  19264. #else
  19265. (void)error;
  19266. (void)ssl_error;
  19267. (void)ssl_backend_error;
  19268. (void)hs_sec;
  19269. (void)hs_usec;
  19270. #endif
  19271. strm = std::unique_ptr<Stream>(
  19272. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19273. write_timeout_sec_, write_timeout_usec_));
  19274. return true;
  19275. }
  19276. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19277. #ifdef CPPHTTPLIB_SSL_ENABLED
  19278. auto is_ssl = is_ssl_;
  19279. #else
  19280. auto is_ssl = false;
  19281. #endif
  19282. if (!req.has_header("Host")) {
  19283. req.headers.emplace("Host", detail::make_default_host_header_value(
  19284. host_, port_, is_ssl, address_family_));
  19285. }
  19286. detail::add_default_user_agent_header(req);
  19287. }
  19288. inline Result WebSocketClient::connect() {
  19289. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19290. shutdown_and_close();
  19291. // Check is custom IP or hostname specified for host_
  19292. std::string connect_host;
  19293. std::string ip;
  19294. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19295. auto error = Error::Success;
  19296. sock_ = detail::create_client_socket(
  19297. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19298. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19299. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19300. write_timeout_usec_, interface_, error);
  19301. if (sock_ == INVALID_SOCKET) {
  19302. if (error == Error::Success) { error = Error::Connection; }
  19303. return Result{error, -1, Headers{}};
  19304. }
  19305. std::unique_ptr<Stream> strm;
  19306. auto stream_error = Error::SSLConnection;
  19307. int ssl_error = 0;
  19308. uint64_t ssl_backend_error = 0;
  19309. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19310. shutdown_and_close();
  19311. #ifdef CPPHTTPLIB_SSL_ENABLED
  19312. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19313. #else
  19314. return Result{stream_error, -1, Headers{}};
  19315. #endif
  19316. }
  19317. Request req;
  19318. req.method = "GET";
  19319. req.path = path_;
  19320. req.headers = headers_;
  19321. prepare_default_headers(req);
  19322. detail::WebSocketUpgradeResponse upgrade;
  19323. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19324. shutdown_and_close();
  19325. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19326. }
  19327. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19328. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19329. websocket_ping_interval_sec_,
  19330. websocket_max_missed_pongs_));
  19331. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19332. }
  19333. inline ReadResult WebSocketClient::read(std::string &msg) {
  19334. if (!ws_) { return Fail; }
  19335. return ws_->read(msg);
  19336. }
  19337. inline bool WebSocketClient::send(const std::string &data) {
  19338. if (!ws_) { return false; }
  19339. return ws_->send(data);
  19340. }
  19341. inline bool WebSocketClient::send(const char *data, size_t len) {
  19342. if (!ws_) { return false; }
  19343. return ws_->send(data, len);
  19344. }
  19345. inline void WebSocketClient::close(CloseStatus status,
  19346. const std::string &reason) {
  19347. if (ws_) { ws_->close(status, reason); }
  19348. }
  19349. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19350. inline const std::string &WebSocketClient::subprotocol() const {
  19351. return subprotocol_;
  19352. }
  19353. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19354. read_timeout_sec_ = sec;
  19355. read_timeout_usec_ = usec;
  19356. // The members above only seed the next connect(); read() consults the
  19357. // stream, so an already-open connection has to be told directly.
  19358. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19359. }
  19360. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19361. write_timeout_sec_ = sec;
  19362. write_timeout_usec_ = usec;
  19363. }
  19364. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19365. websocket_ping_interval_sec_ = sec;
  19366. }
  19367. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19368. websocket_max_missed_pongs_ = count;
  19369. }
  19370. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19371. inline void WebSocketClient::set_address_family(int family) {
  19372. address_family_ = family;
  19373. }
  19374. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19375. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19376. socket_options_ = std::move(socket_options);
  19377. }
  19378. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19379. connection_timeout_sec_ = sec;
  19380. connection_timeout_usec_ = usec;
  19381. }
  19382. inline void WebSocketClient::set_interface(const std::string &intf) {
  19383. interface_ = intf;
  19384. }
  19385. inline void WebSocketClient::set_hostname_addr_map(
  19386. std::map<std::string, std::string> addr_map) {
  19387. addr_map_ = std::move(addr_map);
  19388. }
  19389. #ifdef CPPHTTPLIB_SSL_ENABLED
  19390. inline void
  19391. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19392. const std::string &ca_cert_dir_path) {
  19393. ca_cert_file_path_ = ca_cert_file_path;
  19394. ca_cert_dir_path_ = ca_cert_dir_path;
  19395. }
  19396. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19397. if (store && tls_ctx_) {
  19398. // set_ca_store takes ownership of store
  19399. tls::set_ca_store(tls_ctx_, store);
  19400. custom_ca_loaded_ = true;
  19401. } else if (store) {
  19402. tls::free_ca_store(store);
  19403. }
  19404. }
  19405. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19406. std::size_t size) {
  19407. if (tls_ctx_ && ca_cert && size > 0) {
  19408. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19409. custom_ca_loaded_ = true;
  19410. }
  19411. }
  19412. inline void
  19413. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19414. server_certificate_verification_ = enabled;
  19415. }
  19416. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19417. server_hostname_verification_ = enabled;
  19418. }
  19419. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19420. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19421. }
  19422. #endif // CPPHTTPLIB_SSL_ENABLED
  19423. } // namespace ws
  19424. // ----------------------------------------------------------------------------
  19425. } // namespace httplib
  19426. #endif // CPPHTTPLIB_HTTPLIB_H